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

#include <itkBSplineTransformParametersAdaptor.h>

+ Inheritance diagram for itk::BSplineTransformParametersAdaptor< TTransform >:
+ Collaboration diagram for itk::BSplineTransformParametersAdaptor< TTransform >:

Public Types

using CoefficientImageArray = typename TransformType::CoefficientImageArray
 
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename TransformType::DirectionType
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using FixedParametersValueType = typename Superclass::FixedParametersValueType
 
using ImageType = typename TransformType::ImageType
 
using IndexType = typename TransformType::IndexType
 
using MeshSizeType = typename TransformType::MeshSizeType
 
using OriginType = typename TransformType::OriginType
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using PhysicalDimensionsType = typename TransformType::PhysicalDimensionsType
 
using Pointer = SmartPointer< Self >
 
using RegionType = typename ImageType::RegionType
 
using Self = BSplineTransformParametersAdaptor
 
using SizeType = typename TransformType::SizeType
 
using SpacingType = typename TransformType::SpacingType
 
using Superclass = TransformParametersAdaptor< TTransform >
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = TTransform
 
- Public Types inherited from itk::TransformParametersAdaptor< TTransform >
using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using FixedParametersValueType = typename Superclass::FixedParametersValueType
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformParametersAdaptor
 
using Superclass = TransformParametersAdaptorBase< Transform< typename TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
 
using TransformBaseType = typename Superclass::TransformBaseType
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = TTransform
 
- Public Types inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename TransformBaseType::FixedParametersType
 
using FixedParametersValueType = typename TransformBaseType::FixedParametersValueType
 
using ParametersType = typename TransformBaseType::ParametersType
 
using ParametersValueType = typename ParametersType::ValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformParametersAdaptorBase
 
using Superclass = Object
 
using TransformBasePointer = typename TransformBaseType::Pointer
 
using TransformBaseType = Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension >
 
- 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

void AdaptTransformParameters () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual const DirectionTypeGetRequiredTransformDomainDirection () const
 
virtual const MeshSizeTypeGetRequiredTransformDomainMeshSize () const
 
virtual const OriginTypeGetRequiredTransformDomainOrigin () const
 
virtual const PhysicalDimensionsTypeGetRequiredTransformDomainPhysicalDimensions () const
 
void SetRequiredFixedParameters (const FixedParametersType) override
 
void SetRequiredTransformDomainDirection (const DirectionType &)
 
void SetRequiredTransformDomainMeshSize (const MeshSizeType &)
 
void SetRequiredTransformDomainOrigin (const OriginType &)
 
void SetRequiredTransformDomainPhysicalDimensions (const PhysicalDimensionsType &)
 
- Public Member Functions inherited from itk::TransformParametersAdaptor< TTransform >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetTransform (TransformBaseType *_arg, void *) override
 
virtual void SetTransform (TransformType *_arg)
 
void SetRequiredFixedParameters (const FixedParametersType fixedParameters) override
 
const FixedParametersTypeGetRequiredFixedParameters () const override
 
void AdaptTransformParameters () override
 
- Public Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
virtual void SetRequiredFixedParameters (FixedParametersType _arg)
 
virtual void SetTransform (TransformBaseType *_arg, void *priorityLower=nullptr)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::TransformParametersAdaptor< TTransform >
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 flag)
 
- 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

 BSplineTransformParametersAdaptor ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BSplineTransformParametersAdaptor () override=default
 
- Protected Member Functions inherited from itk::TransformParametersAdaptor< TTransform >
 TransformParametersAdaptor ()=default
 
 ~TransformParametersAdaptor () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 TransformParametersAdaptorBase ()=default
 
 ~TransformParametersAdaptorBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 Member Functions

void UpdateRequiredFixedParameters ()
 

Private Attributes

DirectionType m_RequiredTransformDomainDirection
 
MeshSizeType m_RequiredTransformDomainMeshSize
 
OriginType m_RequiredTransformDomainOrigin
 
PhysicalDimensionsType m_RequiredTransformDomainPhysicalDimensions
 

Additional Inherited Members

- Protected Attributes inherited from itk::TransformParametersAdaptor< TTransform >
TransformPointer m_Transform
 
- Protected Attributes inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
FixedParametersType m_RequiredFixedParameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TTransform>
class itk::BSplineTransformParametersAdaptor< TTransform >

BSplineTransformParametersAdaptor adapts a BSplineTransform to the new specified fixed parameters.

The fixed parameters of the BSplineTransform store the following information (in order as they appear in m_FixedParameters): grid size grid origin grid spacing grid direction

