ITK  5.4.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::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension > Class Template Reference
Group Filtering » Module ITKDisplacementField

#include <itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h>

Detailed Description

template<typename TParametersValueType, unsigned int VDimension>
class itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >

Representation of a smooth deformation field with B-splines.

Although there already exists a B-spline transform in ITK which can be used for processes such as image registration, if these processes involve a dense sampling of an image a significant computational speed-up can be achieved by densely sampling the B-spline transform prior to invoking transformations.

This class takes as input a displacement field, smooths it on demand using the specified B-spline parameters. This represents an alternative approach to B-spline (FFD) registration and is explained more in detail in the reference given below.

Author
Nicholas J. Tustison
REFERENCE
NJ Tustison, BB Avants, JC Gee, "Directly Manipulated Free-Form Deformation Image Registration", IEEE Transactions on Image Processing, 18(3):624-635, 2009.

Definition at line 52 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

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

Public Types

using ArrayType = typename BSplineFilterType::ArrayType
 
using ArrayValueType = typename ArrayType::ValueType
 
using BSplineFilterType = DisplacementFieldToBSplineImageFilter< DisplacementFieldType >
 
using ConstPointer = SmartPointer< const Self >
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using DisplacementFieldControlPointLatticeType = DisplacementFieldType
 
using DisplacementVectorType = typename DisplacementFieldType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointSetType = PointSet< DisplacementVectorType, Dimension >
 
using Self = BSplineSmoothingOnUpdateDisplacementFieldTransform
 
using SplineOrderType = unsigned int
 
using Superclass = DisplacementFieldTransform< TParametersValueType, VDimension >
 
using TransformPointer = typename Transform< TParametersValueType, VDimension, VDimension >::Pointer
 
using WeightsContainerType = typename BSplineFilterType::WeightsContainerType
 
- Public Types inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename DisplacementFieldType::DirectionType
 
using DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using DisplacementFieldType = Image< OutputVectorType, Dimension >
 
using IndexType = typename DisplacementFieldType::IndexType
 
using InputTensorEigenVectorType = CovariantVector< ScalarType, InputDiffusionTensor3DType::Dimension >
 
using InterpolatorType = VectorInterpolateImageFunction< DisplacementFieldType, ScalarType >
 
using OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper< ScalarType, OutputVectorType::Dimension, Dimension >
 
using OutputTensorEigenVectorType = CovariantVector< ScalarType, OutputDiffusionTensor3DType::Dimension >
 
using PixelType = typename DisplacementFieldType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename DisplacementFieldType::PointType
 
using RegionType = typename DisplacementFieldType::RegionType
 
using Self = DisplacementFieldTransform
 
using SizeType = typename DisplacementFieldType::SizeType
 
using SpacingType = typename DisplacementFieldType::SpacingType
 
using Superclass = Transform< TParametersValueType, VDimension, VDimension >
 
using VectorImageDisplacementFieldType = VectorImage< TParametersValueType, Dimension >
 
- 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

const char * GetNameOfClass () const override
 
virtual ArrayType GetNumberOfControlPointsForTheTotalField () const
 
virtual ArrayType GetNumberOfControlPointsForTheUpdateField () const
 
virtual SplineOrderType GetSplineOrder () const
 
void SetMeshSizeForTheTotalField (const ArrayType &)
 
void SetMeshSizeForTheUpdateField (const ArrayType &)
 
virtual void SetNumberOfControlPointsForTheTotalField (ArrayType _arg)
 
virtual void SetNumberOfControlPointsForTheUpdateField (ArrayType _arg)
 
virtual void SetSplineOrder (SplineOrderType _arg)
 
void UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
 
virtual void EnforceStationaryBoundaryOn ()
 
virtual void SetEnforceStationaryBoundary (bool _arg)
 
virtual bool GetEnforceStationaryBoundary () const
 
- Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
void ComputeInverseJacobianWithRespectToPosition (const InputPointType &point, InverseJacobianPositionType &jacobian) const override
 
virtual void ComputeJacobianWithRespectToParameters (const IndexType &, JacobianType &j) const
 
virtual void ComputeJacobianWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian) const
 
void ComputeJacobianWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian) const override
 
virtual const ModifiedTimeType & GetDisplacementFieldSetTime () const
 
bool GetInverse (Self *inverse) const
 
virtual void GetInverseJacobianOfForwardFieldWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian, bool useSVD=false) const
 
virtual void GetInverseJacobianOfForwardFieldWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian, bool useSVD=false) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
const char * GetNameOfClass () const override
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
void SetFixedParameters (const FixedParametersType &) override
 
virtual void SetIdentity ()
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const override
 
OutputVectorPixelType TransformDiffusionTensor (const InputVectorPixelType &) const
 
OutputPointType TransformPoint (const InputPointType &inputPoint) const override
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &) const override
 
void UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
 
virtual void SetDisplacementField (DisplacementFieldType *field)
 
virtual void SetDisplacementField (VectorImageDisplacementFieldType *field)
 
