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

#include <itkMatrixOffsetTransformBase.h>

+ Inheritance diagram for itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >:
+ Collaboration diagram for itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >:

Public Types

using CenterType = InputPointType
 
using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using FixedParametersValueType = typename Superclass::FixedParametersValueType
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, Self::InputSpaceDimension >
 
using InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType
 
using InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointValueType = typename InputPointType::ValueType
 
using InputSymmetricSecondRankTensorType = typename Superclass::InputSymmetricSecondRankTensorType
 
using InputTensorEigenVectorType = CovariantVector< TParametersValueType, InputDiffusionTensor3DType::Dimension >
 
using InputVectorPixelType = typename Superclass::InputVectorPixelType
 
using InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >
 
using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType
 
using InverseMatrixType = Matrix< TParametersValueType, Self::InputSpaceDimension, Self::OutputSpaceDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using JacobianPositionType = typename Superclass::JacobianPositionType
 
using JacobianType = typename Superclass::JacobianType
 
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 OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType
 
using OutputPointType = Point< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputPointValueType = typename OutputPointType::ValueType
 
using OutputSymmetricSecondRankTensorType = typename Superclass::OutputSymmetricSecondRankTensorType
 
using OutputVectorPixelType = typename Superclass::OutputVectorPixelType
 
using OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVectorValueType = typename OutputVectorType::ValueType
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using Pointer = SmartPointer< Self >
 
using ScalarType = typename Superclass::ScalarType
 
using Self = MatrixOffsetTransformBase
 
using Superclass = Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
 
using TransformCategoryEnum = typename Superclass::TransformCategoryEnum
 
using TranslationType = OutputVectorType
 
using TranslationValueType = typename TranslationType::ValueType
 
- Public Types inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
TransformCategoryEnum GetTransformCategory () const override
 
virtual void SetIdentity ()
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
const FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputPointType TransformPoint (const InputPointType &) const =0
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
virtual void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const =0
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jacobian) const
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
- Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
virtual void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end)=0
 
virtual void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end)=0
 
virtual void SetFixedParameters (const FixedParametersType &)=0
 
virtual void SetParameters (const ParametersType &)=0
 
virtual void SetParametersByValue (const ParametersType &p)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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 = NInputDimensions
 
static constexpr unsigned int OutputSpaceDimension = NOutputDimensions
 
static constexpr unsigned int ParametersDimension = NOutputDimensions * (NInputDimensions + 1)
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
static constexpr unsigned int InputSpaceDimension = NInputDimensions
 
static constexpr unsigned int OutputSpaceDimension = NOutputDimensions
 
MatrixType m_Matrix
 
OutputVectorType m_Offset
 
InverseMatrixType m_InverseMatrix
 
bool m_Singular
 
InputPointType m_Center
 
OutputVectorType m_Translation
 
TimeStamp m_MatrixMTime
 
TimeStamp m_InverseMatrixMTime
 
virtual void SetMatrix (const MatrixType &matrix)
 
virtual const MatrixTypeGetMatrix () const
 
void SetOffset (const OutputVectorType &offset)
 
const OutputVectorTypeGetOffset () const
 
void SetCenter (const InputPointType &center)
 
const InputPointTypeGetCenter () const
 
void SetTranslation (const OutputVectorType &translation)
 
const OutputVectorTypeGetTranslation () const
 
void SetParameters (const ParametersType &parameters) override
 
const ParametersTypeGetParameters () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
const FixedParametersTypeGetFixedParameters () const override
 
void Compose (const Self *other, bool pre=false)
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVectorType TransformVector (const InputVectorType &vector) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const override
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &vector) const override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector) const override
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector) const override
 
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override
 
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override
 
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor) const override
 
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor) const override
 
void ComputeJacobianWithRespectToParameters (const InputPointType &x, JacobianType &j) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, InverseJacobianPositionType &jac) const override
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
bool IsLinear () const override
 
const InverseMatrixTypeGetInverseMatrix () const
 
 MatrixOffsetTransformBase (const MatrixType &matrix, const OutputVectorType &offset)
 
 MatrixOffsetTransformBase (unsigned int paramDims)
 
 MatrixOffsetTransformBase ()
 
 ~MatrixOffsetTransformBase () override=default
 
void PrintSelf (std::ostream &s, Indent indent) const override
 