During multiresolution image registration it is often desired to also increase the B-spline grid resolution for greater flexibility in optimizing the transform. As defined in the base class, the user can change the resolution via

transformAdaptor->SetTransform( transform );
transformAdaptor->SetRequiredFixedParameters( fixedParameters );
transformAdaptor->AdaptTransformParameters();

or the user can use the more intuitive API for setting the fixed parameters. E.g., often the user will want to maintain the same transform domain spatial extent but only increase the mesh size. This can be done as follows:

transformAdaptor->SetTransform( transform );
transformAdaptor->SetRequiredTransformDomainOrigin( transform->GetTransformDomainOrigin() );
transformAdaptor->SetRequiredTransformDomainDirection( transform->GetTransformDomainDirection() );
transformAdaptor->SetRequiredTransformDomainPhysicalDimensions( transform->GetTransformDomainPhysicalDimensions()
); transformAdaptor->SetRequiredTransformDomainMeshSize( newMeshSize ); transformAdaptor->AdaptTransformParameters();
Author
Nick Tustison
Marius Staring
Examples
Examples/RegistrationITKv4/DeformableRegistration6.cxx.

Definition at line 64 of file itkBSplineTransformParametersAdaptor.h.

Member Typedef Documentation

◆ CoefficientImageArray

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::CoefficientImageArray = typename TransformType::CoefficientImageArray

Definition at line 101 of file itkBSplineTransformParametersAdaptor.h.

◆ ConstPointer

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::ConstPointer = SmartPointer<const Self>

Definition at line 73 of file itkBSplineTransformParametersAdaptor.h.

◆ DirectionType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::DirectionType = typename TransformType::DirectionType

Definition at line 95 of file itkBSplineTransformParametersAdaptor.h.

◆ FixedParametersType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::FixedParametersType = typename Superclass::FixedParametersType

Definition at line 85 of file itkBSplineTransformParametersAdaptor.h.

◆ FixedParametersValueType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::FixedParametersValueType = typename Superclass::FixedParametersValueType

Definition at line 86 of file itkBSplineTransformParametersAdaptor.h.

◆ ImageType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::ImageType = typename TransformType::ImageType

Definition at line 99 of file itkBSplineTransformParametersAdaptor.h.

◆ IndexType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::IndexType = typename TransformType::IndexType

Definition at line 93 of file itkBSplineTransformParametersAdaptor.h.

◆ MeshSizeType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::MeshSizeType = typename TransformType::MeshSizeType

Definition at line 94 of file itkBSplineTransformParametersAdaptor.h.

◆ OriginType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::OriginType = typename TransformType::OriginType

Definition at line 90 of file itkBSplineTransformParametersAdaptor.h.

◆ ParametersType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::ParametersType = typename Superclass::ParametersType

Definition at line 87 of file itkBSplineTransformParametersAdaptor.h.

◆ ParametersValueType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::ParametersValueType = typename Superclass::ParametersValueType

Definition at line 88 of file itkBSplineTransformParametersAdaptor.h.

◆ PhysicalDimensionsType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::PhysicalDimensionsType = typename TransformType::PhysicalDimensionsType

Definition at line 96 of file itkBSplineTransformParametersAdaptor.h.

◆ Pointer

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::Pointer = SmartPointer<Self>

Definition at line 72 of file itkBSplineTransformParametersAdaptor.h.

◆ RegionType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::RegionType = typename ImageType::RegionType

Definition at line 100 of file itkBSplineTransformParametersAdaptor.h.

◆ Self

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::Self = BSplineTransformParametersAdaptor

Standard class type aliases.

Definition at line 70 of file itkBSplineTransformParametersAdaptor.h.

◆ SizeType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::SizeType = typename TransformType::SizeType

Definition at line 91 of file itkBSplineTransformParametersAdaptor.h.

◆ SpacingType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::SpacingType = typename TransformType::SpacingType

Definition at line 92 of file itkBSplineTransformParametersAdaptor.h.

◆ Superclass

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::Superclass = TransformParametersAdaptor<TTransform>

Definition at line 71 of file itkBSplineTransformParametersAdaptor.h.

◆ TransformPointer

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::TransformPointer = typename TransformType::Pointer

Definition at line 83 of file itkBSplineTransformParametersAdaptor.h.

◆ TransformType

template<typename TTransform >
using itk::BSplineTransformParametersAdaptor< TTransform >::TransformType = TTransform

Typedefs associated with the transform

