#include <itkSymmetricForcesDemonsRegistrationFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SymmetricForcesDemonsRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	DemonsRegistrationFunctionType
typedef Superclass::DisplacementFieldPointer	DisplacementFieldPointer
typedef Superclass::DisplacementFieldType	DisplacementFieldType
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef Superclass::FixedImagePointer	FixedImagePointer
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::MovingImagePointer	MovingImagePointer
typedef Superclass::MovingImageType	MovingImageType
typedef SmartPointer< Self >	Pointer
typedef SymmetricForcesDemonsRegistrationFilter	Self
typedef PDEDeformableRegistrationFilter < TFixedImage, TMovingImage, TDisplacementField >	Superclass
typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType
Public Types inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
typedef FixedImageType::ConstPointer	FixedImageConstPointer
typedef MovingImageType::ConstPointer	MovingImageConstPointer
typedef Superclass::OutputImageType	OutputImageType
typedef PDEDeformableRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	PDEDeformableRegistrationFunctionType
typedef FixedArray< double, ImageDimension >	StandardDeviationsType
Public Types inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
typedef Superclass::InputImageType	InputImageType
typedef Superclass::PixelType	PixelType
typedef OutputImageType	UpdateBufferType
Public Types inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
typedef TDisplacementField::PixelType	InputPixelType
typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType
typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType
typedef TDisplacementField::PixelType	OutputPixelType
typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType
typedef FiniteDifferenceFunctionType::RadiusType	RadiusType
Public Types inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
Public Types inherited from itk::ImageSource< TDisplacementField >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual double	GetIntensityDifferenceThreshold () const
virtual double	GetMetric () const
virtual const char *	GetNameOfClass () const
virtual const double &	GetRMSChange () const
virtual void	SetIntensityDifferenceThreshold (double)
Public Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
DisplacementFieldType *	GetDisplacementField ()
const FixedImageType *	GetFixedImage (void) const
const MovingImageType *	GetMovingImage (void) const
virtual std::vector < SmartPointer< DataObject > >::size_type	GetNumberOfValidRequiredInputs () const
virtual const StandardDeviationsType &	GetStandardDeviations ()
virtual const StandardDeviationsType &	GetUpdateFieldStandardDeviations ()
void	SetFixedImage (const FixedImageType *ptr)
void	SetInitialDisplacementField (const DisplacementFieldType *ptr)
void	SetMovingImage (const MovingImageType *ptr)
virtual void	StopRegistration ()
virtual void	SetSmoothDisplacementField (bool _arg)
virtual bool	GetSmoothDisplacementField () const
virtual void	SmoothDisplacementFieldOn ()
virtual void	SmoothDisplacementFieldOff ()
virtual void	SetStandardDeviations (StandardDeviationsType _arg)
virtual void	SetStandardDeviations (double value)
virtual void	SetSmoothUpdateField (bool _arg)
virtual bool	GetSmoothUpdateField () const
virtual void	SmoothUpdateFieldOn ()
virtual void	SmoothUpdateFieldOff ()
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 >
	typedef (Concept::MultiplyOperator< PixelType, double >) OutputTimesDoubleCheck
	typedef (Concept::AdditiveOperators< PixelType >) OutputAdditiveOperatorsCheck
	typedef (Concept::AdditiveAndAssignOperators< PixelType >) OutputAdditiveAndAssignOperatorsCheck
	typedef (Concept::Convertible< typename TDisplacementField::PixelType, PixelType >) InputConvertibleToOutputCheck
Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const
virtual const IdentifierType &	GetElapsedIterations ()
virtual bool	GetIsInitialized ()
virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
virtual void	SetIsInitialized (bool _arg)
void	SetStateToInitialized ()
void	SetStateToUninitialized ()
virtual void	SetNumberOfIterations (IdentifierType _arg)
virtual const IdentifierType &	GetNumberOfIterations ()
virtual void	SetUseImageSpacing (bool _arg)
virtual void	UseImageSpacingOn ()
virtual void	UseImageSpacingOff ()
virtual const bool &	GetUseImageSpacing ()
virtual void	SetMaximumRMSError (double _arg)
virtual const double &	GetMaximumRMSError ()
virtual void	SetRMSChange (double _arg)
virtual const double &	GetRMSChange ()
virtual void	SetManualReinitialization (bool _arg)
virtual const bool &	GetManualReinitialization ()
virtual void	ManualReinitializationOn ()
virtual void	ManualReinitializationOff ()
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 ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TDisplacementField *image)
Public Member Functions inherited from itk::ImageSource< TDisplacementField >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	ApplyUpdate (const TimeStepType &dt)
virtual void	InitializeIteration ()
void	PrintSelf (std::ostream &os, Indent indent) const
	SymmetricForcesDemonsRegistrationFilter ()
	~SymmetricForcesDemonsRegistrationFilter ()
Protected Member Functions inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
virtual void	CopyInputToOutput ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual bool	Halt ()
virtual void	Initialize ()
virtual void	PostProcessOutput ()
virtual void	SmoothDisplacementField ()
virtual void	SmoothUpdateField ()
	PDEDeformableRegistrationFilter ()
	~PDEDeformableRegistrationFilter ()
Protected Member Functions inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual void	AllocateUpdateBuffer ()
virtual void	ApplyUpdate (const TimeStepType &dt)
virtual TimeStepType	CalculateChange ()
virtual UpdateBufferType *	GetUpdateBuffer ()
virtual void	ThreadedApplyUpdate (const TimeStepType &dt, const ThreadRegionType &regionToProcess, ThreadIdType threadId)
virtual TimeStepType	ThreadedCalculateChange (const ThreadRegionType &regionToProcess, ThreadIdType threadId)
	DenseFiniteDifferenceImageFilter ()
	~DenseFiniteDifferenceImageFilter ()
Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
virtual void	ApplyUpdate (const TimeStepType &dt)=0
	FiniteDifferenceImageFilter ()
virtual void	GenerateData ()
virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
virtual void	SetElapsedIterations (IdentifierType _arg)
virtual bool	ThreadedHalt (void *)
virtual	~FiniteDifferenceImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
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 ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TDisplacementField >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
void	operator= (const Self &)
	SymmetricForcesDemonsRegistrationFilter (const Self &)

Additional Inherited Members
Static Public Attributes inherited from itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
static const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
Static Public Attributes inherited from itk::InPlaceImageFilter< TDisplacementField, TDisplacementField >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TDisplacementField, TDisplacementField >
Static Public Attributes inherited from itk::ImageSource< TDisplacementField >

Detailed Description

template<class TFixedImage, class TMovingImage, class TDisplacementField>
class itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >

Deformably register two images using the demons algorithm.

This class was contributed by Corinne Mattmann, ETH Zurich, Switzerland. based on a variation of the DemonsRegistrationFilter. The basic modification is to use equation (5) from Thirion's paper along with the modification for avoiding large deformations when gradients have small values.

SymmetricForcesDemonsRegistrationFilter 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 algorithm has one parameters: the number of iteration to be performed.

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.

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:: SymmetricForcesDemonsRegistrationFunction; DemonsRegistrationFilter; DemonsRegistrationFunction

Definition at line 70 of file itkSymmetricForcesDemonsRegistrationFilter.h.