ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | Friends | List of all members
itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension > Class Template Reference

#include <itkMatrixOffsetTransformBase.h>

+ Inheritance diagram for itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >:
+ Collaboration diagram for itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >:

Public Types

using CenterType = InputPointType
 
using ConstPointer = SmartPointer< const Self >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointValueType = typename InputPointType::ValueType
 
using InputTensorEigenVectorType = CovariantVector< TParametersValueType, InputDiffusionTensor3DType::Dimension >
 
using InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >
 
using InverseMatrixType = Matrix< TParametersValueType, Self::InputSpaceDimension, Self::OutputSpaceDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using InverseTransformType = MatrixOffsetTransformBase< TParametersValueType, VOutputDimension, VInputDimension >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using MatrixValueType = typename MatrixType::ValueType
 
using OffsetType = OutputVectorType
 
using OffsetValueType = typename OffsetType::ValueType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputPointValueType = typename OutputPointType::ValueType
 
using OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVectorValueType = typename OutputVectorType::ValueType
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = MatrixOffsetTransformBase
 
using Superclass = Transform< TParametersValueType, VInputDimension, VOutputDimension >
 
using TranslationType = OutputVectorType
 
using TranslationValueType = typename TranslationType::ValueType
 
- Public Types inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, VInputDimension >
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, VInputDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VInputDimension >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = Transform< TParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianType = Array2D< ParametersValueType >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >
 
using OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, VOutputDimension >
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, VOutputDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VOutputDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = Transform
 
using Superclass = TransformBaseTemplate< TParametersValueType >
 
- 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 Compose (const Self *other, bool pre=false)
 
void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jac) const override
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &jacobian) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
const InputPointTypeGetCenter () const
 
const FixedParametersTypeGetFixedParameters () const override
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const MatrixTypeGetMatrix () const
 
virtual const char * GetNameOfClass () const
 
const OutputVectorTypeGetOffset () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const OutputVectorTypeGetTranslation () const
 
bool IsLinear () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
virtual void SetIdentity ()
 
void SetParameters (const ParametersType &parameters) override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vec) const override
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vect) const override
 
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override
 
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor) const override
 
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const override
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &vect) const override
 
OutputVectorType TransformVector (const InputVectorType &vect) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vect) const override
 
virtual void SetMatrix (const MatrixType &matrix)
 
void SetOffset (const OutputVectorType &offset)
 
void SetCenter (const InputPointType &center)
 
void SetTranslation (const OutputVectorType &translation)
 
bool GetInverse (InverseTransformType *inverse) const
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
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 &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const =0
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) 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 ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &pnt, InverseJacobianPositionType &jacobian) const
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
template<typename TImage >
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (TImage *image) const
 
template<typename TImage >
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int InputSpaceDimension = VInputDimension
 
static constexpr unsigned int OutputSpaceDimension = VOutputDimension
 
static constexpr unsigned int ParametersDimension = VOutputDimension * (VInputDimension + 1)
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
static constexpr unsigned int InputSpaceDimension = VInputDimension
 
static constexpr unsigned int OutputSpaceDimension = VOutputDimension
 

Protected Member Functions

virtual void ComputeMatrix ()
 
virtual void ComputeMatrixParameters ()
 
virtual void ComputeOffset ()
 
virtual void ComputeTranslation ()
 
const InverseMatrixTypeGetInverseMatrix () const
 
virtual bool GetSingular () const
 
const InverseMatrixTypeGetVarInverseMatrix () const
 
bool InverseMatrixIsOld () const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void SetVarCenter (const InputPointType &center)
 
void SetVarInverseMatrix (const InverseMatrixType &matrix) const
 
void SetVarMatrix (const MatrixType &matrix)
 
void SetVarOffset (const OutputVectorType &offset)
 
void SetVarTranslation (const OutputVectorType &translation)
 
 ~MatrixOffsetTransformBase () override=default
 
 MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset)
 
 MatrixOffsetTransformBase (unsigned int paramDims=ParametersDimension)
 
- Protected Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
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 itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 ()
 

Private Attributes

InputPointType m_Center {}
 
InverseMatrixType m_InverseMatrix { InverseMatrixType::GetIdentity() }
 
TimeStamp m_InverseMatrixMTime
 
MatrixType m_Matrix { MatrixType::GetIdentity() }
 
TimeStamp m_MatrixMTime
 
OutputVectorType m_Offset {}
 
bool m_Singular { false }
 
OutputVectorType m_Translation {}
 

Friends

class MatrixOffsetTransformBase< TParametersValueType, VOutputDimension, VInputDimension >
 

Additional Inherited Members

- Protected Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
class itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >

Matrix and Offset transformation of a vector space (e.g. space coordinates)

This class serves as a base class for transforms that can be expressed as a linear transformation plus a constant offset (e.g., affine, similarity and rigid transforms). This base class also provides the concept of using a center of rotation and a translation instead of an offset.

As derived instances of this class are specializations of an affine transform, any two of these transformations may be composed and the result is an affine transformation. However, the order is important. Given two affine transformations T1 and T2, we will say that "precomposing T1 with T2" yields the transformation which applies T1 to the source, and then applies T2 to that result to obtain the target. Conversely, we will say that "postcomposing T1 with T2" yields the transformation which applies T2 to the source, and then applies T1 to that result to obtain the target. (Whether T1 or T2 comes first lexicographically depends on whether you choose to write mappings from right-to-left or vice versa; we avoid the whole problem by referring to the order of application rather than the textual order.)

Template Parameters
TParametersValueTypeThe type to be used for scalar numeric values. Either float or double.
VInputDimensionThe number of dimensions of the input vector space.
VOutputDimensionThe number of dimensions of the output vector space.

This class provides several methods for setting the matrix and offset defining the transform. To support the registration framework, the transform parameters can also be set as an Array<TParametersValueType> of size (VInputDimension + 1) * VOutputDimension using method SetParameters(). The first (VOutputDimension x VInputDimension) parameters defines the matrix in row-major order (where the column index varies the fastest). The last VOutputDimension parameters defines the translation in each dimensions.

Examples
SphinxExamples/src/IO/TransformFactory/RegisterTransformWithTransformFactory/Code.cxx.

Definition at line 106 of file itkMatrixOffsetTransformBase.h.

Member Typedef Documentation

◆ CenterType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::CenterType = InputPointType

Definition at line 186 of file itkMatrixOffsetTransformBase.h.

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 117 of file itkMatrixOffsetTransformBase.h.

◆ InputCovariantVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputCovariantVectorType = CovariantVector<TParametersValueType, Self::InputSpaceDimension>

Standard covariant vector type for this class

Definition at line 153 of file itkMatrixOffsetTransformBase.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputPointType = Point<TParametersValueType, Self::InputSpaceDimension>

Standard coordinate point type for this class

Definition at line 174 of file itkMatrixOffsetTransformBase.h.

◆ InputPointValueType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputPointValueType = typename InputPointType::ValueType

Definition at line 175 of file itkMatrixOffsetTransformBase.h.

◆ InputTensorEigenVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputTensorEigenVectorType = CovariantVector<TParametersValueType, InputDiffusionTensor3DType::Dimension>

Definition at line 167 of file itkMatrixOffsetTransformBase.h.

◆ InputVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputVectorType = Vector<TParametersValueType, Self::InputSpaceDimension>

Standard vector type for this class

Definition at line 148 of file itkMatrixOffsetTransformBase.h.

◆ InputVnlVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::InputSpaceDimension>

Standard vnl_vector type for this class

Definition at line 170 of file itkMatrixOffsetTransformBase.h.

◆ InverseMatrixType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InverseMatrixType = Matrix<TParametersValueType, Self::InputSpaceDimension, Self::OutputSpaceDimension>

Standard inverse matrix type for this class

Definition at line 184 of file itkMatrixOffsetTransformBase.h.

◆ InverseTransformBasePointer

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

