#include <itkBSplineInterpolationWeightFunctionBase.h>

Detailed Description

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
class itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >

Returns the weights over the support region used for B-spline interpolation/reconstruction.

Computes/evaluate the B-spline interpolation weights over the support region of the B-spline.

This class is templated over the coordinate representation type, the space dimension and the spline order.

See also: Point; Index; ContinuousIndex

Definition at line 49 of file itkBSplineInterpolationWeightFunctionBase.h.

Inheritance diagram for itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >:

[legend]

Public Types
using	ConstPointer = SmartPointer<const Self>
using	ContinuousIndexType = ContinuousIndex<TCoordinate, VSpaceDimension>
using	IndexType = Index<VSpaceDimension>
using	Pointer = SmartPointer<Self>
using	Self = BSplineInterpolationWeightFunctionBase
using	SizeType = Size<VSpaceDimension>
using	Superclass
using	WeightsType = FixedArray<double, NumberOfWeights>

Public Member Functions
WeightsType	Evaluate (const ContinuousIndexType &cindex, const IndexType &startIndex) const
WeightsType	Evaluate (const ContinuousIndexType &index) const override
	ITK_DISALLOW_COPY_AND_MOVE (BSplineInterpolationWeightFunctionBase)
	itkOverrideGetNameOfClassMacro (BSplineInterpolationWeightFunctionBase)
	itkStaticConstMacro (SpaceDimension, unsigned int, VSpaceDimension)
	itkStaticConstMacro (SplineOrder, unsigned int, VSplineOrder)

Static Public Member Functions
static IndexType	ComputeStartIndex (const ContinuousIndexType &index)

Static Public Attributes
static constexpr unsigned long	NumberOfWeights = Math::UnsignedPower(VSplineOrder + 1, VSpaceDimension)
static constexpr SizeType	SupportSize { SizeType::Filled(VSplineOrder + 1) }

Protected Types
using	DerivativeKernelPointer = typename DerivativeKernelType::Pointer
using	DerivativeKernelType = BSplineDerivativeKernelFunction<VSplineOrder>
using	KernelPointer = typename KernelType::Pointer
using	KernelType = BSplineKernelFunction2<VSplineOrder>
using	OneDWeightsType = Matrix<double, Self::SpaceDimension, VSplineOrder + 1>
using	SecondOrderDerivativeKernelPointer = typename SecondOrderDerivativeKernelType::Pointer
using	SecondOrderDerivativeKernelType = BSplineSecondOrderDerivativeKernelFunction2<VSplineOrder>
using	WeightArrayType = typename KernelType::WeightArrayType

Protected Member Functions
	BSplineInterpolationWeightFunctionBase ()=default
virtual void	Compute1DWeights (const ContinuousIndexType &index, const IndexType &startIndex, OneDWeightsType &weights1D) const =0
void	PrintSelf (std::ostream &os, Indent indent) const override
	~BSplineInterpolationWeightFunctionBase () override=default

Private Types
using	TableType = FixedArray<IndexType, NumberOfWeights>

Private Attributes
const TableType	m_OffsetToIndexTable

Member Typedef Documentation

◆ ConstPointer

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::ConstPointer = SmartPointer<const Self>

Definition at line 61 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ ContinuousIndexType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::ContinuousIndexType = ContinuousIndex<TCoordinate, VSpaceDimension>

ContinuousIndex typedef support.

Definition at line 83 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ DerivativeKernelPointer

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::DerivativeKernelPointer = typename DerivativeKernelType::Pointer

protected

Definition at line 112 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ DerivativeKernelType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::DerivativeKernelType = BSplineDerivativeKernelFunction<VSplineOrder>

protected

Definition at line 111 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ IndexType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::IndexType = Index<VSpaceDimension>

Index and size typedef support.

Definition at line 79 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ KernelPointer

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::KernelPointer = typename KernelType::Pointer

protected

Definition at line 110 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ KernelType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::KernelType = BSplineKernelFunction2<VSplineOrder>

protected

Interpolation kernel types.

Definition at line 109 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ OneDWeightsType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::OneDWeightsType = Matrix<double, Self::SpaceDimension, VSplineOrder + 1>

protected

Typedef for intermediary 1D weights. The Matrix is at least twice as fast as std::vector< vnl_vector< double > >, probably because of the fixed size at compile time.

Definition at line 121 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ Pointer

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::Pointer = SmartPointer<Self>

Definition at line 60 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SecondOrderDerivativeKernelPointer

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::SecondOrderDerivativeKernelPointer = typename SecondOrderDerivativeKernelType::Pointer

protected

Definition at line 114 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SecondOrderDerivativeKernelType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::SecondOrderDerivativeKernelType = BSplineSecondOrderDerivativeKernelFunction2<VSplineOrder>

protected

Definition at line 113 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ Self

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::Self = BSplineInterpolationWeightFunctionBase

