ITK  5.4.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::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform > Class Template Reference

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

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 DirectionTypeGetRequiredTransformDomainDirection () const
 
virtual const MeshSizeTypeGetRequiredTransformDomainMeshSize () const
 
virtual const OriginTypeGetRequiredTransformDomainOrigin () const
 
virtual const SizeTypeGetRequiredTransformDomainSize () const
 
virtual const SpacingTypeGetRequiredTransformDomainSpacing () 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 > >
const char * GetNameOfClass () const override
 
virtual const FixedParametersTypeGetRequiredFixedParameters () const
 
- 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
 
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
 
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 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
 
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 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 {}
 

Member Typedef Documentation

◆ ConstPointer

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

◆ DirectionType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::DirectionType = typename TimeVaryingVelocityFieldControlPointLatticeType::DirectionType

◆ FixedParametersType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::FixedParametersType = typename TransformType::FixedParametersType

◆ FixedParametersValueType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::FixedParametersValueType = typename TransformType::FixedParametersValueType

◆ IndexType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::IndexType = typename TimeVaryingVelocityFieldControlPointLatticeType::IndexType

◆ MeshSizeType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::MeshSizeType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType

◆ OriginType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::OriginType = typename TimeVaryingVelocityFieldControlPointLatticeType::PointType

◆ ParametersType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::ParametersType = typename TransformType::ParametersType

◆ ParametersValueType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::ParametersValueType = typename TransformType::ParametersValueType

◆ Pointer

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

◆ RegionType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::RegionType = typename TimeVaryingVelocityFieldControlPointLatticeType::RegionType

◆ Self

Standard class type aliases.

Definition at line 73 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

◆ SizeType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SizeType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeType

◆ SizeValueType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SizeValueType = typename TimeVaryingVelocityFieldControlPointLatticeType::SizeValueType

◆ SpacingType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SpacingType = typename TimeVaryingVelocityFieldControlPointLatticeType::SpacingType

◆ Superclass

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

◆ TimeVaryingVelocityFieldControlPointLatticePointer

◆ TimeVaryingVelocityFieldControlPointLatticeType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::TimeVaryingVelocityFieldControlPointLatticeType = typename TransformType::TimeVaryingVelocityFieldControlPointLatticeType

◆ TransformPointer

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

◆ TransformType

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

Typedefs associated with the transform

Definition at line 85 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

◆ VectorType

template<typename TTransform >
using itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::VectorType = typename TimeVaryingVelocityFieldControlPointLatticeType::PixelType

Constructor & Destructor Documentation

◆ TimeVaryingBSplineVelocityFieldTransformParametersAdaptor()

◆ ~TimeVaryingBSplineVelocityFieldTransformParametersAdaptor()

Member Function Documentation

◆ AdaptTransformParameters()

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

◆ GetNameOfClass()

template<typename TTransform >
const char* itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetRequiredControlPointLatticeDirection()

template<typename TTransform >
const DirectionType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredControlPointLatticeDirection ( ) const
inline

Get the required control point lattice direction.

Definition at line 195 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

◆ GetRequiredControlPointLatticeOrigin()

template<typename TTransform >
const OriginType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredControlPointLatticeOrigin ( ) const
inline

Get the required control point lattice origin.

Definition at line 152 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

◆ GetRequiredControlPointLatticeSize()

template<typename TTransform >
const SizeType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredControlPointLatticeSize ( ) const
inline

Get the required control point lattice size.

Definition at line 182 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

◆ GetRequiredControlPointLatticeSpacing()

template<typename TTransform >
const SpacingType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredControlPointLatticeSpacing ( ) const
inline

Get the required control point lattice spacing.

Definition at line 165 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.

◆ GetRequiredTransformDomainDirection()

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

Get the required direction.

◆ GetRequiredTransformDomainMeshSize()

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

Get the required mesh size.

◆ GetRequiredTransformDomainOrigin()

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

Get the required origin.

◆ GetRequiredTransformDomainSize()

template<typename TTransform >
virtual const SizeType& itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredTransformDomainSize ( ) const
virtual

Get the required domain size.

◆ GetRequiredTransformDomainSpacing()

template<typename TTransform >
virtual const SpacingType& itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetRequiredTransformDomainSpacing ( ) const
virtual

Get the required domain spacing.

◆ GetSplineOrder()

template<typename TTransform >
virtual SizeValueType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::GetSplineOrder ( ) const
virtual

Get spline order (usually from transform)

◆ New()

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

New macro for creation of through a Smart Pointer.

◆ PrintSelf()

template<typename TTransform >
void itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< 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::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredFixedParameters ( const  FixedParametersType)
override

◆ SetRequiredTransformDomainDirection()

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

Alternative method for setting the required direction.

◆ SetRequiredTransformDomainMeshSize()

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

Alternative method for setting the required mesh size.

◆ SetRequiredTransformDomainOrigin()

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

Alternative method for setting the required origin.

◆ SetRequiredTransformDomainSize()

template<typename TTransform >
void itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredTransformDomainSize ( const SizeType )

Alternative method for setting the required sampled size.

◆ SetRequiredTransformDomainSpacing()

template<typename TTransform >
void itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SetRequiredTransformDomainSpacing ( const SpacingType )

Alternative method for setting the required sampled spacing.

◆ SetSplineOrder()

template<typename TTransform >
virtual void itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::SetSplineOrder ( SizeValueType  _arg)
virtual

Set spline order (usually from transform)

◆ UpdateRequiredFixedParameters()

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

Helper function to set m_RequiredFixedParameters

Member Data Documentation

◆ m_RequiredTransformDomainDirection

template<typename TTransform >
DirectionType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainDirection {}
private

◆ m_RequiredTransformDomainMeshSize

template<typename TTransform >
MeshSizeType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainMeshSize {}
private

◆ m_RequiredTransformDomainOrigin

template<typename TTransform >
OriginType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainOrigin {}
private

◆ m_RequiredTransformDomainSize

template<typename TTransform >
SizeType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainSize {}
private

◆ m_RequiredTransformDomainSpacing

template<typename TTransform >
SpacingType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::m_RequiredTransformDomainSpacing {}
private

◆ m_SplineOrder

template<typename TTransform >
SizeValueType itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::m_SplineOrder {}
private

◆ TotalDimension

template<typename TTransform >
constexpr unsigned int itk::TimeVaryingBSplineVelocityFieldTransformParametersAdaptor< TTransform >::TotalDimension = TransformType::Dimension + 1
staticconstexpr

Dimension of parameters.

Definition at line 107 of file itkTimeVaryingBSplineVelocityFieldTransformParametersAdaptor.h.


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