void SetDisplacementField (std::nullptr_t)=delete
 
virtual DisplacementFieldType * GetModifiableDisplacementField ()
 
virtual void SetInverseDisplacementField (DisplacementFieldType *inverseField)
 
virtual DisplacementFieldType * GetModifiableInverseDisplacementField ()
 
virtual void SetInterpolator (InterpolatorType *interpolator)
 
virtual InterpolatorType * GetModifiableInterpolator ()
 
virtual void SetInverseInterpolator (InterpolatorType *interpolator)
 
virtual InterpolatorType * GetModifiableInverseInterpolator ()
 
OutputVectorType TransformVector (const InputVectorType &) const override
 
OutputDiffusionTensor3DType TransformDiffusionTensor (const InputDiffusionTensor3DType &) const
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const override
 
void SetParameters (const ParametersType &params) override
 
void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &j) const override
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- 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
 
virtual const std::string & GetInputSpaceName () const
 
bool GetInverse (Self *) const
 
const char * GetNameOfClass () const override
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
virtual const std::string & GetOutputSpaceName () const
 
const ParametersType & GetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
virtual bool IsLinear () const
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
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 &vector, const InputPointType &point) 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 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 &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
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &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::TransformBaseTemplate< TParametersValueType >
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
 
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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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::DisplacementFieldTransform< TParametersValueType, VDimension >
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 Dimension = VDimension
 
- Static Public Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static constexpr unsigned int Dimension = VDimension
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 

Protected Member Functions

DisplacementFieldPointer BSplineSmoothDisplacementField (const DisplacementFieldType *, const ArrayType &)
 
 BSplineSmoothingOnUpdateDisplacementFieldTransform ()
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BSplineSmoothingOnUpdateDisplacementFieldTransform () override=default
 
- Protected Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
 DisplacementFieldTransform ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~DisplacementFieldTransform () override=default
 
- 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 Attributes

bool m_EnforceStationaryBoundary { true }
 
ArrayType m_NumberOfControlPointsForTheTotalField {}
 
ArrayType m_NumberOfControlPointsForTheUpdateField {}
 
SplineOrderType m_SplineOrder { 3 }
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static InverseTransformBasePointer InvertTransform (const TTransform &transform)
 
- Protected Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
DisplacementFieldType::Pointer m_DisplacementField {}
 
ModifiedTimeType m_DisplacementFieldSetTime { 0 }
 
JacobianType m_IdentityJacobian {}
 
InterpolatorType::Pointer m_Interpolator {}
 
DisplacementFieldType::Pointer m_InverseDisplacementField {}
 
InterpolatorType::Pointer m_InverseInterpolator {}
 
- 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 {}
 

Member Typedef Documentation

◆ ArrayType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::ArrayType = typename BSplineFilterType::ArrayType

Definition at line 93 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ ArrayValueType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::ArrayValueType = typename ArrayType::ValueType

Definition at line 94 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ BSplineFilterType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::BSplineFilterType = DisplacementFieldToBSplineImageFilter<DisplacementFieldType>

Definition at line 90 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ ConstPointer

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

Definition at line 62 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ DerivativeValueType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::DerivativeValueType = typename DerivativeType::ValueType

Definition at line 76 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ DisplacementFieldControlPointLatticeType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::DisplacementFieldControlPointLatticeType = DisplacementFieldType

Definition at line 92 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ DisplacementVectorType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::DisplacementVectorType = typename DisplacementFieldType::PixelType

type alias for projecting the input displacement field onto a B-spline field.

Definition at line 87 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ Pointer

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

Definition at line 61 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ PointSetType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::PointSetType = PointSet<DisplacementVectorType, Dimension>

Definition at line 88 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ Self

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::Self = BSplineSmoothingOnUpdateDisplacementFieldTransform

Standard class type aliases.

Definition at line 59 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ SplineOrderType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SplineOrderType = unsigned int

Definition at line 89 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ Superclass

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>

Definition at line 60 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ TransformPointer

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::TransformPointer = typename Transform<TParametersValueType, VDimension, VDimension>::Pointer

Definition at line 81 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ WeightsContainerType

template<typename TParametersValueType , unsigned int VDimension>
using itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::WeightsContainerType = typename BSplineFilterType::WeightsContainerType

Definition at line 91 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

Constructor & Destructor Documentation

◆ BSplineSmoothingOnUpdateDisplacementFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>
itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::BSplineSmoothingOnUpdateDisplacementFieldTransform ( )
protected

◆ ~BSplineSmoothingOnUpdateDisplacementFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>
itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::~BSplineSmoothingOnUpdateDisplacementFieldTransform ( )
overrideprotecteddefault

Member Function Documentation

◆ BSplineSmoothDisplacementField()

template<typename TParametersValueType , unsigned int VDimension>
DisplacementFieldPointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::BSplineSmoothDisplacementField ( const DisplacementFieldType *  ,
const ArrayType &   
)
protected

Smooth the displacement field using B-splines.

Sets displacement field and projects it onto the space of B-spline transforms.

