Deformably register two images using a symmetric forces demons algorithm. More...

#include <sitkFastSymmetricForcesDemonsRegistrationFilter.h>

Inheritance diagram for itk::simple::FastSymmetricForcesDemonsRegistrationFilter:

Collaboration diagram for itk::simple::FastSymmetricForcesDemonsRegistrationFilter:

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = FastSymmetricForcesDemonsRegistrationFilter

enum	UseGradientTypeType { Symmetric, Fixed, WarpedMoving, MappedMoving }

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &fixedImage, const Image &movingImage)

Image	Execute (const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField)

	FastSymmetricForcesDemonsRegistrationFilter ()

uint32_t	GetElapsedIterations () const
	Number of iterations run. More...

double	GetIntensityDifferenceThreshold () const

double	GetMaximumError () const

unsigned int	GetMaximumKernelWidth () const

double	GetMaximumRMSError () const

double	GetMaximumUpdateStepLength () const

double	GetMetric () const

std::string	GetName () const

uint32_t	GetNumberOfIterations () const

double	GetRMSChange () const

bool	GetSmoothDisplacementField () const

bool	GetSmoothUpdateField () const

std::vector< double >	GetStandardDeviations () const

std::vector< double >	GetUpdateFieldStandardDeviations () const

UseGradientTypeType	GetUseGradientType () const

bool	GetUseImageSpacing () const

Self &	SetIntensityDifferenceThreshold (double IntensityDifferenceThreshold)

Self &	SetMaximumError (double MaximumError)

Self &	SetMaximumKernelWidth (unsigned int MaximumKernelWidth)

Self &	SetMaximumRMSError (double MaximumRMSError)

Self &	SetMaximumUpdateStepLength (double MaximumUpdateStepLength)

Self &	SetNumberOfIterations (uint32_t NumberOfIterations)

Self &	SetSmoothDisplacementField (bool SmoothDisplacementField)

Self &	SetSmoothUpdateField (bool SmoothUpdateField)

Self &	SetStandardDeviations (double value)

Self &	SetStandardDeviations (std::vector< double > StandardDeviations)

Self &	SetUpdateFieldStandardDeviations (double value)

Self &	SetUpdateFieldStandardDeviations (std::vector< double > UpdateFieldStandardDeviations)

Self &	SetUseGradientType (UseGradientTypeType UseGradientType)

Self &	SetUseImageSpacing (bool UseImageSpacing)

Self &	SmoothDisplacementFieldOff ()

Self &	SmoothDisplacementFieldOn ()

Self &	SmoothUpdateFieldOff ()

Self &	SmoothUpdateFieldOn ()

void	StopRegistration ()

std::string	ToString () const

Self &	UseImageSpacingOff ()

Self &	UseImageSpacingOn ()

virtual	~FastSymmetricForcesDemonsRegistrationFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image(Self::)(const Image fixedImage, const Image movingImage, const Image initialDisplacementField)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image fixedImage, const Image movingImage, const Image *initialDisplacementField)

Private Attributes
itk::ProcessObject *	m_Filter {nullptr}

double	m_IntensityDifferenceThreshold {0.001}

double	m_MaximumError {0.1}

unsigned int	m_MaximumKernelWidth {30u}

double	m_MaximumRMSError {0.02}

double	m_MaximumUpdateStepLength {0.5}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

uint32_t	m_NumberOfIterations {10u}

std::function< uint32_t()>	m_pfGetElapsedIterations

std::function< double()>	m_pfGetMetric

std::function< void()>	m_pfGetStopRegistration

double	m_RMSChange {0.0}

bool	m_SmoothDisplacementField {true}

bool	m_SmoothUpdateField {false}

std::vector< double >	m_StandardDeviations {std::vector<double>(3, 1.0)}

std::vector< double >	m_UpdateFieldStandardDeviations {std::vector<double>(3, 1.0)}

UseGradientTypeType	m_UseGradientType {itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Symmetric}

bool	m_UseImageSpacing {true}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Deformably register two images using a symmetric forces demons algorithm.

This class was contributed by Tom Vercauteren, INRIA & Mauna Kea Technologies based on a variation of the DemonsRegistrationFilter .

FastSymmetricForcesDemonsRegistrationFilter implements the demons deformable algorithm that register two images by computing the deformation field which will map a moving image onto a fixed image.

A deformation field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.

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

The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial deformation field maybe set via SetInitialDisplacementField or SetInput. If no initial field is set, a zero field is used as the initial condition.

The output deformation field can be obtained via methods GetOutput or GetDisplacementField.

This class make use of the finite difference solver hierarchy. Update for each iteration is computed in DemonsRegistrationFunction .

Author: Tom Vercauteren, INRIA & Mauna Kea Technologies

This implementation was taken from the Insight Journal paper: https://www.insight-journal.org/browse/publication/154

Warning: This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.

See also: DemonsRegistrationFilter; DemonsRegistrationFunction; itk::FastSymmetricForcesDemonsRegistrationFilter for the Doxygen on the original ITK class.

Examples: DemonsRegistration2/DemonsRegistration2.cxx.

Definition at line 66 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::FastSymmetricForcesDemonsRegistrationFilter::MemberFunctionType = Image (Self::*)( const Image * fixedImage, const Image * movingImage, const Image * initialDisplacementField )

private

Setup for member function dispatching

Definition at line 262 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ PixelIDTypeList

using itk::simple::FastSymmetricForcesDemonsRegistrationFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 78 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ Self

using itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Self = FastSymmetricForcesDemonsRegistrationFilter

Definition at line 68 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

Member Enumeration Documentation

◆ UseGradientTypeType

enum itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseGradientTypeType

Enumerator
Symmetric
Fixed
WarpedMoving
MappedMoving

Definition at line 110 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

Constructor & Destructor Documentation

◆ ~FastSymmetricForcesDemonsRegistrationFilter()

virtual itk::simple::FastSymmetricForcesDemonsRegistrationFilter::~FastSymmetricForcesDemonsRegistrationFilter ( )

virtual

Destructor

◆ FastSymmetricForcesDemonsRegistrationFilter()

itk::simple::FastSymmetricForcesDemonsRegistrationFilter::FastSymmetricForcesDemonsRegistrationFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Execute	(	const Image &	fixedImage,
		const Image &	movingImage
	)

◆ Execute() [2/2]

Image itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Execute	(	const Image &	fixedImage,
		const Image &	movingImage,
		const Image &	initialDisplacementField
	)

Execute the filter on the input image

Examples: DemonsRegistration2/DemonsRegistration2.cxx.

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::FastSymmetricForcesDemonsRegistrationFilter::ExecuteInternal	(	const Image *	fixedImage,
		const Image *	movingImage,
		const Image *	initialDisplacementField
	)

private

◆ GetElapsedIterations()

uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetElapsedIterations ( ) const

inline

Number of iterations run.

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Examples: DemonsRegistration2/DemonsRegistration2.cxx.

Definition at line 217 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetIntensityDifferenceThreshold()

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetIntensityDifferenceThreshold ( ) const

inline

Definition at line 197 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetMaximumError()

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumError ( ) const

inline

Set/Get the desired maximum error of the Guassian kernel approximate.

Definition at line 188 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetMaximumKernelWidth()

unsigned int itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumKernelWidth ( ) const

inline

Set/Get the desired limits of the Gaussian kernel width.

Definition at line 178 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetMaximumRMSError()

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumRMSError ( ) const

inline

Definition at line 108 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetMaximumUpdateStepLength()

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumUpdateStepLength ( ) const

inline

Definition at line 127 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetMetric()

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMetric ( ) const

inline

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. This value is calculated for the current iteration

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 234 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetName()

std::string itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 247 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetNumberOfIterations()

uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetNumberOfIterations ( ) const

inline

Definition at line 100 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetRMSChange()

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetRMSChange ( ) const

inline

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Examples: DemonsRegistration2/DemonsRegistration2.cxx.

Definition at line 225 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetSmoothDisplacementField()

bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetSmoothDisplacementField ( ) const

inline

Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()

Definition at line 141 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetSmoothUpdateField()

bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetSmoothUpdateField ( ) const

inline

Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()

Definition at line 155 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetStandardDeviations()

std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetStandardDeviations ( ) const

inline

Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.

Definition at line 92 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetUpdateFieldStandardDeviations()

std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUpdateFieldStandardDeviations ( ) const

inline

Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.

Definition at line 168 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetUseGradientType()

UseGradientTypeType itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUseGradientType ( ) const

inline

Definition at line 118 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GetUseImageSpacing()

bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUseImageSpacing ( ) const

inline

Definition at line 209 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetIntensityDifferenceThreshold()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetIntensityDifferenceThreshold ( double IntensityDifferenceThreshold )

inline

Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.

Definition at line 193 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetMaximumError()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumError ( double MaximumError )

inline

Set/Get the desired maximum error of the Guassian kernel approximate.

Definition at line 183 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetMaximumKernelWidth()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumKernelWidth ( unsigned int MaximumKernelWidth )

inline

Set/Get the desired limits of the Gaussian kernel width.

Definition at line 173 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetMaximumRMSError()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumRMSError ( double MaximumRMSError )

inline

Definition at line 104 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetMaximumUpdateStepLength()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumUpdateStepLength ( double MaximumUpdateStepLength )

inline

Set/Get the maximum update step length.

Definition at line 123 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetNumberOfIterations()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetNumberOfIterations ( uint32_t NumberOfIterations )

inline

Examples: DemonsRegistration2/DemonsRegistration2.cxx.

Definition at line 96 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetSmoothDisplacementField()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetSmoothDisplacementField ( bool SmoothDisplacementField )

inline

Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()

Definition at line 132 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetSmoothUpdateField()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetSmoothUpdateField ( bool SmoothUpdateField )

inline

Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()

Definition at line 146 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetStandardDeviations() [1/2]

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetStandardDeviations ( double value )

inline

Set the values of the StandardDeviations vector all to value

Definition at line 87 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetStandardDeviations() [2/2]

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetStandardDeviations ( std::vector< double > StandardDeviations )

inline

Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.

Examples: DemonsRegistration2/DemonsRegistration2.cxx.

Definition at line 84 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetUpdateFieldStandardDeviations() [1/2]

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations ( double value )

inline

Set the values of the UpdateFieldStandardDeviations vector all to value

Definition at line 163 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetUpdateFieldStandardDeviations() [2/2]

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations ( std::vector< double > UpdateFieldStandardDeviations )

inline

Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.

Definition at line 160 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetUseGradientType()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUseGradientType ( UseGradientTypeType UseGradientType )

inline

Definition at line 114 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SetUseImageSpacing()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUseImageSpacing ( bool UseImageSpacing )

inline

Definition at line 201 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SmoothDisplacementFieldOff()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOff ( )

inline

Definition at line 136 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SmoothDisplacementFieldOn()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOn ( )

inline

Set the value of SmoothDisplacementField to true or false respectfully.

Definition at line 135 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SmoothUpdateFieldOff()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOff ( )

inline

Definition at line 150 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ SmoothUpdateFieldOn()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOn ( )

inline

Set the value of SmoothUpdateField to true or false respectfully.

Definition at line 149 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ StopRegistration()

void itk::simple::FastSymmetricForcesDemonsRegistrationFilter::StopRegistration ( )

inline

This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution.

Definition at line 243 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ ToString()

std::string itk::simple::FastSymmetricForcesDemonsRegistrationFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageSpacingOff()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseImageSpacingOff ( )

inline

Definition at line 205 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ UseImageSpacingOn()

Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseImageSpacingOn ( )

inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 204 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 266 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

Member Data Documentation

◆ m_Filter

itk::ProcessObject* itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_Filter {nullptr}

private

Definition at line 307 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_IntensityDifferenceThreshold

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_IntensityDifferenceThreshold {0.001}

private

Definition at line 293 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_MaximumError

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_MaximumError {0.1}

private

Definition at line 291 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_MaximumKernelWidth

unsigned int itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_MaximumKernelWidth {30u}

private

Definition at line 289 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_MaximumRMSError

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_MaximumRMSError {0.02}

private

Definition at line 277 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_MaximumUpdateStepLength

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_MaximumUpdateStepLength {0.5}

private

Definition at line 281 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_MemberFactory

private

Definition at line 268 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_NumberOfIterations

uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_NumberOfIterations {10u}

private

Definition at line 274 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_pfGetElapsedIterations

std::function<uint32_t()> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_pfGetElapsedIterations

private

Definition at line 298 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_pfGetMetric

std::function<double()> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_pfGetMetric

private

Definition at line 302 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_pfGetStopRegistration

std::function<void()> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_pfGetStopRegistration

private

Definition at line 304 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_RMSChange

double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_RMSChange {0.0}

private

Definition at line 300 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_SmoothDisplacementField

bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_SmoothDisplacementField {true}

private

Definition at line 283 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_SmoothUpdateField

bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_SmoothUpdateField {false}

private

Definition at line 285 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_StandardDeviations

std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_StandardDeviations {std::vector<double>(3, 1.0)}

private

Definition at line 271 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_UpdateFieldStandardDeviations

std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_UpdateFieldStandardDeviations {std::vector<double>(3, 1.0)}

private

Definition at line 287 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_UseGradientType

UseGradientTypeType itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_UseGradientType {itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Symmetric}

private

Definition at line 279 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_UseImageSpacing

bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::m_UseImageSpacing {true}

private

Definition at line 295 of file sitkFastSymmetricForcesDemonsRegistrationFilter.h.

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

sitkFastSymmetricForcesDemonsRegistrationFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Member Enumeration Documentation

◆ UseGradientTypeType

Constructor & Destructor Documentation

◆ ~FastSymmetricForcesDemonsRegistrationFilter()

◆ FastSymmetricForcesDemonsRegistrationFilter()

Member Function Documentation

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteInternal()

◆ GetElapsedIterations()

◆ GetIntensityDifferenceThreshold()

◆ GetMaximumError()

◆ GetMaximumKernelWidth()

◆ GetMaximumRMSError()

◆ GetMaximumUpdateStepLength()

◆ GetMetric()

◆ GetName()

◆ GetNumberOfIterations()

◆ GetRMSChange()

◆ GetSmoothDisplacementField()

◆ GetSmoothUpdateField()

◆ GetStandardDeviations()

◆ GetUpdateFieldStandardDeviations()

◆ GetUseGradientType()

◆ GetUseImageSpacing()

◆ SetIntensityDifferenceThreshold()

◆ SetMaximumError()

◆ SetMaximumKernelWidth()

◆ SetMaximumRMSError()

◆ SetMaximumUpdateStepLength()

◆ SetNumberOfIterations()

◆ SetSmoothDisplacementField()

◆ SetSmoothUpdateField()

◆ SetStandardDeviations() [1/2]

◆ SetStandardDeviations() [2/2]

◆ SetUpdateFieldStandardDeviations() [1/2]

◆ SetUpdateFieldStandardDeviations() [2/2]

◆ SetUseGradientType()

◆ SetUseImageSpacing()

◆ SmoothDisplacementFieldOff()

◆ SmoothDisplacementFieldOn()

◆ SmoothUpdateFieldOff()

◆ SmoothUpdateFieldOn()

◆ StopRegistration()

◆ ToString()

◆ UseImageSpacingOff()

◆ UseImageSpacingOn()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_Filter

◆ m_IntensityDifferenceThreshold

◆ m_MaximumError

◆ m_MaximumKernelWidth

◆ m_MaximumRMSError

◆ m_MaximumUpdateStepLength

◆ m_MemberFactory

◆ m_NumberOfIterations

◆ m_pfGetElapsedIterations

◆ m_pfGetMetric

◆ m_pfGetStopRegistration

◆ m_RMSChange

◆ m_SmoothDisplacementField

◆ m_SmoothUpdateField

◆ m_StandardDeviations

◆ m_UpdateFieldStandardDeviations

◆ m_UseGradientType

◆ m_UseImageSpacing