ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject > Class Template Reference

#include <itkImageToSpatialObjectRegistrationMethod.h>

Detailed Description

template<typename TFixedImage, typename TMovingSpatialObject>
class itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >

Base class for Image Registration Methods.

This class is templated over the type of the image and the type of the SpatialObject to be registered. A generic Transform is used by this class. That allows to select at run time the particular type of transformation that is to be applied for registering the images.

This method use a generic Metric in order to compare the two images. the final goal of the registration method is to find the set of parameters of the Transformation that optimizes the metric.

The registration method also support a generic optimizer that can be selected at run-time. The only restriction for the optimizer is that it should be able to operate in single-valued cost functions given that the metrics used to compare images provide a single value as output.

The terms : Fixed image and Moving SpatialObject are used in this class to indicate that the SpatialObject is being mapped by the transform.

This class uses the coordinate system of the Fixed image and searches for a transform that will map the Moving SpatialObject on top of the Fixed image. For doing so, a Metric will be continuously applied to compare the Fixed image with the Transformed Moving SpatialObject.

The ImageToSpatialObjectRegistrationMethod is different from the rest of the registration framework in ITK regarding the interpretation of the Transform with respect to the Fixed and Moving objects. In most of the ITK registration framework, the Transform computed by the optimizer is the one that maps points from the space of the Fixed object into the space of the Moving object. This direction of the transform is the one that makes easier to resample the Moving object into the space of the Fixed object.

In the particular case of ImageToSpatialObject registration, the Transform to be computed is the one mapping points from the SpatialObject into the Image. This allows the SpatialObject to drive the location and geometry of the measurements made in the image - thereby if the spatial object is sparse and/or contains varying geometric features, the metric applied to measure how well that object matches with the image can be rapidly computed only at the sparse locations and using measures that match the local geometry that should be at those locations in the image. This is particularly useful for fast intra-operative registration when the pre-operative data is used to define a SpatialObject and can anticipate how that object will appear in the intra-operative images.

A full discussion of the Transform directions in the ITK registration framework can be found in the ITK Software Guide.

Examples
Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

Definition at line 84 of file itkImageToSpatialObjectRegistrationMethod.h.

+ Inheritance diagram for itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >:
+ Collaboration diagram for itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DataObjectPointer = typename DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
using FixedImageConstPointer = typename FixedImageType::ConstPointer
 
using FixedImageType = TFixedImage
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = typename MetricType::InterpolatorType
 
using MetricPointer = typename MetricType::Pointer
 
using MetricType = ImageToSpatialObjectMetric< FixedImageType, MovingSpatialObjectType >
 
using MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer
 
using MovingSpatialObjectType = TMovingSpatialObject
 
using OptimizerType = SingleValuedNonLinearOptimizer
 
using ParametersType = typename MetricType::TransformParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToSpatialObjectRegistrationMethod
 
using Superclass = ProcessObject
 
using TransformOutputConstPointer = typename TransformOutputType::ConstPointer
 
using TransformOutputPointer = typename TransformOutputType::Pointer
 
using TransformOutputType = DataObjectDecorator< TransformType >
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = typename MetricType::TransformType
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const ParametersTypeGetLastTransformParameters () const
 
ModifiedTimeType GetMTime () const override
 
const char * GetNameOfClass () const override
 
const TransformOutputTypeGetOutput () const
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType output) override
 
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual const FixedImageTypeGetFixedImage () const
 
virtual void SetMovingSpatialObject (const MovingSpatialObjectType *_arg)
 
virtual const MovingSpatialObjectTypeGetMovingSpatialObject () const
 
virtual void SetOptimizer (OptimizerType *_arg)
 
virtual OptimizerTypeGetModifiableOptimizer ()
 
virtual void SetMetric (MetricType *_arg)
 
virtual MetricTypeGetModifiableMetric ()
 
virtual void SetTransform (TransformType *_arg)
 
virtual TransformTypeGetModifiableTransform ()
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual void SetInitialTransformParameters (ParametersType _arg)
 
