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

#include <itkIdentityTransform.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using FixedParametersValueType = typename Superclass::FixedParametersValueType
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >
 
using InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >
 
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 OutputCovariantVectorType = CovariantVector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = IdentityTransform
 
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

void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &jacobian) const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
void SetIdentity ()
 
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
 
- 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
 
virtual bool IsLinear () const
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
void SetParameters (const ParametersType &) override=0
 
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 InputSpaceDimension = NDimensions
 
static constexpr unsigned int OutputSpaceDimension = NDimensions
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
JacobianType m_ZeroJacobian
 
void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &jac) const override
 
bool GetInverse (Self *inverseTransform) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const FixedParametersTypeGetFixedParameters () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
const ParametersTypeGetParameters () const override
 
void SetParameters (const ParametersType &) override
 
 IdentityTransform ()
 
 ~IdentityTransform () override=default
 

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
 
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
 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, unsigned int NDimensions = 3>
class itk::IdentityTransform< TParametersValueType, NDimensions >

Implementation of an Identity Transform.

This class defines the generic interface for an Identity Transform.

It will map every point to itself, every vector to itself and every covariant vector to itself.

This class is intended to be used primarily as a default Transform for initializing those classes supporting a generic Transform.

This class is templated over the Representation type for coordinates (that is the type used for representing the components of points and vectors) and over the dimension of the space. In this case the Input and Output spaces are the same so only one dimension is required.

Examples
Examples/Filtering/ResampleImageFilter6.cxx, Examples/Filtering/ResampleImageFilter9.cxx, Examples/Filtering/ResampleVolumesToBeIsotropic.cxx, Examples/Filtering/SubsampleVolume.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistration7.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, SphinxExamples/src/Compatibility/Deprecated/ResampleRGBImage/Code.cxx, SphinxExamples/src/Core/ImageFunction/ResampleSegmentedImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ResampleAVectorImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/UpsampleAnImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/UpsampleOrDownsampleScalarImage/Code.cxx, SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx, and SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx.

Definition at line 50 of file itkIdentityTransform.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file itkIdentityTransform.h.

◆ FixedParametersType

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

Definition at line 74 of file itkIdentityTransform.h.

◆ FixedParametersValueType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::FixedParametersValueType = typename Superclass::FixedParametersValueType

Definition at line 75 of file itkIdentityTransform.h.

◆ InputCovariantVectorType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::InputCovariantVectorType = CovariantVector<TParametersValueType, Self::InputSpaceDimension>

Standard covariant vector type for this class

Definition at line 92 of file itkIdentityTransform.h.

◆ InputPointType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::InputPointType = Point<TParametersValueType, Self::InputSpaceDimension>

Standard coordinate point type for this class

Definition at line 100 of file itkIdentityTransform.h.

◆ InputVectorType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::InputVectorType = Vector<TParametersValueType, Self::InputSpaceDimension>

Standard vector type for this class.

Definition at line 88 of file itkIdentityTransform.h.

◆ InputVnlVectorType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::InputSpaceDimension>

Standard vnl_vector type for this class.

Definition at line 96 of file itkIdentityTransform.h.

◆ InverseJacobianPositionType

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

Definition at line 82 of file itkIdentityTransform.h.

◆ InverseTransformBasePointer

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

Definition at line 106 of file itkIdentityTransform.h.

◆ InverseTransformBaseType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< 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 105 of file itkIdentityTransform.h.

◆ JacobianPositionType

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

Definition at line 81 of file itkIdentityTransform.h.

◆ JacobianType

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

Type of the Jacobian matrix.

Definition at line 80 of file itkIdentityTransform.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::OutputCovariantVectorType = CovariantVector<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 93 of file itkIdentityTransform.h.

◆ OutputPointType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::OutputPointType = Point<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 101 of file itkIdentityTransform.h.

◆ OutputVectorType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::OutputVectorType = Vector<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 89 of file itkIdentityTransform.h.

◆ OutputVnlVectorType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 97 of file itkIdentityTransform.h.

◆ ParametersType

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

Type of the input parameters.

Definition at line 72 of file itkIdentityTransform.h.

◆ ParametersValueType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::ParametersValueType = typename Superclass::ParametersValueType

Definition at line 73 of file itkIdentityTransform.h.

◆ Pointer

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

Definition at line 58 of file itkIdentityTransform.h.

◆ ScalarType

template<typename TParametersValueType , unsigned int NDimensions = 3>
using itk::IdentityTransform< TParametersValueType, NDimensions >::ScalarType = ParametersValueType

Definition at line 76 of file itkIdentityTransform.h.

◆ Self

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

Standard class type aliases.

Definition at line 56 of file itkIdentityTransform.h.

◆ Superclass

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

Definition at line 57 of file itkIdentityTransform.h.

◆ TransformCategoryEnum

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

Transform category type.

Definition at line 85 of file itkIdentityTransform.h.

Constructor & Destructor Documentation

◆ IdentityTransform()

template<typename TParametersValueType , unsigned int NDimensions = 3>
itk::IdentityTransform< TParametersValueType, NDimensions >::IdentityTransform ( )
inlineprotected

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.

Definition at line 244 of file itkIdentityTransform.h.

◆ ~IdentityTransform()

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

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.

Member Function Documentation

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType , unsigned int NDimensions = 3>
void itk::IdentityTransform< TParametersValueType, NDimensions >::ComputeJacobianWithRespectToParameters ( const InputPointType ,
JacobianType jacobian 
) const
inlineoverride

