itk::simple::TransformToDisplacementFieldFilter Class Reference

Generate a displacement field from a coordinate transform. More...

#include <sitkTransformToDisplacementFieldFilter.h>

Inheritance diagram for itk::simple::TransformToDisplacementFieldFilter:

Collaboration diagram for itk::simple::TransformToDisplacementFieldFilter:

Detailed Description

Generate a displacement field from a coordinate transform.

Output information (spacing, size and direction) for the output image should be set. This information has the normal defaults of unit spacing, zero origin and identity direction. Optionally, the output information can be obtained from a reference image. If the reference image is provided and UseReferenceImage is On, then the spacing, origin and direction of the reference image will be used.

Since this filter produces an image which is a different size than its input, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In particular, this filter overrides ProcessObject::GenerateOutputInformation() .

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

Author

Marius Staring, Leiden University Medical Center, The Netherlands.

This class was taken from the Insight Journal paper: https://doi.org/10.54294/4ids6q

See also

itk::simple::TransformToDisplacementField for the procedural interface

itk::TransformToDisplacementFieldFilter for the Doxygen on the original ITK class.

Examples

DemonsRegistration2/DemonsRegistration2.cs, and DemonsRegistration2/DemonsRegistration2.cxx.

Definition at line 59 of file sitkTransformToDisplacementFieldFilter.h.

Public Types
using	PixelIDTypeList = RealVectorPixelIDTypeList
using	Self = TransformToDisplacementFieldFilter
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 Transform &transform)
std::string	GetName () const
std::vector< double >	GetOutputDirection () const
std::vector< double >	GetOutputOrigin () const
PixelIDValueEnum	GetOutputPixelType () const
	Get the ouput pixel type.
std::vector< double >	GetOutputSpacing () const
std::vector< unsigned int >	GetSize () const
void	SetOutputDirection (std::vector< double > OutputDirection)
void	SetOutputOrigin (std::vector< double > OutputOrigin)
void	SetOutputPixelType (PixelIDValueEnum OutputPixelType)
	Set the output pixel type, only sitkVectorFloat32 and sitkVectorFloat64 are supported.
void	SetOutputSpacing (std::vector< double > OutputSpacing)
void	SetReferenceImage (const Image &refImage)
void	SetSize (std::vector< unsigned int > Size)
std::string	ToString () const
	TransformToDisplacementFieldFilter ()
virtual	~TransformToDisplacementFieldFilter ()
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.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
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

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Transform *transform)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
std::vector< double >	m_OutputDirection { std::vector<double>() }
std::vector< double >	m_OutputOrigin { std::vector<double>(3, 0.0) }
PixelIDValueEnum	m_OutputPixelType { itk::simple::sitkVectorFloat64 }
std::vector< double >	m_OutputSpacing { std::vector<double>(3, 1.0) }
std::vector< unsigned int >	m_Size { std::vector<unsigned int>(3, 64) }

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.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
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::TransformToDisplacementFieldFilter::MemberFunctionType

private

Initial value:

 Image (Self::*)(const Transform *
    transform)

Setup for member function dispatching

Definition at line 162 of file sitkTransformToDisplacementFieldFilter.h.

PixelIDTypeList

using itk::simple::TransformToDisplacementFieldFilter::PixelIDTypeList = RealVectorPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 71 of file sitkTransformToDisplacementFieldFilter.h.

Self

using itk::simple::TransformToDisplacementFieldFilter::Self = TransformToDisplacementFieldFilter

Definition at line 61 of file sitkTransformToDisplacementFieldFilter.h.

Constructor & Destructor Documentation

~TransformToDisplacementFieldFilter()

virtual itk::simple::TransformToDisplacementFieldFilter::~TransformToDisplacementFieldFilter ( )

virtual

Destructor

TransformToDisplacementFieldFilter()

itk::simple::TransformToDisplacementFieldFilter::TransformToDisplacementFieldFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::TransformToDisplacementFieldFilter::Execute

(

const Transform &

transform

)

Execute the filter on the input image

Examples

DemonsRegistration2/DemonsRegistration2.cxx.

ExecuteInternal()

template<class TImageType>

