go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder > Class Template Referenceabstract

#include <itkBSplineInterpolationWeightFunctionBase.h>

Detailed Description

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
class itk::BSplineInterpolationWeightFunctionBase< TCoordRep, 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 50 of file itkBSplineInterpolationWeightFunctionBase.h.

Inheritance diagram for itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >:
Inheritance graph
[legend]

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, VSpaceDimension >
 
using IndexType = Index< VSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = BSplineInterpolationWeightFunctionBase
 
using SizeType = Size< VSpaceDimension >
 
using Superclass = FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >, FixedArray< double, Math::UnsignedPower(VSplineOrder+1, VSpaceDimension)> >
 
using WeightsType = FixedArray< double, NumberOfWeights >
 

Public Member Functions

void ComputeStartIndex (const ContinuousIndexType &index, IndexType &startIndex) const
 
virtual void Evaluate (const ContinuousIndexType &cindex, const IndexType &startIndex, WeightsType &weights) const
 
WeightsType Evaluate (const ContinuousIndexType &index) const override
 
virtual const char * GetClassName () const
 
virtual unsigned long GetNumberOfWeights () const
 
virtual const SizeTypeGetSupportSize ()
 
 ITK_DISALLOW_COPY_AND_MOVE (BSplineInterpolationWeightFunctionBase)
 
 itkStaticConstMacro (SpaceDimension, unsigned int, VSpaceDimension)
 
 itkStaticConstMacro (SplineOrder, unsigned int, VSplineOrder)
 

Static Public Attributes

static constexpr unsigned long NumberOfWeights = Math::UnsignedPower(VSplineOrder + 1, VSpaceDimension)
 

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 TableType = Array2D< unsigned long >
 
using WeightArrayType = typename KernelType::WeightArrayType
 

Protected Member Functions

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

Protected Attributes

unsigned long m_NumberOfWeights
 
TableType m_OffsetToIndexTable
 
SizeType m_SupportSize
 

Private Member Functions

void InitializeOffsetToIndexTable ()
 
void InitializeSupport ()
 

Member Typedef Documentation

◆ ConstPointer

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::ConstPointer = SmartPointer<const Self>

Definition at line 62 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ ContinuousIndexType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::ContinuousIndexType = ContinuousIndex<TCoordRep, VSpaceDimension>

ContinuousIndex typedef support.

Definition at line 84 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ DerivativeKernelPointer

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::DerivativeKernelPointer = typename DerivativeKernelType::Pointer
protected

Definition at line 118 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ DerivativeKernelType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::DerivativeKernelType = BSplineDerivativeKernelFunction<VSplineOrder>
protected

Definition at line 117 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ IndexType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::IndexType = Index<VSpaceDimension>

Index and size typedef support.

Definition at line 80 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ KernelPointer

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::KernelPointer = typename KernelType::Pointer
protected

Definition at line 116 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ KernelType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::KernelType = BSplineKernelFunction2<VSplineOrder>
protected

Interpolation kernel types.

Definition at line 115 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ OneDWeightsType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, 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 130 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ Pointer

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::Pointer = SmartPointer<Self>

Definition at line 61 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SecondOrderDerivativeKernelPointer

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::SecondOrderDerivativeKernelPointer = typename SecondOrderDerivativeKernelType::Pointer
protected

Definition at line 120 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SecondOrderDerivativeKernelType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::SecondOrderDerivativeKernelType = BSplineSecondOrderDerivativeKernelFunction2<VSplineOrder>
protected

Definition at line 119 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ Self

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::Self = BSplineInterpolationWeightFunctionBase

Standard class typedefs.

Definition at line 58 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ SizeType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::SizeType = Size<VSpaceDimension>

Definition at line 81 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ Superclass

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::Superclass = FunctionBase<ContinuousIndex<TCoordRep, VSpaceDimension>, FixedArray<double, Math::UnsignedPower(VSplineOrder + 1, VSpaceDimension)> >

Definition at line 59 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ TableType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::TableType = Array2D<unsigned long>
protected

Lookup table type.

Definition at line 124 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ WeightArrayType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::WeightArrayType = typename KernelType::WeightArrayType
protected

Definition at line 121 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ WeightsType

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::WeightsType = FixedArray<double, NumberOfWeights>

OutputType typedef support.

Definition at line 77 of file itkBSplineInterpolationWeightFunctionBase.h.

Constructor & Destructor Documentation

◆ BSplineInterpolationWeightFunctionBase()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::BSplineInterpolationWeightFunctionBase ( )
protected

◆ ~BSplineInterpolationWeightFunctionBase()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::~BSplineInterpolationWeightFunctionBase ( )
overrideprotecteddefault

Member Function Documentation

◆ Compute1DWeights()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual void itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::Compute1DWeights ( const ContinuousIndexType index,
const IndexType startIndex,
OneDWeightsType weights1D 
) const
protectedpure virtual

◆ ComputeStartIndex()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
void itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::ComputeStartIndex ( const ContinuousIndexType index,
IndexType startIndex 
) const

Compute the start index of the support region.

◆ Evaluate() [1/2]

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual void itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::Evaluate ( const ContinuousIndexType cindex,
const IndexType startIndex,
WeightsType weights 
) const
virtual

Evaluate the weights at specified ContinousIndex position. The weights are returned in the user specified container. This function assume that the weights has a correct size. For efficiency, no size checking is done. On return, startIndex contains the start index of the support region over which the weights are defined.

◆ Evaluate() [2/2]

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
WeightsType itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::Evaluate ( const ContinuousIndexType index) const
override

Evaluate the weights at specified ContinousIndex position.

◆ GetClassName()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual const char * itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::GetClassName ( ) const
virtual

◆ GetNumberOfWeights()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual unsigned long itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::GetNumberOfWeights ( ) const
virtual

Get number of weights.

◆ GetSupportSize()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual const SizeType & itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::GetSupportSize ( )
virtual

Get support region size.

◆ InitializeOffsetToIndexTable()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
void itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::InitializeOffsetToIndexTable ( )
private

Function to initialize the offset table. The offset table is a convenience table, just to keep track where is what.

◆ InitializeSupport()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
void itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::InitializeSupport ( )
private

Function to initialize the support region.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::ITK_DISALLOW_COPY_AND_MOVE ( BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >  )

◆ itkStaticConstMacro() [1/2]

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::itkStaticConstMacro ( SpaceDimension  ,
unsigned int  ,
VSpaceDimension   
)

Space dimension.

◆ itkStaticConstMacro() [2/2]

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::itkStaticConstMacro ( SplineOrder  ,
unsigned int  ,
VSplineOrder   
)

Spline order.

◆ PrintSelf()

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
void itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

Print the member variables.

Field Documentation

◆ m_NumberOfWeights

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
unsigned long itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::m_NumberOfWeights
protected

Member variables.

Definition at line 143 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ m_OffsetToIndexTable

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
TableType itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::m_OffsetToIndexTable
protected

Definition at line 145 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ m_SupportSize

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
SizeType itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::m_SupportSize
protected

Definition at line 144 of file itkBSplineInterpolationWeightFunctionBase.h.

◆ NumberOfWeights

template<class TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
constexpr unsigned long itk::BSplineInterpolationWeightFunctionBase< TCoordRep, VSpaceDimension, VSplineOrder >::NumberOfWeights = Math::UnsignedPower(VSplineOrder + 1, VSpaceDimension)
staticconstexpr

The number of weights as a static const.

Definition at line 74 of file itkBSplineInterpolationWeightFunctionBase.h.



Generated on 2023-01-13 for elastix by doxygen 1.9.6 elastix logo