ITK  5.2.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, NDimensions > Class Template Reference

#include <itkScaleTransform.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = typename Superclass::FixedParametersType
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, NDimensions >
 
using InputPointType = Point< TParametersValueType, NDimensions >
 
using InputVectorType = Vector< TParametersValueType, NDimensions >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, NDimensions >
 
using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = typename Superclass::InverseTransformBaseType
 
using JacobianPositionType = typename Superclass::JacobianPositionType
 
using JacobianType = typename Superclass::JacobianType
 
using MatrixType = typename Superclass::MatrixType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, NDimensions >
 
using OutputPointType = Point< TParametersValueType, NDimensions >
 
using OutputVectorType = Vector< TParametersValueType, NDimensions >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, NDimensions >
 
using ParametersType = typename Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using ScalarType = typename Superclass::ScalarType
 
using ScaleType = FixedArray< TParametersValueType, NDimensions >
 
using Self = ScaleTransform
 
using Superclass = MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
 
- Public Types inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
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

InputCovariantVectorType BackTransform (const OutputCovariantVectorType &vector) const
 
InputPointType BackTransform (const OutputPointType &point) const
 
InputVectorType BackTransform (const OutputVectorType &vector) const
 
InputVnlVectorType BackTransform (const OutputVnlVectorType &vector) const
 
void Compose (const Self *other, bool pre=false)
 
void ComputeJacobianWithRespectToParameters (const InputPointType &point, JacobianType &j) const override
 
void ComputeJacobianWithRespectToPosition (const InputPointType &x, JacobianPositionType &jac) const override
 
void ComputeMatrix () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual const char * GetNameOfClass () const
 
const ParametersTypeGetParameters () const override
 
virtual const ScaleTypeGetScale () 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 &vector) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVectorType TransformVector (const InputVectorType &vector) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const override
 
- Public Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
TransformCategoryEnum GetTransformCategory () const override
 
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
 
- 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
 
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
 
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 &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, 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)
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &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
 
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::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
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 ParametersDimension = NDimensions
 
static constexpr unsigned int SpaceDimension = NDimensions
 
- Static Public Attributes inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 
static constexpr unsigned int ParametersDimension
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, NInputDimensions, NOutputDimensions >
static constexpr unsigned int InputSpaceDimension = NInputDimensions
 
static constexpr unsigned int OutputSpaceDimension = NOutputDimensions
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ScaleTransform ()
 
 ~ScaleTransform () override=default
 
- Protected Member Functions inherited from itk::MatrixOffsetTransformBase< TParametersValueType, NDimensions, NDimensions >
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 ()
 
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
 
- 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 ()
 

Private Attributes

ScaleType m_Scale
 

Additional Inherited Members

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

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.

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 41 of file itkScaleTransform.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 51 of file itkScaleTransform.h.

◆ FixedParametersType

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

Parameters type.

Definition at line 67 of file itkScaleTransform.h.

◆ InputCovariantVectorType

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

Standard covariant vector type for this class.

Definition at line 83 of file itkScaleTransform.h.

◆ InputPointType

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

Standard coordinate point type for this class.

Definition at line 91 of file itkScaleTransform.h.

◆ InputVectorType

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

Standard vector type for this class.

Definition at line 79 of file itkScaleTransform.h.

◆ InputVnlVectorType

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

Standard vnl_vector type for this class.

Definition at line 87 of file itkScaleTransform.h.

◆ InverseJacobianPositionType

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

Definition at line 73 of file itkScaleTransform.h.

◆ InverseTransformBasePointer

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

Definition at line 97 of file itkScaleTransform.h.

◆ InverseTransformBaseType

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

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

Definition at line 96 of file itkScaleTransform.h.

◆ JacobianPositionType

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

Definition at line 72 of file itkScaleTransform.h.

◆ JacobianType

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

Jacobian types.

Definition at line 71 of file itkScaleTransform.h.

◆ MatrixType

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

Definition at line 99 of file itkScaleTransform.h.

◆ OutputCovariantVectorType

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

