itk::ScaleTransform< TParametersValueType, VDimension > Class Template Reference

#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:

• <a href=
• <a href=

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	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
using	InverseTransformBaseType = typename Superclass::InverseTransformBaseType
using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
using	JacobianType = Array2D< ParametersValueType >
using	MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
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	ScalarType = ParametersValueType
using	ScaleType = FixedArray< TParametersValueType, VDimension >
using	Self = ScaleTransform
using	Superclass = MatrixOffsetTransformBase< TParametersValueType, VDimension, VDimension >
Public Types inherited from itk::MatrixOffsetTransformBase< float, 3, 3 >
using	CenterType = InputPointType
using	ConstPointer = SmartPointer< const Self >
using	InputCovariantVectorType = CovariantVector< float, Self::InputSpaceDimension >
using	InputDiffusionTensor3DType = DiffusionTensor3D< float >
using	InputPointType = Point< float, Self::InputSpaceDimension >
using	InputPointValueType = typename InputPointType::ValueType
using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< float, VInputDimension >
using	InputTensorEigenVectorType = CovariantVector< float, InputDiffusionTensor3DType::Dimension >
using	InputVectorPixelType = VariableLengthVector< float >
using	InputVectorType = Vector< float, Self::InputSpaceDimension >
using	InputVnlVectorType = vnl_vector_fixed< float, Self::InputSpaceDimension >
using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
using	InverseMatrixType = Matrix< float, Self::InputSpaceDimension, Self::OutputSpaceDimension >
using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
using	InverseTransformBaseType = typename Superclass::InverseTransformBaseType
using	InverseTransformType = MatrixOffsetTransformBase< float, VOutputDimension, VInputDimension >
using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
using	JacobianType = Array2D< ParametersValueType >
using	MatrixType = Matrix< float, Self::OutputSpaceDimension, Self::InputSpaceDimension >
using	MatrixValueType = typename MatrixType::ValueType
using	OffsetType = OutputVectorType
using	OffsetValueType = typename OffsetType::ValueType
using	OutputCovariantVectorType = CovariantVector< float, Self::OutputSpaceDimension >
using	OutputDiffusionTensor3DType = DiffusionTensor3D< float >
using	OutputPointType = Point< float, Self::OutputSpaceDimension >
using	OutputPointValueType = typename OutputPointType::ValueType
using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< float, VOutputDimension >
using	OutputVectorPixelType = VariableLengthVector< float >
using	OutputVectorType = Vector< float, Self::OutputSpaceDimension >
using	OutputVectorValueType = typename OutputVectorType::ValueType
using	OutputVnlVectorType = vnl_vector_fixed< float, Self::OutputSpaceDimension >
using	Pointer = SmartPointer< Self >
using	ScalarType = ParametersValueType
using	Self = MatrixOffsetTransformBase
using	Superclass = Transform< float, VInputDimension, VOutputDimension >
using	TranslationType = OutputVectorType
using	TranslationValueType = typename TranslationType::ValueType
Public Types inherited from itk::Transform< float, VInputDimension, VOutputDimension >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = Array< ParametersValueType >
using	DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
using	FixedParametersType = OptimizerParameters< FixedParametersValueType >
using	FixedParametersValueType = double
using	InputCovariantVectorType = CovariantVector< float, VInputDimension >
using	InputDiffusionTensor3DType = DiffusionTensor3D< float >
using	InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
using	InputPointType = Point< float, VInputDimension >
using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< float, VInputDimension >
using	InputVectorPixelType = VariableLengthVector< float >
using	InputVectorType = Vector< float, VInputDimension >
using	InputVnlVectorType = vnl_vector_fixed< float, VInputDimension >
using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
using	InverseTransformBaseType = Transform< float, VOutputDimension, VInputDimension >
using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
using	JacobianType = Array2D< ParametersValueType >
using	MatrixType = Matrix< float, Self::OutputSpaceDimension, Self::InputSpaceDimension >
using	NumberOfParametersType = IdentifierType
using	OutputCovariantVectorType = CovariantVector< float, VOutputDimension >
using	OutputDiffusionTensor3DType = DiffusionTensor3D< float >
using	OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
using	OutputPointType = Point< float, VOutputDimension >
using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< float, VOutputDimension >
using	OutputVectorPixelType = VariableLengthVector< float >
using	OutputVectorType = Vector< float, VOutputDimension >
using	OutputVnlVectorType = vnl_vector_fixed< float, VOutputDimension >
using	ParametersType = OptimizerParameters< ParametersValueType >
using	ParametersValueType = float
using	Pointer = SmartPointer< Self >
using	ScalarType = ParametersValueType
using	Self = Transform
using	Superclass = TransformBaseTemplate< float >
using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
Public Types inherited from TransformBaseTemplate< float >
using	ConstPointer = SmartPointer< const Self >
using	FixedParametersType = OptimizerParameters< FixedParametersValueType >
using	FixedParametersValueType = double
using	NumberOfParametersType = IdentifierType
using	ParametersType = OptimizerParameters< ParametersValueType >
using	ParametersValueType = float
using	Pointer = SmartPointer< Self >
using	Self = TransformBaseTemplate
using	Superclass = Object
using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
using	TransformCategoryType = TransformCategoryEnum

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
virtual void	ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
void	ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) 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)
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const
OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vec) const override
OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vect) 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
OutputPointType	TransformPoint (const InputPointType &point) const override
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
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
OutputVnlVectorType	TransformVector (const InputVnlVectorType &vect) const override
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
Public Member Functions inherited from itk::MatrixOffsetTransformBase< float, 3, 3 >
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
virtual void	SetIdentity ()
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< float, 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
virtual InverseTransformBasePointer	GetInverseTransform () 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
virtual bool	IsLinear () const
	itkCloneMacro (Self)
