ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::BSplineTransformInitializer< TTransform, TImage > Class Template Reference

#include <itkBSplineTransformInitializer.h>

Detailed Description

template<typename TTransform, typename TImage>
class itk::BSplineTransformInitializer< TTransform, TImage >

BSplineTransformInitializer 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
Examples
Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, and Examples/RegistrationITKv4/DeformableRegistration8.cxx.

Definition at line 41 of file itkBSplineTransformInitializer.h.

+ Inheritance diagram for itk::BSplineTransformInitializer< TTransform, TImage >:
+ Collaboration diagram for itk::BSplineTransformInitializer< TTransform, TImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename TransformType::DirectionType
 
using ImagePointCoordRepType = typename ImagePointType::CoordRepType
 
using ImagePointer = typename ImageType::ConstPointer
 
using ImagePointType = typename ImageType::PointType
 
using ImageType = TImage
 
using IndexType = typename ImageType::IndexType
 
using MeshSizeType = typename TransformType::MeshSizeType
 
using OriginType = typename TransformType::OriginType
 
using PhysicalDimensionsType = typename TransformType::PhysicalDimensionsType
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename TransformType::RegionType
 
using Self = BSplineTransformInitializer
 
using SizeType = typename RegionType::SizeType
 
using SpacingComponentType = typename SpacingType::ComponentType
 
using SpacingType = typename TransformType::SpacingType
 
using Superclass = Object
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = TTransform
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual void InitializeTransform () const
 
 itkOverrideGetNameOfClassMacro (BSplineTransformInitializer)
 
virtual const TransformTypeGetTransform () const
 
virtual void SetTransform (TransformType *_arg)
 
virtual const ImageTypeGetImage () const
 
virtual void SetImage (const ImageType *_arg)
 
virtual MeshSizeType GetTransformDomainMeshSize () const
 
void SetTransformDomainMeshSize (const MeshSizeType)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int SpaceDimension = TransformType::SpaceDimension
 

Protected Member Functions

 BSplineTransformInitializer ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BSplineTransformInitializer () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

ImagePointer m_Image {}
 
bool m_SetTransformDomainMeshSizeViaInitializer { false }
 
TransformPointer m_Transform {}
 
MeshSizeType m_TransformDomainMeshSize { MeshSizeType::Filled(1) }
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkBSplineTransformInitializer.h.

◆ DirectionType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::DirectionType = typename TransformType::DirectionType

Definition at line 74 of file itkBSplineTransformInitializer.h.

◆ ImagePointCoordRepType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::ImagePointCoordRepType = typename ImagePointType::CoordRepType

Definition at line 66 of file itkBSplineTransformInitializer.h.

◆ ImagePointer

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::ImagePointer = typename ImageType::ConstPointer

Definition at line 63 of file itkBSplineTransformInitializer.h.

◆ ImagePointType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::ImagePointType = typename ImageType::PointType

Definition at line 65 of file itkBSplineTransformInitializer.h.

◆ ImageType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::ImageType = TImage

Types defined from the input image traits.

Definition at line 62 of file itkBSplineTransformInitializer.h.

◆ IndexType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::IndexType = typename ImageType::IndexType

Definition at line 64 of file itkBSplineTransformInitializer.h.

◆ MeshSizeType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::MeshSizeType = typename TransformType::MeshSizeType

Definition at line 76 of file itkBSplineTransformInitializer.h.

◆ OriginType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::OriginType = typename TransformType::OriginType

Definition at line 73 of file itkBSplineTransformInitializer.h.

◆ PhysicalDimensionsType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::PhysicalDimensionsType = typename TransformType::PhysicalDimensionsType

Definition at line 75 of file itkBSplineTransformInitializer.h.

◆ Pointer

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkBSplineTransformInitializer.h.

◆ RegionType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::RegionType = typename TransformType::RegionType

Definition at line 70 of file itkBSplineTransformInitializer.h.

◆ Self

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::Self = BSplineTransformInitializer

Standard class type aliases.

Definition at line 47 of file itkBSplineTransformInitializer.h.

◆ SizeType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::SizeType = typename RegionType::SizeType

Definition at line 71 of file itkBSplineTransformInitializer.h.

◆ SpacingComponentType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::SpacingComponentType = typename SpacingType::ComponentType

Definition at line 77 of file itkBSplineTransformInitializer.h.

◆ SpacingType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::SpacingType = typename TransformType::SpacingType

Definition at line 72 of file itkBSplineTransformInitializer.h.

◆ Superclass

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::Superclass = Object

Definition at line 48 of file itkBSplineTransformInitializer.h.