Standard class typedefs.

Definition at line 57 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SizeType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::SizeType = Size<VSpaceDimension>

Definition at line 80 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ Superclass

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::Superclass

Initial value:

FunctionBase<ContinuousIndex<TCoordinate, VSpaceDimension>,

FixedArray<double, Math::UnsignedPower(VSplineOrder + 1, VSpaceDimension)>>

double

Definition at line 58 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ TableType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::TableType = FixedArray<IndexType, NumberOfWeights>

private

Lookup table type.

Definition at line 135 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ WeightArrayType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::WeightArrayType = typename KernelType::WeightArrayType

protected

Definition at line 115 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ WeightsType

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

using itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::WeightsType = FixedArray<double, NumberOfWeights>

OutputType typedef support.

Definition at line 76 of file itkBSplineInterpolationWeightFunctionBase.h.

Constructor & Destructor Documentation

◆ BSplineInterpolationWeightFunctionBase()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::BSplineInterpolationWeightFunctionBase ( )

protecteddefault

◆ ~BSplineInterpolationWeightFunctionBase()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::~BSplineInterpolationWeightFunctionBase ( )

overrideprotecteddefault

Member Function Documentation

◆ Compute1DWeights()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

virtual void itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::Compute1DWeights	(	const ContinuousIndexType &	index,
		const IndexType &	startIndex,
		OneDWeightsType &	weights1D ) const

protectedpure virtual

Compute the 1D weights.

◆ ComputeStartIndex()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

IndexType itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::ComputeStartIndex ( const ContinuousIndexType & index )

static

Compute the start index of the support region.

◆ Evaluate() [1/2]

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

WeightsType itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::Evaluate	(	const ContinuousIndexType &	cindex,
		const IndexType &	startIndex ) const

Evaluate the weights at specified ContinousIndex position. The weights are returned in the user specified container. On return, startIndex contains the start index of the support region over which the weights are defined.

◆ Evaluate() [2/2]

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

WeightsType itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::Evaluate ( const ContinuousIndexType & index ) const

override

Evaluate the weights at specified ContinousIndex position.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::ITK_DISALLOW_COPY_AND_MOVE ( BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder > )

◆ itkOverrideGetNameOfClassMacro()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::itkOverrideGetNameOfClassMacro ( BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder > )

Run-time type information (and related methods).

◆ itkStaticConstMacro() [1/2]

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::itkStaticConstMacro	(	SpaceDimension	,
		unsigned int	,
		VSpaceDimension	)

Space dimension.

◆ itkStaticConstMacro() [2/2]

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::itkStaticConstMacro	(	SplineOrder	,
		unsigned int	,
		VSplineOrder	)

Spline order.

◆ PrintSelf()

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

void itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotected

Print the member variables.

Member Data Documentation

◆ m_OffsetToIndexTable

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

const TableType itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::m_OffsetToIndexTable

private

Initial value:

{ [] {
    TableType     table;
    std::copy_n(ZeroBasedIndexRange<SpaceDimension>(SupportSize).cbegin(), NumberOfWeights, table.begin());
    return table;
  }() }

Table mapping linear offset to indices.

Definition at line 138 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ NumberOfWeights

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

unsigned long itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::NumberOfWeights = Math::UnsignedPower(VSplineOrder + 1, VSpaceDimension)

staticconstexpr

The number of weights as a static const.

Definition at line 73 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SupportSize

template<typename TCoordinate = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>

SizeType itk::BSplineInterpolationWeightFunctionBase< TCoordinate, VSpaceDimension, VSplineOrder >::SupportSize { SizeType::Filled(VSplineOrder + 1) }

staticconstexpr

The support region size: a hypercube of length SplineOrder + 1

Definition at line 102 of file itkBSplineInterpolationWeightFunctionBase.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Types

Private Attributes

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ DerivativeKernelPointer

◆ DerivativeKernelType

◆ IndexType

◆ KernelPointer

◆ KernelType

◆ OneDWeightsType

◆ Pointer

◆ SecondOrderDerivativeKernelPointer

◆ SecondOrderDerivativeKernelType

◆ Self

◆ SizeType

◆ Superclass

◆ TableType

◆ WeightArrayType

◆ WeightsType

Constructor & Destructor Documentation

◆ BSplineInterpolationWeightFunctionBase()

◆ ~BSplineInterpolationWeightFunctionBase()

Member Function Documentation

◆ Compute1DWeights()

◆ ComputeStartIndex()

◆ Evaluate() [1/2]

◆ Evaluate() [2/2]

◆ ITK_DISALLOW_COPY_AND_MOVE()

◆ itkOverrideGetNameOfClassMacro()

◆ itkStaticConstMacro() [1/2]

◆ itkStaticConstMacro() [2/2]

◆ PrintSelf()

Member Data Documentation

◆ m_OffsetToIndexTable

◆ NumberOfWeights

◆ SupportSize