#include <itkPointSetToSpatialObjectDemonsRegistration.h>

Detailed Description

template<typename TFixedPointSet, typename TMovingSpatialObject>
class itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >

Implementation of Demons Registration between a PointSet and a SpatialObject.

The simplest case of Demons registration suggested by P. Thirion in his paper [125] is defined by a Model and Scene. The Model should be able to respond to the queries of whether a point is inside or outside of the object of interest, while the Scene provides a number of points (the Demons) with vector indicating the direction of inside-outside of the equivalent object of interest. In this implementation, the Scene is represented by an itk::PointSet that has Vectors as PixelData. These vectors should be provided by the user of this class and must be pointing outside of the object of interest. The Model is naturally represented by a itk::SpatialObject since its interface responds to the IsInside() method.

This class is intended to be derived in order to define the method that will update the transform. Such method will be specific for the particular type of transform used.

Definition at line 50 of file itkPointSetToSpatialObjectDemonsRegistration.h.

Inheritance diagram for itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >:

Collaboration diagram for itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer

using	FixedPointSetType = TFixedPointSet

using	MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer

using	MovingSpatialObjectType = TMovingSpatialObject

using	Pointer = SmartPointer<Self>

using	Self = PointSetToSpatialObjectDemonsRegistration

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::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override


virtual void	SetFixedPointSet (const FixedPointSetType *_arg)

virtual const FixedPointSetType *	GetFixedPointSet () const


virtual void	SetMovingSpatialObject (const MovingSpatialObjectType *_arg)

virtual const MovingSpatialObjectType *	GetMovingSpatialObject () const

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () 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 DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

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	ReleaseDataBeforeUpdateFlagOff ()

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

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::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 ()

Protected Member Functions
	PointSetToSpatialObjectDemonsRegistration ()

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

	~PointSetToSpatialObjectDemonsRegistration () override=default

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	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

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

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

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	VerifyInputInformation () const

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	ThreaderUpdateProgressOff ()

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 Attributes
FixedPointSetConstPointer	m_FixedPointSet {}

MovingSpatialObjectConstPointer	m_MovingSpatialObject {}

Additional Inherited Members
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::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::ConstPointer = SmartPointer<const Self>

Definition at line 59 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ FixedPointSetConstPointer

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer

Definition at line 69 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ FixedPointSetType

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::FixedPointSetType = TFixedPointSet

Type of the Fixed PointSet.

Definition at line 68 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ MovingSpatialObjectConstPointer

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer

Definition at line 73 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ MovingSpatialObjectType

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::MovingSpatialObjectType = TMovingSpatialObject

Type of the Moving image.

Definition at line 72 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ Pointer

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::Pointer = SmartPointer<Self>

Definition at line 58 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ Self

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::Self = PointSetToSpatialObjectDemonsRegistration

Standard class type aliases.

Definition at line 56 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ Superclass

template<typename TFixedPointSet, typename TMovingSpatialObject>

using itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::Superclass = ProcessObject

Definition at line 57 of file itkPointSetToSpatialObjectDemonsRegistration.h.

Constructor & Destructor Documentation

◆ PointSetToSpatialObjectDemonsRegistration()

template<typename TFixedPointSet, typename TMovingSpatialObject>

itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::PointSetToSpatialObjectDemonsRegistration ( )

protected

Referenced by GetNameOfClass().

◆ ~PointSetToSpatialObjectDemonsRegistration()

template<typename TFixedPointSet, typename TMovingSpatialObject>

itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::~PointSetToSpatialObjectDemonsRegistration ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TFixedPointSet, typename TMovingSpatialObject>

virtual::itk::LightObject::Pointer itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetFixedPointSet()

template<typename TFixedPointSet, typename TMovingSpatialObject>

virtual const FixedPointSetType * itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::GetFixedPointSet ( ) const

virtual

Set/Get the Fixed image.

◆ GetMovingSpatialObject()

template<typename TFixedPointSet, typename TMovingSpatialObject>

virtual const MovingSpatialObjectType * itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::GetMovingSpatialObject ( ) const

virtual

Set/Get the Moving image.

◆ GetNameOfClass()

template<typename TFixedPointSet, typename TMovingSpatialObject>

const char * itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

References PointSetToSpatialObjectDemonsRegistration().

◆ New()

template<typename TFixedPointSet, typename TMovingSpatialObject>

static Pointer itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedPointSet, typename TMovingSpatialObject>

void itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::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::Object.

◆ SetFixedPointSet()

template<typename TFixedPointSet, typename TMovingSpatialObject>

virtual void itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::SetFixedPointSet ( const FixedPointSetType * _arg )

virtual

Set/Get the Fixed image.

◆ SetMovingSpatialObject()

template<typename TFixedPointSet, typename TMovingSpatialObject>

virtual void itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::SetMovingSpatialObject ( const MovingSpatialObjectType * _arg )

virtual

Set/Get the Moving image.

Member Data Documentation

◆ m_FixedPointSet

template<typename TFixedPointSet, typename TMovingSpatialObject>

FixedPointSetConstPointer itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::m_FixedPointSet {}

private

Definition at line 93 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ m_MovingSpatialObject

template<typename TFixedPointSet, typename TMovingSpatialObject>

MovingSpatialObjectConstPointer itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::m_MovingSpatialObject {}

private

Definition at line 92 of file itkPointSetToSpatialObjectDemonsRegistration.h.

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

itkPointSetToSpatialObjectDemonsRegistration.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ FixedPointSetConstPointer

◆ FixedPointSetType

◆ MovingSpatialObjectConstPointer

◆ MovingSpatialObjectType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ PointSetToSpatialObjectDemonsRegistration()

◆ ~PointSetToSpatialObjectDemonsRegistration()

Member Function Documentation

◆ CreateAnother()

◆ GetFixedPointSet()

◆ GetMovingSpatialObject()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetFixedPointSet()

◆ SetMovingSpatialObject()

Member Data Documentation

◆ m_FixedPointSet

◆ m_MovingSpatialObject