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

#include <itkScaleTransform.h>

Detailed Description

template<typename TParametersValueType = float, unsigned int VDimension = 3>
class itk::ScaleTransform< TParametersValueType, VDimension >

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

The same functionality could be obtained by using the Affine transform, but with a large difference in performance since the affine transform will use a matrix multiplication using a diagonal matrix.

The ND Parameters represent the scale in each dimension. The ND FixedParameters represent the fixed point (i.e. center point) from which scaling originates.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Common/DirectWarningToFile/Code.cxx, SphinxExamples/src/Core/Transform/CopyACompositeTransform/Code.cxx, SphinxExamples/src/Core/Transform/ScaleAnImage/Code.cxx, and SphinxExamples/src/Filtering/ImageGrid/ResampleAnImage/Code.cxx.

Definition at line 45 of file itkScaleTransform.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, VDimension >
 
using InputPointType = Point< TParametersValueType, VDimension >
 
using InputVectorType = Vector< TParametersValueType, VDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, VDimension >
 
using OutputPointType = Point< TParametersValueType, VDimension >
 
using OutputVectorType = Vector< TParametersValueType, VDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VDimension >
 
using Pointer = SmartPointer< Self >
 
using ScaleType = FixedArray< TParametersValueType, VDimension >
 
using Self = ScaleTransform
 
using Superclass = MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
 
- Public Types inherited from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
using CenterType = InputPointType
 
using ConstPointer = SmartPointer< const Self >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, Self::InputSpaceDimension >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputPointType = Point< TParametersValueType, Self::InputSpaceDimension >
 
using InputPointValueType = typename InputPointType::ValueType
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
 
using InputTensorEigenVectorType = CovariantVector< TParametersValueType, InputDiffusionTensor3DType::Dimension >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, Self::InputSpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::InputSpaceDimension >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
 
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 JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianType = Array2D< ParametersValueType >
 
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 = DiffusionTensor3D< TParametersValueType >
 
using OutputPointType = Point< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputPointValueType = typename OutputPointType::ValueType
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, Self::OutputSpaceDimension >
 
using OutputVectorValueType = typename OutputVectorType::ValueType
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, Self::OutputSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
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 Member Functions

InputCovariantVectorType BackTransform (const OutputCovariantVectorType &vect) const
 
InputPointType BackTransform (const OutputPointType &point) const
 
InputVectorType BackTransform (const OutputVectorType &vect) const
 
InputVnlVectorType BackTransform (const OutputVnlVectorType &vect) const
 
void Compose (const Self *other, bool pre=false)
 
void ComputeJacobianWithRespectToParameters (const InputPointType &p, JacobianType &j) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
void ComputeMatrix () override
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
const char * GetNameOfClass () const override
 
const ParametersType & GetParameters () const override
 
virtual const ScaleType & GetScale () const
 
void Scale (const ScaleType &scale, bool pre=false)
 
void SetIdentity () override
 
void SetParameters (const ParametersType &parameters) override
 
void SetScale (const ScaleType &scale)
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vect) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVectorType TransformVector (const InputVectorType &vect) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vect) const override
 
- Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
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
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
const InputPointType & GetCenter () const
 
const FixedParametersType & GetFixedParameters () const override
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const MatrixType & GetMatrix () const
 
const char * GetNameOfClass () const override
 
const OutputVectorType & GetOffset () const
 
const ParametersType & GetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
const OutputVectorType & GetTranslation () const
 
bool IsLinear () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
void SetParameters (const ParametersType &parameters) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vec) const override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vect) const override
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
 
OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor) const override
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor) const override
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor) const override
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &vect) const override
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &) const
 
OutputVectorType TransformVector (const InputVectorType &vect) const override
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vect) const override
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
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 FixedParametersType & GetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
const char * GetNameOfClass () const override
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersType & GetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
 itkCloneMacro (Self)
 
void SetParametersByValue (const ParametersType &p) override
 
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 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 &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
template<typename TImage >
template< typename TImage > std std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ParametersDimension = VDimension
 
static constexpr unsigned int SpaceDimension = VDimension
 
- Static Public Attributes inherited from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
static constexpr unsigned int ParametersDimension
 
