ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ImageRegistrationMethod< TFixedImage, TMovingImage > Class Template Reference
Data Processing Objects » Filters » Registration Filters | Group Registration » Module ITKRegistrationCommon

#include <itkImageRegistrationMethod.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::ImageRegistrationMethod< TFixedImage, TMovingImage >

Base class for Image Registration Methods.

This Class define the generic interface for a registration method.

This class is templated over the type of the two image 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 image are used in this class to indicate what image is being mapped by the transform.

This class uses the coordinate system of the Fixed image as a reference and searches for a Transform that will map points from the space of the Fixed image to the space of the Moving image.

For doing so, a Metric will be continuously applied to compare the Fixed image with the Transformed Moving image. This process also requires to interpolate values from the Moving image.

ITK Sphinx Examples:
  • <a href=
  • <a href=
  • <a href=
  • <a href=

Definition at line 70 of file itkImageRegistrationMethod.h.

+ Inheritance diagram for itk::ImageRegistrationMethod< TFixedImage, TMovingImage >:
+ Collaboration diagram for itk::ImageRegistrationMethod< TFixedImage, TMovingImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DataObjectPointer = typename DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
using FixedImageConstPointer = typename FixedImageType::ConstPointer
 
using FixedImageRegionType = typename MetricType::FixedImageRegionType
 
using FixedImageType = TFixedImage
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = typename MetricType::InterpolatorType
 
using MetricPointer = typename MetricType::Pointer
 
using MetricType = ImageToImageMetric< FixedImageType, MovingImageType >
 
using MovingImageConstPointer = typename MovingImageType::ConstPointer
 
using MovingImageType = TMovingImage
 
using OptimizerType = SingleValuedNonLinearOptimizer
 
using ParametersType = typename MetricType::TransformParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageRegistrationMethod
 
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 FixedImageRegionType & GetFixedImageRegion () const
 
virtual bool GetFixedImageRegionDefined () const
 
virtual const ParametersType & GetInitialTransformParameters () const
 
virtual const ParametersType & GetLastTransformParameters () const
 
ModifiedTimeType GetMTime () const override
 
const char * GetNameOfClass () const override
 
const TransformOutputType * GetOutput () const
 
virtual void Initialize ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType output) override
 
void SetFixedImageRegion (const FixedImageRegionType &region)
 
virtual void SetFixedImageRegionDefined (bool _arg)
 
virtual void SetInitialTransformParameters (const ParametersType &param)
 
void SetFixedImage (const FixedImageType *fixedImage)
 
virtual const FixedImageType * GetFixedImage () const
 
void SetMovingImage (const MovingImageType *movingImage)
 
virtual const MovingImageType * GetMovingImage () const
 
virtual void SetOptimizer (OptimizerType *_arg)
 
virtual OptimizerType * GetModifiableOptimizer ()
 
virtual void SetMetric (MetricType *_arg)
 
virtual MetricType * GetModifiableMetric ()
 
virtual void SetTransform (TransformType *_arg)
 
virtual TransformType * GetModifiableTransform ()
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual InterpolatorType * GetModifiableInterpolator ()
 
- 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 ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
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 DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
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 ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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
 
 ImageRegistrationMethod ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetLastTransformParameters (ParametersType _arg)
 
void StartOptimization ()
 
 ~ImageRegistrationMethod () 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 GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () 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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () 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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

FixedImageConstPointer m_FixedImage {}
 
FixedImageRegionType m_FixedImageRegion {}
 
bool m_FixedImageRegionDefined {}
 
ParametersType m_InitialTransformParameters {}
 
InterpolatorPointer m_Interpolator {}
 
ParametersType m_LastTransformParameters {}
 
MetricPointer m_Metric {}
 
MovingImageConstPointer m_MovingImage {}
 
OptimizerType::Pointer m_Optimizer {}
 