void	SetFixedParameters (const FixedParametersType &) override=0
void	SetParameters (const ParametersType &) override=0
void	SetParametersByValue (const ParametersType &p) override
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
virtual OutputDiffusionTensor3DType	TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
virtual OutputPointType	TransformPoint (const InputPointType &) const=0
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, 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	ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
template< typename TImage > std std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (SmartPointer< TImage > image) const
Public Member Functions inherited from TransformBaseTemplate< float >
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 const FixedParametersType &	GetFixedParameters () const=0
virtual unsigned int	GetInputSpaceDimension () const=0
virtual NumberOfParametersType	GetNumberOfParameters () const=0
virtual unsigned int	GetOutputSpaceDimension () const=0
virtual const ParametersType &	GetParameters () const=0
virtual TransformCategoryEnum	GetTransformCategory () const=0
virtual std::string	GetTransformTypeAsString () const=0
	ITK_DISALLOW_COPY_AND_MOVE (TransformBaseTemplate)
	itkGetConstReferenceMacro (InputSpaceName, std::string)
	itkGetConstReferenceMacro (OutputSpaceName, std::string)
	itkOverrideGetNameOfClassMacro (TransformBaseTemplate)
	itkSetMacro (InputSpaceName, std::string)
	itkSetMacro (OutputSpaceName, std::string)
virtual void	SetFixedParameters (const FixedParametersType &)=0
virtual void	SetParameters (const ParametersType &)=0
virtual void	SetParametersByValue (const ParametersType &p)=0

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::MatrixOffsetTransformBase< float, 3, 3 >
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< float, 3, 3 >
static constexpr unsigned int	InputSpaceDimension
static constexpr unsigned int	OutputSpaceDimension
static constexpr unsigned int	ParametersDimension
Static Public Attributes inherited from itk::Transform< float, VInputDimension, VOutputDimension >
static constexpr unsigned int	InputSpaceDimension
static constexpr unsigned int	OutputSpaceDimension
Static Public Attributes inherited from TransformBaseTemplate< float >
static constexpr TransformCategoryEnum	BSpline
static constexpr TransformCategoryEnum	DisplacementField
static constexpr TransformCategoryEnum	Linear
static constexpr TransformCategoryEnum	Spline
static constexpr TransformCategoryEnum	UnknownTransformCategory
static constexpr TransformCategoryEnum	VelocityField

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override
	ScaleTransform ()
	~ScaleTransform () override=default
Protected Member Functions inherited from itk::MatrixOffsetTransformBase< float, 3, 3 >
virtual void	ComputeMatrix ()
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< float, VInputDimension, VOutputDimension >
LightObject::Pointer	InternalClone () const override
OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
	Transform ()=default
	Transform (NumberOfParametersType numberOfParameters)
	~Transform () override=default
Protected Member Functions inherited from TransformBaseTemplate< float >
	TransformBaseTemplate ()=default
	~TransformBaseTemplate () override=default

Private Attributes
ScaleType	m_Scale {}

Additional Inherited Members
Public Attributes inherited from itk::Transform< float, VInputDimension, VOutputDimension >
InverseJacobianPositionType &jacobian	const
Static Protected Member Functions inherited from itk::Transform< float, VInputDimension, VOutputDimension >
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)
Protected Attributes inherited from itk::Transform< float, 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.

InverseJacobianPositionType

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

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::InverseJacobianPositionType = vnl_matrix_fixed<ParametersValueType, VInputDimension, VOutputDimension>

Definition at line 139 of file itkTransform.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.

