SimpleITK  2.1.0.dev79
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::IterativeInverseDisplacementFieldImageFilter Class Reference

Computes the inverse of a displacement field. More...

#include <sitkIterativeInverseDisplacementFieldImageFilter.h>

+ Inheritance diagram for itk::simple::IterativeInverseDisplacementFieldImageFilter:
+ Collaboration diagram for itk::simple::IterativeInverseDisplacementFieldImageFilter:

Public Types

using PixelIDTypeList = RealVectorPixelIDTypeList
using Self = IterativeInverseDisplacementFieldImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

Image Execute (const Image &image1)
std::string GetName () const
uint32_t GetNumberOfIterations () const
double GetStopValue () const
 IterativeInverseDisplacementFieldImageFilter ()
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
SelfSetStopValue (double StopValue)
std::string ToString () const
virtual ~IterativeInverseDisplacementFieldImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
virtual ~ProcessObject ()
virtual void DebugOn ()
virtual void DebugOff ()
virtual bool GetDebug () const
virtual void SetDebug (bool debugFlag)
virtual void SetNumberOfThreads (unsigned int n)
virtual unsigned int GetNumberOfThreads () const
virtual void SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int GetNumberOfWorkUnits () const

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)

Private Attributes

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
uint32_t m_NumberOfIterations {5u}
double m_StopValue {0.0}


struct detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
static void GlobalDefaultDebugOff ()
static void GlobalDefaultDebugOn ()
static void SetGlobalDefaultDebug (bool debugFlag)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 NonCopyable (const NonCopyable &)=delete
NonCopyableoperator= (const NonCopyable &)=delete
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (EventEnum e)
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Computes the inverse of a displacement field.

IterativeInverseDisplacementFieldImageFilter takes a displacement field as input and computes the displacement field that is its inverse. If the input displacement field was mapping coordinates from a space A into a space B, the output of this filter will map coordinates from the space B into the space A.

The algorithm implemented in this filter uses an iterative method for progressively refining the values of the inverse field. Starting from the direct field, at every pixel the direct mapping of this point is found, and a the negative of the current displacement is stored in the inverse field at the nearest pixel. Then, subsequent iterations verify if any of the neighbor pixels provide a better return to the current pixel, in which case its value is taken for updating the vector in the inverse field.

This method was discussed in the users-list during February 2004.

Corinne Mattmann
See also
itk::simple::IterativeInverseDisplacementField for the procedural interface
itk::IterativeInverseDisplacementFieldImageFilter for the Doxygen on the original ITK class.

Definition at line 48 of file sitkIterativeInverseDisplacementFieldImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 94 of file sitkIterativeInverseDisplacementFieldImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 60 of file sitkIterativeInverseDisplacementFieldImageFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~IterativeInverseDisplacementFieldImageFilter()

virtual itk::simple::IterativeInverseDisplacementFieldImageFilter::~IterativeInverseDisplacementFieldImageFilter ( )


◆ IterativeInverseDisplacementFieldImageFilter()

itk::simple::IterativeInverseDisplacementFieldImageFilter::IterativeInverseDisplacementFieldImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::IterativeInverseDisplacementFieldImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::IterativeInverseDisplacementFieldImageFilter::ExecuteInternal ( const Image image1)

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 80 of file sitkIterativeInverseDisplacementFieldImageFilter.h.

◆ GetNumberOfIterations()

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

◆ GetStopValue()

double itk::simple::IterativeInverseDisplacementFieldImageFilter::GetStopValue ( ) const

◆ SetNumberOfIterations()

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

◆ SetStopValue()

Self& itk::simple::IterativeInverseDisplacementFieldImageFilter::SetStopValue ( double  StopValue)

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_MemberFactory

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

◆ m_NumberOfIterations

uint32_t itk::simple::IterativeInverseDisplacementFieldImageFilter::m_NumberOfIterations {5u}

◆ m_StopValue

double itk::simple::IterativeInverseDisplacementFieldImageFilter::m_StopValue {0.0}

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