#include <itkConstantVelocityFieldTransformParametersAdaptor.h>

Detailed Description

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

ConstantVelocityFieldTransformParametersAdaptor is a helper class intended to definition.

The fixed parameters store the following information: field size field origin field spacing field direction During multiresolution image registration it is often desired to also increase the displacement field 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 field size and decrease the spacing. This can be done as follows:

transformAdaptor->SetTransform( transform );
transformAdaptor->SetRequiredOrigin( displacementField->GetOrigin() );
transformAdaptor->SetRequiredDirection( displacementField->GetDirection() );
transformAdaptor->SetRequiredSize( requiredSize );
transformAdaptor->SetRequiredSpacing( requiredSpacing );
transformAdaptor->AdaptTransformParameters();

Author: Nick Tustison; Brian Avants

Definition at line 64 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

Inheritance diagram for itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >:

Collaboration diagram for itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >:

Public Types
using	ConstantVelocityFieldType = typename TransformType::ConstantVelocityFieldType

using	ConstPointer = SmartPointer< const Self >

using	DirectionType = typename ConstantVelocityFieldType::DirectionType

using	ParametersType = typename TransformType::ParametersType

using	ParametersValueType = typename TransformType::ParametersValueType

using	Pointer = SmartPointer< Self >

using	PointType = typename ConstantVelocityFieldType::PointType

using	Self = ConstantVelocityFieldTransformParametersAdaptor

using	SizeType = typename ConstantVelocityFieldType::SizeType

using	SpacingType = typename ConstantVelocityFieldType::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	Pointer = SmartPointer< Self >

using	Self = TransformParametersAdaptor

using	Superclass = TransformParametersAdaptorBase< Transform< typename TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >

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

const char *	GetNameOfClass () const override

virtual const DirectionType	GetRequiredDirection () const

virtual const PointType	GetRequiredOrigin () const

virtual const SizeType	GetRequiredSize () const

virtual const SpacingType	GetRequiredSpacing () const

void	SetRequiredDirection (const DirectionType &)

void	SetRequiredOrigin (const PointType &)

void	SetRequiredSize (const SizeType &)

void	SetRequiredSpacing (const SpacingType &)

Public Member Functions inherited from itk::TransformParametersAdaptor< TTransform >
void	AdaptTransformParameters () override

const char *	GetNameOfClass () const override

void	SetTransform (TransformBaseType _arg, void ) override

virtual void	SetTransform (TransformType *_arg)

void	SetRequiredFixedParameters (const FixedParametersType fixedParameters) override

Public Member Functions inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
virtual void	AdaptTransformParameters ()=0

const char *	GetNameOfClass () const override

virtual const FixedParametersType &	GetRequiredFixedParameters () const

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

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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () 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
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ConstantVelocityFieldDimension = TransformType::ConstantVelocityFieldDimension

Protected Member Functions
	ConstantVelocityFieldTransformParametersAdaptor ()

	~ConstantVelocityFieldTransformParametersAdaptor () override=default

Protected Member Functions inherited from itk::TransformParametersAdaptor< TTransform >
void	PrintSelf (std::ostream &os, Indent indent) const override

	TransformParametersAdaptor ()=default

	~TransformParametersAdaptor () override=default

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 ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

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 {}

Member Typedef Documentation

◆ ConstantVelocityFieldType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::ConstantVelocityFieldType = typename TransformType::ConstantVelocityFieldType

Definition at line 88 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ ConstPointer

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::ConstPointer = SmartPointer<const Self>

Definition at line 74 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ DirectionType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::DirectionType = typename ConstantVelocityFieldType::DirectionType

Definition at line 91 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ ParametersType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::ParametersType = typename TransformType::ParametersType

Definition at line 85 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ ParametersValueType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::ParametersValueType = typename TransformType::ParametersValueType

Definition at line 86 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ Pointer

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::Pointer = SmartPointer<Self>

Definition at line 73 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ PointType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::PointType = typename ConstantVelocityFieldType::PointType

Definition at line 89 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ Self

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::Self = ConstantVelocityFieldTransformParametersAdaptor

Standard class type aliases.

