ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder > Class Template Reference

#include <itkBSplineTransform.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using PhysicalDimensionsType = typename Superclass::SpacingType
 
using Pointer = SmartPointer< Self >
 
using Self = BSplineTransform
 
using Superclass = BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >
 
- Public Types inherited from itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >
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 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

void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override
 
virtual const char * GetNameOfClass () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
NumberOfParametersType GetNumberOfParametersPerDimension () const override
 
virtual DirectionType GetTransformDomainDirection () const
 
virtual MeshSizeType GetTransformDomainMeshSize () const
 
virtual OriginType GetTransformDomainOrigin () const
 
virtual PhysicalDimensionsType GetTransformDomainPhysicalDimensions () const
 
std::string GetTransformTypeAsString () const override
 
void SetCoefficientImages (const CoefficientImageArray &images) override
 
virtual void SetTransformDomainDirection (const DirectionType &)
 
virtual void SetTransformDomainMeshSize (const MeshSizeType &)
 
virtual void SetTransformDomainOrigin (const OriginType &)
 
virtual void SetTransformDomainPhysicalDimensions (const PhysicalDimensionsType &)
 
void SetFixedParameters (const FixedParametersType &passedParameters) override
 
void TransformPoint (const InputPointType &point, OutputPointType &outputPoint, WeightsType &weights, ParameterIndexArrayType &indices, bool &inside) const override
 
- Public Member Functions inherited from itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >
void ComputeJacobianFromBSplineWeightsWithRespectToPosition (const InputPointType &, WeightsType &, ParameterIndexArrayType &) const
 
void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const override
 
const CoefficientImageArray GetCoefficientImages () const
 
const FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetNumberOfAffectedWeights () const
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
 itkCloneMacro (Self)
 
void SetIdentity ()
 
void SetParameters (const ParametersType &parameters) override
 
void SetParametersByValue (const ParametersType &parameters) override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &) const override
 
void UpdateTransformParameters (const DerivativeType &update, TParametersValueType factor=1.0) override
 
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 FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
virtual const std::string & GetInputSpaceName () const
 
bool GetInverse (Self *) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
virtual const std::string & GetOutputSpaceName () const
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
virtual bool IsLinear () const
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
virtual void SetInputSpaceName (std::string _arg)
 
virtual void SetOutputSpaceName (std::string _arg)
 
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 ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const=0
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianPositionType &) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &pnt, InverseJacobianPositionType &jacobian) const
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (TImage *image) const
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int SpaceDimension = VDimension
 
static constexpr unsigned int SplineOrder = VSplineOrder
 
- Static Public Attributes inherited from itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >
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

 BSplineTransform ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BSplineTransform () override=default
 
- Protected Member Functions inherited from itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >
 BSplineBaseTransform ()
 
void SetFixedParametersFromTransformDomainInformation () const
 
void WrapAsImages ()
 
 ~BSplineBaseTransform () override=default
 
virtual void SetWeightsFunction (WeightsFunctionType *_arg)
 
virtual WeightsFunctionTypeGetModifiableWeightsFunction ()
 
- 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 Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 Member Functions

bool InsideValidRegion (ContinuousIndexType &) const override
 
void SetCoefficientImageInformationFromFixedParameters () override
 
void SetFixedParametersFromCoefficientImageInformation ()
 
void SetFixedParametersFromTransformDomainInformation (const OriginType &meshOrigin, const PhysicalDimensionsType &meshPhysical, const DirectionType &meshDirection, const MeshSizeType &meshSize)
 
void SetFixedParametersGridSizeFromTransformDomainInformation () const override
 
void SetFixedParametersGridOriginFromTransformDomainInformation () const override
 
void SetFixedParametersGridSpacingFromTransformDomainInformation () const override
 
void SetFixedParametersGridDirectionFromTransformDomainInformation () const override
 

Additional Inherited Members

