#include <itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h>

Inheritance diagram for itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, NDimensions >:

Collaboration diagram for itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, NDimensions >:

Public Types
using	ArrayType = typename BSplineFilterType::ArrayType

using	ArrayValueType = typename ArrayType::ValueType

using	BSplineFilterType = DisplacementFieldToBSplineImageFilter< DisplacementFieldType >

using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	DerivativeValueType = typename DerivativeType::ValueType

using	DisplacementFieldConstPointer = typename Superclass::DisplacementFieldConstPointer

using	DisplacementFieldControlPointLatticeType = DisplacementFieldType

using	DisplacementFieldPointer = typename Superclass::DisplacementFieldPointer

using	DisplacementFieldType = typename Superclass::DisplacementFieldType

using	DisplacementVectorType = typename DisplacementFieldType::PixelType

using	Pointer = SmartPointer< Self >

using	PointSetType = PointSet< DisplacementVectorType, Dimension >

using	ScalarType = typename Superclass::ScalarType

using	Self = BSplineSmoothingOnUpdateDisplacementFieldTransform

using	SplineOrderType = unsigned int

using	Superclass = DisplacementFieldTransform< TParametersValueType, NDimensions >

using	TransformPointer = typename Transform< TParametersValueType, NDimensions, NDimensions >::Pointer

using	WeightsContainerType = typename BSplineFilterType::WeightsContainerType

Public Types inherited from itk::DisplacementFieldTransform< TParametersValueType, NDimensions >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = typename Superclass::DerivativeType

using	DirectionType = typename DisplacementFieldType::DirectionType

using	DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer

using	DisplacementFieldPointer = typename DisplacementFieldType::Pointer

using	DisplacementFieldType = Image< OutputVectorType, Dimension >

using	FixedParametersType = typename Superclass::FixedParametersType

using	FixedParametersValueType = typename Superclass::FixedParametersValueType

using	IndexType = typename DisplacementFieldType::IndexType

using	InputCovariantVectorType = typename Superclass::InputCovariantVectorType

using	InputDiffusionTensor3DType = typename Superclass::InputDiffusionTensor3DType

using	InputPointType = typename Superclass::InputPointType

using	InputTensorEigenVectorType = CovariantVector< ScalarType, InputDiffusionTensor3DType::Dimension >

using	InputVectorPixelType = typename Superclass::InputVectorPixelType

using	InputVectorType = typename Superclass::InputVectorType

using	InputVnlVectorType = typename Superclass::InputVnlVectorType

using	InterpolatorType = VectorInterpolateImageFunction< DisplacementFieldType, ScalarType >

using	InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType

using	InverseTransformBasePointer = typename Superclass::InverseTransformBasePointer

using	JacobianPositionType = typename Superclass::JacobianPositionType

using	JacobianType = typename Superclass::JacobianType

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper< ScalarType, OutputVectorType::Dimension, Dimension >

using	OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType

using	OutputDiffusionTensor3DType = typename Superclass::OutputDiffusionTensor3DType

using	OutputPointType = typename Superclass::OutputPointType

using	OutputTensorEigenVectorType = CovariantVector< ScalarType, OutputDiffusionTensor3DType::Dimension >

using	OutputVectorPixelType = typename Superclass::OutputVectorPixelType

using	OutputVectorType = typename Superclass::OutputVectorType

using	OutputVnlVectorType = typename Superclass::OutputVnlVectorType

using	ParametersType = typename Superclass::ParametersType

using	ParametersValueType = typename Superclass::ParametersValueType

using	PixelType = typename DisplacementFieldType::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = typename DisplacementFieldType::PointType

using	RegionType = typename DisplacementFieldType::RegionType

using	ScalarType = typename Superclass::ScalarType

using	Self = DisplacementFieldTransform

using	SizeType = typename DisplacementFieldType::SizeType

using	SpacingType = typename DisplacementFieldType::SpacingType

using	Superclass = Transform< TParametersValueType, NDimensions, NDimensions >

using	TransformCategoryEnum = typename Superclass::TransformCategoryEnum

Public Types inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = Array< ParametersValueType >

using	DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >

using	FixedParametersType = typename Superclass::FixedParametersType

using	FixedParametersValueType = typename Superclass::FixedParametersValueType

using	InputCovariantVectorType = CovariantVector< TParametersValueType, NInputDimensions >

using	InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

using	InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >

using	InputPointType = Point< TParametersValueType, NInputDimensions >

using	InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, NInputDimensions >

using	InputVectorPixelType = VariableLengthVector< TParametersValueType >

using	InputVectorType = Vector< TParametersValueType, NInputDimensions >

using	InputVnlVectorType = vnl_vector_fixed< TParametersValueType, NInputDimensions >

using	InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, NInputDimensions, NOutputDimensions >

using	InverseTransformBasePointer = typename InverseTransformBaseType::Pointer

using	InverseTransformBaseType = Transform< TParametersValueType, NOutputDimensions, NInputDimensions >

using	JacobianPositionType = vnl_matrix_fixed< ParametersValueType, NOutputDimensions, NInputDimensions >

using	JacobianType = Array2D< ParametersValueType >

using	MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	OutputCovariantVectorType = CovariantVector< TParametersValueType, NOutputDimensions >

using	OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >

using	OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >

using	OutputPointType = Point< TParametersValueType, NOutputDimensions >

using	OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, NOutputDimensions >

