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

#include <itkBSplineBaseTransform.h>

Detailed Description

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
class itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >

A base class with common elements of BSplineTransform and BSplineDeformableTransform.

Definition at line 34 of file itkBSplineBaseTransform.h.

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

Public Types

using CoefficientImageArray = FixedArray< ImagePointer, VDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename WeightsFunctionType::ContinuousIndexType
 
using DirectionType = typename ImageType::DirectionType
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = Image< ParametersValueType, Self::SpaceDimension >
 
using IndexType = typename RegionType::IndexType
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, Self::SpaceDimension >
 
using InputPointType = Point< TParametersValueType, Self::SpaceDimension >
 
using InputVectorType = Vector< TParametersValueType, Self::SpaceDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, SpaceDimension >
 
using MeshSizeType = SizeType
 
using OriginType = typename ImageType::PointType
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, Self::SpaceDimension >
 
using OutputPointType = Point< TParametersValueType, Self::SpaceDimension >
 
using OutputVectorType = Vector< TParametersValueType, Self::SpaceDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, SpaceDimension >
 
using ParameterIndexArrayType = FixedArray< unsigned long, NumberOfWeights >
 
using ParametersValueType = typename ParametersType::ValueType
 
using PhysicalDimensionsType = typename ImageType::SpacingType
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using RegionType = ImageRegion< Self::SpaceDimension >
 
using Self = BSplineBaseTransform
 
using SizeType = typename RegionType::SizeType
 
using SpacingType = typename ImageType::SpacingType
 
using Superclass = Transform< TParametersValueType, VDimension, VDimension >
 
using WeightsFunctionType = BSplineInterpolationWeightFunction< ScalarType, Self::SpaceDimension, Self::SplineOrder >
 
using WeightsType = typename WeightsFunctionType::WeightsType
 
- Public Types inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
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

void ComputeJacobianFromBSplineWeightsWithRespectToPosition (const InputPointType &, WeightsType &, ParameterIndexArrayType &) const
 
void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override=0
 
void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const override
 
const CoefficientImageArray GetCoefficientImages () const
 
const FixedParametersType & GetFixedParameters () const override
 
const char * GetNameOfClass () const override
 
unsigned int GetNumberOfAffectedWeights () const
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
NumberOfParametersType GetNumberOfParameters () const override=0
 
virtual NumberOfParametersType GetNumberOfParametersPerDimension () const =0
 
const ParametersType & GetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
 itkCloneMacro (Self)
 
virtual void SetCoefficientImages (const CoefficientImageArray &images)=0
 
void SetIdentity ()
 
void SetParameters (const ParametersType &parameters) override
 
void SetParametersByValue (const ParametersType &parameters) override
 
virtual void TransformPoint (const InputPointType &inputPoint, OutputPointType &outputPoint, WeightsType &weights, ParameterIndexArrayType &indices, bool &inside) const =0
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &) const override
 
void UpdateTransformParameters (const DerivativeType &update, TParametersValueType factor=1.0) override
 
void SetFixedParameters (const FixedParametersType &parameters) override=0
 
OutputVectorType TransformVector (const InputVectorType &) const override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const override
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
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
 
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 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
 

Static Public Attributes

static constexpr unsigned int NumberOfWeights { WeightsFunctionType::NumberOfWeights }
 
static constexpr unsigned int SpaceDimension = VDimension
 
static constexpr unsigned int SplineOrder = VSplineOrder
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 

Protected Member Functions

 BSplineBaseTransform ()=default
 
virtual bool InsideValidRegion (ContinuousIndexType &) const =0
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetCoefficientImageInformationFromFixedParameters ()=0
 
void SetFixedParametersFromTransformDomainInformation () const
 
virtual void SetFixedParametersGridDirectionFromTransformDomainInformation () const =0
 
virtual void SetFixedParametersGridOriginFromTransformDomainInformation () const =0
 
virtual void SetFixedParametersGridSizeFromTransformDomainInformation () const =0
 
virtual void SetFixedParametersGridSpacingFromTransformDomainInformation () const =0
 