Compute the Jacobian of the transformation

This method computes the Jacobian matrix of the transformation. given point or vector, returning the transformed point or vector. The rank of the Jacobian will also indicate if the transform is invertible at this point.

The Jacobian can be expressed as a set of partial derivatives of the output point components with respect to the parameters that defined the transform:

\[ J=\left[ \begin{array}{cccc} \frac{\partial x_{1}}{\partial p_{1}} & \frac{\partial x_{2}}{\partial p_{1}} & \cdots & \frac{\partial x_{n}}{\partial p_{1}}\\ \frac{\partial x_{1}}{\partial p_{2}} & \frac{\partial x_{2}}{\partial p_{2}} & \cdots & \frac{\partial x_{n}}{\partial p_{2}}\\ \vdots & \vdots & \ddots & \vdots \\ \frac{\partial x_{1}}{\partial p_{m}} & \frac{\partial x_{2}}{\partial p_{m}} & \cdots & \frac{\partial x_{n}}{\partial p_{m}} \end{array}\right] \]

Definition at line 175 of file itkIdentityTransform.h.

◆ ComputeJacobianWithRespectToPosition()

template<typename TParametersValueType , unsigned int NDimensions = 3>
void itk::IdentityTransform< TParametersValueType, NDimensions >::ComputeJacobianWithRespectToPosition ( const InputPointType ,
JacobianPositionType jac 
) const
inlineoverride

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.

Definition at line 186 of file itkIdentityTransform.h.

◆ CreateAnother()

template<typename TParametersValueType , unsigned int NDimensions = 3>
virtual::itk::LightObject::Pointer itk::IdentityTransform< 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 , unsigned int NDimensions = 3>
const FixedParametersType& itk::IdentityTransform< TParametersValueType, NDimensions >::GetFixedParameters ( ) const
inlineoverridevirtual

Get the Fixed Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

Definition at line 221 of file itkIdentityTransform.h.

◆ GetInverse()

template<typename TParametersValueType , unsigned int NDimensions = 3>
bool itk::IdentityTransform< TParametersValueType, NDimensions >::GetInverse ( Self inverseTransform) const
inline

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.

Definition at line 195 of file itkIdentityTransform.h.

◆ GetInverseTransform()

template<typename TParametersValueType , unsigned int NDimensions = 3>
InverseTransformBasePointer itk::IdentityTransform< TParametersValueType, NDimensions >::GetInverseTransform ( ) const
inlineoverridevirtual

Return an inverse of the identity transform - another identity transform.

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

Definition at line 203 of file itkIdentityTransform.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

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

◆ GetParameters()

template<typename TParametersValueType , unsigned int NDimensions = 3>
const ParametersType& itk::IdentityTransform< TParametersValueType, NDimensions >::GetParameters ( ) const
inlineoverridevirtual

Get the Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

Definition at line 233 of file itkIdentityTransform.h.

◆ GetTransformCategory()

template<typename TParametersValueType , unsigned int NDimensions = 3>
TransformCategoryEnum itk::IdentityTransform< TParametersValueType, NDimensions >::GetTransformCategory ( ) 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) \]

Implements itk::TransformBaseTemplate< TParametersValueType >.

Definition at line 214 of file itkIdentityTransform.h.

◆ New()

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

◆ SetFixedParameters()

template<typename TParametersValueType , unsigned int NDimensions = 3>
void itk::IdentityTransform< TParametersValueType, NDimensions >::SetFixedParameters ( const FixedParametersType )
inlineoverride

Set the fixed parameters and update internal transformation.

Definition at line 228 of file itkIdentityTransform.h.

◆ SetIdentity()

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

Set the transformation to an Identity

This is a nullptr operation in the case of this particular transform. The method is provided only to comply with the interface of other transforms.

Definition at line 143 of file itkIdentityTransform.h.

◆ SetParameters()

template<typename TParametersValueType , unsigned int NDimensions = 3>
void itk::IdentityTransform< TParametersValueType, NDimensions >::SetParameters ( const ParametersType )
inlineoverride

Set the fixed parameters and update internal transformation.

Definition at line 240 of file itkIdentityTransform.h.

◆ TransformCovariantVector()

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

Definition at line 133 of file itkIdentityTransform.h.

◆ TransformPoint()

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

Method to transform a point.

Definition at line 110 of file itkIdentityTransform.h.

◆ TransformVector() [1/2]

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

Definition at line 118 of file itkIdentityTransform.h.

◆ TransformVector() [2/2]

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

Method to transform a vnl_vector.

Definition at line 125 of file itkIdentityTransform.h.

Member Data Documentation

◆ InputSpaceDimension

template<typename TParametersValueType , unsigned int NDimensions = 3>
constexpr unsigned int itk::IdentityTransform< TParametersValueType, NDimensions >::InputSpaceDimension = NDimensions
staticconstexpr

Dimension of the domain space.

Definition at line 68 of file itkIdentityTransform.h.

◆ m_ZeroJacobian

template<typename TParametersValueType , unsigned int NDimensions = 3>
JacobianType itk::IdentityTransform< TParametersValueType, NDimensions >::m_ZeroJacobian
private

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.

Definition at line 256 of file itkIdentityTransform.h.

◆ OutputSpaceDimension

template<typename TParametersValueType , unsigned int NDimensions = 3>
constexpr unsigned int itk::IdentityTransform< TParametersValueType, NDimensions >::OutputSpaceDimension = NDimensions
staticconstexpr

Definition at line 69 of file itkIdentityTransform.h.


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