- 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

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ScaleTransform ()
 
 ~ScaleTransform () override=default
 
- Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
virtual void ComputeMatrixParameters ()
 
virtual void ComputeOffset ()
 
virtual void ComputeTranslation ()
 
const InverseMatrixType & GetInverseMatrix () const
 
virtual bool GetSingular () const
 
const InverseMatrixType & GetVarInverseMatrix () 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 (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
 

Private Attributes

ScaleType m_Scale {}
 

Additional Inherited Members

- Public Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
InverseJacobianPositionType &jacobian const
 
- Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
template<typename TTransform >
static InverseTransformBasePointer InvertTransform (const TTransform &transform)
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >
FixedParametersType m_FixedParameters {}
 
ParametersType m_Parameters {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 55 of file itkScaleTransform.h.

◆ InputCovariantVectorType

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

Standard covariant vector type for this class.

Definition at line 87 of file itkScaleTransform.h.

◆ InputPointType

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

Standard coordinate point type for this class.

Definition at line 95 of file itkScaleTransform.h.

◆ InputVectorType

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

Standard vector type for this class.

Definition at line 83 of file itkScaleTransform.h.

◆ InputVnlVectorType

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

Standard vnl_vector type for this class.

Definition at line 91 of file itkScaleTransform.h.

◆ InverseTransformBasePointer

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

Definition at line 101 of file itkScaleTransform.h.

◆ InverseTransformBaseType

template<typename TParametersValueType = float, unsigned int VDimension = 3>
using itk::ScaleTransform< TParametersValueType, VDimension >::InverseTransformBaseType = typename Superclass::InverseTransformBaseType

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

Definition at line 100 of file itkScaleTransform.h.

◆ OutputCovariantVectorType

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

Definition at line 88 of file itkScaleTransform.h.

◆ OutputPointType

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

Definition at line 96 of file itkScaleTransform.h.

◆ OutputVectorType

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

Definition at line 84 of file itkScaleTransform.h.

◆ OutputVnlVectorType

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

Definition at line 92 of file itkScaleTransform.h.

◆ Pointer

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

Definition at line 54 of file itkScaleTransform.h.

◆ ScaleType

template<typename TParametersValueType = float, unsigned int VDimension = 3>
using itk::ScaleTransform< TParametersValueType, VDimension >::ScaleType = FixedArray<TParametersValueType, VDimension>

Standard vector type for this class.

Definition at line 80 of file itkScaleTransform.h.

◆ Self

template<typename TParametersValueType = float, unsigned int VDimension = 3>
using itk::ScaleTransform< TParametersValueType, VDimension >::Self = ScaleTransform

Standard class type aliases.

Definition at line 52 of file itkScaleTransform.h.

◆ Superclass

template<typename TParametersValueType = float, unsigned int VDimension = 3>
using itk::ScaleTransform< TParametersValueType, VDimension >::Superclass = MatrixOffsetTransformBase<TParametersValueType, VDimension, VDimension>

Definition at line 53 of file itkScaleTransform.h.

Constructor & Destructor Documentation

◆ ScaleTransform()

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

Construct an ScaleTransform object.

◆ ~ScaleTransform()

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

Destroy an ScaleTransform object.

Member Function Documentation

◆ BackTransform() [1/4]

template<typename TParametersValueType = float, unsigned int VDimension = 3>
InputCovariantVectorType itk::ScaleTransform< TParametersValueType, VDimension >::BackTransform ( const OutputCovariantVectorType &  vect) const
inline

◆ BackTransform() [2/4]

template<typename TParametersValueType = float, unsigned int VDimension = 3>
InputPointType itk::ScaleTransform< TParametersValueType, VDimension >::BackTransform ( const OutputPointType &  point) const
inline

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

◆ BackTransform() [3/4]

template<typename TParametersValueType = float, unsigned int VDimension = 3>
InputVectorType itk::ScaleTransform< TParametersValueType, VDimension >::BackTransform ( const OutputVectorType &  vect) const
inline

◆ BackTransform() [4/4]

template<typename TParametersValueType = float, unsigned int VDimension = 3>
InputVnlVectorType itk::ScaleTransform< TParametersValueType, VDimension >::BackTransform ( const OutputVnlVectorType &  vect) const
inline

◆ Compose()

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

Compose with another ScaleTransform.

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
void itk::ScaleTransform< TParametersValueType, VDimension >::ComputeJacobianWithRespectToParameters ( const InputPointType &  p,
JacobianType &  j 
) const
override

Get the Jacobian matrix.

◆ ComputeJacobianWithRespectToPosition()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
void itk::ScaleTransform< TParametersValueType, VDimension >::ComputeJacobianWithRespectToPosition ( const InputPointType &  x,
JacobianPositionType &  jac 
) const
override

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

◆ ComputeMatrix()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
void itk::ScaleTransform< TParametersValueType, VDimension >::ComputeMatrix ( )
overridevirtual

Reimplemented from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >.

◆ GetInverse()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
bool itk::ScaleTransform< TParametersValueType, VDimension >::GetInverse ( Self *  inverse) const

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

◆ GetInverseTransform()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
InverseTransformBasePointer itk::ScaleTransform< TParametersValueType, VDimension >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

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

◆ GetNameOfClass()

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

◆ GetParameters()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
const ParametersType& itk::ScaleTransform< TParametersValueType, VDimension >::GetParameters ( ) const
override

Get the parameters that uniquely define the transform This is typically used by optimizers during the process of image registration. The parameters are organized as {scale X, scale Y, scale Z } = { parameter[0], parameter[1], parameter[2] } respectively

◆ GetScale()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
virtual const ScaleType& itk::ScaleTransform< TParametersValueType, VDimension >::GetScale ( ) const
virtual

Get access to scale values

◆ New()

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

New macro for creation of through a smart pointer.

◆ PrintSelf()

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

Print contents of an ScaleTransform

◆ Scale()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
void itk::ScaleTransform< TParametersValueType, VDimension >::Scale ( const ScaleType &  scale,
bool  pre = false 
)

Compose this transform transformation with another scaling. The pre argument is irrelevant here since scale transforms are commutative, pre and postcomposition are therefore equivalent.

◆ SetIdentity()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
void itk::ScaleTransform< TParametersValueType, VDimension >::SetIdentity ( )
overridevirtual

Set the transformation to an Identity

This sets all the scales to 1.0

Reimplemented from itk::MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >.

◆ SetParameters()

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

Set parameters. This method sets the parameters for the transform value specified by the user. The parameters are organized as scale[i] = parameter[i]. That means that in 3D the scale parameters for the coordinates {x,y,z} are {parameter[0], parameter[1], parameter[2]} respectively

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

◆ SetScale()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
void itk::ScaleTransform< TParametersValueType, VDimension >::SetScale ( const ScaleType &  scale)

Set the factors of an Scale Transform This method sets the factors of an ScaleTransform to a value specified by the user. This method cannot be done with SetMacro because itk::Array has not an operator== defined. The array of scales correspond in order to the factors to be applied to each one of the coordinates. For example, in 3D, scale[0] corresponds to X, scale[1] corresponds to Y and scale[2] corresponds to Z.

◆ TransformCovariantVector()

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

◆ TransformPoint()

template<typename TParametersValueType = float, unsigned int VDimension = 3>
OutputPointType itk::ScaleTransform< TParametersValueType, VDimension >::TransformPoint ( const InputPointType &  point) const
override

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

◆ TransformVector() [1/2]

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

◆ TransformVector() [2/2]

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

Member Data Documentation

◆ m_Scale

template<typename TParametersValueType = float, unsigned int VDimension = 3>
ScaleType itk::ScaleTransform< TParametersValueType, VDimension >::m_Scale {}
private

Definition at line 221 of file itkScaleTransform.h.

◆ ParametersDimension

template<typename TParametersValueType = float, unsigned int VDimension = 3>
constexpr unsigned int itk::ScaleTransform< TParametersValueType, VDimension >::ParametersDimension = VDimension
staticconstexpr

Definition at line 65 of file itkScaleTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = float, unsigned int VDimension = 3>
constexpr unsigned int itk::ScaleTransform< TParametersValueType, VDimension >::SpaceDimension = VDimension
staticconstexpr

Dimension of the domain space.

Definition at line 64 of file itkScaleTransform.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16