void WrapAsImages ()
 
 ~BSplineBaseTransform () override=default
 
virtual void SetWeightsFunction (WeightsFunctionType *_arg)
 
virtual WeightsFunctionType * GetModifiableWeightsFunction ()
 
- Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
 Transform ()=default
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override=default
 

Protected Attributes

CoefficientImageArray m_CoefficientImages { Self::ArrayOfImagePointerGeneratorHelper() }
 
ParametersType m_InternalParametersBuffer {}
 
WeightsFunctionType::Pointer m_WeightsFunction { WeightsFunctionType::New() }
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 

Static Private Member Functions

static CoefficientImageArray ArrayOfImagePointerGeneratorHelper ()
 

Additional Inherited Members

- Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
InverseJacobianPositionType &jacobian const
 
- Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static InverseTransformBasePointer InvertTransform (const TTransform &transform)
 

Member Typedef Documentation

◆ CoefficientImageArray

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::CoefficientImageArray = FixedArray<ImagePointer, VDimension>

Definition at line 181 of file itkBSplineBaseTransform.h.

◆ ConstPointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ConstPointer = SmartPointer<const Self>

Definition at line 43 of file itkBSplineBaseTransform.h.

◆ ContinuousIndexType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ContinuousIndexType = typename WeightsFunctionType::ContinuousIndexType

Definition at line 236 of file itkBSplineBaseTransform.h.

◆ DirectionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::DirectionType = typename ImageType::DirectionType

Definition at line 225 of file itkBSplineBaseTransform.h.

◆ ImagePointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ImagePointer = typename ImageType::Pointer

Definition at line 180 of file itkBSplineBaseTransform.h.

◆ ImageType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ImageType = Image<ParametersValueType, Self::SpaceDimension>

Definition at line 179 of file itkBSplineBaseTransform.h.

◆ IndexType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::IndexType = typename RegionType::IndexType

Definition at line 222 of file itkBSplineBaseTransform.h.

◆ InputCovariantVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::InputCovariantVectorType = CovariantVector<TParametersValueType, Self::SpaceDimension>

Standard covariant vector type for this class.

Definition at line 80 of file itkBSplineBaseTransform.h.

◆ InputPointType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::InputPointType = Point<TParametersValueType, Self::SpaceDimension>

Standard coordinate point type for this class.

Definition at line 88 of file itkBSplineBaseTransform.h.

◆ InputVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::InputVectorType = Vector<TParametersValueType, Self::SpaceDimension>

Standard vector type for this class.

Definition at line 76 of file itkBSplineBaseTransform.h.

◆ InputVnlVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::InputVnlVectorType = vnl_vector_fixed<TParametersValueType, SpaceDimension>

Standard vnl_vector type for this class.

Definition at line 84 of file itkBSplineBaseTransform.h.

◆ MeshSizeType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::MeshSizeType = SizeType

Definition at line 333 of file itkBSplineBaseTransform.h.

◆ OriginType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::OriginType = typename ImageType::PointType

Definition at line 226 of file itkBSplineBaseTransform.h.

◆ OutputCovariantVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::OutputCovariantVectorType = CovariantVector<TParametersValueType, Self::SpaceDimension>

Definition at line 81 of file itkBSplineBaseTransform.h.

◆ OutputPointType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::OutputPointType = Point<TParametersValueType, Self::SpaceDimension>

Definition at line 89 of file itkBSplineBaseTransform.h.

◆ OutputVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::OutputVectorType = Vector<TParametersValueType, Self::SpaceDimension>

Definition at line 77 of file itkBSplineBaseTransform.h.

◆ OutputVnlVectorType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::OutputVnlVectorType = vnl_vector_fixed<TParametersValueType, SpaceDimension>

Definition at line 85 of file itkBSplineBaseTransform.h.

◆ ParameterIndexArrayType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ParameterIndexArrayType = FixedArray<unsigned long, NumberOfWeights>

Parameter index array type.

Definition at line 242 of file itkBSplineBaseTransform.h.

◆ ParametersValueType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ParametersValueType = typename ParametersType::ValueType

Parameters as SpaceDimension number of images.

Definition at line 178 of file itkBSplineBaseTransform.h.

◆ PhysicalDimensionsType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::PhysicalDimensionsType = typename ImageType::SpacingType

Definition at line 330 of file itkBSplineBaseTransform.h.

◆ PixelType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::PixelType = typename ImageType::PixelType

Definition at line 331 of file itkBSplineBaseTransform.h.

◆ Pointer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::Pointer = SmartPointer<Self>

Definition at line 42 of file itkBSplineBaseTransform.h.

◆ RegionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::RegionType = ImageRegion<Self::SpaceDimension>

Typedefs for specifying the extent of the grid.

Definition at line 220 of file itkBSplineBaseTransform.h.

◆ Self

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::Self = BSplineBaseTransform

Standard class type aliases.

Definition at line 40 of file itkBSplineBaseTransform.h.

◆ SizeType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SizeType = typename RegionType::SizeType

Definition at line 223 of file itkBSplineBaseTransform.h.

◆ SpacingType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SpacingType = typename ImageType::SpacingType

Definition at line 224 of file itkBSplineBaseTransform.h.

◆ Superclass

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::Superclass = Transform<TParametersValueType, VDimension, VDimension>

Definition at line 41 of file itkBSplineBaseTransform.h.

◆ WeightsFunctionType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::WeightsFunctionType = BSplineInterpolationWeightFunction<ScalarType, Self::SpaceDimension, Self::SplineOrder>

Interpolation weights function type.

Definition at line 233 of file itkBSplineBaseTransform.h.

◆ WeightsType

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
using itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::WeightsType = typename WeightsFunctionType::WeightsType

Definition at line 235 of file itkBSplineBaseTransform.h.

Constructor & Destructor Documentation

◆ BSplineBaseTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::BSplineBaseTransform ( )
protecteddefault

◆ ~BSplineBaseTransform()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::~BSplineBaseTransform ( )
overrideprotecteddefault

Member Function Documentation

◆ ArrayOfImagePointerGeneratorHelper()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
static CoefficientImageArray itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ArrayOfImagePointerGeneratorHelper ( )
staticprivate

◆ ComputeJacobianFromBSplineWeightsWithRespectToPosition()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ComputeJacobianFromBSplineWeightsWithRespectToPosition ( const InputPointType &  ,
WeightsType &  ,
ParameterIndexArrayType &   
) const

Get Jacobian at a point. A very specialized function just for BSplines

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ComputeJacobianWithRespectToParameters ( const InputPointType &  ,
JacobianType &   
) const
overridepure virtual

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ ComputeJacobianWithRespectToPosition()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::ComputeJacobianWithRespectToPosition ( const InputPointType &  ,
JacobianPositionType &   
) const
inlineoverride

Definition at line 305 of file itkBSplineBaseTransform.h.

References GetNameOfClass().

◆ GetCoefficientImages()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
const CoefficientImageArray itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetCoefficientImages ( ) const
inline

Get the array of coefficient images.

Definition at line 199 of file itkBSplineBaseTransform.h.

◆ GetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
const FixedParametersType& itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetFixedParameters ( ) const
override

Get the Transformation Fixed Parameters.

◆ GetModifiableWeightsFunction()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual WeightsFunctionType* itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetModifiableWeightsFunction ( )
protectedvirtual

Get/Set to allow subclasses to access and manipulate the weights function.

◆ GetNameOfClass()

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

◆ GetNumberOfAffectedWeights()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
unsigned int itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetNumberOfAffectedWeights ( ) const

◆ GetNumberOfLocalParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
NumberOfParametersType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetNumberOfLocalParameters ( ) const
inlineoverridevirtual

Return the number of local parameters

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

Definition at line 337 of file itkBSplineBaseTransform.h.

◆ GetNumberOfParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
NumberOfParametersType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetNumberOfParameters ( ) const
overridepure virtual

Return the number of parameters that completely define the Transform

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ GetNumberOfParametersPerDimension()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual NumberOfParametersType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetNumberOfParametersPerDimension ( ) const
pure virtual

Return the number of parameters per dimension

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ GetParameters()

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

Get the Transformation Parameters.

◆ GetTransformCategory()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
TransformCategoryEnum itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::GetTransformCategory ( ) const
inlineoverride

Definition at line 322 of file itkBSplineBaseTransform.h.

◆ InsideValidRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual bool itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::InsideValidRegion ( ContinuousIndexType &  ) const
protectedpure virtual

Check if a continuous index is inside the valid region.

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ itkCloneMacro()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::itkCloneMacro ( Self  )

implement type-specific clone method

◆ PrintSelf()

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

Print contents of an BSplineBaseTransform.

◆ SetCoefficientImageInformationFromFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetCoefficientImageInformationFromFixedParameters ( )
protectedpure virtual

Construct control point grid size from transform domain information

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetCoefficientImages()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetCoefficientImages ( const CoefficientImageArray &  images)
pure virtual

Set the array of coefficient images.

This is an alternative API for setting the BSpline coefficients as an array of SpaceDimension images. The fixed parameters are taken from the first image. It is assumed that the buffered region of all the subsequent images are the same as the first image. Note that no error checking is done.

Warning: use either the SetParameters() or SetCoefficientImages() API. Mixing the two modes may results in unexpected results.

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParameters ( const FixedParametersType &  parameters)
overridepure virtual

This method sets the fixed parameters of the transform. For a BSpline deformation transform, the fixed parameters are the following: grid size, grid origin, grid spacing, and grid direction. However, all of these are set via the much more intuitive SetTransformDomainXXX() functions

The fixed parameters are the three times the size of the templated dimensions. This function has the effect of make the following non- existing functional calls: transform->SetGridSpacing( spacing ); transform->SetGridOrigin( origin ); transform->SetGridDirection( direction ); transform->SetGridRegion( bsplineRegion );

With recent updates to this transform, however, all these parameters are set indirectly by setting the transform domain parameters unless the user sets them with SetFixedParameters().

This function was added to allow the transform to work with the itkTransformReader/Writer I/O filters.

Implements itk::Transform< TParametersValueType, VDimension, VDimension >.

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParametersFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersFromTransformDomainInformation ( ) const
protected

Construct control point grid from transform domain information

◆ SetFixedParametersGridDirectionFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridDirectionFromTransformDomainInformation ( ) const
protectedpure virtual

Construct control point grid direction from transform domain information

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParametersGridOriginFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridOriginFromTransformDomainInformation ( ) const
protectedpure virtual

Construct control point grid origin from transform domain information

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParametersGridSizeFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridSizeFromTransformDomainInformation ( ) const
protectedpure virtual

Construct control point grid size from transform domain information

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParametersGridSpacingFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersGridSpacingFromTransformDomainInformation ( ) const
protectedpure virtual

Construct control point grid spacing from transform domain information

Implemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetIdentity()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetIdentity ( )

This method can ONLY be invoked AFTER calling SetParameters(). This restriction is due to the fact that the BSplineBaseTransform does not copy the array of parameters internally, instead it keeps a pointer to the user-provided array of parameters. This method is also in violation of the const-correctness of the parameters since the parameter array has been passed to the transform on a 'const' basis but the values get modified when the user invokes SetIdentity().

◆ SetParameters()

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

This method sets the parameters of the transform. For a BSpline deformation transform, the parameters are the BSpline coefficients on a sparse grid.

The parameters are N number of N-D grid of coefficients. Each N-D grid is represented as a flat array of scalars (in the same configuration as an itk::Image). The N arrays are then concatenated to form one parameter array.

For efficiency, this transform does not make a copy of the parameters. It only keeps a pointer to the input parameters. It assumes that the memory is managed by the caller. Use SetParametersByValue to force the transform to call copy the parameters.

This method wraps each grid as itk::Image's using the user specified fixed parameters. NOTE: The transform domain must be set first.

Implements itk::Transform< TParametersValueType, VDimension, VDimension >.

◆ SetParametersByValue()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetParametersByValue ( const ParametersType &  parameters)
override

