itk::TransformBaseTemplate< TParametersValueType > Class Template Reference

#include <itkTransformBase.h>

Inheritance diagram for itk::TransformBaseTemplate< TParametersValueType >:

Collaboration diagram for itk::TransformBaseTemplate< TParametersValueType >:

Detailed Description

template<typename TParametersValueType>
class itk::TransformBaseTemplate< TParametersValueType >

Definition at line 45 of file itkTransformBase.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef OptimizerParameters < FixedParametersValueType >	FixedParametersType
typedef double	FixedParametersValueType
typedef IdentifierType	NumberOfParametersType
typedef OptimizerParameters < ParametersValueType >	ParametersType
typedef TParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef TransformBaseTemplate	Self
typedef Object	Superclass
enum	TransformCategoryType {   UnknownTransformCategory =0,   Linear =1,   BSpline =2,   Spline =3,   DisplacementField =4,   VelocityField =5 }
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual void	CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end)=0
virtual void	CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end)=0
virtual const FixedParametersType &	GetFixedParameters () const =0
virtual unsigned int	GetInputSpaceDimension (void) const =0
virtual const char *	GetNameOfClass () const
virtual NumberOfParametersType	GetNumberOfParameters (void) const =0
virtual unsigned int	GetOutputSpaceDimension (void) const =0
virtual const ParametersType &	GetParameters (void) const =0
virtual TransformCategoryType	GetTransformCategory () const =0
virtual std::string	GetTransformTypeAsString () const =0
virtual void	SetFixedParameters (const FixedParametersType &)=0
virtual void	SetParameters (const ParametersType &)=0
virtual void	SetParametersByValue (const ParametersType &p)=0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual 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
virtual const TimeStamp &	GetTimeStamp () 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

Protected Member Functions
	TransformBaseTemplate ()
virtual	~TransformBaseTemplate ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
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
void	operator= (const Self &) ITK_DELETE_FUNCTION
	TransformBaseTemplate (const Self &) ITK_DELETE_FUNCTION

Additional Inherited Members
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 ()
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TParametersValueType>

typedef SmartPointer<const Self> itk::TransformBaseTemplate< TParametersValueType >::ConstPointer

Definition at line 52 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef OptimizerParameters<FixedParametersValueType> itk::TransformBaseTemplate< TParametersValueType >::FixedParametersType

Definition at line 59 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef double itk::TransformBaseTemplate< TParametersValueType >::FixedParametersValueType

Definition at line 58 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef IdentifierType itk::TransformBaseTemplate< TParametersValueType >::NumberOfParametersType

The number of parameters can potentially be very large, therefore we use here a large capacity integer.

Definition at line 75 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef OptimizerParameters<ParametersValueType> itk::TransformBaseTemplate< TParametersValueType >::ParametersType

Definition at line 57 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef TParametersValueType itk::TransformBaseTemplate< TParametersValueType >::ParametersValueType

Type of the input parameters.

Definition at line 56 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef SmartPointer<Self> itk::TransformBaseTemplate< TParametersValueType >::Pointer

Definition at line 51 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef TransformBaseTemplate itk::TransformBaseTemplate< TParametersValueType >::Self

Standard class typedefs.

Definition at line 49 of file itkTransformBase.h.

template<typename TParametersValueType>

typedef Object itk::TransformBaseTemplate< TParametersValueType >::Superclass

Definition at line 50 of file itkTransformBase.h.

Member Enumeration Documentation

template<typename TParametersValueType>

enum itk::TransformBaseTemplate::TransformCategoryType

Enumerator
UnknownTransformCategory
Linear
BSpline
Spline
DisplacementField
VelocityField

Definition at line 128 of file itkTransformBase.h.

Constructor & Destructor Documentation

template<typename TParametersValueType>

itk::TransformBaseTemplate< TParametersValueType >::TransformBaseTemplate ( )

inlineprotected

Definition at line 141 of file itkTransformBase.h.

template<typename TParametersValueType>

virtual itk::TransformBaseTemplate< TParametersValueType >::~TransformBaseTemplate ( )

inlineprotectedvirtual

Definition at line 142 of file itkTransformBase.h.

template<typename TParametersValueType>

itk::TransformBaseTemplate< TParametersValueType >::TransformBaseTemplate ( const Self &  )

private