TransformPointer m_Transform {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 79 of file itkImageRegistrationMethod.h.

◆ DataObjectPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointer = typename DataObject::Pointer

Smart Pointer type to a DataObject.

Definition at line 122 of file itkImageRegistrationMethod.h.

◆ DataObjectPointerArraySizeType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

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

Definition at line 202 of file itkImageRegistrationMethod.h.

◆ FixedImageConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageConstPointer = typename FixedImageType::ConstPointer

Definition at line 89 of file itkImageRegistrationMethod.h.

◆ FixedImageRegionType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageRegionType = typename MetricType::FixedImageRegionType

Definition at line 98 of file itkImageRegistrationMethod.h.

◆ FixedImageType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::FixedImageType = TFixedImage

Type of the Fixed image.

Definition at line 88 of file itkImageRegistrationMethod.h.

◆ InterpolatorPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 112 of file itkImageRegistrationMethod.h.

◆ InterpolatorType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::InterpolatorType = typename MetricType::InterpolatorType

Type of the Interpolator.

Definition at line 111 of file itkImageRegistrationMethod.h.

◆ MetricPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MetricPointer = typename MetricType::Pointer

Definition at line 97 of file itkImageRegistrationMethod.h.

◆ MetricType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MetricType = ImageToImageMetric<FixedImageType, MovingImageType>

Type of the metric.

Definition at line 96 of file itkImageRegistrationMethod.h.

◆ MovingImageConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageConstPointer = typename MovingImageType::ConstPointer

Definition at line 93 of file itkImageRegistrationMethod.h.

◆ MovingImageType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::MovingImageType = TMovingImage

Type of the Moving image.

Definition at line 92 of file itkImageRegistrationMethod.h.

◆ OptimizerType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::OptimizerType = SingleValuedNonLinearOptimizer

Type of the optimizer.

Definition at line 115 of file itkImageRegistrationMethod.h.

◆ ParametersType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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 119 of file itkImageRegistrationMethod.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 78 of file itkImageRegistrationMethod.h.

◆ Self

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Self = ImageRegistrationMethod

Standard class type aliases.

Definition at line 76 of file itkImageRegistrationMethod.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Superclass = ProcessObject

Definition at line 77 of file itkImageRegistrationMethod.h.

◆ TransformOutputConstPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputConstPointer = typename TransformOutputType::ConstPointer

Definition at line 108 of file itkImageRegistrationMethod.h.

◆ TransformOutputPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputPointer = typename TransformOutputType::Pointer

Definition at line 107 of file itkImageRegistrationMethod.h.

◆ TransformOutputType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformOutputType = DataObjectDecorator<TransformType>

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

Definition at line 106 of file itkImageRegistrationMethod.h.

◆ TransformPointer

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformPointer = typename TransformType::Pointer

Definition at line 102 of file itkImageRegistrationMethod.h.

◆ TransformType

template<typename TFixedImage , typename TMovingImage >
using itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::TransformType = typename MetricType::TransformType

Type of the Transform .

Definition at line 101 of file itkImageRegistrationMethod.h.

Constructor & Destructor Documentation

◆ ImageRegistrationMethod()

template<typename TFixedImage , typename TMovingImage >
itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod ( )
protected

◆ ~ImageRegistrationMethod()

template<typename TFixedImage , typename TMovingImage >
itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::~ImageRegistrationMethod ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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 TMovingImage >
virtual const FixedImageType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImage ( ) const
virtual

Set/Get the Fixed image.

◆ GetFixedImageRegion()

template<typename TFixedImage , typename TMovingImage >
virtual const FixedImageRegionType & itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegion ( ) const
virtual

Get the region of the fixed image to be considered as region of interest during the registration. This region will be passed to the ImageMetric in order to restrict the metric computation to consider only this region.

◆ GetFixedImageRegionDefined()

template<typename TFixedImage , typename TMovingImage >
virtual bool itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetFixedImageRegionDefined ( ) const
virtual

True if a region has been defined for the fixed image to which the ImageMetric will limit its computation

◆ GetInitialTransformParameters()

template<typename TFixedImage , typename TMovingImage >
virtual const ParametersType & itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetInitialTransformParameters ( ) const
virtual

◆ GetLastTransformParameters()

template<typename TFixedImage , typename TMovingImage >
virtual const ParametersType & itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetLastTransformParameters ( ) const
virtual

Get the last transformation parameters visited by the optimizer.

◆ GetModifiableInterpolator()

template<typename TFixedImage , typename TMovingImage >
virtual InterpolatorType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableInterpolator ( )
virtual

Set/Get the Interpolator.

◆ GetModifiableMetric()

template<typename TFixedImage , typename TMovingImage >
virtual MetricType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableMetric ( )
virtual

Set/Get the Metric.

◆ GetModifiableOptimizer()

template<typename TFixedImage , typename TMovingImage >
virtual OptimizerType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableOptimizer ( )
virtual

Set/Get the Optimizer.

◆ GetModifiableTransform()

template<typename TFixedImage , typename TMovingImage >
virtual TransformType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetModifiableTransform ( )
virtual

Set/Get the Transform.

◆ GetMovingImage()

template<typename TFixedImage , typename TMovingImage >
virtual const MovingImageType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetMovingImage ( ) const
virtual

Set/Get the Moving image.

◆ GetMTime()

template<typename TFixedImage , typename TMovingImage >
ModifiedTimeType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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 TMovingImage >
const char * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetOutput()

template<typename TFixedImage , typename TMovingImage >
const TransformOutputType * itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::GetOutput ( ) const

Returns the transform resulting from the registration process

◆ Initialize()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::Initialize ( )
virtual

Initialize by setting the interconnects between the components.

◆ MakeOutput()

template<typename TFixedImage , typename TMovingImage >
DataObjectPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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 TMovingImage >
static Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::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 TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImage ( const FixedImageType *  fixedImage)

Set/Get the Fixed image.

◆ SetFixedImageRegion()

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegion ( const FixedImageRegionType &  region)

Set the region of the fixed image to be considered as region of interest during the registration. This region will be passed to the ImageMetric in order to restrict the metric computation to consider only this region.

Warning
The same region can also be set directly into the metric. please avoid to set the region in both places since this can lead to inconsistent configurations.

◆ SetFixedImageRegionDefined()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetFixedImageRegionDefined ( bool  _arg)
virtual

Turn on/off the use of a fixed image region to which the ImageMetric will limit its computation.

Warning
The region must have been previously defined using the SetFixedImageRegion member function

◆ SetInitialTransformParameters()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetInitialTransformParameters ( const ParametersType &  param)
virtual

Set/Get the initial transformation parameters.

◆ SetInterpolator()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetInterpolator ( InterpolatorType *  _arg)
virtual

Set/Get the Interpolator.

◆ SetLastTransformParameters()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetLastTransformParameters ( ParametersType  _arg)
protectedvirtual

Provides derived classes with the ability to set this private var

◆ SetMetric()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetMetric ( MetricType *  _arg)
virtual

Set/Get the Metric.

◆ SetMovingImage()

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetMovingImage ( const MovingImageType *  movingImage)

Set/Get the Moving image.

◆ SetOptimizer()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetOptimizer ( OptimizerType *  _arg)
virtual

Set/Get the Optimizer.

◆ SetTransform()

template<typename TFixedImage , typename TMovingImage >
virtual void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::SetTransform ( TransformType *  _arg)
virtual

Set/Get the Transform.

◆ StartOptimization()

template<typename TFixedImage , typename TMovingImage >
void itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::StartOptimization ( )
protected

Start the optimization.

Member Data Documentation

◆ m_FixedImage

template<typename TFixedImage , typename TMovingImage >
FixedImageConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_FixedImage {}
private

Definition at line 234 of file itkImageRegistrationMethod.h.

◆ m_FixedImageRegion

template<typename TFixedImage , typename TMovingImage >
FixedImageRegionType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_FixedImageRegion {}
private

Definition at line 243 of file itkImageRegistrationMethod.h.

◆ m_FixedImageRegionDefined

template<typename TFixedImage , typename TMovingImage >
bool itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_FixedImageRegionDefined {}
private

Definition at line 242 of file itkImageRegistrationMethod.h.

◆ m_InitialTransformParameters

template<typename TFixedImage , typename TMovingImage >
ParametersType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_InitialTransformParameters {}
private

Definition at line 239 of file itkImageRegistrationMethod.h.

◆ m_Interpolator

template<typename TFixedImage , typename TMovingImage >
InterpolatorPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Interpolator {}
private

Definition at line 237 of file itkImageRegistrationMethod.h.

◆ m_LastTransformParameters

template<typename TFixedImage , typename TMovingImage >
ParametersType itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_LastTransformParameters {}
private

Definition at line 240 of file itkImageRegistrationMethod.h.

◆ m_Metric

template<typename TFixedImage , typename TMovingImage >
MetricPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Metric {}
private

Definition at line 230 of file itkImageRegistrationMethod.h.

◆ m_MovingImage

template<typename TFixedImage , typename TMovingImage >
MovingImageConstPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_MovingImage {}
private

Definition at line 233 of file itkImageRegistrationMethod.h.

◆ m_Optimizer

template<typename TFixedImage , typename TMovingImage >
OptimizerType::Pointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Optimizer {}
private

Definition at line 231 of file itkImageRegistrationMethod.h.

◆ m_Transform

template<typename TFixedImage , typename TMovingImage >
TransformPointer itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::m_Transform {}
private

Definition at line 236 of file itkImageRegistrationMethod.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3