Definition at line 198 of file itkMatrixOffsetTransformBase.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::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 197 of file itkMatrixOffsetTransformBase.h.

◆ InverseTransformType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InverseTransformType = MatrixOffsetTransformBase<TParametersValueType, VOutputDimension, VInputDimension>

Definition at line 200 of file itkMatrixOffsetTransformBase.h.

◆ MatrixType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixType = Matrix<TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension>

Standard matrix type for this class

Definition at line 180 of file itkMatrixOffsetTransformBase.h.

◆ MatrixValueType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixValueType = typename MatrixType::ValueType

Definition at line 181 of file itkMatrixOffsetTransformBase.h.

◆ OffsetType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OffsetType = OutputVectorType

Definition at line 188 of file itkMatrixOffsetTransformBase.h.

◆ OffsetValueType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OffsetValueType = typename OffsetType::ValueType

Definition at line 189 of file itkMatrixOffsetTransformBase.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputCovariantVectorType = CovariantVector<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 154 of file itkMatrixOffsetTransformBase.h.

◆ OutputPointType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputPointType = Point<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 176 of file itkMatrixOffsetTransformBase.h.

◆ OutputPointValueType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputPointValueType = typename OutputPointType::ValueType

Definition at line 177 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputVectorType = Vector<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 149 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorValueType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputVectorValueType = typename OutputVectorType::ValueType

Definition at line 150 of file itkMatrixOffsetTransformBase.h.

◆ OutputVnlVectorType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::OutputSpaceDimension>

Definition at line 171 of file itkMatrixOffsetTransformBase.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::Pointer = SmartPointer<Self>

Definition at line 116 of file itkMatrixOffsetTransformBase.h.

◆ Self

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::Self = MatrixOffsetTransformBase

Standard type alias

Definition at line 113 of file itkMatrixOffsetTransformBase.h.

◆ Superclass

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

Definition at line 114 of file itkMatrixOffsetTransformBase.h.

◆ TranslationType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TranslationType = OutputVectorType

Definition at line 191 of file itkMatrixOffsetTransformBase.h.

◆ TranslationValueType

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TranslationValueType = typename TranslationType::ValueType

Definition at line 193 of file itkMatrixOffsetTransformBase.h.

Constructor & Destructor Documentation

◆ MatrixOffsetTransformBase() [1/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixOffsetTransformBase ( const MatrixType matrix,
const OutputVectorType offset 
)
protected

Construct an MatrixOffsetTransformBase object

This method constructs a new MatrixOffsetTransformBase object and
initializes the matrix and offset parts of the transformation
to values specified by the caller.  If the arguments are
omitted, then the MatrixOffsetTransformBase is initialized to an identity
transformation in the appropriate number of dimensions. 

◆ MatrixOffsetTransformBase() [2/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixOffsetTransformBase ( unsigned int  paramDims = ParametersDimension)
explicitprotected

Construct an MatrixOffsetTransformBase object

This method constructs a new MatrixOffsetTransformBase object and
initializes the matrix and offset parts of the transformation
to values specified by the caller.  If the arguments are
omitted, then the MatrixOffsetTransformBase is initialized to an identity
transformation in the appropriate number of dimensions. 

◆ ~MatrixOffsetTransformBase()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::~MatrixOffsetTransformBase ( )
overrideprotecteddefault

Destroy an MatrixOffsetTransformBase object

Member Function Documentation

◆ Compose()

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

Compose with another MatrixOffsetTransformBase

This method composes self with another MatrixOffsetTransformBase of the same dimension, modifying self to be the composition of self and other. If the argument pre is true, then other is precomposed with self; that is, the resulting transformation consists of first applying other to the source, followed by self. If pre is false or omitted, then other is post-composed with self; that is the resulting transformation consists of first applying self to the source, followed by other. This updates the Translation based on current center.

◆ ComputeInverseJacobianWithRespectToPosition()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeInverseJacobianWithRespectToPosition ( const InputPointType x,
InverseJacobianPositionType jac 
) const
override

Get the jacobian with respect to position. This simply returns the inverse of the current Matrix. jac will be resized as needed, but it's more efficient if it's already properly sized.

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeJacobianWithRespectToParameters ( const InputPointType p,
JacobianType jacobian 
) const
override

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. Get local Jacobian for the given point j will sized properly as needed.

◆ ComputeJacobianWithRespectToPosition()

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

Get the jacobian with respect to position. This simply returns the current Matrix. jac will be resized as needed, but it's more efficient if it's already properly sized.

◆ ComputeMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeMatrix ( )
protectedvirtual

◆ ComputeMatrixParameters()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeMatrixParameters ( )
protectedvirtual

◆ ComputeOffset()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeOffset ( )
protectedvirtual

◆ ComputeTranslation()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeTranslation ( )
protectedvirtual

◆ GetCenter()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
const InputPointType& itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetCenter ( ) const
inline

Get center of rotation of the MatrixOffsetTransformBase

This method returns the point used as the fixed center of rotation for the MatrixOffsetTransformBase. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset

Definition at line 324 of file itkMatrixOffsetTransformBase.h.

◆ GetFixedParameters()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
const FixedParametersType& itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetFixedParameters ( ) const
overridevirtual

Get the Fixed Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
bool itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetInverse ( InverseTransformType inverse) const

Create inverse of an affine transformation

This populates the parameters an affine transform such that
the transform is the inverse of self. If self is not invertible,
an exception is thrown.
Note that by default the inverese transform is centered at
the origin. If you need to compute the inverse centered at a point, p,

\code
transform2->SetCenter( p );
transform1->GetInverse( transform2 );
\endcode

transform2 will now contain the inverse of transform1 and will
with its center set to p. Flipping the two statements will produce an
incorrect transform.

◆ GetInverseMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
const InverseMatrixType& itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetInverseMatrix ( ) const
protected
Deprecated:
Use GetInverse for public API instead. Method will eventually be made a protected member function

◆ GetInverseTransform()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
InverseTransformBasePointer itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ GetMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual const MatrixType& itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetMatrix ( ) const
inlinevirtual

Get matrix of an MatrixOffsetTransformBase

This method returns the value of the matrix of the MatrixOffsetTransformBase. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset

Definition at line 251 of file itkMatrixOffsetTransformBase.h.

◆ GetNameOfClass()

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

◆ GetOffset()

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

Get offset of an MatrixOffsetTransformBase

This method returns the offset value of the MatrixOffsetTransformBase. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset

Definition at line 280 of file itkMatrixOffsetTransformBase.h.

◆ GetParameters()

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

Get the Transformation Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetSingular()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual bool itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetSingular ( ) const
protectedvirtual

◆ GetTransformCategory()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
TransformCategoryEnum itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::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 215 of file itkMatrixOffsetTransformBase.h.

◆ GetTranslation()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
const OutputVectorType& itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetTranslation ( ) const
inline

Get translation component of the MatrixOffsetTransformBase

This method returns the translation used after rotation about the center point. To define an affine transform, you must set the matrix, center, and translation OR the matrix and offset

Definition at line 352 of file itkMatrixOffsetTransformBase.h.

◆ GetVarInverseMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
const InverseMatrixType& itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::GetVarInverseMatrix ( ) const
inlineprotected

Definition at line 527 of file itkMatrixOffsetTransformBase.h.

◆ InverseMatrixIsOld()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
bool itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InverseMatrixIsOld ( ) const
inlineprotected

Definition at line 538 of file itkMatrixOffsetTransformBase.h.

◆ IsLinear()

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

Definition at line 496 of file itkMatrixOffsetTransformBase.h.

◆ New()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
static Pointer itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::New ( )
static

New macro for creation of through a Smart Pointer

◆ PrintSelf()

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

Print contents of an MatrixOffsetTransformBase

Reimplemented from itk::Object.

◆ SetCenter()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetCenter ( const InputPointType center)
inline

Set center of rotation of an MatrixOffsetTransformBase

This method sets the center of rotation of an MatrixOffsetTransformBase
to a fixed point - for most transforms derived from this class,
this point is not a "parameter" of the transform - the exception is that
"centered" transforms have center as a parameter during optimization.

This method updates offset wrt to current translation and matrix.
That is, changing the center changes the transform!

WARNING: When using the Center, we strongly recommend only changing the
matrix and translation to define a transform.   Changing a transform's
center, changes the mapping between spaces - specifically, translation is
not changed with respect to that new center, and so the offset is updated
to * maintain the consistency with translation.   If a center is not used,
or is set before the matrix and the offset, then it is safe to change the
offset directly.
       As a rule of thumb, if you wish to set the center explicitly, set
before Offset computations are done.

To define an affine transform, you must set the matrix,
center, and translation OR the matrix and offset 

Definition at line 308 of file itkMatrixOffsetTransformBase.h.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetFixedParameters ( const FixedParametersType )
overridevirtual

Set the fixed parameters and update internal transformation.

Implements itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ SetIdentity()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetIdentity ( )
virtual

◆ SetMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetMatrix ( const MatrixType matrix)
inlinevirtual

Set matrix of an MatrixOffsetTransformBase

This method sets the matrix of an MatrixOffsetTransformBase to a
value specified by the user.

This updates the Offset wrt to current translation
and center.  See the warning regarding offset-versus-translation
in the documentation for SetCenter.

To define an affine transform, you must set the matrix,
center, and translation OR the matrix and offset 

Reimplemented in itk::Similarity2DTransform< TParametersValueType >, itk::Rigid2DTransform< TParametersValueType >, itk::Rigid3DTransform< TParametersValueType >, itk::ScaleSkewVersor3DTransform< TParametersValueType >, itk::ComposeScaleSkewVersor3DTransform< TParametersValueType >, itk::Similarity3DTransform< TParametersValueType >, and itk::ScaleVersor3DTransform< TParametersValueType >.

Definition at line 232 of file itkMatrixOffsetTransformBase.h.

◆ SetOffset()

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

Set offset (origin) of an MatrixOffset TransformBase.

This method sets the offset of an MatrixOffsetTransformBase to a
value specified by the user.
This updates Translation wrt current center.  See the warning regarding
offset-versus-translation in the documentation for SetCenter.
To define an affine transform, you must set the matrix,
center, and translation OR the matrix and offset 

Definition at line 265 of file itkMatrixOffsetTransformBase.h.

◆ SetParameters()

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

Set the transformation from a container of parameters. The first (VOutputDimension x VInputDimension) parameters define the matrix and the last VOutputDimension parameters the translation. Offset is updated based on current center.

Implements itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ SetTranslation()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetTranslation ( const OutputVectorType translation)
inline

Set translation of an MatrixOffsetTransformBase

This method sets the translation of an MatrixOffsetTransformBase.
This updates Offset to reflect current translation.
To define an affine transform, you must set the matrix,
center, and translation OR the matrix and offset 

Definition at line 336 of file itkMatrixOffsetTransformBase.h.

◆ SetVarCenter()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetVarCenter ( const InputPointType center)
inlineprotected

Definition at line 582 of file itkMatrixOffsetTransformBase.h.

◆ SetVarInverseMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetVarInverseMatrix ( const InverseMatrixType matrix) const
inlineprotected

Definition at line 532 of file itkMatrixOffsetTransformBase.h.

◆ SetVarMatrix()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetVarMatrix ( const MatrixType matrix)
inlineprotected

Definition at line 557 of file itkMatrixOffsetTransformBase.h.

◆ SetVarOffset()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetVarOffset ( const OutputVectorType offset)
inlineprotected

Definition at line 576 of file itkMatrixOffsetTransformBase.h.

◆ SetVarTranslation()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::SetVarTranslation ( const OutputVectorType translation)
inlineprotected

Definition at line 567 of file itkMatrixOffsetTransformBase.h.

◆ TransformCovariantVector() [1/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputCovariantVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputCovariantVectorType vec) const
override

◆ TransformCovariantVector() [2/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputVectorPixelType ) const
overridevirtual

◆ TransformDiffusionTensor3D() [1/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputDiffusionTensor3DType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformDiffusionTensor3D ( const InputDiffusionTensor3DType ) const
overridevirtual

Method to transform a diffusion tensor

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ TransformDiffusionTensor3D() [2/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformDiffusionTensor3D ( const InputVectorPixelType ) const
overridevirtual

Method to transform a diffusion tensor stored in a VectorImage

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ TransformPoint()

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputPointType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::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. The TransformPoint method transforms its argument as an affine point, whereas the TransformVector method transforms its argument as a vector.

◆ TransformSymmetricSecondRankTensor() [1/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputSymmetricSecondRankTensorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformSymmetricSecondRankTensor ( const InputSymmetricSecondRankTensorType ) const
overridevirtual

Method to transform a ssr tensor stored in a VectorImage

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ TransformSymmetricSecondRankTensor() [2/2]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformSymmetricSecondRankTensor ( const InputVectorPixelType ) const
overridevirtual

Method to transform a ssr tensor stored in a VectorImage

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ TransformVector() [1/3]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorPixelType ) const
overridevirtual

Method to transform a vector stored in a VectorImage.

Reimplemented from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >.

◆ TransformVector() [2/3]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorType vect) const
override

◆ TransformVector() [3/3]

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVnlVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVnlVectorType vect) const
override

Friends And Related Function Documentation

◆ MatrixOffsetTransformBase< TParametersValueType, VOutputDimension, VInputDimension >

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
friend class MatrixOffsetTransformBase< TParametersValueType, VOutputDimension, VInputDimension >
friend

InverseTransformType must be a friend to allow the generation of a transformation from its inverse (function GetInverse).

Definition at line 203 of file itkMatrixOffsetTransformBase.h.

Member Data Documentation

◆ InputSpaceDimension

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
constexpr unsigned int itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::InputSpaceDimension = VInputDimension
staticconstexpr

Dimension of the domain space.

Definition at line 126 of file itkMatrixOffsetTransformBase.h.

◆ m_Center

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
InputPointType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_Center {}
private

Definition at line 595 of file itkMatrixOffsetTransformBase.h.

◆ m_InverseMatrix

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
InverseMatrixType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_InverseMatrix { InverseMatrixType::GetIdentity() }
mutableprivate

Definition at line 592 of file itkMatrixOffsetTransformBase.h.

◆ m_InverseMatrixMTime

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
TimeStamp itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_InverseMatrixMTime
mutableprivate

Definition at line 600 of file itkMatrixOffsetTransformBase.h.

◆ m_Matrix

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
MatrixType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_Matrix { MatrixType::GetIdentity() }
private

Definition at line 590 of file itkMatrixOffsetTransformBase.h.

◆ m_MatrixMTime

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
TimeStamp itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_MatrixMTime
private

To avoid recomputation of the inverse if not needed

Definition at line 599 of file itkMatrixOffsetTransformBase.h.

◆ m_Offset

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_Offset {}
private

Definition at line 591 of file itkMatrixOffsetTransformBase.h.

◆ m_Singular

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
bool itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_Singular { false }
mutableprivate

Definition at line 593 of file itkMatrixOffsetTransformBase.h.

◆ m_Translation

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
OutputVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::m_Translation {}
private

Definition at line 596 of file itkMatrixOffsetTransformBase.h.

◆ OutputSpaceDimension

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
constexpr unsigned int itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::OutputSpaceDimension = VOutputDimension
staticconstexpr

Definition at line 127 of file itkMatrixOffsetTransformBase.h.

◆ ParametersDimension

template<typename TParametersValueType = double, unsigned int VInputDimension = 3, unsigned int VOutputDimension = 3>
constexpr unsigned int itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ParametersDimension = VOutputDimension * (VInputDimension + 1)
staticconstexpr

Definition at line 128 of file itkMatrixOffsetTransformBase.h.


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