ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::TranslationTransform< TParametersValueType, VDimension > Class Template Reference
Group Core » Module ITKTransform

#include <itkTranslationTransform.h>

Detailed Description

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

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, and Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

Definition at line 43 of file itkTranslationTransform.h.

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

Public Types

using ConstPointer = SmartPointer<const Self>
 
typedef OptimizerParameters< FixedParametersValueType > FixedParametersType
 
using InputCovariantVectorType = CovariantVector<TParametersValueType, VDimension>
 
using InputPointType = Point<TParametersValueType, VDimension>
 
using InputVectorType = Vector<TParametersValueType, VDimension>
 
using InputVnlVectorType = vnl_vector_fixed<TParametersValueType, VDimension>
 
using InverseJacobianPositionType
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using JacobianPositionType
 
using JacobianType
 
typedef IdentifierType NumberOfParametersType
 
using OutputCovariantVectorType = CovariantVector<TParametersValueType, VDimension>
 
using OutputPointType = Point<TParametersValueType, VDimension>
 
using OutputVectorType = Vector<TParametersValueType, VDimension>
 
using OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, VDimension>
 
typedef OptimizerParameters< ParametersValueType > ParametersType
 
using Pointer = SmartPointer<Self>
 
using ScalarType
 
using Self = TranslationTransform
 
using Superclass = Transform<TParametersValueType, VDimension, VDimension>
 
typedef TransformBaseTemplateEnums::TransformCategory TransformCategoryEnum
 
- Public Types inherited from itk::Transform< double, 3, 3 >
using ConstPointer
 
using DerivativeType
 
using DirectionChangeMatrix
 
typedef OptimizerParameters< FixedParametersValueType > FixedParametersType
 
using FixedParametersType
 
typedef double FixedParametersValueType
 
using FixedParametersValueType
 
using InputCovariantVectorType
 
using InputDiffusionTensor3DType
 
using InputDirectionMatrix
 
using InputPointType
 
using InputSymmetricSecondRankTensorType
 
using InputVectorPixelType
 
using InputVectorType
 
using InputVnlVectorType
 
using InverseJacobianPositionType
 
using InverseTransformBasePointer
 
using InverseTransformBaseType
 
using JacobianPositionType
 
using JacobianType
 
using MatrixType
 
typedef IdentifierType NumberOfParametersType
 
using NumberOfParametersType
 
using OutputCovariantVectorType
 
using OutputDiffusionTensor3DType
 
using OutputDirectionMatrix
 
using OutputPointType
 
using OutputSymmetricSecondRankTensorType
 
using OutputVectorPixelType
 
using OutputVectorType
 
using OutputVnlVectorType
 
typedef OptimizerParameters< ParametersValueType > ParametersType
 
using ParametersType
 
typedef double ParametersValueType
 
using ParametersValueType
 
using Pointer
 
using ScalarType
 
using Self
 
using Superclass
 
typedef TransformBaseTemplateEnums::TransformCategory TransformCategoryEnum
 
using TransformCategoryEnum
 
- Public Types inherited from TransformBaseTemplate< double >
using ConstPointer
 
using FixedParametersType
 
using FixedParametersValueType
 
using NumberOfParametersType
 
using ParametersType
 
using ParametersValueType
 
using Pointer
 
using Self
 
using Superclass
 
using TransformCategoryEnum
 
using TransformCategoryType
 

Public Member Functions

InputCovariantVectorType BackTransform (const OutputCovariantVectorType &vect) const
 
InputPointType BackTransform (const OutputPointType &point) const
 
InputVectorType BackTransform (const OutputVectorType &vect) const
 
InputVnlVectorType BackTransform (const OutputVnlVectorType &vect) const
 
void Compose (const Self *other, bool pre=false)
 
void ComputeJacobianWithRespectToParameters (const InputPointType &point, JacobianType &jacobian) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jacobian) const
 
virtual::itk::LightObject::Pointer CreateAnother () const
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
const char * GetNameOfClass () const override
 
NumberOfParametersType GetNumberOfParameters () const override
 
const OutputVectorType & GetOffset () const
 
const ParametersType & GetParameters () 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
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vect) const override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
OutputVectorType TransformVector (const InputVectorType &vect) const override
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vect) const override
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
void Translate (const OutputVectorType &offset, bool pre=false)
 
const FixedParametersType & GetFixedParameters () const override
 
- Public Member Functions inherited from itk::Transform< double, 3, 3 >
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &pnt, InverseJacobianPositionType &jacobian) const
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &cachedJacobian) const
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jacobian) const
 
