itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > Class Template Reference

#include <itkPDEDeformableRegistrationFunction.h>

Inheritance diagram for itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:

Collaboration diagram for itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >:

Detailed Description

template<typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >

This is an abstract base class for all PDE functions which drives a deformable registration algorithm. It is used by PDEDeformationRegistrationFilter subclasses to compute the output deformation field which will map a moving image onto a fixed image.

This class is templated over the fixed image type, moving image type and the deformation field type.

See Also

PDEDeformableRegistrationFilter

Definition at line 41 of file itkPDEDeformableRegistrationFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TDisplacementField	DisplacementFieldType
typedef DisplacementFieldType::Pointer	DisplacementFieldTypePointer
typedef FixedImageType::ConstPointer	FixedImagePointer
typedef TFixedImage	FixedImageType
typedef MovingImageType::ConstPointer	MovingImagePointer
typedef TMovingImage	MovingImageType
typedef SmartPointer< Self >	Pointer
typedef PDEDeformableRegistrationFunction	Self
typedef FiniteDifferenceFunction < TDisplacementField >	Superclass
Public Types inherited from itk::FiniteDifferenceFunction< TDisplacementField >
typedef SmartPointer< const Self >	ConstPointer
typedef ZeroFluxNeumannBoundaryCondition < ImageType >	DefaultBoundaryConditionType
typedef Vector< float, itkGetStaticConstMacro(ImageDimension) >	FloatOffsetType
typedef TDisplacementField	ImageType
typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension) >	NeighborhoodScalesType
typedef ConstNeighborhoodIterator < TDisplacementField, DefaultBoundaryConditionType >	NeighborhoodType
typedef double	PixelRealType
typedef ImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef ConstNeighborhoodIterator < TDisplacementField > ::RadiusType	RadiusType
typedef FiniteDifferenceFunction	Self
typedef LightObject	Superclass
typedef double	TimeStepType
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
DisplacementFieldType *	GetDisplacementField (void)
double	GetEnergy () const
const FixedImageType *	GetFixedImage (void) const
double	GetGradientStep () const
const MovingImageType *	GetMovingImage (void) const
virtual const char *	GetNameOfClass () const
bool	GetNormalizeGradient () const
void	SetDisplacementField (DisplacementFieldTypePointer ptr)
void	SetEnergy (double e)
void	SetFixedImage (const FixedImageType *ptr)
void	SetGradientStep (double e)
void	SetMovingImage (const MovingImageType *ptr)
void	SetNormalizeGradient (bool e)
Public Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
virtual TimeStepType	ComputeGlobalTimeStep (void *GlobalData) const =0
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0
virtual void *	GetGlobalDataPointer () const =0
const RadiusType &	GetRadius () const
void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
virtual void	InitializeIteration ()
virtual void	ReleaseGlobalDataPointer (void *GlobalData) const =0
void	SetRadius (const RadiusType &r)
void	SetScaleCoefficients (PixelRealType vals[ImageDimension])
Public Member Functions inherited from itk::LightObject
virtual Pointer	CreateAnother () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

Protected Member Functions
	PDEDeformableRegistrationFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~PDEDeformableRegistrationFunction () override
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
	FiniteDifferenceFunction ()
	~FiniteDifferenceFunction () 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
DisplacementFieldTypePointer	m_DisplacementField
double	m_Energy
FixedImagePointer	m_FixedImage
double	m_GradientStep
MovingImagePointer	m_MovingImage
bool	m_NormalizeGradient
Protected Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
RadiusType	m_Radius
PixelRealType	m_ScaleCoefficients [ImageDimension]
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Additional Inherited Members
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
static const unsigned int	ImageDimension

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef SmartPointer< const Self > itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ConstPointer

Definition at line 49 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef TDisplacementField itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType

Deformation field type.

Definition at line 64 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef DisplacementFieldType::Pointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer

Definition at line 65 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef FixedImageType::ConstPointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer

Definition at line 61 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef TFixedImage itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType

FixedImage image type.

Definition at line 60 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef MovingImageType::ConstPointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer

Definition at line 57 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef TMovingImage itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType

MovingImage image type.

Definition at line 53 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef SmartPointer< Self > itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Pointer

Definition at line 48 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef PDEDeformableRegistrationFunction itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self

Standard class typedefs.

Definition at line 46 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

typedef FiniteDifferenceFunction< TDisplacementField > itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass

Definition at line 47 of file itkPDEDeformableRegistrationFunction.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction ( )

inlineprotected

Definition at line 113 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField, itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Energy, itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImage, itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientStep, itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImage, and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NormalizeGradient.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::~PDEDeformableRegistrationFunction ( )

inlineoverrideprotected

Definition at line 123 of file itkPDEDeformableRegistrationFunction.h.

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

DisplacementFieldType* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetDisplacementField ( void  )

inline

Get the deformation field. This function should have been declared const. It is not for backward compatibility reasons.

Definition at line 94 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetEnergy ( ) const

inline

Definition at line 106 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Energy.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

const FixedImageType* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetFixedImage ( void  ) const

inline

Get the fixed image.

Definition at line 85 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImage.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGradientStep ( ) const

inline

Definition at line 108 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientStep.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

const MovingImageType* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImage ( void  ) const

inline

Get the moving image.

Definition at line 77 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImage.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const char* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.

Reimplemented in itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

bool itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNormalizeGradient ( ) const

inline

Definition at line 110 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NormalizeGradient.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

inlineoverrideprotectedvirtual

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::FiniteDifferenceFunction< TDisplacementField >.

Reimplemented in itk::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::FastSymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::MIRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >.

Definition at line 125 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImage, itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImage, and itk::FiniteDifferenceFunction< TDisplacementField >::PrintSelf().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetDisplacementField ( DisplacementFieldTypePointer  ptr )

inline

Set the deformation field image.

Definition at line 89 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetEnergy ( double  e )

inline

Definition at line 105 of file itkPDEDeformableRegistrationFunction.h.

References itk::Math::e, and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Energy.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetFixedImage ( const FixedImageType *  ptr )

inline

Set the fixed image.

Definition at line 81 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImage.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientStep ( double  e )

inline

Definition at line 107 of file itkPDEDeformableRegistrationFunction.h.

References itk::Math::e, and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientStep.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImage ( const MovingImageType *  ptr )

inline

Set the moving image.

Definition at line 73 of file itkPDEDeformableRegistrationFunction.h.

References itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImage.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetNormalizeGradient ( bool  e )

inline

Definition at line 109 of file itkPDEDeformableRegistrationFunction.h.

References itk::Math::e, and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NormalizeGradient.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

DisplacementFieldTypePointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField

protected

The deformation field.

Definition at line 141 of file itkPDEDeformableRegistrationFunction.h.

Referenced by itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetDisplacementField(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction(), and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetDisplacementField().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Energy

mutableprotected

Definition at line 143 of file itkPDEDeformableRegistrationFunction.h.

Referenced by itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetEnergy(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction(), and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetEnergy().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

FixedImagePointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImage

protected

The fixed image.

Definition at line 138 of file itkPDEDeformableRegistrationFunction.h.

Referenced by itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetFixedImage(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf(), and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetFixedImage().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientStep

mutableprotected

Definition at line 147 of file itkPDEDeformableRegistrationFunction.h.

Referenced by itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGradientStep(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction(), and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientStep().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

MovingImagePointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImage

protected

The moving image.

Definition at line 135 of file itkPDEDeformableRegistrationFunction.h.

Referenced by itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImage(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf(), and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImage().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

bool itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NormalizeGradient

protected

Definition at line 145 of file itkPDEDeformableRegistrationFunction.h.

Referenced by itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNormalizeGradient(), itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction(), and itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetNormalizeGradient().

---

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

• itkPDEDeformableRegistrationFunction.h