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

#include <itkVariationalRegistrationFunction.h>

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

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

Detailed Description

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

Base class for force calculation in the variational registration framework.

This class is templated over fixed image type, moving image type and deformation field type. This function has the fixed image, the moving image and the current displacement field as input and computes an update value in ComputeUpdate().

Implement a concrete force type in a subclass; overwrite the methods InitializeIteration() and ComputeUpdate().

See Also

VariationalRegistrationFilter

Note

This class was developed with funding from the German Research Foundation (DFG: EH 224/3-1 and HA 235/9-1).

Author

Alexander Schmidt-Richberg

Rene Werner

Jan Ehrhardt

Definition at line 51 of file itkVariationalRegistrationFunction.h.

Classes
struct	GlobalDataStruct

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DisplacementFieldType = TDisplacementField
using	DisplacementFieldTypePointer = typename DisplacementFieldType::ConstPointer
using	FixedImagePointer = typename FixedImageType::ConstPointer
using	FixedImageType = TFixedImage
using	MaskImagePixelType = unsigned char
using	MaskImagePointer = typename MaskImageType::ConstPointer
using	MaskImageType = Image< MaskImagePixelType, ImageDimension >
using	MovingImagePointer = typename MovingImageType::ConstPointer
using	MovingImageType = TMovingImage
using	MovingImageWarperPointer = typename MovingImageWarperType::Pointer
using	MovingImageWarperType = itk::ContinuousBorderWarpImageFilter< FixedImageType, WarpedImageType, DisplacementFieldType >
using	Pointer = SmartPointer< Self >
using	Self = VariationalRegistrationFunction
using	Superclass = FiniteDifferenceFunction< TDisplacementField >
using	TimeStepType = typename Superclass::TimeStepType
using	WarpedImagePointer = typename WarpedImageType::ConstPointer
using	WarpedImageType = TFixedImage
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
TimeStepType	ComputeGlobalTimeStep (void *) const override
virtual const DisplacementFieldType *	GetDisplacementField (void) const
virtual const FixedImageType *	GetFixedImage (void) const
void *	GetGlobalDataPointer () const override
virtual MaskImagePixelType	GetMaskBackgroundThreshold (void) const
virtual const MaskImageType *	GetMaskImage (void) const
virtual double	GetMetric () const
virtual const MovingImageType *	GetMovingImage (void) const
virtual const MovingImageWarperType *	GetMovingImageWarper (void) const
virtual const char *	GetNameOfClass () const
virtual double	GetRMSChange () const
virtual const TimeStepType	GetTimeStep (void) const
void	InitializeIteration () override
void	ReleaseGlobalDataPointer (void *GlobalData) const override
virtual void	SetDisplacementField (DisplacementFieldType *ptr)
virtual void	SetFixedImage (const FixedImageType *ptr)
virtual void	SetMaskBackgroundThreshold (MaskImagePixelType threshold)
virtual void	SetMaskImage (const MaskImageType *ptr)
virtual void	SetMovingImage (const MovingImageType *ptr)
virtual void	SetMovingImageWarper (MovingImageWarperType *ptr)
virtual void	SetTimeStep (TimeStepType timeStep)
Public Member Functions inherited from itk::FiniteDifferenceFunction< TDisplacementField >
const NeighborhoodScalesType	ComputeNeighborhoodScales () const
virtual PixelType	ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))=0
const RadiusType &	GetRadius () const
void	GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
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

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::FiniteDifferenceFunction< TDisplacementField >
static constexpr unsigned int	ImageDimension

Protected Member Functions
virtual const WarpedImagePointer	GetWarpedImage (void) const
void	PrintSelf (std::ostream &os, Indent indent) const override
	VariationalRegistrationFunction ()
virtual void	WarpMovingImage (void)
	~VariationalRegistrationFunction () override
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 ()

Private Attributes
DisplacementFieldTypePointer	m_DisplacementField
FixedImagePointer	m_FixedImage
MaskImagePixelType	m_MaskBackgroundThreshold
MaskImagePointer	m_MaskImage
double	m_Metric
std::mutex	m_MetricCalculationLock
MovingImagePointer	m_MovingImage
MovingImageWarperPointer	m_MovingImageWarper
SizeValueType	m_NumberOfPixelsProcessed
double	m_RMSChange
double	m_SumOfMetricValues
double	m_SumOfSquaredChange
TimeStepType	m_TimeStep

Additional Inherited Members
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
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

Member Typedef Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 61 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Deformation field type.

Definition at line 84 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::DisplacementFieldTypePointer = typename DisplacementFieldType::ConstPointer

Definition at line 85 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 77 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

FixedImage image type.

Definition at line 76 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MaskImagePixelType = unsigned char

MovingImage image type.

Definition at line 88 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MaskImagePointer = typename MaskImageType::ConstPointer

Definition at line 90 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MaskImageType = Image< MaskImagePixelType, ImageDimension >

Definition at line 89 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 73 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

MovingImage image type.

Definition at line 72 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageWarperPointer = typename MovingImageWarperType::Pointer

Definition at line 96 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::MovingImageWarperType = itk::ContinuousBorderWarpImageFilter< FixedImageType, WarpedImageType, DisplacementFieldType >

Typedef of the warp image filter.

Definition at line 95 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 60 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Standard class type alias.

Definition at line 58 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 59 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType = typename Superclass::TimeStepType

Definition at line 63 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::WarpedImagePointer = typename WarpedImageType::ConstPointer

Definition at line 81 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::WarpedImageType = TFixedImage

FixedImage image type.

Definition at line 80 of file itkVariationalRegistrationFunction.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

protected

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlineoverrideprotected

Definition at line 187 of file itkVariationalRegistrationFunction.h.

Member Function Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

TimeStepType itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep ( void *  ) const

inlineoverridevirtual

Computes the time step for an update. Returns the constant time step.

See Also

SetTimeStep()

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

Reimplemented in itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >.

Definition at line 163 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const DisplacementFieldType* itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetDisplacementField ( void  ) const

inlinevirtual

Get the deformation field.

Definition at line 120 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Get the fixed image.

Definition at line 112 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void* itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetGlobalDataPointer ( ) const

overridevirtual

Return a pointer to a global data structure that is passed to this object from the solver at each calculation.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual MaskImagePixelType itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMaskBackgroundThreshold ( void  ) const

inlinevirtual

Get the MaskBackgroundThreshold. All Pixels of the mask image will be treated as background if the are <= this threshold.

Definition at line 154 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaskBackgroundThreshold.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const MaskImageType* itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMaskImage ( void  ) const

inlinevirtual

Get the mask image.

Definition at line 128 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaskImage.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual double itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMetric ( ) const

inlinevirtual

Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images.

Definition at line 178 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Metric.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Get the Moving image.

Definition at line 104 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const MovingImageWarperType* itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImageWarper ( void  ) const

inlinevirtual

Get the moving image warper.

Definition at line 136 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageWarper.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

virtual

Run-time type information (and related methods)

Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.

Reimplemented in itk::VariationalRegistrationFastNCCFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >, itk::VariationalRegistrationDemonsFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual double itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange ( ) const

inlinevirtual

Get the rms change in deformation field.

Definition at line 182 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_RMSChange.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const TimeStepType itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetTimeStep ( void  ) const

inlinevirtual

Get the time step.

Definition at line 144 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep.

Referenced by itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep(), and itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual const WarpedImagePointer itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetWarpedImage ( void  ) const

protectedvirtual

Get the warped image.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::InitializeIteration ( )

overridevirtual

Set the object's state before each iteration.

Reimplemented from itk::FiniteDifferenceFunction< TDisplacementField >.

Reimplemented in itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overrideprotectedvirtual

Print information about the filter.

Reimplemented from itk::LightObject.

Reimplemented in itk::VariationalRegistrationSSDFunction< TFixedImage, TMovingImage, TDisplacementField >, and itk::VariationalRegistrationNCCFunction< TFixedImage, TMovingImage, TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ReleaseGlobalDataPointer ( void *  GlobalData ) const

overridevirtual

Release memory for global data structure.

Implements itk::FiniteDifferenceFunction< TDisplacementField >.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetDisplacementField ( DisplacementFieldType *  ptr )

inlinevirtual

Set the deformation field.

Definition at line 116 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Set the fixed image.

Definition at line 108 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMaskBackgroundThreshold ( MaskImagePixelType  threshold )

inlinevirtual

Set the MaskBackgroundThreshold. All Pixels of the mask image will be treated as background if the are <= this threshold.

Definition at line 149 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaskBackgroundThreshold.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMaskImage ( const MaskImageType *  ptr )

inlinevirtual

Set the mask image.

Definition at line 124 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaskImage.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

inlinevirtual

Set the Moving image.

Definition at line 100 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageWarper ( MovingImageWarperType *  ptr )

inlinevirtual

Set the moving image warper.

Definition at line 132 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageWarper.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetTimeStep ( TimeStepType  timeStep )

inlinevirtual

Set the time step. This time step will be used by ComputeGlobalTimeStep().

Definition at line 140 of file itkVariationalRegistrationFunction.h.

References itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::WarpMovingImage ( void  )

protectedvirtual

Warp the moving image into the domain of the fixed image using the deformation field.

Member Data Documentation

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

constexpr unsigned int itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = Superclass::ImageDimension

static

Get image dimension.

Definition at line 69 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

The deformation field.

Definition at line 216 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

The fixed image.

Definition at line 213 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

MaskImagePixelType itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaskBackgroundThreshold

private

Threshold to define the background in the mask image.

Definition at line 228 of file itkVariationalRegistrationFunction.h.

Referenced by itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMaskBackgroundThreshold(), and itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMaskBackgroundThreshold().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

MaskImagePointer itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MaskImage

private

The deformation field.

Definition at line 219 of file itkVariationalRegistrationFunction.h.

Referenced by itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMaskImage(), and itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMaskImage().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_Metric

mutableprivate

The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images.

Definition at line 233 of file itkVariationalRegistrationFunction.h.

Referenced by itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMetric().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

std::mutex itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MetricCalculationLock

mutableprivate

Mutex lock to protect modification to metric.

Definition at line 240 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

private

The Moving image.

Definition at line 210 of file itkVariationalRegistrationFunction.h.

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

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

MovingImageWarperPointer itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_MovingImageWarper

private

A class to warp the moving image into the domain of the fixed image.

Definition at line 222 of file itkVariationalRegistrationFunction.h.

Referenced by itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetMovingImageWarper(), and itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetMovingImageWarper().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

SizeValueType itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_NumberOfPixelsProcessed

mutableprivate

Definition at line 235 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_RMSChange

mutableprivate

Definition at line 236 of file itkVariationalRegistrationFunction.h.

Referenced by itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange().

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SumOfMetricValues

mutableprivate

Definition at line 234 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

double itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_SumOfSquaredChange

mutableprivate

Definition at line 237 of file itkVariationalRegistrationFunction.h.

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

TimeStepType itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::m_TimeStep

private

The global timestep.

Definition at line 225 of file itkVariationalRegistrationFunction.h.

Referenced by itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeGlobalTimeStep(), itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::GetTimeStep(), and itk::VariationalRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::SetTimeStep().

---

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

• itkVariationalRegistrationFunction.h