void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *inverseTransform) const
 
const char * GetNameOfClass () const override
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
unsigned int GetOutputSpaceDimension () 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 &vector) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const=0
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector) 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 &p, JacobianType &jacobian) const=0
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (TImage *image) const
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 
- Public Member Functions inherited from TransformBaseTemplate< double >
 ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)
 
 ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)
 
 itkGetConstReferenceMacro (InputSpaceName, std::string)
 
 itkGetConstReferenceMacro (InputSpaceName, std::string)
 
 itkGetConstReferenceMacro (OutputSpaceName, std::string)
 
 itkGetConstReferenceMacro (OutputSpaceName, std::string)
 
 itkOverrideGetNameOfClassMacro (TransformBaseTemplate)
 
 itkOverrideGetNameOfClassMacro (TransformBaseTemplate)
 
 itkSetMacro (InputSpaceName, std::string)
 
 itkSetMacro (InputSpaceName, std::string)
 
 itkSetMacro (OutputSpaceName, std::string)
 
 itkSetMacro (OutputSpaceName, std::string)
 
virtual void SetFixedParameters (const FixedParametersType &)=0
 
virtual void SetFixedParameters (const FixedParametersType &)=0
 
virtual void SetParameters (const ParametersType &)=0
 
virtual void SetParameters (const ParametersType &)=0
 
virtual void SetParametersByValue (const ParametersType &p)=0
 
virtual void SetParametersByValue (const ParametersType &p)=0
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ParametersDimension = VDimension
 
static constexpr unsigned int SpaceDimension = VDimension
 
- Static Public Attributes inherited from itk::Transform< double, 3, 3 >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
- Static Public Attributes inherited from TransformBaseTemplate< double >
static constexpr TransformCategoryEnum BSpline
 
static constexpr TransformCategoryEnum BSpline
 
static constexpr TransformCategoryEnum DisplacementField
 
static constexpr TransformCategoryEnum DisplacementField
 
static constexpr TransformCategoryEnum Linear
 
static constexpr TransformCategoryEnum Linear
 
static constexpr TransformCategoryEnum Spline
 
static constexpr TransformCategoryEnum Spline
 
static constexpr TransformCategoryEnum UnknownTransformCategory
 
static constexpr TransformCategoryEnum UnknownTransformCategory
 
static constexpr TransformCategoryEnum VelocityField
 
static constexpr TransformCategoryEnum VelocityField
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 TranslationTransform ()
 
 ~TranslationTransform () override=default
 
- Protected Member Functions inherited from itk::Transform< double, 3, 3 >
LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
 Transform ()=default
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override=default
 
- Protected Member Functions inherited from TransformBaseTemplate< double >
 TransformBaseTemplate ()=default
 
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
 ~TransformBaseTemplate () override=default
 

Private Attributes

JacobianType m_IdentityJacobian {}
 
