ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::TranslationTransform< TParametersValueType, NDimensions > Class Template Reference

#include <itkTranslationTransform.h>

+ Inheritance diagram for itk::TranslationTransform< TParametersValueType, NDimensions >:
+ Collaboration diagram for itk::TranslationTransform< TParametersValueType, NDimensions >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, NDimensions >
 
using InputPointType = Point< TParametersValueType, NDimensions >
 
using InputVectorType = Vector< TParametersValueType, NDimensions >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, NDimensions >
 
using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using JacobianPositionType = typename Superclass::JacobianPositionType
 
using JacobianType = typename Superclass::JacobianType
 
using NumberOfParametersType = typename Superclass::NumberOfParametersType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, NDimensions >
 
using OutputPointType = Point< TParametersValueType, NDimensions >
 
using OutputVectorType = Vector< TParametersValueType, NDimensions >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, NDimensions >
 
using ParametersType = typename Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using ScalarType = typename Superclass::ScalarType
 
using Self = TranslationTransform
 
using Superclass = Transform< TParametersValueType, NDimensions, NDimensions >
 
using TransformCategoryEnum = typename Superclass::TransformCategoryEnum
 
- Public Types inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using FixedParametersValueType = typename Superclass::FixedParametersValueType
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, NInputDimensions >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, NInputDimensions >
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, NInputDimensions >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, NInputDimensions >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, NInputDimensions >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, NInputDimensions, NOutputDimensions >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = Transform< TParametersValueType, NOutputDimensions, NInputDimensions >
 
using JacobianPositionType = vnl_matrix_fixed< ParametersValueType, NOutputDimensions, NInputDimensions >
 
using JacobianType = Array2D< ParametersValueType >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using NumberOfParametersType = typename Superclass::NumberOfParametersType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, NOutputDimensions >
 
using OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, NOutputDimensions >
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, NOutputDimensions >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, NOutputDimensions >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, NOutputDimensions >
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = Transform
 
using Superclass = TransformBaseTemplate< TParametersValueType >
 
using TransformCategoryEnum = typename Superclass::TransformCategoryEnum
 
- Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
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

InputCovariantVectorType BackTransform (const OutputCovariantVectorType &vector) const
 
InputPointType BackTransform (const OutputPointType &point) const
 
InputVectorType BackTransform (const OutputVectorType &vector) const
 
InputVnlVectorType BackTransform (const OutputVnlVectorType &vector) const
 
void Compose (const Self *other, bool pre=false)
 
void ComputeJacobianWithRespectToParameters (const InputPointType &point, JacobianType &j) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const char * GetNameOfClass () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
const OutputVectorTypeGetOffset () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
bool IsLinear () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
void SetIdentity ()
 
void SetOffset (const OutputVectorType &offset)
 
void SetParameters (const ParametersType &parameters) override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVectorType TransformVector (const InputVectorType &vector) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const override
 
void Translate (const OutputVectorType &offset, bool pre=false)
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
const FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const=0
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const=0
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jacobian) const
 
- 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
 
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
 

Static Public Member Functions

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 constexpr unsigned int ParametersDimension = NDimensions
 
static constexpr unsigned int SpaceDimension = NDimensions
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
JacobianType m_IdentityJacobian
 
OutputVectorType m_Offset
 
const FixedParametersTypeGetFixedParameters () const override
 
 TranslationTransform ()
 
 ~TranslationTransform () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
LightObject::Pointer InternalClone () const override
 
 Transform ()
 
 Transform (NumberOfParametersType NumberOfParameters)
 
 ~Transform () override=default
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
ParametersType m_Parameters
 
FixedParametersType m_FixedParameters
 
DirectionChangeMatrix m_DirectionChange
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
class itk::TranslationTransform< TParametersValueType, NDimensions >

Translation transformation of a vector space (e.g. space coordinates)

The same functionality could be obtained by using the Affine transform, but with a large difference in performance.