◆ EnforceStationaryBoundaryOn()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::EnforceStationaryBoundaryOn ( )
virtual

Enforce stationary boundaries. Important for diffeomorphic transforms.

◆ GetEnforceStationaryBoundary()

template<typename TParametersValueType , unsigned int VDimension>
virtual bool itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetEnforceStationaryBoundary ( ) const
virtual

Enforce stationary boundaries. Important for diffeomorphic transforms.

◆ GetNameOfClass()

template<typename TParametersValueType , unsigned int VDimension>
const char* itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::TransformBaseTemplate< TParametersValueType >.

◆ GetNumberOfControlPointsForTheTotalField()

template<typename TParametersValueType , unsigned int VDimension>
virtual ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetNumberOfControlPointsForTheTotalField ( ) const
virtual

Get the control point grid size defining the B-spline estimate of the scalar bias field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

◆ GetNumberOfControlPointsForTheUpdateField()

template<typename TParametersValueType , unsigned int VDimension>
virtual ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetNumberOfControlPointsForTheUpdateField ( ) const
virtual

Get the control point grid size defining the B-spline estimate of the update field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

◆ GetSplineOrder()

template<typename TParametersValueType , unsigned int VDimension>
virtual SplineOrderType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetSplineOrder ( ) const
virtual

Get the spline order defining the displacement field estimate. Default = 3.

◆ InternalClone()

template<typename TParametersValueType , unsigned int VDimension>
LightObject::Pointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::InternalClone ( ) const
overrideprotectedvirtual

Clone the current transform

Reimplemented from itk::LightObject.

◆ New()

template<typename TParametersValueType , unsigned int VDimension>
static Pointer itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::New ( )
static

New macro for creation of through a Smart Pointer

◆ PrintSelf()

template<typename TParametersValueType , unsigned int VDimension>
void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ SetEnforceStationaryBoundary()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetEnforceStationaryBoundary ( bool  _arg)
virtual

Enforce stationary boundaries. Important for diffeomorphic transforms.

◆ SetMeshSizeForTheTotalField()

template<typename TParametersValueType , unsigned int VDimension>
void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetMeshSizeForTheTotalField ( const ArrayType &  )

Set the total field mesh size which is used to specify the control point grid size. The mesh size in each dimension is calculated as the difference between the control point grid size and the spline order, i.e. meshSize = controlPointGridSize - SplineOrder.

◆ SetMeshSizeForTheUpdateField()

template<typename TParametersValueType , unsigned int VDimension>
void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetMeshSizeForTheUpdateField ( const ArrayType &  )

Set the update field mesh size which is used to specify the control point grid size. The mesh size in each dimension is calculated as the difference between the control point grid size and the spline order, i.e. meshSize = controlPointGridSize - SplineOrder.

◆ SetNumberOfControlPointsForTheTotalField()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetNumberOfControlPointsForTheTotalField ( ArrayType  _arg)
virtual

Set the control point grid size defining the B-spline estimate of the total field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

◆ SetNumberOfControlPointsForTheUpdateField()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetNumberOfControlPointsForTheUpdateField ( ArrayType  _arg)
virtual

Set the control point grid size defining the B-spline estimate of the update field. In each dimension, the B-spline mesh size is equal to the number of control points in that dimension minus the spline order. Default = 4 control points in each dimension for a mesh size of 1 in each dimension.

◆ SetSplineOrder()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetSplineOrder ( SplineOrderType  _arg)
virtual

Set the spline order defining the bias field estimate. Default = 3.

◆ UpdateTransformParameters()

template<typename TParametersValueType , unsigned int VDimension>
void itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::UpdateTransformParameters ( const DerivativeType &  update,
ScalarType  factor = 1.0 
)
overridevirtual

Update the transform's parameters by the values in update. We assume update is of the same length as Parameters. Throw exception otherwise. The update process performs an smoothing on the displacement field by using BSplines. factor is a scalar multiplier for each value in update. BSplineSmoothDisplacementField is called after the update is added to the field. See base class for more details.

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

Member Data Documentation

◆ Dimension

template<typename TParametersValueType , unsigned int VDimension>
constexpr unsigned int itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::Dimension = VDimension
staticconstexpr

Dimension of the domain spaces.

Definition at line 71 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ m_EnforceStationaryBoundary

template<typename TParametersValueType , unsigned int VDimension>
bool itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_EnforceStationaryBoundary { true }
private

Definition at line 201 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ m_NumberOfControlPointsForTheTotalField

template<typename TParametersValueType , unsigned int VDimension>
ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_NumberOfControlPointsForTheTotalField {}
private

Definition at line 203 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ m_NumberOfControlPointsForTheUpdateField

template<typename TParametersValueType , unsigned int VDimension>
ArrayType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_NumberOfControlPointsForTheUpdateField {}
private

Definition at line 202 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h.

◆ m_SplineOrder

template<typename TParametersValueType , unsigned int VDimension>
SplineOrderType itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_SplineOrder { 3 }
private

Definition at line 200 of file itkBSplineSmoothingOnUpdateDisplacementFieldTransform.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