OutputVectorType m_Offset {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::Transform< double, 3, 3 >
static InverseTransformBasePointer InvertTransform (const TTransform &transform)
 
- Protected Attributes inherited from itk::Transform< double, 3, 3 >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 52 of file itkTranslationTransform.h.

◆ FixedParametersType

template<typename TParametersValueType = double, unsigned int VDimension = 3>

◆ InputCovariantVectorType

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

Standard covariant vector type for this class.

Definition at line 84 of file itkTranslationTransform.h.

◆ InputPointType

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

Standard coordinate point type for this class.

Definition at line 92 of file itkTranslationTransform.h.

◆ InputVectorType

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

Standard vector type for this class.

Definition at line 80 of file itkTranslationTransform.h.

◆ InputVnlVectorType

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

Standard vnl_vector type for this class.

Definition at line 88 of file itkTranslationTransform.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double, unsigned int VDimension = 3>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InverseJacobianPositionType

Definition at line 132 of file itkTransform.h.

◆ InverseTransformBasePointer

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

Definition at line 98 of file itkTranslationTransform.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = double, unsigned int VDimension = 3>
using itk::TranslationTransform< TParametersValueType, VDimension >::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 VDimension = 3>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianPositionType

Definition at line 131 of file itkTransform.h.

◆ JacobianType

template<typename TParametersValueType = double, unsigned int VDimension = 3>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianType

Type of the Jacobian matrix.

Definition at line 130 of file itkTransform.h.

◆ NumberOfParametersType

template<typename TParametersValueType = double, unsigned int VDimension = 3>

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

◆ OutputCovariantVectorType

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

Definition at line 85 of file itkTranslationTransform.h.

◆ OutputPointType

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

Definition at line 93 of file itkTranslationTransform.h.

◆ OutputVectorType

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

Definition at line 81 of file itkTranslationTransform.h.

◆ OutputVnlVectorType

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

Definition at line 89 of file itkTranslationTransform.h.

◆ ParametersType

template<typename TParametersValueType = double, unsigned int VDimension = 3>

◆ Pointer

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

Definition at line 51 of file itkTranslationTransform.h.

◆ ScalarType

template<typename TParametersValueType = double, unsigned int VDimension = 3>
using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::ScalarType

Type of the scalar representing coordinate and vector elements.

Definition at line 127 of file itkTransform.h.

◆ Self

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

Standard class type aliases.

Definition at line 49 of file itkTranslationTransform.h.

◆ Superclass

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

Definition at line 50 of file itkTranslationTransform.h.

◆ TransformCategoryEnum

template<typename TParametersValueType = double, unsigned int VDimension = 3>

Constructor & Destructor Documentation

◆ TranslationTransform()

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

Referenced by GetNameOfClass().

◆ ~TranslationTransform()

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

Member Function Documentation

◆ BackTransform() [1/4]

template<typename TParametersValueType, unsigned int VDimension>
auto itk::TranslationTransform< TParametersValueType, VDimension >::BackTransform ( const OutputCovariantVectorType & vect) const
inline

Definition at line 289 of file itkTranslationTransform.h.

◆ BackTransform() [2/4]

template<typename TParametersValueType, unsigned int VDimension>
auto itk::TranslationTransform< TParametersValueType, VDimension >::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.

References m_Offset, and itk::point().

Referenced by TransformCovariantVector().

◆ BackTransform() [3/4]

template<typename TParametersValueType, unsigned int VDimension>
auto itk::TranslationTransform< TParametersValueType, VDimension >::BackTransform ( const OutputVectorType & vect) const
inline

Definition at line 271 of file itkTranslationTransform.h.

◆ BackTransform() [4/4]

template<typename TParametersValueType, unsigned int VDimension>
auto itk::TranslationTransform< TParametersValueType, VDimension >::BackTransform ( const OutputVnlVectorType & vect) const
inline

Definition at line 280 of file itkTranslationTransform.h.

◆ Compose()

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

Compose with another TranslationTransform.

◆ ComputeJacobianWithRespectToParameters()

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

Compute the Jacobian Matrix of the transformation at one point

References itk::point().

◆ ComputeJacobianWithRespectToPosition() [1/2]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
void itk::TranslationTransform< TParametersValueType, VDimension >::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.

References itk::Transform< TParametersValueType, VDimension, VDimension >::ComputeJacobianWithRespectToPosition().

◆ ComputeJacobianWithRespectToPosition() [2/2]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual void itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::ComputeJacobianWithRespectToPosition ( const InputPointType & x,
JacobianPositionType & jacobian ) const
inline

This provides the ability to get a local jacobian value in a dense/local transform, e.g. DisplacementFieldTransform. For such transforms it would be unclear what parameters would refer to. Generally, global transforms should return an identity jacobian since there is no change with respect to position.

Definition at line 528 of file itkTransform.h.

◆ CreateAnother()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual::itk::LightObject::Pointer itk::TranslationTransform< TParametersValueType, VDimension >::CreateAnother ( ) const

◆ GetFixedParameters()

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

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

Reimplemented from itk::Transform< double, 3, 3 >.

Definition at line 240 of file itkTranslationTransform.h.

References itk::Transform< double, 3, 3 >::m_FixedParameters.

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
bool itk::TranslationTransform< TParametersValueType, VDimension >::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 VDimension = 3>
InverseTransformBasePointer itk::TranslationTransform< TParametersValueType, VDimension >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

Reimplemented from itk::Transform< double, 3, 3 >.

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
const char * itk::TranslationTransform< TParametersValueType, VDimension >::GetNameOfClass ( ) const
override
See also
LightObject::GetNameOfClass()

References TransformBaseTemplate< double >::itkOverrideGetNameOfClassMacro(), and TranslationTransform().

◆ GetNumberOfParameters()

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

Return the number of parameters that completely define the Transform

Reimplemented from itk::Transform< double, 3, 3 >.

Definition at line 204 of file itkTranslationTransform.h.

◆ GetOffset()

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

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

Definition at line 106 of file itkTranslationTransform.h.

References m_Offset.

◆ GetParameters()

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

Get the Transformation Parameters.

Reimplemented from itk::Transform< double, 3, 3 >.

◆ GetTransformCategory()

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

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

Reimplemented from itk::Transform< double, 3, 3 >.

Definition at line 224 of file itkTranslationTransform.h.

References TransformBaseTemplate< double >::Linear.

◆ IsLinear()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
bool itk::TranslationTransform< TParametersValueType, VDimension >::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< double, 3, 3 >.

Definition at line 215 of file itkTranslationTransform.h.

◆ New()

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

New macro for creation of through the object factory.

◆ PrintSelf()

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

Print contents of an TranslationTransform.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
void itk::TranslationTransform< TParametersValueType, VDimension >::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< double, 3, 3 >.

Definition at line 233 of file itkTranslationTransform.h.

◆ SetIdentity()

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

Set the parameters to the IdentityTransform

◆ SetOffset()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
void itk::TranslationTransform< TParametersValueType, VDimension >::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.

References m_Offset.

◆ SetParameters()

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

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

Implements itk::Transform< double, 3, 3 >.

◆ TransformCovariantVector() [1/5]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputCovariantVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputCovariantVectorType & ) const
inline