- Protected Attributes inherited from itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >
CoefficientImageArray m_CoefficientImages
 
ParametersType m_InternalParametersBuffer
 
WeightsFunctionType::Pointer m_WeightsFunction
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

Deformable transform using a BSpline representation.

This class encapsulates a deformable transform of points from one N-dimensional space to another N-dimensional space. The deformation field is modelled using B-splines. A deformation is defined on a sparse regular grid of control points \( \vec{\lambda}_j \) and is varied by defining a deformation \( \vec{g}(\vec{\lambda}_j) \) of each control point. The deformation \( D(\vec{x}) \) at any point \( \vec{x} \) is obtained by using a B-spline interpolation kernel.

The deformation field grid is defined by a user specified transform domain (origin, physical dimensions, direction) and B-spline mesh size where the mesh size is the number of polynomial patches comprising the finite domain of support. The relationship between the mesh size ( number of polynomial pieces) and the number of control points in any given dimension is

mesh size = number of control points - spline order

Each grid/control point has associated with it N deformation coefficients \( \vec{\delta}_j \), representing the N directional components of the deformation. Deformation outside the grid plus support region for the BSpline interpolation is assumed to be zero.

The parameters for this transform is N x N-D grid of spline coefficients. The user specifies the parameters as one flat array: each N-D grid is represented by an array in the same way an N-D image is represented in the buffer; the N arrays are then concatenated together to form a single array.

The following illustrates the typical usage of this class:

using TransformType = BSplineTransform<double,2,3>;
auto transform = TransformType::New();
transform->SetTransformDomainOrigin( origin );
transform->SetTransformDomainPhysicalDimensions( physicalDimensions );
transform->SetTransformDomainDirection( direction );
transform->SetTransformDomainMeshSize( meshSize );
// NB: The region must be set first before setting the parameters
TransformType::ParametersType parameters( transform->GetNumberOfParameters() );
// Fill the parameters with values
transform->SetParameters( parameters )
outputPoint = transform->TransformPoint( inputPoint );

An alternative way to set the B-spline coefficients is via array of images. The fixed parameters of the transform are taken directly from the first image. It is assumed that the subsequent images are the same buffered region. The following illustrates the API:

TransformType::ImageConstPointer images[2];
// Fill the images up with values
transform->SetCoefficientImages( images );
outputPoint = transform->TransformPoint( inputPoint );
Warning
Use either the SetParameters() or SetCoefficientImages() API. Mixing the two modes may results in unexpected results.

The class is templated coordinate representation type (float or double), the space dimension and the spline order.

Examples
Examples/IO/TransformReadWrite.cxx, Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, Examples/RegistrationITKv4/DeformableRegistration8.cxx, and SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesBSpline/Code.cxx.

Definition at line 103 of file itkBSplineTransform.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 112 of file itkBSplineTransform.h.

◆ PhysicalDimensionsType

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

Definition at line 255 of file itkBSplineTransform.h.

◆ Pointer

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

Definition at line 111 of file itkBSplineTransform.h.

◆ Self

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

Standard class type aliases.

Definition at line 109 of file itkBSplineTransform.h.

◆ Superclass

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

Definition at line 110 of file itkBSplineTransform.h.

Constructor & Destructor Documentation

◆ BSplineTransform()

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

◆ ~BSplineTransform()

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

Member Function Documentation

◆ ComputeJacobianWithRespectToParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::ComputeJacobianWithRespectToParameters ( const InputPointType ,
JacobianType  
) const
overridevirtual

Compute the Jacobian in one position.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ GetNameOfClass()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual const char* itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ GetNumberOfParameters()

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

Return the number of parameters that completely define the Transfom.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ GetNumberOfParametersPerDimension()

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

Return the number of parameters per dimension.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ GetTransformDomainDirection()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual DirectionType itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::GetTransformDomainDirection ( ) const
virtual

Function to retrieve the transform domain direction.