ITK Sphinx Examples:
Examples
Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration10.cxx, Examples/RegistrationITKv4/ImageRegistration11.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/ImageRegistration17.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration3.cxx, Examples/RegistrationITKv4/ImageRegistration4.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint3.cxx, Examples/RegistrationITKv4/MeanSquaresImageMetric1.cxx, Examples/RegistrationITKv4/MultiResImageRegistration1.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, SphinxExamples/src/Core/Mesh/TranslateOneMesh/Code.cxx, SphinxExamples/src/Core/Transform/TranslateImage/Code.cxx, SphinxExamples/src/Registration/Common/ComputeMeanSquareBetweenTwoImages/Code.cxx, SphinxExamples/src/Registration/Common/GlobalRegistrationOfTwoImages/Code.cxx, SphinxExamples/src/Registration/Common/MutualInformation/Code.cxx, SphinxExamples/src/Registration/Common/Perform2DTranslationRegistrationWithMeanSquares/Code.cxx, and SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx.

Definition at line 43 of file itkTranslationTransform.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::ConstPointer = SmartPointer<const Self>

Definition at line 52 of file itkTranslationTransform.h.

◆ FixedParametersType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::FixedParametersType = typename Superclass::FixedParametersType

Standard parameters container.

Definition at line 68 of file itkTranslationTransform.h.

◆ InputCovariantVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InputCovariantVectorType = CovariantVector<TParametersValueType, NDimensions>

Standard covariant vector type for this class.

Definition at line 84 of file itkTranslationTransform.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InputPointType = Point<TParametersValueType, NDimensions>

Standard coordinate point type for this class.

Definition at line 92 of file itkTranslationTransform.h.

◆ InputVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InputVectorType = Vector<TParametersValueType, NDimensions>

Standard vector type for this class.

Definition at line 80 of file itkTranslationTransform.h.

◆ InputVnlVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, NDimensions>

Standard vnl_vector type for this class.

Definition at line 88 of file itkTranslationTransform.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType

Definition at line 74 of file itkTranslationTransform.h.

◆ InverseTransformBasePointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

Definition at line 98 of file itkTranslationTransform.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::InverseTransformBaseType = typename Superclass::InverseTransformBaseType

Base inverse transform type. This type should not be changed to the concrete inverse transform type or inheritance would be lost.

Definition at line 97 of file itkTranslationTransform.h.

◆ JacobianPositionType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::JacobianPositionType = typename Superclass::JacobianPositionType

Definition at line 73 of file itkTranslationTransform.h.

◆ JacobianType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::JacobianType = typename Superclass::JacobianType

Standard Jacobian containers.

Definition at line 72 of file itkTranslationTransform.h.

◆ NumberOfParametersType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::NumberOfParametersType = typename Superclass::NumberOfParametersType

The number of parameters defining this transform.

Definition at line 77 of file itkTranslationTransform.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::OutputCovariantVectorType = CovariantVector<TParametersValueType, NDimensions>

Definition at line 85 of file itkTranslationTransform.h.

◆ OutputPointType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::OutputPointType = Point<TParametersValueType, NDimensions>

Definition at line 93 of file itkTranslationTransform.h.

◆ OutputVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::OutputVectorType = Vector<TParametersValueType, NDimensions>

Definition at line 81 of file itkTranslationTransform.h.

◆ OutputVnlVectorType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, NDimensions>

Definition at line 89 of file itkTranslationTransform.h.

◆ ParametersType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::ParametersType = typename Superclass::ParametersType

Definition at line 69 of file itkTranslationTransform.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::Pointer = SmartPointer<Self>

Definition at line 51 of file itkTranslationTransform.h.

◆ ScalarType

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::ScalarType = typename Superclass::ScalarType

Standard scalar type for this class.

Definition at line 65 of file itkTranslationTransform.h.

◆ Self

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::Self = TranslationTransform

Standard class type aliases.

Definition at line 49 of file itkTranslationTransform.h.

◆ Superclass

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::Superclass = Transform<TParametersValueType, NDimensions, NDimensions>

Definition at line 50 of file itkTranslationTransform.h.

◆ TransformCategoryEnum

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
using itk::TranslationTransform< TParametersValueType, NDimensions >::TransformCategoryEnum = typename Superclass::TransformCategoryEnum

Transform category type.

Definition at line 101 of file itkTranslationTransform.h.

Constructor & Destructor Documentation

◆ TranslationTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
itk::TranslationTransform< TParametersValueType, NDimensions >::TranslationTransform ( )
protected

Get the Fixed Parameters. The TranslationTransform does not require Fixed parameters, therefore this method returns an parameters array of size zero.