Method to transform a CovariantVector.

Definition at line 234 of file itkTransform.h.

◆ TransformCovariantVector() [2/5]

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

References BackTransform(), and itk::point().

◆ TransformCovariantVector() [3/5]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputCovariantVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputCovariantVectorType & vector,
const InputPointType & point ) const

Method to transform a CovariantVector, using a point. Global transforms can ignore the point parameter. Local transforms (e.g. deformation field transform) must override and provide required behavior. By default, point is ignored and TransformCovariantVector(vector) is called

◆ TransformCovariantVector() [4/5]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputVectorPixelType & vector) const
inline

Method to transform a CovariantVector stored in a VectorImage.

Definition at line 252 of file itkTransform.h.

◆ TransformCovariantVector() [5/5]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputVectorPixelType & vector,
const InputPointType & point ) const

Method to transform a CovariantVector, using a point. Global transforms can ignore the point parameter. Local transforms (e.g. deformation field transform) must override and provide required behavior. By default, point is ignored and TransformCovariantVector(vector) is called

◆ TransformPoint()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
OutputPointType itk::TranslationTransform< TParametersValueType, VDimension >::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.

References itk::point(), and itk::Transform< TParametersValueType, VDimension, VDimension >::TransformVector().

◆ TransformVector() [1/8]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorPixelType & vector) const
inline

Method to transform a vector stored in a VectorImage.

Definition at line 218 of file itkTransform.h.

◆ TransformVector() [2/8]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorPixelType & vector,
const InputPointType & point ) const

Method to transform a vector stored in a VectorImage, at a point. For global transforms, point is ignored and TransformVector( vector ) is called. Local transforms (e.g. deformation field transform) must override and provide required behavior.

◆ TransformVector() [3/8]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorType & ) const
inline

Method to transform a vector.

Definition at line 186 of file itkTransform.h.

◆ TransformVector() [4/8]

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

◆ TransformVector() [5/8]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorType & vector,
const InputPointType & point ) const

Method to transform a vector at a given location. For global transforms, point is ignored and TransformVector( vector ) is called. Local transforms (e.g. deformation field transform) must override and provide required behavior.

◆ TransformVector() [6/8]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVnlVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVnlVectorType & ) const
inline

Method to transform a vnl_vector.

Definition at line 202 of file itkTransform.h.

◆ TransformVector() [7/8]

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

References itk::Transform< TParametersValueType, VDimension, VDimension >::TransformCovariantVector().

◆ TransformVector() [8/8]

template<typename TParametersValueType = double, unsigned int VDimension = 3>
virtual OutputVnlVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVnlVectorType & vector,
const InputPointType & point ) const

Method to transform a vnl_vector, at a point. For global transforms, point is ignored and TransformVector( vector ) is called. Local transforms (e.g. deformation field transform) must override and provide required behavior.

◆ Translate()

template<typename TParametersValueType = double, unsigned int VDimension = 3>
void itk::TranslationTransform< TParametersValueType, VDimension >::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 VDimension = 3>
JacobianType itk::TranslationTransform< TParametersValueType, VDimension >::m_IdentityJacobian {}
private

Definition at line 255 of file itkTranslationTransform.h.

◆ m_Offset

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

Definition at line 256 of file itkTranslationTransform.h.

Referenced by BackTransform(), GetOffset(), and SetOffset().

◆ ParametersDimension

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

Definition at line 62 of file itkTranslationTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3>
unsigned int itk::TranslationTransform< TParametersValueType, VDimension >::SpaceDimension = VDimension
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: