BSplineTransformInitializerFilter is a helper class intended to initialize the control point grid such that it has a physically consistent definition. It sets the transform domain origin, physical dimensions and direction from information obtained from the image. It also sets the mesh size if asked to do so by calling SetTransformDomainMeshSize() before calling InitializeTransform(). More...

#include <sitkBSplineTransformInitializerFilter.h>

Inheritance diagram for itk::simple::BSplineTransformInitializerFilter:

Collaboration diagram for itk::simple::BSplineTransformInitializerFilter:

Detailed Description

BSplineTransformInitializerFilter is a helper class intended to initialize the control point grid such that it has a physically consistent definition. It sets the transform domain origin, physical dimensions and direction from information obtained from the image. It also sets the mesh size if asked to do so by calling SetTransformDomainMeshSize() before calling InitializeTransform().

Author: Luis Ibanez Nick Tustison

See also: itk::simple::BSplineTransformInitializer for the procedural interface; itk::BSplineTransformInitializer for the Doxygen on the original ITK class.

Definition at line 48 of file sitkBSplineTransformInitializerFilter.h.

Public Types
using	PixelIDTypeList = AllPixelIDTypeList

using	Self = BSplineTransformInitializerFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	BSplineTransformInitializerFilter ()

BSplineTransform	Execute (const Image &image1)

std::string	GetName () const override

unsigned int	GetOrder () const

std::vector< uint32_t >	GetTransformDomainMeshSize () const

Self &	SetOrder (unsigned int order)

Self &	SetTransformDomainMeshSize (const std::vector< uint32_t > &TransformDomainMeshSize)

std::string	ToString () const override

	~BSplineTransformInitializerFilter () override

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
typedef BSplineTransform(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
BSplineTransform	ExecuteInternal (const Image &image1)

template<unsigned int NDimension, unsigned int NOrder>
BSplineTransform	ExecuteInternalWithOrder (const Image &image1)

Private Attributes
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

unsigned int	m_Order

std::vector< uint32_t >	m_TransformDomainMeshSize

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

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

private

Setup for member function dispatching

Definition at line 118 of file sitkBSplineTransformInitializerFilter.h.

◆ PixelIDTypeList

using itk::simple::BSplineTransformInitializerFilter::PixelIDTypeList = AllPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkBSplineTransformInitializerFilter.h.

◆ Self

using itk::simple::BSplineTransformInitializerFilter::Self = BSplineTransformInitializerFilter

Definition at line 51 of file sitkBSplineTransformInitializerFilter.h.

Constructor & Destructor Documentation

◆ BSplineTransformInitializerFilter()

itk::simple::BSplineTransformInitializerFilter::BSplineTransformInitializerFilter ( )

Default Constructor that takes no arguments and initializes default parameters

◆ ~BSplineTransformInitializerFilter()

itk::simple::BSplineTransformInitializerFilter::~BSplineTransformInitializerFilter ( )

override

Destructor

Member Function Documentation

◆ Execute()

BSplineTransform itk::simple::BSplineTransformInitializerFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

BSplineTransform itk::simple::BSplineTransformInitializerFilter::ExecuteInternal ( const Image & image1 )

private

◆ ExecuteInternalWithOrder()

template<unsigned int NDimension, unsigned int NOrder>

BSplineTransform itk::simple::BSplineTransformInitializerFilter::ExecuteInternalWithOrder ( const Image & image1 )

private

◆ GetName()

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

inlineoverridevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkBSplineTransformInitializerFilter.h.

◆ GetOrder()

unsigned int itk::simple::BSplineTransformInitializerFilter::GetOrder ( ) const

inline

Definition at line 94 of file sitkBSplineTransformInitializerFilter.h.

◆ GetTransformDomainMeshSize()

std::vector<uint32_t> itk::simple::BSplineTransformInitializerFilter::GetTransformDomainMeshSize ( ) const

inline

Definition at line 78 of file sitkBSplineTransformInitializerFilter.h.

◆ SetOrder()

Self& itk::simple::BSplineTransformInitializerFilter::SetOrder ( unsigned int order )

inline

The order of the bspline in the output BSplineTransform. This value effects the number of control points.

Definition at line 88 of file sitkBSplineTransformInitializerFilter.h.

◆ SetTransformDomainMeshSize()

Self& itk::simple::BSplineTransformInitializerFilter::SetTransformDomainMeshSize ( const std::vector< uint32_t > & TransformDomainMeshSize )

inline

Allow the user to set the mesh size of the transform via the initializer even though the initializer does not do anything with that information. Default = 1^ImageDimension.

Definition at line 69 of file sitkBSplineTransformInitializerFilter.h.