Member Function Documentation

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::CopyInFixedParameters ( const FixedParametersValueType *const  begin, const FixedParametersValueType *const  end  )

pure virtual

This function allow copying a range of values into the FixedParameters The range of values must conform to std::copy(begin, end, m_FixedParameters) requirements.

Implemented in itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::CopyInParameters ( const ParametersValueType *const  begin, const ParametersValueType *const  end  )

pure virtual

This function allow copying a range of values into the Parameters The range of values must conform to std::copy(begin, end, m_Parameters) requirements.

Implemented in itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

template<typename TParametersValueType>

virtual const FixedParametersType& itk::TransformBaseTemplate< TParametersValueType >::GetFixedParameters ( ) const

pure virtual

Get the fixed parameters.

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >, itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >, itk::CompositeTransform< TParametersValueType, NDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::IdentityTransform< TParametersValueType, NDimensions >, itk::TranslationTransform< TParametersValueType, NDimensions >, itk::KernelTransform< TParametersValueType, NDimensions >, itk::BSplineBaseTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::CenteredSimilarity2DTransform< TParametersValueType >, and itk::CenteredRigid2DTransform< TParametersValueType >.

template<typename TParametersValueType>

virtual unsigned int itk::TransformBaseTemplate< TParametersValueType >::GetInputSpaceDimension ( void  ) const

pure virtual

Get the size of the input space

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

template<typename TParametersValueType>

virtual const char* itk::TransformBaseTemplate< TParametersValueType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::BSplineDeformableTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::BSplineTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::AffineTransform< TParametersValueType, NDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >, itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >, itk::AzimuthElevationToCartesianTransform< TParametersValueType, NDimensions >, itk::CompositeTransform< TParametersValueType, NDimensions >, itk::DisplacementFieldTransform< TParametersValueType, NDimensions >, itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, NDimensions >, itk::Similarity2DTransform< TParametersValueType >, itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::KernelTransform< TParametersValueType, NDimensions >, itk::Rigid3DTransform< TParametersValueType >, itkv3::Rigid3DTransform< TParametersValueType >, itk::CenteredSimilarity2DTransform< TParametersValueType >, itk::ScaleSkewVersor3DTransform< TParametersValueType >, itk::Rigid2DTransform< TParametersValueType >, itk::BSplineExponentialDiffeomorphicTransform< TParametersValueType, NDimensions >, itk::GaussianExponentialDiffeomorphicTransform< TParametersValueType, NDimensions >, itk::CenteredRigid2DTransform< TParametersValueType >, itk::TimeVaryingVelocityFieldTransform< TParametersValueType, NDimensions >, itk::IdentityTransform< TParametersValueType, NDimensions >, itk::Rigid3DPerspectiveTransform< TParametersValueType >, itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, NDimensions >, itk::QuaternionRigidTransform< TParametersValueType >, itk::ScaleVersor3DTransform< TParametersValueType >, itk::Euler3DTransform< TParametersValueType >, itk::Similarity3DTransform< TParametersValueType >, itk::VersorRigid3DTransform< TParametersValueType >, itk::TranslationTransform< TParametersValueType, NDimensions >, itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, NDimensions >, itk::ScaleTransform< TParametersValueType, NDimensions >, itk::VersorTransform< TParametersValueType >, itk::Euler2DTransform< TParametersValueType >, itk::ElasticBodySplineKernelTransform< TParametersValueType, NDimensions >, itk::ElasticBodyReciprocalSplineKernelTransform< TParametersValueType, NDimensions >, itk::ThinPlateR2LogRSplineKernelTransform< TParametersValueType, NDimensions >, itk::CenteredEuler3DTransform< TParametersValueType >, itk::GaussianSmoothingOnUpdateTimeVaryingVelocityFieldTransform< TParametersValueType, NDimensions >, itk::ScaleLogarithmicTransform< TParametersValueType, NDimensions >, itk::ThinPlateSplineKernelTransform< TParametersValueType, NDimensions >, itk::VolumeSplineKernelTransform< TParametersValueType, NDimensions >, itk::FixedCenterOfRotationAffineTransform< TParametersValueType, NDimensions >, itk::ConstantVelocityFieldTransform< TParametersValueType, NDimensions >, itk::BSplineBaseTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::CenteredAffineTransform< TParametersValueType, NDimensions >, itk::ScalableAffineTransform< TParametersValueType, NDimensions >, and itk::VelocityFieldTransform< TParametersValueType, NDimensions >.