JacobianPositionType

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

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianPositionType = vnl_matrix_fixed<ParametersValueType, VOutputDimension, VInputDimension>

Definition at line 138 of file itkTransform.h.

JacobianType

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

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::JacobianType = Array2D<ParametersValueType>

Type of the Jacobian matrix.

Definition at line 137 of file itkTransform.h.

MatrixType

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

using itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::MatrixType = Matrix<TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension>

Standard matrix type for this class

Definition at line 180 of file itkMatrixOffsetTransformBase.h.

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.

ScalarType

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

using itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::ScalarType = ParametersValueType

Type of the scalar representing coordinate and vector elements.

Definition at line 145 of file itkTransform.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() [1/3]

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

virtual void itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::ComputeJacobianWithRespectToPosition ( const InputPointType &  , JacobianPositionType &    ) const

inline

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

Definition at line 454 of file itkTransform.h.

ComputeJacobianWithRespectToPosition() [2/3]

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.

ComputeJacobianWithRespectToPosition() [3/3]

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

void itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::ComputeJacobianWithRespectToPosition ( const InputPointType &  x, JacobianPositionType &  jac  ) const

override

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

ComputeMatrix()

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

void itk::ScaleTransform< TParametersValueType, VDimension >::ComputeMatrix ( )

overridevirtual

Reimplemented from itk::MatrixOffsetTransformBase< float, 3, 3 >.

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< float, 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

overridevirtual

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

Implements TransformBaseTemplate< float >.

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< float, 3, 3 >.

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< float, 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() [1/7]

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

virtual OutputCovariantVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputCovariantVectorType &  ) const

inline

Method to transform a CovariantVector.

Definition at line 412 of file itkTransform.h.

TransformCovariantVector() [2/7]

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

OutputCovariantVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputCovariantVectorType &  vec ) const

override

TransformCovariantVector() [3/7]

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

OutputCovariantVectorType itk::ScaleTransform< TParametersValueType, VDimension >::TransformCovariantVector ( const InputCovariantVectorType &  vect ) const

override

TransformCovariantVector() [4/7]

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

virtual OutputCovariantVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector	(	const InputCovariantVectorType &	vector,
		const InputPointType &	point
	)		const

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

TransformCovariantVector() [5/7]

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

virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputVectorPixelType &  ) const

inlinevirtual

Method to transform a CovariantVector stored in a VectorImage.

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

Definition at line 412 of file itkTransform.h.

TransformCovariantVector() [6/7]

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

OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector ( const InputVectorPixelType &  ) const

overridevirtual

Method to transform a CovariantVector stored in a VectorImage.

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

TransformCovariantVector() [7/7]

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

virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformCovariantVector	(	const InputVectorPixelType &	vector,
		const InputPointType &	point
	)		const

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

TransformPoint()

template<typename TParametersValueType = 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/11]

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

virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorPixelType &  ) const

inlinevirtual

Method to transform a vector stored in a VectorImage.

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

Definition at line 401 of file itkTransform.h.

TransformVector() [2/11]

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

OutputVectorPixelType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorPixelType &  ) const

overridevirtual

Method to transform a vector stored in a VectorImage.

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

TransformVector() [3/11]

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

virtual OutputVectorPixelType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector	(	const InputVectorPixelType &	vector,
		const InputPointType &	point
	)		const

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

TransformVector() [4/11]

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

virtual OutputVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorType &  ) const

inline

Method to transform a vector.

Definition at line 401 of file itkTransform.h.

TransformVector() [5/11]

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

OutputVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVectorType &  vect ) const

override

TransformVector() [6/11]

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

OutputVectorType itk::ScaleTransform< TParametersValueType, VDimension >::TransformVector ( const InputVectorType &  vect ) const

override

TransformVector() [7/11]

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

virtual OutputVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector	(	const InputVectorType &	vector,
		const InputPointType &	point
	)		const

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

TransformVector() [8/11]

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

virtual OutputVnlVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVnlVectorType &  ) const

inline

Method to transform a vnl_vector.

Definition at line 401 of file itkTransform.h.

TransformVector() [9/11]

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

OutputVnlVectorType itk::MatrixOffsetTransformBase< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector ( const InputVnlVectorType &  vect ) const

override

TransformVector() [10/11]

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

OutputVnlVectorType itk::ScaleTransform< TParametersValueType, VDimension >::TransformVector ( const InputVnlVectorType &  vect ) const

override

TransformVector() [11/11]

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

virtual OutputVnlVectorType itk::Transform< TParametersValueType, VInputDimension, VOutputDimension >::TransformVector	(	const InputVnlVectorType &	vector,
		const InputPointType &	point
	)		const

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

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:

• itkScaleTransform.h