This method sets the parameters of the transform. For a BSpline deformation transform, the parameters are the BSpline coefficients on a sparse grid.

The parameters are N number of N-D grid of coefficients. Each N-D grid is represented as a flat array of doubles (in the same configuration as an itk::Image). The N arrays are then concatenated to form one parameter array.

This methods makes a copy of the parameters while for efficiency the SetParameters method does not.

This method wraps each grid as itk::Image's using the user specified fixed parameters. NOTE: The fixed parameters must be set first.

◆ SetWeightsFunction()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SetWeightsFunction ( WeightsFunctionType *  _arg)
protectedvirtual

Get/Set to allow subclasses to access and manipulate the weights function.

◆ TransformCovariantVector()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
OutputCovariantVectorType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformCovariantVector ( const InputCovariantVectorType &  ) const
inlineoverride

Definition at line 289 of file itkBSplineBaseTransform.h.

◆ TransformPoint() [1/2]

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformPoint ( const InputPointType &  inputPoint,
OutputPointType &  outputPoint,
WeightsType &  weights,
ParameterIndexArrayType &  indices,
bool &  inside 
) const
pure virtual

Transform points by a BSpline deformable transformation. On return, weights contains the interpolation weights used to compute the deformation and indices of the x (zeroth) dimension coefficient parameters in the support region used to compute the deformation. Parameter indices for the i-th dimension can be obtained by adding ( i * this->GetNumberOfParametersPerDimension() ) to the indices array.

Implemented in itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >, and itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ TransformPoint() [2/2]

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

Transform points by a BSpline deformable transformation.

◆ TransformVector() [1/2]

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
OutputVectorType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformVector ( const InputVectorType &  ) const
inlineoverride

Definition at line 271 of file itkBSplineBaseTransform.h.

◆ TransformVector() [2/2]

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
OutputVnlVectorType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::TransformVector ( const InputVnlVectorType &  ) const
inlineoverride

Method to transform a vnl_vector - not applicable for this type of transform

Definition at line 280 of file itkBSplineBaseTransform.h.

◆ UpdateTransformParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::UpdateTransformParameters ( const DerivativeType &  update,
TParametersValueType  factor = 1.0 
)
override

Update the transform's parameters by the adding values in update to current parameter values. We assume update is of the same length as Parameters. Throw exception otherwise. factor is a scalar multiplier for each value in update. SetParameters is called at the end of this method, to allow transforms to perform any required operations on the update parameters, typically a conversion to member variables for use in TransformPoint. Derived classes should override to provide specialized behavior.

◆ WrapAsImages()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::WrapAsImages ( )
protected

Wrap flat array into images of coefficients.

Member Data Documentation

◆ m_CoefficientImages

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
CoefficientImageArray itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::m_CoefficientImages { Self::ArrayOfImagePointerGeneratorHelper() }
protected

Array of images representing the B-spline coefficients in each dimension wrapped from the flat parameters in m_InternalParametersBuffer

Definition at line 402 of file itkBSplineBaseTransform.h.

◆ m_InternalParametersBuffer

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
ParametersType itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::m_InternalParametersBuffer {}
protected

Internal parameters buffer.

Definition at line 405 of file itkBSplineBaseTransform.h.

◆ m_WeightsFunction

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
WeightsFunctionType::Pointer itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::m_WeightsFunction { WeightsFunctionType::New() }
protected

Pointer to function used to compute Bspline interpolation weights.

Definition at line 408 of file itkBSplineBaseTransform.h.

◆ NumberOfWeights

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
constexpr unsigned int itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::NumberOfWeights { WeightsFunctionType::NumberOfWeights }
staticconstexpr

Number of weights.

Definition at line 239 of file itkBSplineBaseTransform.h.

◆ SpaceDimension

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
constexpr unsigned int itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SpaceDimension = VDimension
staticconstexpr

Dimension of the domain space.

Definition at line 49 of file itkBSplineBaseTransform.h.

◆ SplineOrder

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
constexpr unsigned int itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >::SplineOrder = VSplineOrder
staticconstexpr

The BSpline order.

Definition at line 52 of file itkBSplineBaseTransform.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