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
using	ConstPointer = SmartPointer< const Self >
using	DisplacementFieldType = TDisplacementField
using	DisplacementFieldTypePointer = typename DisplacementFieldType::Pointer
using	FixedImagePointer = typename FixedImageType::ConstPointer
using	FixedImageType = TFixedImage
using	MovingImagePointer = typename MovingImageType::ConstPointer
using	MovingImageType = TMovingImage
using	Pointer = SmartPointer< Self >
using	Self = PDEDeformableRegistrationFunction
using	Superclass = FiniteDifferenceFunction< TDisplacementField >
Public Types inherited from itk::FiniteDifferenceFunction< TDisplacementField >
using	ConstPointer = SmartPointer< const Self >
using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< ImageType >
using	FloatOffsetType = Vector< float, Self::ImageDimension >
using	ImageType = TDisplacementField
using	NeighborhoodScalesType = Vector< PixelRealType, Self::ImageDimension >
using	NeighborhoodType = ConstNeighborhoodIterator< TDisplacementField, DefaultBoundaryConditionType >
using	PixelRealType = double
using	PixelType = typename ImageType::PixelType
using	Pointer = SmartPointer< Self >
using	RadiusType = typename ConstNeighborhoodIterator< TDisplacementField >::RadiusType
using	Self = FiniteDifferenceFunction
using	Superclass = LightObject
using	TimeStepType = double
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
DisplacementFieldType *	GetDisplacementField ()
double	GetEnergy () const
const FixedImageType *	GetFixedImage () const
double	GetGradientStep () const
const MovingImageType *	GetMovingImage () 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=default
Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
	FiniteDifferenceFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~FiniteDifferenceFunction () override=default
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
std::atomic< 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 constexpr unsigned int	ImageDimension

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 51 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldType = TDisplacementField

Deformation field type.

Definition at line 66 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer = typename DisplacementFieldType::Pointer

Definition at line 67 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImagePointer = typename FixedImageType::ConstPointer

Definition at line 63 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::FixedImageType = TFixedImage

FixedImage image type.

Definition at line 62 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImagePointer = typename MovingImageType::ConstPointer

Definition at line 59 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageType = TMovingImage

MovingImage image type.

Definition at line 58 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 50 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Self = PDEDeformableRegistrationFunction

Standard class type aliases.

Definition at line 48 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::Superclass = FiniteDifferenceFunction< TDisplacementField >

Definition at line 49 of file itkPDEDeformableRegistrationFunction.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlineprotected

Definition at line 102 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 ( )

overrideprotecteddefault

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inline

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

Definition at line 91 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 95 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 ( ) const

inline

Get the fixed image.

Definition at line 82 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 97 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 ( ) const

inline

Get the moving image.

Definition at line 74 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::ESMDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::SymmetricForcesDemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::MeanSquareRegistrationFunction< 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 99 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::LightObject.

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

Definition at line 114 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 86 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 94 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 78 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 96 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 70 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 98 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 130 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 132 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 127 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 136 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 124 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 134 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