Definition at line 82 of file itkBSplineTransformParametersAdaptor.h.

Constructor & Destructor Documentation

◆ BSplineTransformParametersAdaptor()

template<typename TTransform >
itk::BSplineTransformParametersAdaptor< TTransform >::BSplineTransformParametersAdaptor ( )
protected

◆ ~BSplineTransformParametersAdaptor()

template<typename TTransform >
itk::BSplineTransformParametersAdaptor< TTransform >::~BSplineTransformParametersAdaptor ( )
overrideprotecteddefault

Member Function Documentation

◆ AdaptTransformParameters()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::AdaptTransformParameters ( )
overridevirtual

◆ CreateAnother()

template<typename TTransform >
virtual::itk::LightObject::Pointer itk::BSplineTransformParametersAdaptor< TTransform >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetNameOfClass()

template<typename TTransform >
virtual const char* itk::BSplineTransformParametersAdaptor< TTransform >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::TransformParametersAdaptor< TTransform >.

◆ GetRequiredTransformDomainDirection()

template<typename TTransform >
virtual const DirectionType& itk::BSplineTransformParametersAdaptor< TTransform >::GetRequiredTransformDomainDirection ( ) const
virtual

Get the required direction.

◆ GetRequiredTransformDomainMeshSize()

template<typename TTransform >
virtual const MeshSizeType& itk::BSplineTransformParametersAdaptor< TTransform >::GetRequiredTransformDomainMeshSize ( ) const
virtual

Get the required mesh size.

◆ GetRequiredTransformDomainOrigin()

template<typename TTransform >
virtual const OriginType& itk::BSplineTransformParametersAdaptor< TTransform >::GetRequiredTransformDomainOrigin ( ) const
virtual

Get the required origin.

◆ GetRequiredTransformDomainPhysicalDimensions()

template<typename TTransform >
virtual const PhysicalDimensionsType& itk::BSplineTransformParametersAdaptor< TTransform >::GetRequiredTransformDomainPhysicalDimensions ( ) const
virtual

Get the required physical dimensions.

◆ New()

template<typename TTransform >
static Pointer itk::BSplineTransformParametersAdaptor< TTransform >::New ( )
static

New macro for creation of through a Smart Pointer.

◆ PrintSelf()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::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.

◆ SetRequiredFixedParameters()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::SetRequiredFixedParameters ( const  FixedParametersType)
override

◆ SetRequiredTransformDomainDirection()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::SetRequiredTransformDomainDirection ( const DirectionType )

Alternative method for setting the required direction.

◆ SetRequiredTransformDomainMeshSize()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::SetRequiredTransformDomainMeshSize ( const MeshSizeType )

Alternative method for setting the required mesh size.

◆ SetRequiredTransformDomainOrigin()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::SetRequiredTransformDomainOrigin ( const OriginType )

Alternative method for setting the required origin.

◆ SetRequiredTransformDomainPhysicalDimensions()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::SetRequiredTransformDomainPhysicalDimensions ( const PhysicalDimensionsType )

Alternative method for setting the required mesh size.

◆ UpdateRequiredFixedParameters()

template<typename TTransform >
void itk::BSplineTransformParametersAdaptor< TTransform >::UpdateRequiredFixedParameters ( )
private

Helper function to set m_RequiredFixedParameters

Member Data Documentation

◆ m_RequiredTransformDomainDirection

template<typename TTransform >
DirectionType itk::BSplineTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainDirection
private

Definition at line 155 of file itkBSplineTransformParametersAdaptor.h.

◆ m_RequiredTransformDomainMeshSize

template<typename TTransform >
MeshSizeType itk::BSplineTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainMeshSize
private

Definition at line 153 of file itkBSplineTransformParametersAdaptor.h.

◆ m_RequiredTransformDomainOrigin

template<typename TTransform >
OriginType itk::BSplineTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainOrigin
private

Definition at line 154 of file itkBSplineTransformParametersAdaptor.h.

◆ m_RequiredTransformDomainPhysicalDimensions

template<typename TTransform >
PhysicalDimensionsType itk::BSplineTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainPhysicalDimensions
private

Definition at line 156 of file itkBSplineTransformParametersAdaptor.h.

◆ SpaceDimension

template<typename TTransform >
constexpr unsigned int itk::BSplineTransformParametersAdaptor< TTransform >::SpaceDimension = TransformType::SpaceDimension
staticconstexpr

Dimension of parameters.

Definition at line 104 of file itkBSplineTransformParametersAdaptor.h.


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