SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::InvertDisplacementFieldImageFilter Class Reference

Iteratively estimate the inverse field of a displacement field. More...

#include <sitkInvertDisplacementFieldImageFilter.h>

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

Public Types

typedef RealVectorPixelIDTypeList PixelIDTypeList
typedef InvertDisplacementFieldImageFilter 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

SelfEnforceBoundaryConditionOff ()
SelfEnforceBoundaryConditionOn ()
Image Execute (const Image &image1)
Image Execute (const Image &image1, uint32_t maximumNumberOfIterations, double maxErrorToleranceThreshold, double meanErrorToleranceThreshold, bool enforceBoundaryCondition)
bool GetEnforceBoundaryCondition () const
double GetMaxErrorNorm () const
double GetMaxErrorToleranceThreshold () const
uint32_t GetMaximumNumberOfIterations () const
double GetMeanErrorNorm () const
double GetMeanErrorToleranceThreshold () const
std::string GetName () const
 InvertDisplacementFieldImageFilter ()
SelfSetEnforceBoundaryCondition (bool EnforceBoundaryCondition)
SelfSetMaxErrorToleranceThreshold (double MaxErrorToleranceThreshold)
SelfSetMaximumNumberOfIterations (uint32_t MaximumNumberOfIterations)
SelfSetMeanErrorToleranceThreshold (double MeanErrorToleranceThreshold)
std::string ToString () const
 ~InvertDisplacementFieldImageFilter ()
- 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

bool m_EnforceBoundaryCondition
double m_MaxErrorNorm
double m_MaxErrorToleranceThreshold
uint32_t m_MaximumNumberOfIterations
double m_MeanErrorNorm
double m_MeanErrorToleranceThreshold
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory


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

Iteratively estimate the inverse field of a displacement field.

Nick Tustison

Brian Avants

See also
itk::simple::InvertDisplacementField for the procedural interface
itk::InvertDisplacementFieldImageFilter for the Doxygen on the original ITK class.

Definition at line 44 of file sitkInvertDisplacementFieldImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 130 of file sitkInvertDisplacementFieldImageFilter.h.

Define the pixels types supported by this filter

Definition at line 56 of file sitkInvertDisplacementFieldImageFilter.h.

Definition at line 46 of file sitkInvertDisplacementFieldImageFilter.h.

Constructor & Destructor Documentation

itk::simple::InvertDisplacementFieldImageFilter::InvertDisplacementFieldImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::InvertDisplacementFieldImageFilter::~InvertDisplacementFieldImageFilter ( )


Member Function Documentation

Self& itk::simple::InvertDisplacementFieldImageFilter::EnforceBoundaryConditionOff ( )

Definition at line 90 of file sitkInvertDisplacementFieldImageFilter.h.

Self& itk::simple::InvertDisplacementFieldImageFilter::EnforceBoundaryConditionOn ( )

Set the value of EnforceBoundaryCondition to true or false respectfully.

Definition at line 89 of file sitkInvertDisplacementFieldImageFilter.h.

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

Execute the filter on the input image

Image itk::simple::InvertDisplacementFieldImageFilter::Execute ( const Image image1,
uint32_t  maximumNumberOfIterations,
double  maxErrorToleranceThreshold,
double  meanErrorToleranceThreshold,
bool  enforceBoundaryCondition 

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::InvertDisplacementFieldImageFilter::ExecuteInternal ( const Image image1)
bool itk::simple::InvertDisplacementFieldImageFilter::GetEnforceBoundaryCondition ( ) const

Definition at line 94 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::GetMaxErrorNorm ( ) const

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 101 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::GetMaxErrorToleranceThreshold ( ) const

Definition at line 74 of file sitkInvertDisplacementFieldImageFilter.h.

uint32_t itk::simple::InvertDisplacementFieldImageFilter::GetMaximumNumberOfIterations ( ) const

Definition at line 66 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::GetMeanErrorNorm ( ) const

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 109 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::GetMeanErrorToleranceThreshold ( ) const

Definition at line 82 of file sitkInvertDisplacementFieldImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 112 of file sitkInvertDisplacementFieldImageFilter.h.

Self& itk::simple::InvertDisplacementFieldImageFilter::SetEnforceBoundaryCondition ( bool  EnforceBoundaryCondition)

Definition at line 86 of file sitkInvertDisplacementFieldImageFilter.h.

Self& itk::simple::InvertDisplacementFieldImageFilter::SetMaxErrorToleranceThreshold ( double  MaxErrorToleranceThreshold)

Definition at line 70 of file sitkInvertDisplacementFieldImageFilter.h.

Self& itk::simple::InvertDisplacementFieldImageFilter::SetMaximumNumberOfIterations ( uint32_t  MaximumNumberOfIterations)

Definition at line 62 of file sitkInvertDisplacementFieldImageFilter.h.

Self& itk::simple::InvertDisplacementFieldImageFilter::SetMeanErrorToleranceThreshold ( double  MeanErrorToleranceThreshold)

Definition at line 78 of file sitkInvertDisplacementFieldImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 135 of file sitkInvertDisplacementFieldImageFilter.h.

Member Data Documentation

bool itk::simple::InvertDisplacementFieldImageFilter::m_EnforceBoundaryCondition

Definition at line 144 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::m_MaxErrorNorm

Definition at line 146 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::m_MaxErrorToleranceThreshold

Definition at line 142 of file sitkInvertDisplacementFieldImageFilter.h.

uint32_t itk::simple::InvertDisplacementFieldImageFilter::m_MaximumNumberOfIterations

Definition at line 141 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::m_MeanErrorNorm

Definition at line 148 of file sitkInvertDisplacementFieldImageFilter.h.

double itk::simple::InvertDisplacementFieldImageFilter::m_MeanErrorToleranceThreshold

Definition at line 143 of file sitkInvertDisplacementFieldImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::InvertDisplacementFieldImageFilter::m_MemberFactory

Definition at line 137 of file sitkInvertDisplacementFieldImageFilter.h.

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