SimpleITK  2.0.0rc2.post17
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

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

Public Member Functions

SelfEnforceBoundaryConditionOff ()
 
SelfEnforceBoundaryConditionOn ()
 
Image Execute (const Image &image1)
 
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
 
virtual ~InvertDisplacementFieldImageFilter ()
 
- 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

bool m_EnforceBoundaryCondition {true}
 
double m_MaxErrorNorm {0.0}
 
double m_MaxErrorToleranceThreshold {0.1}
 
uint32_t m_MaximumNumberOfIterations {10u}
 
double m_MeanErrorNorm {0.0}
 
double m_MeanErrorToleranceThreshold {0.001}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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

Iteratively estimate the inverse field of a displacement field.

Author
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 45 of file sitkInvertDisplacementFieldImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 127 of file sitkInvertDisplacementFieldImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 57 of file sitkInvertDisplacementFieldImageFilter.h.

◆ Self

Definition at line 47 of file sitkInvertDisplacementFieldImageFilter.h.

Constructor & Destructor Documentation

◆ ~InvertDisplacementFieldImageFilter()

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

Destructor

◆ InvertDisplacementFieldImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ EnforceBoundaryConditionOff()

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

Definition at line 90 of file sitkInvertDisplacementFieldImageFilter.h.

◆ EnforceBoundaryConditionOn()

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

Set the value of EnforceBoundaryCondition to true or false respectfully.

Definition at line 89 of file sitkInvertDisplacementFieldImageFilter.h.

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetEnforceBoundaryCondition()

bool itk::simple::InvertDisplacementFieldImageFilter::GetEnforceBoundaryCondition ( ) const
inline

Definition at line 94 of file sitkInvertDisplacementFieldImageFilter.h.

◆ GetMaxErrorNorm()

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

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.

◆ GetMaxErrorToleranceThreshold()

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

Definition at line 74 of file sitkInvertDisplacementFieldImageFilter.h.

◆ GetMaximumNumberOfIterations()

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

Definition at line 66 of file sitkInvertDisplacementFieldImageFilter.h.

◆ GetMeanErrorNorm()

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

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.

◆ GetMeanErrorToleranceThreshold()

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

Definition at line 82 of file sitkInvertDisplacementFieldImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 113 of file sitkInvertDisplacementFieldImageFilter.h.

◆ SetEnforceBoundaryCondition()

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

Definition at line 86 of file sitkInvertDisplacementFieldImageFilter.h.

◆ SetMaxErrorToleranceThreshold()

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

Definition at line 70 of file sitkInvertDisplacementFieldImageFilter.h.

◆ SetMaximumNumberOfIterations()

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

Definition at line 62 of file sitkInvertDisplacementFieldImageFilter.h.

◆ SetMeanErrorToleranceThreshold()

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

Definition at line 78 of file sitkInvertDisplacementFieldImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 131 of file sitkInvertDisplacementFieldImageFilter.h.

Member Data Documentation

◆ m_EnforceBoundaryCondition

bool itk::simple::InvertDisplacementFieldImageFilter::m_EnforceBoundaryCondition {true}
private

Definition at line 143 of file sitkInvertDisplacementFieldImageFilter.h.

◆ m_MaxErrorNorm

double itk::simple::InvertDisplacementFieldImageFilter::m_MaxErrorNorm {0.0}
private

Definition at line 146 of file sitkInvertDisplacementFieldImageFilter.h.

◆ m_MaxErrorToleranceThreshold

double itk::simple::InvertDisplacementFieldImageFilter::m_MaxErrorToleranceThreshold {0.1}
private

Definition at line 139 of file sitkInvertDisplacementFieldImageFilter.h.

◆ m_MaximumNumberOfIterations

uint32_t itk::simple::InvertDisplacementFieldImageFilter::m_MaximumNumberOfIterations {10u}
private

Definition at line 137 of file sitkInvertDisplacementFieldImageFilter.h.

◆ m_MeanErrorNorm

double itk::simple::InvertDisplacementFieldImageFilter::m_MeanErrorNorm {0.0}
private

Definition at line 148 of file sitkInvertDisplacementFieldImageFilter.h.

◆ m_MeanErrorToleranceThreshold

double itk::simple::InvertDisplacementFieldImageFilter::m_MeanErrorToleranceThreshold {0.001}
private

Definition at line 141 of file sitkInvertDisplacementFieldImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::InvertDisplacementFieldImageFilter::m_MemberFactory
private

Definition at line 133 of file sitkInvertDisplacementFieldImageFilter.h.


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