#include <itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h>

Detailed Description

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

TimeVaryingBSplineVelocityFieldTransformParametersAdaptor is a helper class intended to definition.

The fixed parameters store the following information:

B-spline mesh size
field origin
domain spacing
domain size (note that domain_spacing * (domain_size - 1) = physical dimensions of transform domain)
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->SetRequiredTransformDomainOrigin( displacementField->GetOrigin() );
transformAdaptor->SetRequiredTransformDomainDirection( displacementField->GetDirection() );
transformAdaptor->SetRequiredTransformDomainSize( requiredSize );
transformAdaptor->SetRequiredTransformDomainSpacing( requiredSpacing );
transformAdaptor->SetRequiredTransformDomainMeshSize( requiredMeshSize );
transformAdaptor->SetSplineOrder( transform->GetSplineOrder() );
transformAdaptor->AdaptTransformParameters();

Author: Nick Tustison; Brian Avants

Definition at line 66 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

Inheritance diagram for itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >:

Collaboration diagram for itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DirectionType = typename TimeVaryingVelocityFieldControlPointLatticeType::DirectionType

using	FixedParametersType = typename TransformType::FixedParametersType

using	FixedParametersValueType = typename TransformType::FixedParametersValueType

using	IndexType = typename TimeVaryingVelocityFieldControlPointLatticeType::IndexType

using	MeshSizeType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType

using	OriginType = typename TimeVaryingVelocityFieldControlPointLatticeType::PointType

using	ParametersType = typename TransformType::ParametersType

using	ParametersValueType = typename TransformType::ParametersValueType

using	Pointer = SmartPointer< Self >

using	RegionType = typename TimeVaryingVelocityFieldControlPointLatticeType::RegionType

using	Self = TimeVaryingBSplineVelocityFieldTransformParametersAdaptor

using	SizeType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType

using	SizeValueType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeValueType

using	SpacingType = typename TimeVaryingVelocityFieldControlPointLatticeType::SpacingType

using	Superclass = TransformParametersAdaptor< TTransform >

using	TimeVaryingVelocityFieldControlPointLatticePointer = typename TimeVaryingVelocityFieldControlPointLatticeType::Pointer

using	TimeVaryingVelocityFieldControlPointLatticeType = typename TransformType::TimeVaryingVelocityFieldControlPointLatticeType

using	TransformPointer = typename TransformType::Pointer

using	TransformType = TTransform

using	VectorType = typename TimeVaryingVelocityFieldControlPointLatticeType::PixelType

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

const DirectionType	GetRequiredControlPointLatticeDirection () const

virtual const DirectionType &	GetRequiredTransformDomainDirection () const

virtual const MeshSizeType &	GetRequiredTransformDomainMeshSize () const

virtual const OriginType &	GetRequiredTransformDomainOrigin () const

virtual const SizeType &	GetRequiredTransformDomainSize () const

virtual const SpacingType &	GetRequiredTransformDomainSpacing () const

virtual SizeValueType	GetSplineOrder () const

void	SetRequiredFixedParameters (const FixedParametersType) override

void	SetRequiredTransformDomainDirection (const DirectionType &)

void	SetRequiredTransformDomainMeshSize (const MeshSizeType &)

void	SetRequiredTransformDomainOrigin (const OriginType &)

void	SetRequiredTransformDomainSize (const SizeType &)

void	SetRequiredTransformDomainSpacing (const SpacingType &)

virtual void	SetSplineOrder (SizeValueType _arg)


const OriginType	GetRequiredControlPointLatticeOrigin () const


const SpacingType	GetRequiredControlPointLatticeSpacing () const


const SizeType	GetRequiredControlPointLatticeSize () const

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 *cmd) 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) const

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	TotalDimension = TransformType::Dimension + 1

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

	TimeVaryingBSplineVelocityFieldTransformParametersAdaptor ()

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

Private Member Functions
void	UpdateRequiredFixedParameters ()

Private Attributes
DirectionType	m_RequiredTransformDomainDirection {}

MeshSizeType	m_RequiredTransformDomainMeshSize {}

OriginType	m_RequiredTransformDomainOrigin {}

SizeType	m_RequiredTransformDomainSize {}

SpacingType	m_RequiredTransformDomainSpacing {}

SizeValueType	m_SplineOrder {}

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