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

#include <sitkInverseDisplacementFieldImageFilter.h>

Inheritance diagram for itk::simple::InverseDisplacementFieldImageFilter:

Collaboration diagram for itk::simple::InverseDisplacementFieldImageFilter:

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 49 of file sitkInverseDisplacementFieldImageFilter.h.

Public Types
using	PixelIDTypeList = RealVectorPixelIDTypeList

using	Self = InverseDisplacementFieldImageFilter

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

std::vector< double >	GetOutputOrigin () const

std::vector< double >	GetOutputSpacing () const

std::vector< uint32_t >	GetSize () const

unsigned int	GetSubsamplingFactor () const

	InverseDisplacementFieldImageFilter ()

Self &	SetOutputOrigin (std::vector< double > OutputOrigin)

Self &	SetOutputSpacing (std::vector< double > OutputSpacing)

void	SetReferenceImage (const Image &refImage)

Self &	SetSize (std::vector< uint32_t > Size)

Self &	SetSubsamplingFactor (unsigned int SubsamplingFactor)

std::string	ToString () const

virtual	~InverseDisplacementFieldImageFilter ()

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

std::vector< double >	m_OutputOrigin {std::vector<double>(3, 0.0)}

std::vector< double >	m_OutputSpacing {std::vector<double>(3, 1.0)}

std::vector< uint32_t >	m_Size {std::vector<uint32_t>(3, 0)}

unsigned int	m_SubsamplingFactor {16u}

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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 123 of file sitkInverseDisplacementFieldImageFilter.h.

◆ PixelIDTypeList

using itk::simple::InverseDisplacementFieldImageFilter::PixelIDTypeList = RealVectorPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkInverseDisplacementFieldImageFilter.h.

◆ Self

using itk::simple::InverseDisplacementFieldImageFilter::Self = InverseDisplacementFieldImageFilter

Definition at line 51 of file sitkInverseDisplacementFieldImageFilter.h.

Constructor & Destructor Documentation

◆ ~InverseDisplacementFieldImageFilter()

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

virtual

Destructor

◆ InverseDisplacementFieldImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::InverseDisplacementFieldImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 105 of file sitkInverseDisplacementFieldImageFilter.h.

◆ GetOutputOrigin()

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

inline

Get the output image origin.

Definition at line 82 of file sitkInverseDisplacementFieldImageFilter.h.

◆ GetOutputSpacing()

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

inline

Get the output image spacing.

Definition at line 92 of file sitkInverseDisplacementFieldImageFilter.h.

◆ GetSize()

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

inline

Get the size of the output image.

Definition at line 72 of file sitkInverseDisplacementFieldImageFilter.h.

◆ GetSubsamplingFactor()

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 102 of file sitkInverseDisplacementFieldImageFilter.h.

◆ SetOutputOrigin()

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

inline

Set the output image origin.

Definition at line 77 of file sitkInverseDisplacementFieldImageFilter.h.

◆ SetOutputSpacing()

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

inline

Set the output image spacing.

Definition at line 87 of file sitkInverseDisplacementFieldImageFilter.h.

◆ SetReferenceImage()

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

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

◆ SetSize()

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

inline

Set the size of the output image.

Definition at line 67 of file sitkInverseDisplacementFieldImageFilter.h.

◆ SetSubsamplingFactor()

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 97 of file sitkInverseDisplacementFieldImageFilter.h.