#include <itkKernelTransform.h>

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

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

Detailed Description

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

Intended to be a base class for elastic body spline and thin plate spline. This is implemented in as straightforward a manner as possible from the IEEE TMI paper by Davis, Khotanzad, Flamig, and Harms, Vol. 16, No. 3 June 1997. Notation closely follows their paper, so if you have it in front of you, this code will make a lot more sense.

KernelTransform: Provides support for defining source and target landmarks Defines a number of data types used in the computations Defines the mathematical framework used to compute all splines, so that subclasses need only provide a kernel specific to that spline

This formulation allows the stiffness of the spline to be adjusted, allowing the spline to vary from interpolating the landmarks to approximating the landmarks. This part of the formulation is based on the short paper by R. Sprengel, K. Rohr, H. Stiehl. "Thin-Plate Spline Approximation for Image Registration". In 18th International Conference of the IEEE Engineering in Medicine and Biology Society. 1996.

Definition at line 61 of file itkKernelTransform.h.

Public Types
using	AMatrixType = vnl_matrix_fixed< TParametersValueType, NDimensions, NDimensions >

using	BMatrixType = vnl_vector_fixed< TParametersValueType, NDimensions >

using	ColumnMatrixType = vnl_matrix_fixed< TParametersValueType, NDimensions, 1 >

using	ConstPointer = SmartPointer< const Self >

using	DMatrixType = vnl_matrix< TParametersValueType >

using	FixedParametersType = typename Superclass::FixedParametersType

using	GMatrixType = vnl_matrix_fixed< TParametersValueType, NDimensions, NDimensions >

using	IMatrixType = vnl_matrix_fixed< TParametersValueType, NDimensions, NDimensions >

using	InputCovariantVectorType = typename Superclass::InputCovariantVectorType

using	InputPointType = typename Superclass::InputPointType

using	InputVectorType = typename Superclass::InputVectorType

using	InputVnlVectorType = typename Superclass::InputVnlVectorType

using	InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType

using	JacobianPositionType = typename Superclass::JacobianPositionType

using	JacobianType = typename Superclass::JacobianType

using	KMatrixType = vnl_matrix< TParametersValueType >

using	LMatrixType = vnl_matrix< TParametersValueType >

using	NumberOfParametersType = typename Superclass::NumberOfParametersType

using	OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType

using	OutputPointType = typename Superclass::OutputPointType

using	OutputVectorType = typename Superclass::OutputVectorType

using	OutputVnlVectorType = typename Superclass::OutputVnlVectorType

using	ParametersType = typename Superclass::ParametersType

using	PMatrixType = vnl_matrix< TParametersValueType >

using	Pointer = SmartPointer< Self >

using	PointIdentifier = typename PointSetType::PointIdentifier

using	PointsConstIterator = typename PointSetType::PointsContainerConstIterator

using	PointsContainer = typename PointSetType::PointsContainer

using	PointSetPointer = typename PointSetType::Pointer

using	PointSetTraitsType = DefaultStaticMeshTraits< TParametersValueType, NDimensions, NDimensions, TParametersValueType, TParametersValueType >

using	PointSetType = PointSet< InputPointType, NDimensions, PointSetTraitsType >

using	PointsIterator = typename PointSetType::PointsContainerIterator

using	RowMatrixType = vnl_matrix_fixed< TParametersValueType, 1, NDimensions >

using	ScalarType = typename Superclass::ScalarType

using	Self = KernelTransform

using	Superclass = Transform< TParametersValueType, NDimensions, NDimensions >

using	TransformCategoryType = typename Superclass::TransformCategoryType

using	VectorSetPointer = typename VectorSetType::Pointer

using	VectorSetType = itk::VectorContainer< SizeValueType, InputVectorType >

using	WMatrixType = vnl_matrix< TParametersValueType >

using	YMatrixType = vnl_matrix< TParametersValueType >

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	TransformCategoryType = typename Superclass::TransformCategoryType

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

enum	TransformCategoryType { UnknownTransformCategory =0, Linear =1, BSpline =2, Spline =3, DisplacementField =4, VelocityField =5 }

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 &p, JacobianType &jacobian) const override

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

void	ComputeWMatrix ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const VectorSetType *	GetDisplacements () const

const FixedParametersType &	GetFixedParameters () const override

virtual VectorSetType *	GetModifiableDisplacements ()

virtual const char *	GetNameOfClass () const

const ParametersType &	GetParameters () const override

TransformCategoryType	GetTransformCategory () const override

void	SetFixedParameters (const FixedParametersType &) override

void	SetParameters (const ParametersType &) override

OutputPointType	TransformPoint (const InputPointType &thisPoint) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override

virtual void	UpdateParameters () const


virtual PointSetType *	GetModifiableSourceLandmarks ()

virtual const PointSetType *	GetSourceLandmarks () const

virtual void	SetSourceLandmarks (PointSetType *)


virtual PointSetType *	GetModifiableTargetLandmarks ()

virtual const PointSetType *	GetTargetLandmarks () const

virtual void	SetTargetLandmarks (PointSetType *)


OutputVectorType	TransformVector (const InputVectorType &) const override


OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override


virtual void	SetStiffness (double _arg)

virtual double	GetStiffness () const

Public Member Functions inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
virtual void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const =0

virtual void	ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const

void	CopyInFixedParameters (const FixedParametersValueType const begin, const FixedParametersValueType const end) override

void	CopyInParameters (const ParametersValueType const begin, const ParametersValueType const end) override

const FixedParametersType &	GetFixedParameters () const override

unsigned int	GetInputSpaceDimension () const override

bool	GetInverse (Self *) const

virtual InverseTransformBasePointer	GetInverseTransform () const

virtual NumberOfParametersType	GetNumberOfFixedParameters () const

virtual NumberOfParametersType	GetNumberOfLocalParameters () const

NumberOfParametersType	GetNumberOfParameters () const override

unsigned int	GetOutputSpaceDimension () const override

const ParametersType &	GetParameters () const override

TransformCategoryType	GetTransformCategory () const override

std::string	GetTransformTypeAsString () const override

virtual bool	IsLinear () const

	itkCloneMacro (Self)

void	SetFixedParameters (const FixedParametersType &) override=0

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 &tensor, const InputPointType &point) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &) const

virtual OutputVectorPixelType	TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const

virtual OutputPointType	TransformPoint (const InputPointType &) const =0

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const

virtual OutputSymmetricSecondRankTensorType	TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const

virtual OutputVectorPixelType	TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, 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 OutputVectorPixelType	TransformVector (const InputVectorPixelType &) const

virtual OutputVectorPixelType	TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const

virtual void	UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.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 &x, 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

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 noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	SpaceDimension = NDimensions

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

static constexpr unsigned int	OutputSpaceDimension

Protected Member Functions
void	ComputeD ()

virtual void	ComputeDeformationContribution (const InputPointType &inputPoint, OutputPointType &result) const

virtual void	ComputeG (const InputVectorType &landmarkVector, GMatrixType &gmatrix) const

void	ComputeK ()

void	ComputeL ()

void	ComputeP ()

virtual const GMatrixType &	ComputeReflexiveG (PointsIterator) const

void	ComputeY ()

	KernelTransform ()

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

void	ReorganizeW ()

	~KernelTransform () override=default

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

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

	Transform ()

	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 &time)

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

Protected Attributes
AMatrixType	m_AMatrix

BMatrixType	m_BVector

VectorSetPointer	m_Displacements

DMatrixType	m_DMatrix

GMatrixType	m_GMatrix

IMatrixType	m_I

KMatrixType	m_KMatrix

LMatrixType	m_LMatrix

PMatrixType	m_PMatrix

PointSetPointer	m_SourceLandmarks

double	m_Stiffness

PointSetPointer	m_TargetLandmarks

WMatrixType	m_WMatrix

bool	m_WMatrixComputed

YMatrixType	m_YMatrix

Protected Attributes inherited from itk::Transform< TParametersValueType, NDimensions, NDimensions >
DirectionChangeMatrix	m_DirectionChange

FixedParametersType	m_FixedParameters

ParametersType	m_Parameters

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