◆ ~TranslationTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
itk::TranslationTransform< TParametersValueType, NDimensions >::~TranslationTransform ( )
overrideprotecteddefault

Get the Fixed Parameters. The TranslationTransform does not require Fixed parameters, therefore this method returns an parameters array of size zero.

Member Function Documentation

◆ BackTransform() [1/4]

template<typename TParametersValueType , unsigned int NDimensions>
TranslationTransform< TParametersValueType, NDimensions >::InputCovariantVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::BackTransform ( const OutputCovariantVectorType vector) const
inline

Definition at line 286 of file itkTranslationTransform.h.

◆ BackTransform() [2/4]

template<typename TParametersValueType , unsigned int NDimensions>
TranslationTransform< TParametersValueType, NDimensions >::InputPointType itk::TranslationTransform< TParametersValueType, NDimensions >::BackTransform ( const OutputPointType point) const
inline

This method finds the point or vector that maps to a given point or vector under the affine transformation defined by self. If no such point exists, an exception is thrown.

Definition at line 262 of file itkTranslationTransform.h.

◆ BackTransform() [3/4]

template<typename TParametersValueType , unsigned int NDimensions>
TranslationTransform< TParametersValueType, NDimensions >::InputVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::BackTransform ( const OutputVectorType vector) const
inline

Definition at line 270 of file itkTranslationTransform.h.

◆ BackTransform() [4/4]

template<typename TParametersValueType , unsigned int NDimensions>
TranslationTransform< TParametersValueType, NDimensions >::InputVnlVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::BackTransform ( const OutputVnlVectorType vector) const
inline

Definition at line 278 of file itkTranslationTransform.h.

◆ Compose()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::Compose ( const Self other,
bool  pre = false 
)

Compose with another TranslationTransform.

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::ComputeJacobianWithRespectToParameters ( const InputPointType point,
JacobianType j 
) const
override

Compute the Jacobian Matrix of the transformation at one point

◆ ComputeJacobianWithRespectToPosition()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::ComputeJacobianWithRespectToPosition ( const InputPointType x,
JacobianPositionType jac 
) const
override

Get the jacobian with respect to position, which simply is an identity jacobian because the transform is position-invariant. jac will be resized as needed, but it will be more efficient if it is already properly sized.

◆ CreateAnother()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
virtual::itk::LightObject::Pointer itk::TranslationTransform< TParametersValueType, NDimensions >::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.

◆ GetFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
const FixedParametersType& itk::TranslationTransform< TParametersValueType, NDimensions >::GetFixedParameters ( ) const
inlineoverridevirtual

Get the Fixed Parameters. The TranslationTransform does not require Fixed parameters, therefore this method returns an parameters array of size zero.

Implements itk::TransformBaseTemplate< TParametersValueType >.

Definition at line 240 of file itkTranslationTransform.h.

References itk::Array< TValue >::SetSize().

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
bool itk::TranslationTransform< TParametersValueType, NDimensions >::GetInverse ( Self inverse) const

Find inverse of an affine transformation. This method creates and returns a new TranslationTransform object which is the inverse of self. If self is not invertible, false is returned.

◆ GetInverseTransform()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
InverseTransformBasePointer itk::TranslationTransform< TParametersValueType, NDimensions >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

Reimplemented from itk::Transform< TParametersValueType, NDimensions, NDimensions >.

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
virtual const char* itk::TranslationTransform< TParametersValueType, NDimensions >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Transform< TParametersValueType, NDimensions, NDimensions >.

◆ GetNumberOfParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
NumberOfParametersType itk::TranslationTransform< TParametersValueType, NDimensions >::GetNumberOfParameters ( ) const
inlineoverridevirtual

Return the number of parameters that completely define the Transfom

Implements itk::TransformBaseTemplate< TParametersValueType >.

Definition at line 204 of file itkTranslationTransform.h.

◆ GetOffset()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
const OutputVectorType& itk::TranslationTransform< TParametersValueType, NDimensions >::GetOffset ( ) const
inline

This method returns the value of the offset of the TranslationTransform.

Definition at line 106 of file itkTranslationTransform.h.

◆ GetParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
const ParametersType& itk::TranslationTransform< TParametersValueType, NDimensions >::GetParameters ( ) const
overridevirtual