Definition at line 84 of file itkScaleTransform.h.

◆ OutputPointType

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

Definition at line 92 of file itkScaleTransform.h.

◆ OutputVectorType

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

Definition at line 80 of file itkScaleTransform.h.

◆ OutputVnlVectorType

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

Definition at line 88 of file itkScaleTransform.h.

◆ ParametersType

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

Definition at line 68 of file itkScaleTransform.h.

◆ Pointer

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

Definition at line 50 of file itkScaleTransform.h.

◆ ScalarType

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

Scalar type.

Definition at line 64 of file itkScaleTransform.h.

◆ ScaleType

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

Standard vector type for this class.

Definition at line 76 of file itkScaleTransform.h.

◆ Self

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

Standard class type aliases.

Definition at line 48 of file itkScaleTransform.h.

◆ Superclass

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

Definition at line 49 of file itkScaleTransform.h.

Constructor & Destructor Documentation

◆ ScaleTransform()

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

Construct an ScaleTransform object.

◆ ~ScaleTransform()

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

Destroy an ScaleTransform object.

Member Function Documentation

◆ BackTransform() [1/4]

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

◆ BackTransform() [2/4]

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
InputPointType itk::ScaleTransform< TParametersValueType, NDimensions >::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 NDimensions = 3>
InputVectorType itk::ScaleTransform< TParametersValueType, NDimensions >::BackTransform ( const OutputVectorType vector) const
inline

◆ BackTransform() [4/4]

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

◆ Compose()

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

Compose with another ScaleTransform.

◆ ComputeJacobianWithRespectToParameters()

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

Get the Jacobian matrix.

◆ ComputeJacobianWithRespectToPosition()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TParametersValueType, NDimensions >::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 NDimensions = 3>
void itk::ScaleTransform< TParametersValueType, NDimensions >::ComputeMatrix ( )
overridevirtual

To avoid recomputation of the inverse if not needed

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

◆ CreateAnother()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
virtual::itk::LightObject::Pointer itk::ScaleTransform< TParametersValueType, NDimensions >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetInverse()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
bool itk::ScaleTransform< TParametersValueType, NDimensions >::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 NDimensions = 3>
InverseTransformBasePointer itk::ScaleTransform< TParametersValueType, NDimensions >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

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

◆ GetNameOfClass()

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

◆ GetParameters()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
const ParametersType& itk::ScaleTransform< TParametersValueType, NDimensions >::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 itk::TransformBaseTemplate< TParametersValueType >.

◆ GetScale()

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

Get access to scale values

◆ New()

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

New macro for creation of through a smart pointer.

◆ PrintSelf()

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

Print contents of an ScaleTransform

Reimplemented from itk::Object.

◆ Scale()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TParametersValueType, NDimensions >::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 NDimensions = 3>
void itk::ScaleTransform< TParametersValueType, NDimensions >::SetIdentity ( )
overridevirtual

Set the transformation to an Identity

This sets all the scales to 1.0

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

◆ SetParameters()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TParametersValueType, NDimensions >::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, NInputDimensions, NOutputDimensions >.

◆ SetScale()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
void itk::ScaleTransform< TParametersValueType, NDimensions >::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 NDimensions = 3>
OutputCovariantVectorType itk::ScaleTransform< TParametersValueType, NDimensions >::TransformCovariantVector ( const InputCovariantVectorType vector) const
override

◆ TransformPoint()

template<typename TParametersValueType = float, unsigned int NDimensions = 3>
OutputPointType itk::ScaleTransform< TParametersValueType, NDimensions >::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 NDimensions = 3>
OutputVectorType itk::ScaleTransform< TParametersValueType, NDimensions >::TransformVector ( const InputVectorType vector) const
override

◆ TransformVector() [2/2]

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

Member Data Documentation

◆ m_Scale

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

Definition at line 217 of file itkScaleTransform.h.

◆ ParametersDimension

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

Definition at line 61 of file itkScaleTransform.h.

◆ SpaceDimension

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

Dimension of the domain space.

Definition at line 60 of file itkScaleTransform.h.


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