◆ GetTransformDomainMeshSize()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual MeshSizeType itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::GetTransformDomainMeshSize ( ) const
virtual

Function to retrieve the transform domain mesh size.

◆ GetTransformDomainOrigin()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual OriginType itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::GetTransformDomainOrigin ( ) const
virtual

Function to retrieve the transform domain origin.

◆ GetTransformDomainPhysicalDimensions()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual PhysicalDimensionsType itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::GetTransformDomainPhysicalDimensions ( ) const
virtual

Function to retrieve the transform domain physical dimensions.

◆ GetTransformTypeAsString()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
std::string itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::GetTransformTypeAsString ( ) const
overridevirtual

Generate a platform independent name

Implements itk::TransformBaseTemplate< TParametersValueType >.

◆ InsideValidRegion()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
bool itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::InsideValidRegion ( ContinuousIndexType ) const
overrideprivatevirtual

Check if a continuous index is inside the valid region.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ New()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
static Pointer itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::New ( )
static

New macro for creation of through the object factory.

◆ PrintSelf()

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

◆ SetCoefficientImageInformationFromFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetCoefficientImageInformationFromFixedParameters ( )
overrideprivatevirtual

Construct control point grid size from transform domain information in the fixed parameters.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetCoefficientImages()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetCoefficientImages ( const CoefficientImageArray images)
overridevirtual

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.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParameters()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParameters ( const FixedParametersType passedParameters)
overridevirtual

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::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ SetFixedParametersFromCoefficientImageInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersFromCoefficientImageInformation ( )
private

◆ SetFixedParametersFromTransformDomainInformation()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetFixedParametersFromTransformDomainInformation ( const OriginType meshOrigin,
const PhysicalDimensionsType meshPhysical,
const DirectionType meshDirection,
const MeshSizeType meshSize 
)
private

◆ SetFixedParametersGridDirectionFromTransformDomainInformation()

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

Methods have empty implementations

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

Definition at line 314 of file itkBSplineTransform.h.

◆ SetFixedParametersGridOriginFromTransformDomainInformation()

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

Methods have empty implementations

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

Definition at line 309 of file itkBSplineTransform.h.

◆ SetFixedParametersGridSizeFromTransformDomainInformation()

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

Methods have empty implementations

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

Definition at line 307 of file itkBSplineTransform.h.

◆ SetFixedParametersGridSpacingFromTransformDomainInformation()

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

Methods have empty implementations

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

Definition at line 311 of file itkBSplineTransform.h.

◆ SetTransformDomainDirection()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetTransformDomainDirection ( const DirectionType )
virtual

Function to specify the transform domain direction.

◆ SetTransformDomainMeshSize()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetTransformDomainMeshSize ( const MeshSizeType )
virtual

Function to specify the transform domain mesh size.

◆ SetTransformDomainOrigin()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetTransformDomainOrigin ( const OriginType )
virtual

Function to specify the transform domain origin.

◆ SetTransformDomainPhysicalDimensions()

template<typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSplineOrder = 3>
virtual void itk::BSplineTransform< TParametersValueType, VDimension, VSplineOrder >::SetTransformDomainPhysicalDimensions ( const PhysicalDimensionsType )
virtual

Function to specify the transform domain physical dimensions.

◆ TransformPoint()

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

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.

Implements itk::BSplineBaseTransform< TParametersValueType, VDimension, VSplineOrder >.

Member Data Documentation

◆ SpaceDimension

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

Dimension of the domain space.

Definition at line 121 of file itkBSplineTransform.h.

◆ SplineOrder

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

The BSpline order.

Definition at line 124 of file itkBSplineTransform.h.


The documentation for this class was generated from the following file:
New
static Pointer New()
itk::images
*par Constraints *The filter requires an image with at least two dimensions and a vector *length of at least The theory supports extension to scalar images
Definition: itkVectorGradientMagnitudeImageFilter.h:107