ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
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 SelfConstPointer
 
typedef TDisplacementField DisplacementFieldType
 
typedef
DisplacementFieldType::Pointer 
DisplacementFieldTypePointer
 
typedef
FixedImageType::ConstPointer 
FixedImagePointer
 
typedef TFixedImage FixedImageType
 
typedef
MovingImageType::ConstPointer 
MovingImagePointer
 
typedef TMovingImage MovingImageType
 
typedef SmartPointer< SelfPointer
 
typedef
PDEDeformableRegistrationFunction 
Self
 
typedef
FiniteDifferenceFunction
< TDisplacementField > 
Superclass
 
- Public Types inherited from itk::FiniteDifferenceFunction< TDisplacementField >
typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef
ConstNeighborhoodIterator
< TDisplacementField >
::RadiusType 
RadiusType
 
typedef FiniteDifferenceFunction Self
 
typedef LightObject Superclass
 
typedef double TimeStepType
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

DisplacementFieldTypeGetDisplacementField (void)
 
double GetEnergy () const
 
const FixedImageTypeGetFixedImage (void) const
 
double GetGradientStep () const
 
const MovingImageTypeGetMovingImage (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 RadiusTypeGetRadius () 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 ()
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
 FiniteDifferenceFunction ()
 
 ~FiniteDifferenceFunction ()
 
- 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
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 PDEDeformableRegistrationFunction (const Self &) ITK_DELETE_FUNCTION
 

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
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::~PDEDeformableRegistrationFunction ( )
inlineprotected

Definition at line 123 of file itkPDEDeformableRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PDEDeformableRegistrationFunction ( const Self )
private

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
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
const FixedImageType* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetFixedImage ( void  ) const
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGradientStep ( ) const
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
const MovingImageType* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImage ( void  ) const
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
virtual const char* itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNameOfClass ( ) const
virtual
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetNormalizeGradient ( ) const
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::operator= ( const Self )
private
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetDisplacementField ( DisplacementFieldTypePointer  ptr)
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetEnergy ( double  e)
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetFixedImage ( const FixedImageType ptr)
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetGradientStep ( double  e)
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImage ( const MovingImageType ptr)
inline
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
void itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetNormalizeGradient ( bool  e)
inline

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
DisplacementFieldTypePointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_DisplacementField
protected
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Energy
mutableprotected
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
FixedImagePointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_FixedImage
protected
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
double itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_GradientStep
mutableprotected
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
MovingImagePointer itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImage
protected
template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >
bool itk::PDEDeformableRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NormalizeGradient
protected

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