◆ TransformPointer

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::TransformPointer = typename TransformType::Pointer

Types defined from transform traits.

Definition at line 69 of file itkBSplineTransformInitializer.h.

◆ TransformType

template<typename TTransform , typename TImage >
using itk::BSplineTransformInitializer< TTransform, TImage >::TransformType = TTransform

Type of the transform to initialize.

Definition at line 59 of file itkBSplineTransformInitializer.h.

Constructor & Destructor Documentation

◆ BSplineTransformInitializer()

template<typename TTransform , typename TImage >
itk::BSplineTransformInitializer< TTransform, TImage >::BSplineTransformInitializer ( )
protecteddefault

◆ ~BSplineTransformInitializer()

template<typename TTransform , typename TImage >
itk::BSplineTransformInitializer< TTransform, TImage >::~BSplineTransformInitializer ( )
overrideprotecteddefault

Member Function Documentation

◆ GetImage()

template<typename TTransform , typename TImage >
virtual const ImageType* itk::BSplineTransformInitializer< TTransform, TImage >::GetImage ( ) const
virtual

Set/Get the image to initialize the domain.

◆ GetTransform()

template<typename TTransform , typename TImage >
virtual const TransformType* itk::BSplineTransformInitializer< TTransform, TImage >::GetTransform ( ) const
virtual

Set/Get the transform to be initialized.

◆ GetTransformDomainMeshSize()

template<typename TTransform , typename TImage >
virtual MeshSizeType itk::BSplineTransformInitializer< TTransform, TImage >::GetTransformDomainMeshSize ( ) const
virtual

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 size is 1^ImageDimension.

◆ InitializeTransform()

template<typename TTransform , typename TImage >
virtual void itk::BSplineTransformInitializer< TTransform, TImage >::InitializeTransform ( ) const
virtual

Initialize the transform using the specified transformation domain.

◆ itkOverrideGetNameOfClassMacro()

template<typename TTransform , typename TImage >
itk::BSplineTransformInitializer< TTransform, TImage >::itkOverrideGetNameOfClassMacro ( BSplineTransformInitializer< TTransform, TImage >  )

Run-time type information (and related methods).

◆ New()

template<typename TTransform , typename TImage >
static Pointer itk::BSplineTransformInitializer< TTransform, TImage >::New ( )
static

New macro for creation of through a Smart Pointer.

◆ PrintSelf()

template<typename TTransform , typename TImage >
void itk::BSplineTransformInitializer< TTransform, TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ SetImage()

template<typename TTransform , typename TImage >
virtual void itk::BSplineTransformInitializer< TTransform, TImage >::SetImage ( const ImageType _arg)
virtual

Set/Get the image to initialize the domain.

◆ SetTransform()

template<typename TTransform , typename TImage >
virtual void itk::BSplineTransformInitializer< TTransform, TImage >::SetTransform ( TransformType _arg)
virtual

Set/Get the transform to be initialized.

◆ SetTransformDomainMeshSize()

template<typename TTransform , typename TImage >
void itk::BSplineTransformInitializer< TTransform, TImage >::SetTransformDomainMeshSize ( const  MeshSizeType)

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 size is 1^ImageDimension.

Member Data Documentation

◆ m_Image

template<typename TTransform , typename TImage >
ImagePointer itk::BSplineTransformInitializer< TTransform, TImage >::m_Image {}
private

Definition at line 112 of file itkBSplineTransformInitializer.h.

◆ m_SetTransformDomainMeshSizeViaInitializer

template<typename TTransform , typename TImage >
bool itk::BSplineTransformInitializer< TTransform, TImage >::m_SetTransformDomainMeshSizeViaInitializer { false }
private

Definition at line 116 of file itkBSplineTransformInitializer.h.

◆ m_Transform

template<typename TTransform , typename TImage >
TransformPointer itk::BSplineTransformInitializer< TTransform, TImage >::m_Transform {}
private

Definition at line 113 of file itkBSplineTransformInitializer.h.

◆ m_TransformDomainMeshSize

template<typename TTransform , typename TImage >
MeshSizeType itk::BSplineTransformInitializer< TTransform, TImage >::m_TransformDomainMeshSize { MeshSizeType::Filled(1) }
private

Definition at line 115 of file itkBSplineTransformInitializer.h.

◆ SpaceDimension

template<typename TTransform , typename TImage >
constexpr unsigned int itk::BSplineTransformInitializer< TTransform, TImage >::SpaceDimension = TransformType::SpaceDimension
staticconstexpr

Dimension of parameters.

Definition at line 80 of file itkBSplineTransformInitializer.h.


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