itk::TransformBase Class Reference

#include <itkTransformBase.h>

Inheritance diagram for itk::TransformBase:

Collaboration diagram for itk::TransformBase:

Detailed Description

This class is an abstract class to represent the transform

Definition at line 39 of file itkTransformBase.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef IdentifierType	NumberOfParametersType
typedef OptimizerParameters < ParametersValueType >	ParametersType
typedef double	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef TransformBase	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 const ParametersType &	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 ParametersType &)=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
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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
	TransformBase ()
virtual	~TransformBase ()
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
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 &)
	TransformBase (const Self &)

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)
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType
Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

typedef SmartPointer< const Self > itk::TransformBase::ConstPointer

Definition at line 46 of file itkTransformBase.h.

typedef IdentifierType itk::TransformBase::NumberOfParametersType

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

Definition at line 53 of file itkTransformBase.h.

typedef OptimizerParameters< ParametersValueType > itk::TransformBase::ParametersType

Definition at line 50 of file itkTransformBase.h.

typedef double itk::TransformBase::ParametersValueType

Type of the input parameters.

Definition at line 49 of file itkTransformBase.h.

typedef SmartPointer< Self > itk::TransformBase::Pointer

Definition at line 45 of file itkTransformBase.h.

typedef TransformBase itk::TransformBase::Self

Standard class typedefs.

Definition at line 43 of file itkTransformBase.h.

typedef Object itk::TransformBase::Superclass

Definition at line 44 of file itkTransformBase.h.

Member Enumeration Documentation

enum itk::TransformBase::TransformCategoryType

Enumerator:

UnknownTransformCategory
Linear
BSpline
Spline
DisplacementField
VelocityField

Definition at line 92 of file itkTransformBase.h.

Constructor & Destructor Documentation

itk::TransformBase::TransformBase ( )

inlineprotected

Definition at line 105 of file itkTransformBase.h.

virtual itk::TransformBase::~TransformBase ( )

inlineprotectedvirtual

Definition at line 106 of file itkTransformBase.h.

itk::TransformBase::TransformBase ( const Self &  )

private

Member Function Documentation

virtual const ParametersType& itk::TransformBase::GetFixedParameters ( ) const

pure virtual

Get the fixed parameters.

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

virtual unsigned int itk::TransformBase::GetInputSpaceDimension ( void  ) const

pure virtual

Get the size of the input space

Implemented in itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, and itk::Transform< TScalar, NDimensions, NDimensions >.

virtual const char* itk::TransformBase::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

virtual NumberOfParametersType itk::TransformBase::GetNumberOfParameters ( void  ) const

pure virtual

Return the number of parameters that completely define the Transfom

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

virtual unsigned int itk::TransformBase::GetOutputSpaceDimension ( void  ) const

pure virtual

Get the size of the output space

Implemented in itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, and itk::Transform< TScalar, NDimensions, NDimensions >.

virtual const ParametersType& itk::TransformBase::GetParameters ( void  ) const

pure virtual

Get the Transformation Parameters.

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

virtual TransformCategoryType itk::TransformBase::GetTransformCategory ( ) const

pure virtual

Get transform category

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

virtual std::string itk::TransformBase::GetTransformTypeAsString ( ) const

pure virtual

Generate a platform independent name

Implemented in itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, and itk::Transform< TScalar, NDimensions, NDimensions >.

void itk::TransformBase::operator= ( const Self &  )

private

virtual void itk::TransformBase::SetFixedParameters ( const ParametersType &  )

pure virtual

Set the fixed parameters.

Implemented in itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, itk::Transform< TScalar, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::DisplacementFieldTransform< TScalar, NDimensions >, itk::MultiTransform< TScalar, NDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, itk::ConstantVelocityFieldTransform< TScalar, NDimensions >, and itk::VelocityFieldTransform< TScalar, NDimensions >.

virtual void itk::TransformBase::SetParameters ( const ParametersType &  )

pure virtual

Set the transformation parameters and update internal transformation.

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

virtual void itk::TransformBase::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< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, and itk::Transform< TScalar, NDimensions, NDimensions >.

---

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

• itkTransformBase.h