using	OutputVectorPixelType = VariableLengthVector< TParametersValueType >

using	OutputVectorType = Vector< TParametersValueType, NOutputDimensions >

using	OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, NOutputDimensions >

using	ParametersType = typename Superclass::ParametersType

using	ParametersValueType = typename Superclass::ParametersValueType

using	Pointer = SmartPointer< Self >

using	ScalarType = ParametersValueType

using	Self = Transform

using	Superclass = TransformBaseTemplate< TParametersValueType >

using	TransformCategoryEnum = typename Superclass::TransformCategoryEnum

Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
using	ConstPointer = SmartPointer< const Self >

using	FixedParametersType = OptimizerParameters< FixedParametersValueType >

using	FixedParametersValueType = double

using	NumberOfParametersType = IdentifierType

using	ParametersType = OptimizerParameters< ParametersValueType >

using	ParametersValueType = TParametersValueType

using	Pointer = SmartPointer< Self >

using	Self = TransformBaseTemplate

using	Superclass = Object

using	TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

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

Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, NDimensions >
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	SetDisplacementField (DisplacementFieldType *field)

virtual DisplacementFieldType *	GetModifiableDisplacementField ()

virtual const DisplacementFieldType *	GetDisplacementField () const

virtual void	SetInverseDisplacementField (DisplacementFieldType *inverseField)

virtual DisplacementFieldType *	GetModifiableInverseDisplacementField ()

virtual const DisplacementFieldType *	GetInverseDisplacementField () const

virtual void	SetInterpolator (InterpolatorType *interpolator)

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const InterpolatorType *	GetInterpolator () const

virtual void	SetInverseInterpolator (InterpolatorType *interpolator)

virtual InterpolatorType *	GetModifiableInverseInterpolator ()

virtual const InterpolatorType *	GetInverseInterpolator () const

virtual const ModifiedTimeType &	GetDisplacementFieldSetTime () const

OutputPointType	TransformPoint (const InputPointType &inputPoint) const override

OutputVectorType	TransformVector (const InputVectorType &) const override

OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override

OutputDiffusionTensor3DType	TransformDiffusionTensor (const InputDiffusionTensor3DType &) const

OutputVectorPixelType	TransformDiffusionTensor (const InputVectorPixelType &) const

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override

OutputVectorPixelType	TransformCovariantVector (const InputVectorPixelType &) const override

void	SetParameters (const ParametersType &params) override

void	SetFixedParameters (const FixedParametersType &) override

void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &j) const override

virtual void	ComputeJacobianWithRespectToParameters (const IndexType &, JacobianType &j) const

void	ComputeJacobianWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian) const override

void	ComputeInverseJacobianWithRespectToPosition (const InputPointType &point, InverseJacobianPositionType &jacobian) const override

virtual void	ComputeJacobianWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian) const

virtual void	GetInverseJacobianOfForwardFieldWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian, bool useSVD=false) const

virtual void	GetInverseJacobianOfForwardFieldWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian, bool useSVD=false) const

void	UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override

bool	GetInverse (Self *inverse) const

InverseTransformBasePointer	GetInverseTransform () const override

virtual void	SetIdentity ()

TransformCategoryEnum	GetTransformCategory () const override

NumberOfParametersType	GetNumberOfLocalParameters () 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, NDimensions, NDimensions >
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 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	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const

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

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

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, NDimensions >
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	Dimension = NDimensions

Static Public Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, NDimensions >
static constexpr unsigned int	Dimension = NDimensions

Static Public Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
static constexpr unsigned int	InputSpaceDimension

static constexpr unsigned int	OutputSpaceDimension

SplineOrderType	m_SplineOrder { 3 }

bool	m_EnforceStationaryBoundary { true }

ArrayType	m_NumberOfControlPointsForTheUpdateField

ArrayType	m_NumberOfControlPointsForTheTotalField

virtual void	EnforceStationaryBoundaryOn ()

virtual void	EnforceStationaryBoundaryOff ()

virtual void	SetEnforceStationaryBoundary (bool _arg)

virtual bool	GetEnforceStationaryBoundary () const

	BSplineSmoothingOnUpdateDisplacementFieldTransform ()

	~BSplineSmoothingOnUpdateDisplacementFieldTransform () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

LightObject::Pointer	InternalClone () const override

DisplacementFieldPointer	BSplineSmoothDisplacementField (const DisplacementFieldType *, const ArrayType &)

Additional Inherited Members
Protected Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, NDimensions >
	DisplacementFieldTransform ()

	~DisplacementFieldTransform () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
LightObject::Pointer	InternalClone () const override

	Transform ()

	Transform (NumberOfParametersType numberOfParameters)

	~Transform () override=default

OutputDiffusionTensor3DType	PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const

Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
	TransformBaseTemplate ()=default

	~TransformBaseTemplate () override=default

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 ()

Protected Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, NDimensions >
DisplacementFieldType::Pointer	m_DisplacementField

DisplacementFieldType::Pointer	m_InverseDisplacementField

InterpolatorType::Pointer	m_Interpolator

InterpolatorType::Pointer	m_InverseInterpolator

ModifiedTimeType	m_DisplacementFieldSetTime { 0 }

JacobianType	m_IdentityJacobian

Protected Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
ParametersType	m_Parameters

FixedParametersType	m_FixedParameters

DirectionChangeMatrix	m_DirectionChange

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

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

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.