template<typename TParametersValueType>

virtual NumberOfParametersType itk::TransformBaseTemplate< TParametersValueType >::GetNumberOfParameters ( void  ) const

pure virtual

Return the number of parameters that completely define the Transfom

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::CompositeTransform< TParametersValueType, NDimensions >, itk::BSplineBaseTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::BSplineDeformableTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::BSplineTransform< TParametersValueType, NDimensions, VSplineOrder >, and itk::TranslationTransform< TParametersValueType, NDimensions >.

template<typename TParametersValueType>

virtual unsigned int itk::TransformBaseTemplate< TParametersValueType >::GetOutputSpaceDimension ( void  ) const

pure virtual

Get the size of the output space

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

template<typename TParametersValueType>

virtual const ParametersType& itk::TransformBaseTemplate< TParametersValueType >::GetParameters ( void  ) const

pure virtual

Get the Transformation Parameters.

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >, itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >, itk::CompositeTransform< TParametersValueType, NDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::IdentityTransform< TParametersValueType, NDimensions >, itk::Rigid2DTransform< TParametersValueType >, itk::KernelTransform< TParametersValueType, NDimensions >, itk::BSplineBaseTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::Similarity2DTransform< TParametersValueType >, itk::CenteredSimilarity2DTransform< TParametersValueType >, itk::Rigid3DPerspectiveTransform< TParametersValueType >, itk::CenteredRigid2DTransform< TParametersValueType >, itk::ScaleSkewVersor3DTransform< TParametersValueType >, itk::QuaternionRigidTransform< TParametersValueType >, itk::Similarity3DTransform< TParametersValueType >, itk::TranslationTransform< TParametersValueType, NDimensions >, itk::ScaleVersor3DTransform< TParametersValueType >, itk::ScaleTransform< TParametersValueType, NDimensions >, itk::VersorTransform< TParametersValueType >, itk::VersorRigid3DTransform< TParametersValueType >, itk::CenteredEuler3DTransform< TParametersValueType >, itk::ScaleLogarithmicTransform< TParametersValueType, NDimensions >, itk::Euler3DTransform< TParametersValueType >, and itk::CenteredAffineTransform< TParametersValueType, NDimensions >.

template<typename TParametersValueType>

virtual TransformCategoryType itk::TransformBaseTemplate< TParametersValueType >::GetTransformCategory ( ) const

pure virtual

Get transform category

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::DisplacementFieldTransform< TParametersValueType, NDimensions >, itk::CompositeTransform< TParametersValueType, NDimensions >, itk::BSplineBaseTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >, itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >, itk::IdentityTransform< TParametersValueType, NDimensions >, itk::KernelTransform< TParametersValueType, NDimensions >, and itk::TranslationTransform< TParametersValueType, NDimensions >.

template<typename TParametersValueType>

virtual std::string itk::TransformBaseTemplate< TParametersValueType >::GetTransformTypeAsString ( ) const

pure virtual

Generate a platform independent name

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

template<typename TParametersValueType>

void itk::TransformBaseTemplate< TParametersValueType >::operator= ( const Self &  )

private

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetFixedParameters ( const FixedParametersType &  )

pure virtual

Set the fixed parameters.

Implemented in itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::DisplacementFieldTransform< TParametersValueType, NDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::TranslationTransform< TParametersValueType, NDimensions >, itk::ConstantVelocityFieldTransform< TParametersValueType, NDimensions >, and itk::VelocityFieldTransform< TParametersValueType, NDimensions >.

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetParameters ( const ParametersType &  )

pure virtual

Set the transformation parameters and update internal transformation.

Implemented in itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >, itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, itk::Transform< TParametersValueType, NDimensions, NSubDimensions >, itk::DisplacementFieldTransform< TParametersValueType, NDimensions >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, and itk::TranslationTransform< TParametersValueType, NDimensions >.

template<typename TParametersValueType>

virtual void itk::TransformBaseTemplate< TParametersValueType >::SetParametersByValue ( const ParametersType &  p )

pure virtual

Set the transformation by copying parameters and update internal transformation. This method forces the transform to copy the parameters. The default implementation is to call SetParameters. This call must be overridden if the transform normally implements SetParameters by keeping a reference to the parameters.

See Also

SetParameters

Implemented in itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::Transform< TParametersValueType, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.

---

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

• itkTransformBase.h