const InverseMatrixTypeGetVarInverseMatrix () const
 
void SetVarInverseMatrix (const InverseMatrixType &matrix) const
 
bool InverseMatrixIsOld () const
 
virtual void ComputeMatrixParameters ()
 
virtual void ComputeMatrix ()
 
void SetVarMatrix (const MatrixType &matrix)
 
virtual void ComputeTranslation ()
 
void SetVarTranslation (const OutputVectorType &translation)
 
virtual void ComputeOffset ()
 
void SetVarOffset (const OutputVectorType &offset)
 
void SetVarCenter (const InputPointType &center)
 
virtual bool GetSingular () const
 

Additional Inherited Members

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

Detailed Description

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
class itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >

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.
NInputDimensionsThe number of dimensions of the input vector space.
NOutputDimensionsThe 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 (NInputDimension + 1) * NOutputDimension using method SetParameters(). The first (NOutputDimension x NInputDimension) parameters defines the matrix in row-major order (where the column index varies the fastest). The last NOutputDimension 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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::CenterType = InputPointType

Definition at line 186 of file itkMatrixOffsetTransformBase.h.

◆ ConstPointer

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

Definition at line 117 of file itkMatrixOffsetTransformBase.h.

◆ FixedParametersType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::FixedParametersType = typename Superclass::FixedParametersType

Parameters Type

Definition at line 131 of file itkMatrixOffsetTransformBase.h.

◆ FixedParametersValueType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::FixedParametersValueType = typename Superclass::FixedParametersValueType

Definition at line 132 of file itkMatrixOffsetTransformBase.h.

◆ InputCovariantVectorType

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

Standard covariant vector type for this class

Definition at line 153 of file itkMatrixOffsetTransformBase.h.

◆ InputDiffusionTensor3DType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType

Standard diffusion tensor type for this class

Definition at line 160 of file itkMatrixOffsetTransformBase.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InputPointValueType = typename InputPointType::ValueType

Definition at line 175 of file itkMatrixOffsetTransformBase.h.

◆ InputSymmetricSecondRankTensorType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InputSymmetricSecondRankTensorType = typename Superclass::InputSymmetricSecondRankTensorType

Standard tensor type for this class

Definition at line 164 of file itkMatrixOffsetTransformBase.h.

◆ InputTensorEigenVectorType

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

Definition at line 167 of file itkMatrixOffsetTransformBase.h.

◆ InputVectorPixelType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InputVectorPixelType = typename Superclass::InputVectorPixelType

Definition at line 156 of file itkMatrixOffsetTransformBase.h.

◆ InputVectorType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, Self::InputSpaceDimension>

Standard vnl_vector type for this class

Definition at line 170 of file itkMatrixOffsetTransformBase.h.

◆ InverseJacobianPositionType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType

Definition at line 139 of file itkMatrixOffsetTransformBase.h.

◆ InverseMatrixType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

Definition at line 198 of file itkMatrixOffsetTransformBase.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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.

◆ JacobianPositionType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::JacobianPositionType = typename Superclass::JacobianPositionType

Definition at line 138 of file itkMatrixOffsetTransformBase.h.

◆ JacobianType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::JacobianType = typename Superclass::JacobianType

Jacobian Types

Definition at line 137 of file itkMatrixOffsetTransformBase.h.

◆ MatrixType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::MatrixValueType = typename MatrixType::ValueType

Definition at line 181 of file itkMatrixOffsetTransformBase.h.

◆ OffsetType

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

Definition at line 188 of file itkMatrixOffsetTransformBase.h.

◆ OffsetValueType

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

Definition at line 189 of file itkMatrixOffsetTransformBase.h.

◆ OutputCovariantVectorType

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

Definition at line 154 of file itkMatrixOffsetTransformBase.h.

◆ OutputDiffusionTensor3DType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType

Definition at line 161 of file itkMatrixOffsetTransformBase.h.

◆ OutputPointType

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

Definition at line 176 of file itkMatrixOffsetTransformBase.h.

◆ OutputPointValueType

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

Definition at line 177 of file itkMatrixOffsetTransformBase.h.

◆ OutputSymmetricSecondRankTensorType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::OutputSymmetricSecondRankTensorType = typename Superclass::OutputSymmetricSecondRankTensorType

Definition at line 165 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorPixelType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::OutputVectorPixelType = typename Superclass::OutputVectorPixelType

Definition at line 157 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorType

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

Definition at line 149 of file itkMatrixOffsetTransformBase.h.

◆ OutputVectorValueType

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

Definition at line 150 of file itkMatrixOffsetTransformBase.h.

◆ OutputVnlVectorType

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

Definition at line 171 of file itkMatrixOffsetTransformBase.h.

◆ ParametersType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::ParametersType = typename Superclass::ParametersType

Definition at line 133 of file itkMatrixOffsetTransformBase.h.

◆ ParametersValueType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::ParametersValueType = typename Superclass::ParametersValueType

Definition at line 134 of file itkMatrixOffsetTransformBase.h.

◆ Pointer

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

Definition at line 116 of file itkMatrixOffsetTransformBase.h.

◆ ScalarType

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::ScalarType = typename Superclass::ScalarType

Standard scalar type for this class

Definition at line 145 of file itkMatrixOffsetTransformBase.h.

◆ Self

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

Standard type alias

Definition at line 113 of file itkMatrixOffsetTransformBase.h.

◆ Superclass

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

Definition at line 114 of file itkMatrixOffsetTransformBase.h.

◆ TransformCategoryEnum

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
using itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformCategoryEnum = typename Superclass::TransformCategoryEnum

Transform category type.

Definition at line 142 of file itkMatrixOffsetTransformBase.h.

◆ TranslationType

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

Definition at line 191 of file itkMatrixOffsetTransformBase.h.

◆ TranslationValueType

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

Definition at line 193 of file itkMatrixOffsetTransformBase.h.

Constructor & Destructor Documentation

◆ MatrixOffsetTransformBase() [1/3]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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/3]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase ( unsigned int  paramDims)
protected

To avoid recomputation of the inverse if not needed

◆ MatrixOffsetTransformBase() [3/3]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase ( )
protected

To avoid recomputation of the inverse if not needed

◆ ~MatrixOffsetTransformBase()

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

Destroy an MatrixOffsetTransformBase object

Member Function Documentation

◆ Compose()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::ComputeJacobianWithRespectToParameters ( const InputPointType x,
JacobianType j 
) 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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::ComputeMatrix ( )
protectedvirtual

◆ ComputeMatrixParameters()

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

◆ ComputeOffset()

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

To avoid recomputation of the inverse if not needed

◆ ComputeTranslation()

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

To avoid recomputation of the inverse if not needed

◆ CreateAnother()

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

◆ GetCenter()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
const InputPointType& itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 319 of file itkMatrixOffsetTransformBase.h.

◆ GetFixedParameters()

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

Get the Fixed Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetInverse()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
bool itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::GetInverse ( Self 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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
const InverseMatrixType& itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
InverseTransformBasePointer itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

Reimplemented from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >.

◆ GetMatrix()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
virtual const MatrixType& itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 246 of file itkMatrixOffsetTransformBase.h.

◆ GetNameOfClass()

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

◆ GetOffset()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
const OutputVectorType& itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 275 of file itkMatrixOffsetTransformBase.h.

◆ GetParameters()

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

Get the Transformation Parameters.

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ GetSingular()

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

To avoid recomputation of the inverse if not needed

◆ GetTransformCategory()

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

◆ GetTranslation()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
const OutputVectorType& itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 347 of file itkMatrixOffsetTransformBase.h.

◆ GetVarInverseMatrix()

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

To avoid recomputation of the inverse if not needed

Definition at line 523 of file itkMatrixOffsetTransformBase.h.

◆ InverseMatrixIsOld()

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

To avoid recomputation of the inverse if not needed

Definition at line 534 of file itkMatrixOffsetTransformBase.h.

◆ IsLinear()

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

Definition at line 491 of file itkMatrixOffsetTransformBase.h.

◆ New()

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

New macro for creation of through a Smart Pointer

◆ PrintSelf()

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

Print contents of an MatrixOffsetTransformBase

Reimplemented from itk::Object.

◆ SetCenter()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 303 of file itkMatrixOffsetTransformBase.h.

◆ SetFixedParameters()

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

Set the fixed parameters and update internal transformation.

Implements itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >.

◆ SetIdentity()

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

◆ SetMatrix()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
virtual void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 

Definition at line 227 of file itkMatrixOffsetTransformBase.h.

◆ SetOffset()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 260 of file itkMatrixOffsetTransformBase.h.

◆ SetParameters()

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

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

Implements itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >.

◆ SetTranslation()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
void itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 331 of file itkMatrixOffsetTransformBase.h.

◆ SetVarCenter()

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

To avoid recomputation of the inverse if not needed

Definition at line 578 of file itkMatrixOffsetTransformBase.h.

◆ SetVarInverseMatrix()

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

To avoid recomputation of the inverse if not needed

Definition at line 528 of file itkMatrixOffsetTransformBase.h.

◆ SetVarMatrix()

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

To avoid recomputation of the inverse if not needed

Definition at line 553 of file itkMatrixOffsetTransformBase.h.

◆ SetVarOffset()

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

To avoid recomputation of the inverse if not needed

Definition at line 572 of file itkMatrixOffsetTransformBase.h.

◆ SetVarTranslation()

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

To avoid recomputation of the inverse if not needed

Definition at line 563 of file itkMatrixOffsetTransformBase.h.

◆ TransformCovariantVector() [1/2]

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

To avoid recomputation of the inverse if not needed

◆ TransformCovariantVector() [2/2]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformCovariantVector ( const InputVectorPixelType vector) const
override

To avoid recomputation of the inverse if not needed

◆ TransformDiffusionTensor3D() [1/2]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputDiffusionTensor3DType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformDiffusionTensor3D ( const InputDiffusionTensor3DType tensor) const
override

To avoid recomputation of the inverse if not needed

◆ TransformDiffusionTensor3D() [2/2]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformDiffusionTensor3D ( const InputVectorPixelType tensor) const
override

To avoid recomputation of the inverse if not needed

◆ TransformPoint()

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputPointType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::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 NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputSymmetricSecondRankTensorType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformSymmetricSecondRankTensor ( const InputSymmetricSecondRankTensorType tensor) const
override

To avoid recomputation of the inverse if not needed

◆ TransformSymmetricSecondRankTensor() [2/2]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformSymmetricSecondRankTensor ( const InputVectorPixelType tensor) const
override

To avoid recomputation of the inverse if not needed

◆ TransformVector() [1/3]

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::TransformVector ( const InputVectorPixelType vector) const
override

To avoid recomputation of the inverse if not needed

◆ TransformVector() [2/3]

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

To avoid recomputation of the inverse if not needed

◆ TransformVector() [3/3]

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

To avoid recomputation of the inverse if not needed

Member Data Documentation

◆ InputSpaceDimension

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

Dimension of the domain space.

Definition at line 126 of file itkMatrixOffsetTransformBase.h.

◆ m_Center

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
InputPointType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::m_Center
private

To avoid recomputation of the inverse if not needed

Definition at line 591 of file itkMatrixOffsetTransformBase.h.

◆ m_InverseMatrix

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
InverseMatrixType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::m_InverseMatrix
mutableprivate

To avoid recomputation of the inverse if not needed

Definition at line 588 of file itkMatrixOffsetTransformBase.h.

◆ m_InverseMatrixMTime

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

To avoid recomputation of the inverse if not needed

Definition at line 596 of file itkMatrixOffsetTransformBase.h.

◆ m_Matrix

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
MatrixType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::m_Matrix
private

To avoid recomputation of the inverse if not needed

Definition at line 583 of file itkMatrixOffsetTransformBase.h.

◆ m_MatrixMTime

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

To avoid recomputation of the inverse if not needed

Definition at line 595 of file itkMatrixOffsetTransformBase.h.

◆ m_Offset

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputVectorType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::m_Offset
private

To avoid recomputation of the inverse if not needed

Definition at line 587 of file itkMatrixOffsetTransformBase.h.

◆ m_Singular

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
bool itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::m_Singular
mutableprivate

To avoid recomputation of the inverse if not needed

Definition at line 589 of file itkMatrixOffsetTransformBase.h.

◆ m_Translation

template<typename TParametersValueType = double, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
OutputVectorType itk::MatrixOffsetTransformBase< TParametersValueType, NInputDimensions, NOutputDimensions >::m_Translation
private

To avoid recomputation of the inverse if not needed

Definition at line 592 of file itkMatrixOffsetTransformBase.h.

◆ OutputSpaceDimension

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

Definition at line 127 of file itkMatrixOffsetTransformBase.h.

◆ ParametersDimension

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

Definition at line 128 of file itkMatrixOffsetTransformBase.h.


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