SimpleITK  1.3.0.dev449
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::InverseDisplacementFieldImageFilter Class Reference

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

#include <sitkInverseDisplacementFieldImageFilter.h>

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

Public Types

typedef RealVectorPixelIDTypeList PixelIDTypeList
 
typedef InverseDisplacementFieldImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< uint32_t > &size, const std::vector< double > &outputOrigin, const std::vector< double > &outputSpacing, unsigned int subsamplingFactor)
 
std::string GetName () const
 
std::vector< double > GetOutputOrigin () const
 
std::vector< double > GetOutputSpacing () const
 
std::vector< uint32_tGetSize () const
 
unsigned int GetSubsamplingFactor () const
 
 InverseDisplacementFieldImageFilter ()
 
SelfSetOutputOrigin (const std::vector< double > &OutputOrigin)
 
SelfSetOutputSpacing (const std::vector< double > &OutputSpacing)
 
void SetReferenceImage (const Image &refImage)
 
SelfSetSize (const std::vector< uint32_t > &Size)
 
SelfSetSubsamplingFactor (unsigned int SubsamplingFactor)
 
std::string ToString () const
 
virtual ~InverseDisplacementFieldImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

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

Private Attributes

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< double > m_OutputOrigin
 
std::vector< double > m_OutputSpacing
 
std::vector< uint32_tm_Size
 
unsigned int m_SubsamplingFactor
 

Friends

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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.

InverseDisplacementFieldImageFilter 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.

Given that both the input and output displacement field are represented as discrete images with pixel type vector, the inverse will be only an estimation and will probably not correspond to a perfect inverse. The precision of the inverse can be improved at the price of increasing the computation time and memory consumption in this filter.

The method used for computing the inverse displacement field is to subsample the input field using a regular grid and create Kerned-Base Spline in which the reference landmarks are the coordinates of the deformed point and the target landmarks are the negative of the displacement vectors. The kernel-base spline is then used for regularly sampling the output space and recover vector values for every single pixel.

The subsampling factor used for the regular grid of the input field will determine the number of landmarks in the KernelBased spline and therefore it will have a dramatic effect on both the precision of output displacement field and the computational time required for the filter to complete the estimation. A large subsampling factor will result in few landmarks in the KernelBased spline, therefore on fast computation and low precision. A small subsampling factor will result in a large number of landmarks in the KernelBased spline, therefore a large memory consumption, long computation time and high precision for the inverse estimation.

This filter expects both the input and output images to be of pixel type Vector .

See also
itk::simple::InverseDisplacementField for the procedural interface
itk::InverseDisplacementFieldImageFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkInverseDisplacementFieldImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::InverseDisplacementFieldImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 127 of file sitkInverseDisplacementFieldImageFilter.h.

Define the pixels types supported by this filter

Definition at line 62 of file sitkInverseDisplacementFieldImageFilter.h.

Definition at line 52 of file sitkInverseDisplacementFieldImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::InverseDisplacementFieldImageFilter::~InverseDisplacementFieldImageFilter ( )
virtual

Destructor

itk::simple::InverseDisplacementFieldImageFilter::InverseDisplacementFieldImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::InverseDisplacementFieldImageFilter::Execute ( const Image image1,
const std::vector< uint32_t > &  size,
const std::vector< double > &  outputOrigin,
const std::vector< double > &  outputSpacing,
unsigned int  subsamplingFactor 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::InverseDisplacementFieldImageFilter::ExecuteInternal ( const Image image1)
private
std::string itk::simple::InverseDisplacementFieldImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkInverseDisplacementFieldImageFilter.h.

std::vector<double> itk::simple::InverseDisplacementFieldImageFilter::GetOutputOrigin ( ) const
inline

Get the output image origin.

Definition at line 84 of file sitkInverseDisplacementFieldImageFilter.h.

std::vector<double> itk::simple::InverseDisplacementFieldImageFilter::GetOutputSpacing ( ) const
inline

Get the output image spacing.

Definition at line 94 of file sitkInverseDisplacementFieldImageFilter.h.

std::vector<uint32_t> itk::simple::InverseDisplacementFieldImageFilter::GetSize ( ) const
inline

Get the size of the output image.

Definition at line 74 of file sitkInverseDisplacementFieldImageFilter.h.

unsigned int itk::simple::InverseDisplacementFieldImageFilter::GetSubsamplingFactor ( ) const
inline

Set/Get the factor used for subsampling the input displacement field. A large value in this factor will produce a fast computation of the inverse field but with low precision. A small value of this factor will produce a precise computation of the inverse field at the price of large memory consumption and long computational time.

Definition at line 104 of file sitkInverseDisplacementFieldImageFilter.h.

Self& itk::simple::InverseDisplacementFieldImageFilter::SetOutputOrigin ( const std::vector< double > &  OutputOrigin)
inline

Set the output image origin.

Definition at line 79 of file sitkInverseDisplacementFieldImageFilter.h.

Self& itk::simple::InverseDisplacementFieldImageFilter::SetOutputSpacing ( const std::vector< double > &  OutputSpacing)
inline

Set the output image spacing.

Definition at line 89 of file sitkInverseDisplacementFieldImageFilter.h.

void itk::simple::InverseDisplacementFieldImageFilter::SetReferenceImage ( const Image refImage)

This methods sets the output size, origin, and direction to that of the provided image

Self& itk::simple::InverseDisplacementFieldImageFilter::SetSize ( const std::vector< uint32_t > &  Size)
inline

Set the size of the output image.

Definition at line 69 of file sitkInverseDisplacementFieldImageFilter.h.

Self& itk::simple::InverseDisplacementFieldImageFilter::SetSubsamplingFactor ( unsigned int  SubsamplingFactor)
inline

Set/Get the factor used for subsampling the input displacement field. A large value in this factor will produce a fast computation of the inverse field but with low precision. A small value of this factor will produce a precise computation of the inverse field at the price of large memory consumption and long computational time.

Definition at line 99 of file sitkInverseDisplacementFieldImageFilter.h.

std::string itk::simple::InverseDisplacementFieldImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 131 of file sitkInverseDisplacementFieldImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::InverseDisplacementFieldImageFilter::m_MemberFactory
private

Definition at line 133 of file sitkInverseDisplacementFieldImageFilter.h.

std::vector<double> itk::simple::InverseDisplacementFieldImageFilter::m_OutputOrigin
private

Definition at line 139 of file sitkInverseDisplacementFieldImageFilter.h.

std::vector<double> itk::simple::InverseDisplacementFieldImageFilter::m_OutputSpacing
private

Definition at line 141 of file sitkInverseDisplacementFieldImageFilter.h.

std::vector<uint32_t> itk::simple::InverseDisplacementFieldImageFilter::m_Size
private

Definition at line 137 of file sitkInverseDisplacementFieldImageFilter.h.

unsigned int itk::simple::InverseDisplacementFieldImageFilter::m_SubsamplingFactor
private

Definition at line 142 of file sitkInverseDisplacementFieldImageFilter.h.


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