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

#include <itkDisplacementFieldTransformParametersAdaptor.h>

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

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.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
DisplacementFieldType::DirectionType 
DirectionType
 
typedef
TransformType::DisplacementFieldType 
DisplacementFieldType
 
typedef
TransformType::FixedParametersType 
FixedParametersType
 
typedef
TransformType::FixedParametersValueType 
FixedParametersValueType
 
typedef
TransformType::ParametersType 
ParametersType
 
typedef
TransformType::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef
DisplacementFieldType::PointType 
PointType
 
typedef
DisplacementFieldTransformParametersAdaptor 
Self
 
typedef
DisplacementFieldType::SizeType 
SizeType
 
typedef
DisplacementFieldType::SpacingType 
SpacingType
 
typedef
TransformParametersAdaptor
< TTransform > 
Superclass
 
typedef TransformType::Pointer TransformPointer
 
typedef TTransform TransformType
 
- Public Types inherited from itk::TransformParametersAdaptor< TTransform >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::FixedParametersType 
FixedParametersType
 
typedef
Superclass::FixedParametersValueType 
FixedParametersValueType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef TransformParametersAdaptor Self
 
typedef
TransformParametersAdaptorBase
< Transform< typename
TTransform::ScalarType,
TTransform::InputSpaceDimension,
TTransform::OutputSpaceDimension > > 
Superclass
 
typedef
Superclass::TransformBaseType 
TransformBaseType
 
typedef TransformType::Pointer TransformPointer
 
typedef TTransform TransformType
 
- Public Types inherited from itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >
typedef SmartPointer< const SelfConstPointer
 
typedef
TransformBaseType::FixedParametersType 
FixedParametersType
 
typedef
TransformBaseType::FixedParametersValueType 
FixedParametersValueType
 
typedef
TransformBaseType::ParametersType 
ParametersType
 
typedef ParametersType::ValueType ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef
TransformParametersAdaptorBase 
Self
 
typedef Object Superclass
 
typedef TransformBaseType::Pointer TransformBasePointer
 
typedef Transform
< TTransform::ScalarType,
TTransform::InputSpaceDimension,
TTransform::OutputSpaceDimension > 
TransformBaseType
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void AdaptTransformParameters () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
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 >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const FixedParametersTypeGetRequiredFixedParameters () const override
 
virtual void SetTransform (TransformType *_arg)
 
virtual void SetTransform (TransformBaseType *_arg, void *) override
 
virtual void SetRequiredFixedParameters (const FixedParametersType fixedParameters) 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int SpaceDimension = TransformType::Dimension
 

Protected Member Functions

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

 DisplacementFieldTransformParametersAdaptor (const Self &)
 
void operator= (const Self &)
 

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
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TTransform >
typedef SmartPointer<const Self> itk::DisplacementFieldTransformParametersAdaptor< TTransform >::ConstPointer
template<typename TTransform >
typedef DisplacementFieldType::DirectionType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::DirectionType
template<typename TTransform >
typedef TransformType::DisplacementFieldType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::DisplacementFieldType
template<typename TTransform >
typedef TransformType::FixedParametersType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::FixedParametersType
template<typename TTransform >
typedef TransformType::FixedParametersValueType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::FixedParametersValueType
template<typename TTransform >
typedef TransformType::ParametersType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::ParametersType
template<typename TTransform >
typedef TransformType::ParametersValueType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::ParametersValueType
template<typename TTransform >
typedef SmartPointer<Self> itk::DisplacementFieldTransformParametersAdaptor< TTransform >::Pointer
template<typename TTransform >
typedef DisplacementFieldType::PointType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::PointType

Standard class typedefs.

Definition at line 70 of file itkDisplacementFieldTransformParametersAdaptor.h.

template<typename TTransform >
typedef DisplacementFieldType::SizeType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SizeType
template<typename TTransform >
typedef DisplacementFieldType::SpacingType itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SpacingType
template<typename TTransform >
typedef TransformParametersAdaptor<TTransform> itk::DisplacementFieldTransformParametersAdaptor< TTransform >::Superclass
template<typename TTransform >
typedef TransformType::Pointer itk::DisplacementFieldTransformParametersAdaptor< TTransform >::TransformPointer
template<typename TTransform >
typedef TTransform itk::DisplacementFieldTransformParametersAdaptor< TTransform >::TransformType

Typedefs associated with the transform

Definition at line 79 of file itkDisplacementFieldTransformParametersAdaptor.h.

Constructor & Destructor Documentation

template<typename TTransform >
itk::DisplacementFieldTransformParametersAdaptor< TTransform >::DisplacementFieldTransformParametersAdaptor ( )
protected
template<typename TTransform >
itk::DisplacementFieldTransformParametersAdaptor< TTransform >::~DisplacementFieldTransformParametersAdaptor ( )
protected
template<typename TTransform >
itk::DisplacementFieldTransformParametersAdaptor< TTransform >::DisplacementFieldTransformParametersAdaptor ( const Self )
private

Member Function Documentation

template<typename TTransform >
virtual void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::AdaptTransformParameters ( )
overridevirtual
template<typename TTransform >
virtual::itk::LightObject::Pointer itk::DisplacementFieldTransformParametersAdaptor< 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.

Reimplemented in itk::GaussianSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor< TTransform >.

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

Get the required direction.

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

Get the required origin.

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

Get the required size.

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

Get the required spacing.

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

New macro for creation of through a Smart Pointer.

template<typename TTransform >
void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::operator= ( const Self )
private
template<typename TTransform >
void itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SetRequiredDirection ( const DirectionType )

Alternative method for setting the required direction.

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

Alternative method for setting the required origin.

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

Alternative method for setting the required size.

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

Alternative method for setting the required spacing.

Member Data Documentation

template<typename TTransform >
const unsigned int itk::DisplacementFieldTransformParametersAdaptor< TTransform >::SpaceDimension = TransformType::Dimension
static

Dimension of parameters.

Definition at line 96 of file itkDisplacementFieldTransformParametersAdaptor.h.


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