ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::TransformBaseTemplate< TParametersValueType > Class Template Referenceabstract

#include <itkTransformBase.h>

+ Inheritance diagram for itk::TransformBaseTemplate< TParametersValueType >:
+ Collaboration diagram for itk::TransformBaseTemplate< TParametersValueType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = OptimizerParameters< FixedParametersValueType >
 
using FixedParametersValueType = double
 
using NumberOfParametersType = IdentifierType
 
using ParametersType = OptimizerParameters< ParametersValueType >
 
using ParametersValueType = TParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformBaseTemplate
 
using Superclass = Object
 
using TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
 
- 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

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 FixedParametersTypeGetFixedParameters () const =0
 
virtual unsigned int GetInputSpaceDimension () const =0
 
virtual const char * GetNameOfClass () const
 
virtual NumberOfParametersType GetNumberOfParameters () const =0
 
virtual unsigned int GetOutputSpaceDimension () const =0
 
virtual const ParametersTypeGetParameters () const =0
 
virtual TransformCategoryEnum 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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

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

- 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
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

Definition at line 68 of file itkTransformBase.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 77 of file itkTransformBase.h.

◆ FixedParametersType

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::FixedParametersType = OptimizerParameters<FixedParametersValueType>

Definition at line 84 of file itkTransformBase.h.

◆ FixedParametersValueType

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::FixedParametersValueType = double

Definition at line 83 of file itkTransformBase.h.

◆ NumberOfParametersType

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::NumberOfParametersType = IdentifierType

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

Definition at line 91 of file itkTransformBase.h.

◆ ParametersType

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::ParametersType = OptimizerParameters<ParametersValueType>

Definition at line 82 of file itkTransformBase.h.

◆ ParametersValueType

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::ParametersValueType = TParametersValueType

Type of the input parameters.

Definition at line 81 of file itkTransformBase.h.

◆ Pointer

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 76 of file itkTransformBase.h.

◆ Self

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::Self = TransformBaseTemplate

Standard class type aliases.

Definition at line 74 of file itkTransformBase.h.

◆ Superclass

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::Superclass = Object

Definition at line 75 of file itkTransformBase.h.

◆ TransformCategoryEnum

template<typename TParametersValueType>
using itk::TransformBaseTemplate< TParametersValueType >::TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

Definition at line 149 of file itkTransformBase.h.

Constructor & Destructor Documentation

◆ TransformBaseTemplate()

template<typename TParametersValueType>
itk::TransformBaseTemplate< TParametersValueType >::TransformBaseTemplate ( )
protecteddefault

◆ ~TransformBaseTemplate()

template<typename TParametersValueType>
itk::TransformBaseTemplate< TParametersValueType >::~TransformBaseTemplate ( )
overrideprotecteddefault

Member Function Documentation

◆ CopyInFixedParameters()

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 >.

◆ CopyInParameters()

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 >.

◆ GetFixedParameters()

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

◆ GetInputSpaceDimension()

template<typename TParametersValueType>
virtual unsigned int itk::TransformBaseTemplate< TParametersValueType >::GetInputSpaceDimension ( ) const
pure virtual

◆ GetNameOfClass()

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::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TParametersValueType, 2, 2 >, itk::MatrixOffsetTransformBase< TParametersValueType, 3, 3 >, itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >, itk::BSplineTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::AffineTransform< TParametersValueType, 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::MultiTransform< TParametersValueType, NDimensions, NSubDimensions >, itk::Similarity2DTransform< TParametersValueType >, itk::MultiTransform< TParametersValueType, NDimensions, NDimensions >, itk::v3::Rigid3DTransform< TParametersValueType >, itk::KernelTransform< TParametersValueType, NDimensions >, itk::Rigid3DTransform< TParametersValueType >, itk::CenteredSimilarity2DTransform< TParametersValueType >, itk::ScaleSkewVersor3DTransform< TParametersValueType >, itk::BSplineExponentialDiffeomorphicTransform< TParametersValueType, NDimensions >, itk::GaussianExponentialDiffeomorphicTransform< TParametersValueType, NDimensions >, itk::ComposeScaleSkewVersor3DTransform< TParametersValueType >, itk::Rigid2DTransform< TParametersValueType >, itk::CenteredRigid2DTransform< TParametersValueType >, itk::TimeVaryingVelocityFieldTransform< TParametersValueType, NDimensions >, itk::IdentityTransform< TParametersValueType, NDimensions >, itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, NDimensions >, itk::ScaleVersor3DTransform< TParametersValueType >, itk::QuaternionRigidTransform< TParametersValueType >, itk::Euler3DTransform< TParametersValueType >, itk::Similarity3DTransform< TParametersValueType >, itk::VersorRigid3DTransform< TParametersValueType >, itk::Rigid3DPerspectiveTransform< TParametersValueType >, itk::VersorTransform< TParametersValueType >, itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, NDimensions >, itk::TranslationTransform< TParametersValueType, NDimensions >, itk::ScaleTransform< TParametersValueType, NDimensions >, itk::Euler2DTransform< TParametersValueType >, itk::ElasticBodySplineKernelTransform< TParametersValueType, NDimensions >, itk::ThinPlateR2LogRSplineKernelTransform< TParametersValueType, NDimensions >, itk::CenteredEuler3DTransform< TParametersValueType >, itk::ElasticBodyReciprocalSplineKernelTransform< TParametersValueType, NDimensions >, itk::GaussianSmoothingOnUpdateTimeVaryingVelocityFieldTransform< TParametersValueType, NDimensions >, itk::ScaleLogarithmicTransform< TParametersValueType, NDimensions >, itk::ThinPlateSplineKernelTransform< TParametersValueType, NDimensions >, itk::VolumeSplineKernelTransform< TParametersValueType, NDimensions >, itk::ConstantVelocityFieldTransform< TParametersValueType, NDimensions >, itk::FixedCenterOfRotationAffineTransform< TParametersValueType, NDimensions >, itk::VelocityFieldTransform< TParametersValueType, NDimensions >, itk::BSplineBaseTransform< TParametersValueType, NDimensions, VSplineOrder >, itk::CenteredAffineTransform< TParametersValueType, NDimensions >, and itk::ScalableAffineTransform< TParametersValueType, NDimensions >.

◆ GetNumberOfParameters()

template<typename TParametersValueType>
virtual NumberOfParametersType itk::TransformBaseTemplate< TParametersValueType >::GetNumberOfParameters ( ) const
pure virtual

◆ GetOutputSpaceDimension()

template<typename TParametersValueType>
virtual unsigned int itk::TransformBaseTemplate< TParametersValueType >::GetOutputSpaceDimension ( ) const
pure virtual

◆ GetParameters()

template<typename TParametersValueType>
virtual const ParametersType& itk::TransformBaseTemplate< TParametersValueType >::GetParameters ( ) 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::ScaleSkewVersor3DTransform< TParametersValueType >, itk::ComposeScaleSkewVersor3DTransform< TParametersValueType >, itk::CenteredRigid2DTransform< TParametersValueType >, itk::QuaternionRigidTransform< TParametersValueType >, itk::Similarity3DTransform< TParametersValueType >, itk::ScaleVersor3DTransform< TParametersValueType >, itk::TranslationTransform< TParametersValueType, NDimensions >, 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 >.

◆ GetTransformCategory()

template<typename TParametersValueType>
virtual TransformCategoryEnum itk::TransformBaseTemplate< TParametersValueType >::GetTransformCategory ( ) const
pure virtual

◆ GetTransformTypeAsString()

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

◆ SetFixedParameters()

template<typename TParametersValueType>
virtual void itk::TransformBaseTemplate< TParametersValueType >::SetFixedParameters ( const FixedParametersType )
pure virtual

◆ SetParameters()

template<typename TParametersValueType>
virtual void itk::TransformBaseTemplate< TParametersValueType >::SetParameters ( const ParametersType )
pure virtual

◆ SetParametersByValue()

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, 3, 2 >, itk::Transform< TParametersValueType, NDimensions, NDimensions >, and itk::Transform< TParametersValueType, NDimensions, NSubDimensions >.


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