Get the Transformation Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetTransformCategory()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
TransformCategoryEnum itk::TranslationTransform< TParametersValueType, NDimensions >::GetTransformCategory ( ) const
inlineoverridevirtual

Indicates the category transform. e.g. an affine transform, or a local one, e.g. a deformation field.

Implements itk::TransformBaseTemplate< TParametersValueType >.

Definition at line 224 of file itkTranslationTransform.h.

◆ IsLinear()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
bool itk::TranslationTransform< TParametersValueType, NDimensions >::IsLinear ( ) const
inlineoverridevirtual

Indicates that this transform is linear. That is, given two points P and Q, and scalar coefficients a and b, then

\[ T( a*P + b*Q ) = a * T(P) + b * T(Q) \]

Reimplemented from itk::Transform< TParametersValueType, NDimensions, NDimensions >.

Definition at line 215 of file itkTranslationTransform.h.

◆ New()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
static Pointer itk::TranslationTransform< TParametersValueType, NDimensions >::New ( )
static

New macro for creation of through the object factory.

Examples
SphinxExamples/src/Core/Transform/TranslateAVectorImage/Code.cxx.

◆ PrintSelf()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Print contents of an TranslationTransform.

Reimplemented from itk::Object.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::SetFixedParameters ( const FixedParametersType )
inlineoverridevirtual

Set the fixed parameters and update internal transformation. The Translation Transform does not require fixed parameters, therefore the implementation of this method is a null operation.

Implements itk::Transform< TParametersValueType, NDimensions, NDimensions >.

Definition at line 233 of file itkTranslationTransform.h.

◆ SetIdentity()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::SetIdentity ( )

Set the parameters to the IdentityTransform

◆ SetOffset()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::SetOffset ( const OutputVectorType offset)
inline

Set offset of an Translation Transform. This method sets the offset of an TranslationTransform to a value specified by the user.

Definition at line 124 of file itkTranslationTransform.h.

◆ SetParameters()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::SetParameters ( const ParametersType parameters)
overridevirtual

This method sets the parameters for the transform value specified by the user.

Implements itk::Transform< TParametersValueType, NDimensions, NDimensions >.

◆ TransformCovariantVector()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
OutputCovariantVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::TransformCovariantVector ( const InputCovariantVectorType vector) const
override

◆ TransformPoint()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
OutputPointType itk::TranslationTransform< TParametersValueType, NDimensions >::TransformPoint ( const InputPointType point) const
override

Transform by an affine transformation. This method applies the affine transform given by self to a given point or vector, returning the transformed point or vector.

◆ TransformVector() [1/2]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
OutputVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::TransformVector ( const InputVectorType vector) const
override

◆ TransformVector() [2/2]

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
OutputVnlVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::TransformVector ( const InputVnlVectorType vector) const
override

◆ Translate()

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
void itk::TranslationTransform< TParametersValueType, NDimensions >::Translate ( const OutputVectorType offset,
bool  pre = false 
)

Compose affine transformation with a translation. This method modifies self to include a translation of the origin. The translation is precomposed with self if pre is true, and postcomposed otherwise.

Member Data Documentation

◆ m_IdentityJacobian

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
JacobianType itk::TranslationTransform< TParametersValueType, NDimensions >::m_IdentityJacobian
private

Get the Fixed Parameters. The TranslationTransform does not require Fixed parameters, therefore this method returns an parameters array of size zero.

Definition at line 255 of file itkTranslationTransform.h.

◆ m_Offset

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
OutputVectorType itk::TranslationTransform< TParametersValueType, NDimensions >::m_Offset
private

Get the Fixed Parameters. The TranslationTransform does not require Fixed parameters, therefore this method returns an parameters array of size zero.

Definition at line 256 of file itkTranslationTransform.h.

◆ ParametersDimension

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
constexpr unsigned int itk::TranslationTransform< TParametersValueType, NDimensions >::ParametersDimension = NDimensions
staticconstexpr

Definition at line 62 of file itkTranslationTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = double, unsigned int NDimensions = 3>
constexpr unsigned int itk::TranslationTransform< TParametersValueType, NDimensions >::SpaceDimension = NDimensions
staticconstexpr

Dimension of the domain space.

Definition at line 61 of file itkTranslationTransform.h.


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