ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject > Class Template Reference

#include <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
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
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 ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
MovingSpatialObjectConstPointer m_MovingSpatialObject
 
FixedPointSetConstPointer m_FixedPointSet
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () const
 
virtual void SetMovingSpatialObject (const MovingSpatialObjectType *_arg)
 
virtual const MovingSpatialObjectTypeGetMovingSpatialObject () const
 
 PointSetToSpatialObjectDemonsRegistration ()
 
 ~PointSetToSpatialObjectDemonsRegistration () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateData ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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[1] 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.

[1] J-P. Thirion "Image matching as a Diffusion Process: and Analogy with Maxwell's Demons", Medical Image Analysis, 1998, Vol. 2, No. 3, pp 243-260.

Definition at line 53 of file itkPointSetToSpatialObjectDemonsRegistration.h.

Member Typedef Documentation

◆ ConstPointer

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

◆ FixedPointSetConstPointer

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

◆ FixedPointSetType

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

Type of the Fixed PointSet.

Definition at line 71 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ MovingSpatialObjectConstPointer

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

◆ MovingSpatialObjectType

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

Type of the Moving image.

Definition at line 75 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ Pointer

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

◆ Self

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

Standard class type aliases.

Definition at line 59 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ Superclass

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

Constructor & Destructor Documentation

◆ PointSetToSpatialObjectDemonsRegistration()

template<typename TFixedPointSet , typename TMovingSpatialObject >
itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::PointSetToSpatialObjectDemonsRegistration ( )
protected

Set/Get the Fixed image.

◆ ~PointSetToSpatialObjectDemonsRegistration()

template<typename TFixedPointSet , typename TMovingSpatialObject >
itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::~PointSetToSpatialObjectDemonsRegistration ( )
overrideprotecteddefault

Set/Get the Fixed image.

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 Fixed image.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

◆ 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

Set/Get the Fixed image.

Reimplemented from itk::ProcessObject.

◆ 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

Set/Get the Fixed image.

Definition at line 96 of file itkPointSetToSpatialObjectDemonsRegistration.h.

◆ m_MovingSpatialObject

template<typename TFixedPointSet , typename TMovingSpatialObject >
MovingSpatialObjectConstPointer itk::PointSetToSpatialObjectDemonsRegistration< TFixedPointSet, TMovingSpatialObject >::m_MovingSpatialObject
private

Set/Get the Fixed image.

Definition at line 95 of file itkPointSetToSpatialObjectDemonsRegistration.h.


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