Definition at line 71 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ SizeType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::SizeType = typename ConstantVelocityFieldType::SizeType

Definition at line 90 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ SpacingType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::SpacingType = typename ConstantVelocityFieldType::SpacingType

Definition at line 92 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ Superclass

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::Superclass = TransformParametersAdaptor<TTransform>

Definition at line 72 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ TransformPointer

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::TransformPointer = typename TransformType::Pointer

Definition at line 84 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

◆ TransformType

template<typename TTransform >

using itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::TransformType = TTransform

Typedefs associated with the transform

Definition at line 83 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

Constructor & Destructor Documentation

◆ ConstantVelocityFieldTransformParametersAdaptor()

template<typename TTransform >

itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::ConstantVelocityFieldTransformParametersAdaptor ( )

protected

◆ ~ConstantVelocityFieldTransformParametersAdaptor()

template<typename TTransform >

itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::~ConstantVelocityFieldTransformParametersAdaptor ( )

overrideprotecteddefault

Member Function Documentation

◆ AdaptTransformParameters()

template<typename TTransform >

void itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::AdaptTransformParameters ( )

overridevirtual

Initialize the transform using the specified fixed parameters

Implements itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >.

Reimplemented in itk::GaussianExponentialDiffeomorphicTransformParametersAdaptor< TTransform >.

◆ GetNameOfClass()

template<typename TTransform >

const char * itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::GaussianExponentialDiffeomorphicTransformParametersAdaptor< TTransform >.

◆ GetRequiredDirection()

template<typename TTransform >

virtual const DirectionType itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredDirection ( ) const

virtual

Get the required direction.

◆ GetRequiredOrigin()

template<typename TTransform >

virtual const PointType itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredOrigin ( ) const

virtual

Get the required origin.

◆ GetRequiredSize()

template<typename TTransform >

virtual const SizeType itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredSize ( ) const

virtual

Get the required size.

◆ GetRequiredSpacing()

template<typename TTransform >

virtual const SpacingType itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredSpacing ( ) const

virtual

Get the required spacing.

◆ New()

template<typename TTransform >

static Pointer itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::New ( )

static

New macro for creation of through a Smart Pointer.

◆ SetRequiredDirection()

template<typename TTransform >

void itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredDirection ( const DirectionType & )

Alternative method for setting the required direction.

◆ SetRequiredOrigin()

template<typename TTransform >

void itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredOrigin ( const PointType & )

Alternative method for setting the required origin.

◆ SetRequiredSize()

template<typename TTransform >

void itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredSize ( const SizeType & )

Alternative method for setting the required size.

◆ SetRequiredSpacing()

template<typename TTransform >

void itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredSpacing ( const SpacingType & )

Alternative method for setting the required spacing.

Member Data Documentation

◆ ConstantVelocityFieldDimension

template<typename TTransform >

constexpr unsigned int itk::ConstantVelocityFieldTransformParametersAdaptor< TTransform >::ConstantVelocityFieldDimension = TransformType::ConstantVelocityFieldDimension

staticconstexpr

Dimension of parameters.

Definition at line 95 of file itkConstantVelocityFieldTransformParametersAdaptor.h.

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

itkConstantVelocityFieldTransformParametersAdaptor.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstantVelocityFieldType

◆ ConstPointer

◆ DirectionType

◆ ParametersType

◆ ParametersValueType

◆ Pointer

◆ PointType

◆ Self

◆ SizeType

◆ SpacingType

◆ Superclass

◆ TransformPointer

◆ TransformType

Constructor & Destructor Documentation

◆ ConstantVelocityFieldTransformParametersAdaptor()

◆ ~ConstantVelocityFieldTransformParametersAdaptor()

Member Function Documentation

◆ AdaptTransformParameters()

◆ GetNameOfClass()

◆ GetRequiredDirection()

◆ GetRequiredOrigin()

◆ GetRequiredSize()

◆ GetRequiredSpacing()

◆ New()

◆ SetRequiredDirection()

◆ SetRequiredOrigin()

◆ SetRequiredSize()

◆ SetRequiredSpacing()

Member Data Documentation

◆ ConstantVelocityFieldDimension