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

#include <itkDisplacementFieldTransformParametersAdaptor.h>

Detailed Description

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

DisplacementFieldTransformParametersAdaptor 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 itkDisplacementFieldTransformParametersAdaptor.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename DisplacementFieldType::DirectionType
 
using DisplacementFieldType = typename TransformType::DisplacementFieldType
 
using FixedParametersType = typename TransformType::FixedParametersType
 
using FixedParametersValueType = typename TransformType::FixedParametersValueType
 
using ParametersType = typename TransformType::ParametersType
 
using ParametersValueType = typename TransformType::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename DisplacementFieldType::PointType
 
using Self = DisplacementFieldTransformParametersAdaptor
 
using SizeType = typename DisplacementFieldType::SizeType
 
using SpacingType = typename DisplacementFieldType::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
 
virtual const DirectionType GetRequiredDirection () const
 
virtual const PointType GetRequiredOrigin () const
 
virtual const SizeType GetRequiredSize () const
 
virtual const SpacingType GetRequiredSpacing () const
 
 itkOverrideGetNameOfClassMacro (DisplacementFieldTransformParametersAdaptor)
 
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
 
 itkOverrideGetNameOfClassMacro (TransformParametersAdaptor)
 
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 const FixedParametersTypeGetRequiredFixedParameters () const
 
 itkOverrideGetNameOfClassMacro (TransformParametersAdaptorBase)
 
- 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::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 SpaceDimension = TransformType::Dimension
 

Protected Member Functions

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

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::DisplacementFieldTransformParametersAdaptor< TTransform >::ConstPointer = SmartPointer<const Self>

◆ DirectionType

template<typename TTransform >
using itk::DisplacementFieldTransformParametersAdaptor< TTransform >::DirectionType = typename DisplacementFieldType::DirectionType

◆ DisplacementFieldType

template<typename TTransform >
using itk::DisplacementFieldTransformParametersAdaptor< TTransform >::DisplacementFieldType = typename TransformType::DisplacementFieldType

◆ FixedParametersType

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

◆ FixedParametersValueType

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

◆ ParametersType

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

◆ ParametersValueType

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

◆ Pointer

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

◆ PointType

template<typename TTransform >
using itk::DisplacementFieldTransformParametersAdaptor< TTransform >::PointType = typename DisplacementFieldType::PointType

◆ Self

Standard class type aliases.

Definition at line 70 of file itkDisplacementFieldTransformParametersAdaptor.h.

◆ SizeType

template<typename TTransform >
using itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SizeType = typename DisplacementFieldType::SizeType

◆ SpacingType

template<typename TTransform >
using itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SpacingType = typename DisplacementFieldType::SpacingType

◆ Superclass

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

◆ TransformPointer

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

◆ TransformType

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

Typedefs associated with the transform

Definition at line 82 of file itkDisplacementFieldTransformParametersAdaptor.h.

Constructor & Destructor Documentation

◆ DisplacementFieldTransformParametersAdaptor()

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

◆ ~DisplacementFieldTransformParametersAdaptor()

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

Member Function Documentation

◆ AdaptTransformParameters()

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

◆ GetRequiredDirection()

template<typename TTransform >
virtual const DirectionType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::GetRequiredDirection ( ) const
virtual

Get the required direction.

◆ GetRequiredOrigin()

template<typename TTransform >
virtual const PointType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::GetRequiredOrigin ( ) const
virtual

Get the required origin.

◆ GetRequiredSize()

template<typename TTransform >
virtual const SizeType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::GetRequiredSize ( ) const
virtual

Get the required size.

◆ GetRequiredSpacing()

template<typename TTransform >
virtual const SpacingType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::GetRequiredSpacing ( ) const
virtual

Get the required spacing.

◆ itkOverrideGetNameOfClassMacro()

template<typename TTransform >
itk::DisplacementFieldTransformParametersAdaptor< TTransform >::itkOverrideGetNameOfClassMacro ( DisplacementFieldTransformParametersAdaptor< TTransform >  )

Run-time type information (and related methods).

◆ New()

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

New macro for creation of through a Smart Pointer.

◆ SetRequiredDirection()

template<typename TTransform >
void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SetRequiredDirection ( const DirectionType )

Alternative method for setting the required direction.

◆ SetRequiredOrigin()

template<typename TTransform >
void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SetRequiredOrigin ( const PointType )

Alternative method for setting the required origin.

◆ SetRequiredSize()

template<typename TTransform >
void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SetRequiredSize ( const SizeType )

Alternative method for setting the required size.

◆ SetRequiredSpacing()

template<typename TTransform >
void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SetRequiredSpacing ( const SpacingType )

Alternative method for setting the required spacing.

Member Data Documentation

◆ SpaceDimension

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

Dimension of parameters.

Definition at line 96 of file itkDisplacementFieldTransformParametersAdaptor.h.


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