Image itk::simple::TransformToDisplacementFieldFilter::ExecuteInternal ( const Transform * transform )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::TransformToDisplacementFieldFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 144 of file sitkTransformToDisplacementFieldFilter.h.

GetOutputDirection()

std::vector< double > itk::simple::TransformToDisplacementFieldFilter::GetOutputDirection ( ) const

inline

Set the output direction cosine matrix.

Definition at line 140 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputDirection.

GetOutputOrigin()

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

inline

Get the output image origin.

Definition at line 114 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputOrigin.

GetOutputPixelType()

PixelIDValueEnum itk::simple::TransformToDisplacementFieldFilter::GetOutputPixelType ( ) const

inline

Get the ouput pixel type.

Definition at line 88 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputPixelType.

GetOutputSpacing()

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

inline

Get the output image spacing.

Definition at line 127 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputSpacing.

GetSize()

std::vector< unsigned int > itk::simple::TransformToDisplacementFieldFilter::GetSize ( ) const

inline

Set/Get the size of the output image.

Definition at line 101 of file sitkTransformToDisplacementFieldFilter.h.

References m_Size.

SetOutputDirection()

void itk::simple::TransformToDisplacementFieldFilter::SetOutputDirection ( std::vector< double > OutputDirection )

inline

Set the output direction cosine matrix.

Definition at line 134 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputDirection.

SetOutputOrigin()

void itk::simple::TransformToDisplacementFieldFilter::SetOutputOrigin ( std::vector< double > OutputOrigin )

inline

Set the output image origin.

Definition at line 108 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputOrigin.

SetOutputPixelType()

void itk::simple::TransformToDisplacementFieldFilter::SetOutputPixelType ( PixelIDValueEnum OutputPixelType )

inline

Set the output pixel type, only sitkVectorFloat32 and sitkVectorFloat64 are supported.

Definition at line 82 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputPixelType.

SetOutputSpacing()

void itk::simple::TransformToDisplacementFieldFilter::SetOutputSpacing ( std::vector< double > OutputSpacing )

inline

Set the output image spacing.

Definition at line 121 of file sitkTransformToDisplacementFieldFilter.h.

References m_OutputSpacing.

SetReferenceImage()

void itk::simple::TransformToDisplacementFieldFilter::SetReferenceImage

(

const Image &

refImage

)

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

Examples

DemonsRegistration2/DemonsRegistration2.cxx.

SetSize()

void itk::simple::TransformToDisplacementFieldFilter::SetSize ( std::vector< unsigned int > Size )

inline

Set/Get the size of the output image.

Definition at line 95 of file sitkTransformToDisplacementFieldFilter.h.

References m_Size.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 164 of file sitkTransformToDisplacementFieldFilter.h.

References ExecuteInternal().

Member Data Documentation

m_OutputDirection

std::vector<double> itk::simple::TransformToDisplacementFieldFilter::m_OutputDirection { std::vector<double>() }

private

Definition at line 181 of file sitkTransformToDisplacementFieldFilter.h.

Referenced by GetOutputDirection(), and SetOutputDirection().

m_OutputOrigin

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

private

Definition at line 176 of file sitkTransformToDisplacementFieldFilter.h.

Referenced by GetOutputOrigin(), and SetOutputOrigin().

m_OutputPixelType

PixelIDValueEnum itk::simple::TransformToDisplacementFieldFilter::m_OutputPixelType { itk::simple::sitkVectorFloat64 }

private

Definition at line 172 of file sitkTransformToDisplacementFieldFilter.h.

Referenced by GetOutputPixelType(), and SetOutputPixelType().

m_OutputSpacing

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

private

Definition at line 178 of file sitkTransformToDisplacementFieldFilter.h.

Referenced by GetOutputSpacing(), and SetOutputSpacing().

m_Size

std::vector<unsigned int> itk::simple::TransformToDisplacementFieldFilter::m_Size { std::vector<unsigned int>(3, 64) }

private

Definition at line 174 of file sitkTransformToDisplacementFieldFilter.h.

Referenced by GetSize(), and SetSize().

---

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

• sitkTransformToDisplacementFieldFilter.h