virtual const ParametersTypeGetInitialTransformParameters () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData () override
 
 ImageToSpatialObjectRegistrationMethod ()
 
void Initialize ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageToSpatialObjectRegistrationMethod () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ParametersType m_InitialTransformParameters {}
 
ParametersType m_LastTransformParameters {}
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Attributes

FixedImageConstPointer m_FixedImage {}
 
InterpolatorPointer m_Interpolator {}
 
MetricPointer m_Metric {}
 
MovingSpatialObjectConstPointer m_MovingSpatialObject {}
 
OptimizerType::Pointer m_Optimizer {}
 
TransformPointer m_Transform {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ConstPointer = SmartPointer<const Self>

Definition at line 93 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ DataObjectPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::DataObjectPointer = typename DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 135 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ DataObjectPointerArraySizeType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

Make a DataObject of the correct type to be used as the specified output.

Definition at line 182 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ FixedImageConstPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::FixedImageConstPointer = typename FixedImageType::ConstPointer

Definition at line 103 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ FixedImageType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::FixedImageType = TFixedImage

Type of the Fixed image.

Definition at line 102 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ InterpolatorPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 125 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ InterpolatorType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::InterpolatorType = typename MetricType::InterpolatorType

Type of the Interpolator.

Definition at line 124 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ MetricPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::MetricPointer = typename MetricType::Pointer

Definition at line 111 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ MetricType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::MetricType = ImageToSpatialObjectMetric<FixedImageType, MovingSpatialObjectType>

Type of the metric.

Definition at line 110 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ MovingSpatialObjectConstPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer

Definition at line 107 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ MovingSpatialObjectType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::MovingSpatialObjectType = TMovingSpatialObject

Type of the Moving image.

Definition at line 106 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ OptimizerType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::OptimizerType = SingleValuedNonLinearOptimizer

Type of the optimizer.

Definition at line 128 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ ParametersType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ParametersType = typename MetricType::TransformParametersType

Type of the Transformation parameters This is the same type used to represent the search space of the optimization algorithm

Definition at line 132 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ Pointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::Pointer = SmartPointer<Self>

Definition at line 92 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ Self

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::Self = ImageToSpatialObjectRegistrationMethod

Standard class type aliases.

Definition at line 90 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ Superclass

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::Superclass = ProcessObject

Definition at line 91 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ TransformOutputConstPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::TransformOutputConstPointer = typename TransformOutputType::ConstPointer

Definition at line 121 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ TransformOutputPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::TransformOutputPointer = typename TransformOutputType::Pointer

Definition at line 120 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ TransformOutputType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::TransformOutputType = DataObjectDecorator<TransformType>

Type for the output: Using Decorator pattern for enabling the Transform to be passed in the data pipeline

Definition at line 119 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ TransformPointer

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::TransformPointer = typename TransformType::Pointer

Definition at line 115 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ TransformType

template<typename TFixedImage , typename TMovingSpatialObject >
using itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::TransformType = typename MetricType::TransformType

Type of the Transform .

Definition at line 114 of file itkImageToSpatialObjectRegistrationMethod.h.

Constructor & Destructor Documentation

◆ ImageToSpatialObjectRegistrationMethod()

template<typename TFixedImage , typename TMovingSpatialObject >
itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectRegistrationMethod ( )
protected

◆ ~ImageToSpatialObjectRegistrationMethod()

template<typename TFixedImage , typename TMovingSpatialObject >
itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::~ImageToSpatialObjectRegistrationMethod ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TFixedImage , typename TMovingSpatialObject >
void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GenerateData ( )
overrideprotectedvirtual

Method invoked by the pipeline in order to trigger the computation of the registration.

Reimplemented from itk::ProcessObject.

◆ GetFixedImage()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual const FixedImageType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetFixedImage ( ) const
virtual

Set/Get the Fixed image.

◆ GetInitialTransformParameters()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual const ParametersType& itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetInitialTransformParameters ( ) const
virtual

Set/Get the initial transformation parameters.

◆ GetLastTransformParameters()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual const ParametersType& itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetLastTransformParameters ( ) const
virtual

Get the last transformation parameters visited by the optimizer.

◆ GetModifiableInterpolator()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual InterpolatorType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetModifiableInterpolator ( )
virtual

Set/Get the Interpolator.

◆ GetModifiableMetric()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual MetricType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetModifiableMetric ( )
virtual

Set/Get the Metric.

◆ GetModifiableOptimizer()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual OptimizerType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetModifiableOptimizer ( )
virtual

Set/Get the Optimizer.

◆ GetModifiableTransform()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual TransformType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetModifiableTransform ( )
virtual

Set/Get the Transform.

◆ GetMovingSpatialObject()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual const MovingSpatialObjectType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetMovingSpatialObject ( ) const
virtual

Set/Get the Moving Spatial Object.

◆ GetMTime()

template<typename TFixedImage , typename TMovingSpatialObject >
ModifiedTimeType itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetMTime ( ) const
overridevirtual

Method to return the latest modified time of this object or any of its cached ivars

Reimplemented from itk::Object.

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingSpatialObject >
const char* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetNameOfClass ( ) const
overridevirtual

◆ GetOutput()

template<typename TFixedImage , typename TMovingSpatialObject >
const TransformOutputType* itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::GetOutput ( ) const

Returns the transform resulting from the registration process

◆ Initialize()

template<typename TFixedImage , typename TMovingSpatialObject >
void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::Initialize ( )
protected

Initialize by setting the interconnects between the components.

◆ MakeOutput()

template<typename TFixedImage , typename TMovingSpatialObject >
DataObjectPointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TFixedImage , typename TMovingSpatialObject >
static Pointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingSpatialObject >
void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ SetFixedImage()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetFixedImage ( const FixedImageType _arg)
virtual

Set/Get the Fixed image.

◆ SetInitialTransformParameters()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetInitialTransformParameters ( ParametersType  _arg)
virtual

Set/Get the initial transformation parameters.

◆ SetInterpolator()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetInterpolator ( InterpolatorType _arg)
virtual

Set/Get the Interpolator.

◆ SetMetric()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetMetric ( MetricType _arg)
virtual

Set/Get the Metric.

◆ SetMovingSpatialObject()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetMovingSpatialObject ( const MovingSpatialObjectType _arg)
virtual

Set/Get the Moving Spatial Object.

◆ SetOptimizer()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetOptimizer ( OptimizerType _arg)
virtual

Set/Get the Optimizer.

◆ SetTransform()

template<typename TFixedImage , typename TMovingSpatialObject >
virtual void itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::SetTransform ( TransformType _arg)
virtual

Set/Get the Transform.

Member Data Documentation

◆ m_FixedImage

template<typename TFixedImage , typename TMovingSpatialObject >
FixedImageConstPointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_FixedImage {}
private

Definition at line 215 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_InitialTransformParameters

template<typename TFixedImage , typename TMovingSpatialObject >
ParametersType itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_InitialTransformParameters {}
protected

Definition at line 207 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_Interpolator

template<typename TFixedImage , typename TMovingSpatialObject >
InterpolatorPointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_Interpolator {}
private

Definition at line 218 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_LastTransformParameters

template<typename TFixedImage , typename TMovingSpatialObject >
ParametersType itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_LastTransformParameters {}
protected

Definition at line 208 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_Metric

template<typename TFixedImage , typename TMovingSpatialObject >
MetricPointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_Metric {}
private

Definition at line 211 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_MovingSpatialObject

template<typename TFixedImage , typename TMovingSpatialObject >
MovingSpatialObjectConstPointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_MovingSpatialObject {}
private

Definition at line 214 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_Optimizer

template<typename TFixedImage , typename TMovingSpatialObject >
OptimizerType::Pointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_Optimizer {}
private

Definition at line 212 of file itkImageToSpatialObjectRegistrationMethod.h.

◆ m_Transform

template<typename TFixedImage , typename TMovingSpatialObject >
TransformPointer itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::m_Transform {}
private

Definition at line 217 of file itkImageToSpatialObjectRegistrationMethod.h.


The documentation for this class was generated from the following file: