#include <itkFastSymmetricForcesDemonsRegistrationFilter.h>

Detailed Description

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

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://doi.org/10.54294/ux2obj

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

Definition at line 73 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DemonsRegistrationFunctionType = ESMDemonsRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >

using	GradientType = typename DemonsRegistrationFunctionType::GradientEnum

using	Pointer = SmartPointer< Self >

using	Self = FastSymmetricForcesDemonsRegistrationFilter

using	Superclass = PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Public Types inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = TDisplacementField

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImageType = TFixedImage

using	MovingImageConstPointer = typename MovingImageType::ConstPointer

using	MovingImagePointer = typename MovingImageType::Pointer

using	MovingImageType = TMovingImage

using	PDEDeformableRegistrationFunctionType = PDEDeformableRegistrationFunction< FixedImageType, MovingImageType, DisplacementFieldType >

using	Pointer = SmartPointer< Self >

using	Self = PDEDeformableRegistrationFilter

using	StandardDeviationsType = FixedArray< double, ImageDimension >

using	Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >

Public Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = DenseFiniteDifferenceImageFilter

using	Superclass = FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >

using	UpdateBufferType = OutputImageType

Public Types inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	FiniteDifferenceFunctionType = FiniteDifferenceFunction< TDisplacementField >

using	InputImageType = TDisplacementField

using	InputPixelType = typename TDisplacementField ::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TDisplacementField

using	OutputPixelType = typename TDisplacementField ::PixelType

using	OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType

using	PixelType = OutputPixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	Self = FiniteDifferenceImageFilter

using	Superclass = InPlaceImageFilter< TDisplacementField, TDisplacementField >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Public Types inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TDisplacementField

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TDisplacementField, TDisplacementField >

Public Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TDisplacementField

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TDisplacementField >

Public Types inherited from itk::ImageSource< TDisplacementField >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TDisplacementField

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual double	GetIntensityDifferenceThreshold () const

virtual double	GetMaximumUpdateStepLength () const

virtual double	GetMetric () const

const char *	GetNameOfClass () const override

const double &	GetRMSChange () const override

virtual GradientType	GetUseGradientType () const

virtual void	SetIntensityDifferenceThreshold (double)

virtual void	SetMaximumUpdateStepLength (double)

virtual void	SetUseGradientType (GradientType gtype)

Public Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
DisplacementFieldType *	GetDisplacementField ()

virtual const FixedImageType *	GetFixedImage () const

virtual const DisplacementFieldType *	GetInitialDisplacementField () const

virtual const MovingImageType *	GetMovingImage () const

const char *	GetNameOfClass () const override

std::vector< SmartPointer< DataObject > >::size_type	GetNumberOfValidRequiredInputs () const override

virtual const StandardDeviationsType &	GetStandardDeviations () const

virtual const StandardDeviationsType &	GetUpdateFieldStandardDeviations () const

virtual void	SetFixedImage (const FixedImageType *input)

virtual void	SetInitialDisplacementField (const DisplacementFieldType *input)

virtual void	SetMovingImage (const MovingImageType *input)

virtual void	StopRegistration ()

virtual void	SetSmoothDisplacementField (bool _arg)

virtual bool	GetSmoothDisplacementField () const

virtual void	SmoothDisplacementFieldOn ()

virtual void	SetStandardDeviations (StandardDeviationsType _arg)

virtual void	SetStandardDeviations (double value)

virtual void	SetSmoothUpdateField (bool _arg)

virtual bool	GetSmoothUpdateField () const

virtual void	SmoothUpdateFieldOn ()

virtual void	SetUpdateFieldStandardDeviations (StandardDeviationsType _arg)

virtual void	SetUpdateFieldStandardDeviations (double value)

virtual void	SetMaximumError (double _arg)

virtual double	GetMaximumError () const

virtual void	SetMaximumKernelWidth (unsigned int _arg)

virtual unsigned int	GetMaximumKernelWidth () const

Public Member Functions inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual const FiniteDifferenceFunctionType ::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations () const

virtual bool	GetIsInitialized ()

const char *	GetNameOfClass () const override

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations () const

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual const bool &	GetUseImageSpacing () const

virtual void	SetMaximumRMSError (double _arg)

virtual const double &	GetMaximumRMSError () const

virtual void	SetRMSChange (double _arg)

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

Public Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TDisplacementField *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TDisplacementField >
OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = FixedImageType::ImageDimension

Static Public Attributes inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TDisplacementField >
static constexpr unsigned int	OutputImageDimension

Protected Types
using	AdderPointer = typename AdderType::Pointer

using	AdderType = AddImageFilter< DisplacementFieldType, DisplacementFieldType, DisplacementFieldType >

using	MultiplyByConstantPointer = typename MultiplyByConstantType::Pointer

using	MultiplyByConstantType = MultiplyImageFilter< DisplacementFieldType, itk::Image< TimeStepType, ImageDimension >, DisplacementFieldType >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Protected Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
using	ThreadRegionType = typename UpdateBufferType::RegionType

Protected Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Member Functions
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

	FastSymmetricForcesDemonsRegistrationFilter ()

void	InitializeIteration () override

void	PrintSelf (std::ostream &os, Indent indent) const override

	~FastSymmetricForcesDemonsRegistrationFilter () override=default

Protected Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
void	CopyInputToOutput () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

bool	Halt () override

void	Initialize () override

void	InitializeIteration () override

	PDEDeformableRegistrationFilter ()

void	PostProcessOutput () override

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SmoothDisplacementField ()

virtual void	SmoothUpdateField ()

	~PDEDeformableRegistrationFilter () override=default

Protected Member Functions inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

void	CopyInputToOutput () override

	DenseFiniteDifferenceImageFilter ()

virtual UpdateBufferType *	GetUpdateBuffer ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)

virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)

	~DenseFiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *)

	~FiniteDifferenceImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
DemonsRegistrationFunctionType *	DownCastDifferenceFunctionType ()

const DemonsRegistrationFunctionType *	DownCastDifferenceFunctionType () const

Private Attributes
AdderPointer	m_Adder {}

MultiplyByConstantPointer	m_Multiplier {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
IdentifierType	m_ElapsedIterations

bool	m_IsInitialized

bool	m_ManualReinitialization

double	m_MaximumRMSError

IdentifierType	m_NumberOfIterations

double	m_RMSChange

Protected Attributes inherited from itk::ImageSource< TDisplacementField >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ AdderPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::AdderPointer = typename AdderType::Pointer

protected

Definition at line 179 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ AdderType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::AdderType = AddImageFilter<DisplacementFieldType, DisplacementFieldType, DisplacementFieldType>

protected

Definition at line 176 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ ConstPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 83 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ DemonsRegistrationFunctionType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DemonsRegistrationFunctionType = ESMDemonsRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>

DemonsRegistrationFilterFunction type.

FIXME: Why is this the only permissible function ?

Definition at line 121 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ GradientType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GradientType = typename DemonsRegistrationFunctionType::GradientEnum

Definition at line 123 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ MultiplyByConstantPointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MultiplyByConstantPointer = typename MultiplyByConstantType::Pointer

protected

Definition at line 178 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ MultiplyByConstantType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::MultiplyByConstantType = MultiplyImageFilter<DisplacementFieldType, itk::Image<TimeStepType, ImageDimension>, DisplacementFieldType>

protected

other type alias

Definition at line 174 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ Pointer

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Definition at line 82 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ Self

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

Standard class type aliases.

Definition at line 80 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ Superclass

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::Superclass = PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>

Definition at line 81 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ TimeStepType

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

using itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

protected

Take timestep type from the FiniteDifferenceFunction.

Definition at line 166 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

Constructor & Destructor Documentation

◆ FastSymmetricForcesDemonsRegistrationFilter()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

protected

◆ ~FastSymmetricForcesDemonsRegistrationFilter()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overrideprotecteddefault

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::AllocateUpdateBuffer ( )

overrideprotectedvirtual

This method allocates storage in m_UpdateBuffer. It is called from FiniteDifferenceFilter::GenerateData().

Implements itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

◆ ApplyUpdate()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ApplyUpdate ( const TimeStepType & dt )

overrideprotectedvirtual

Apply update.

Implements itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

◆ DownCastDifferenceFunctionType() [1/2]

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

DemonsRegistrationFunctionType* itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DownCastDifferenceFunctionType ( )

private

Downcast the DifferenceFunction using a dynamic_cast to ensure that it is of the correct type (i.e. a DemonsRegistrationFunction).

Throws an exception if the function is not of the expected type.

◆ DownCastDifferenceFunctionType() [2/2]

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

const DemonsRegistrationFunctionType* itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::DownCastDifferenceFunctionType ( ) const

private

◆ GetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual double itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetIntensityDifferenceThreshold ( ) const

virtual

◆ GetMaximumUpdateStepLength()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual double itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetMaximumUpdateStepLength ( ) const

virtual

◆ GetMetric()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

virtual

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 overlapping region between the two images. This value is calculated for the current iteration

◆ GetNameOfClass()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetRMSChange()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

const double& itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetRMSChange ( ) const

overridevirtual

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

Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

◆ GetUseGradientType()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual GradientType itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::GetUseGradientType ( ) const

virtual

◆ InitializeIteration()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overrideprotectedvirtual

Initialize the state of filter and equation before each iteration.

Reimplemented from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >.

◆ New()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

static Pointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

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

overrideprotectedvirtual

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::ProcessObject.

◆ SetIntensityDifferenceThreshold()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetIntensityDifferenceThreshold ( double )

virtual

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.

◆ SetMaximumUpdateStepLength()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetMaximumUpdateStepLength ( double )

virtual

Set/Get the maximum update step length.

◆ SetUseGradientType()

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

virtual void itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::SetUseGradientType ( GradientType gtype )

virtual

Member Data Documentation

◆ ImageDimension

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

constexpr unsigned int itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::ImageDimension = FixedImageType::ImageDimension

staticconstexpr

Definition at line 103 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_Adder

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

AdderPointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_Adder {}

private

Definition at line 194 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

◆ m_Multiplier

template<typename TFixedImage , typename TMovingImage , typename TDisplacementField >

MultiplyByConstantPointer itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >::m_Multiplier {}

private

Definition at line 193 of file itkFastSymmetricForcesDemonsRegistrationFilter.h.

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

itkFastSymmetricForcesDemonsRegistrationFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AdderPointer

◆ AdderType

◆ ConstPointer

◆ DemonsRegistrationFunctionType

◆ GradientType

◆ MultiplyByConstantPointer

◆ MultiplyByConstantType

◆ Pointer

◆ Self

◆ Superclass

◆ TimeStepType

Constructor & Destructor Documentation

◆ FastSymmetricForcesDemonsRegistrationFilter()

◆ ~FastSymmetricForcesDemonsRegistrationFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ApplyUpdate()

◆ DownCastDifferenceFunctionType() [1/2]

◆ DownCastDifferenceFunctionType() [2/2]

◆ GetIntensityDifferenceThreshold()

◆ GetMaximumUpdateStepLength()

◆ GetMetric()

◆ GetNameOfClass()

◆ GetRMSChange()

◆ GetUseGradientType()

◆ InitializeIteration()

◆ New()

◆ PrintSelf()

◆ SetIntensityDifferenceThreshold()

◆ SetMaximumUpdateStepLength()

◆ SetUseGradientType()

Member Data Documentation

◆ ImageDimension

◆ m_Adder

◆ m_Multiplier

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