ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | List of all members
itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder > Class Template Reference

#include <itkBSplineInterpolationWeightFunction.h>

+ Inheritance diagram for itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >:
+ Collaboration diagram for itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, VSpaceDimension >
 
using IndexType = Index< VSpaceDimension >
 
using Pointer = SmartPointer< Self >
 
using Self = BSplineInterpolationWeightFunction
 
using SizeType = Size< VSpaceDimension >
 
using Superclass = FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >, FixedArray< double, Math::UnsignedPower(VSplineOrder+1, VSpaceDimension)> >
 
using WeightsType = typename Superclass::OutputType
 
- Public Types inherited from itk::FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >, FixedArray< double, Math::UnsignedPower(VSplineOrder+1, VSpaceDimension)> >
using ConstPointer = SmartPointer< const Self >
 
using InputType = ContinuousIndex< TCoordRep, VSpaceDimension >
 
using OutputType = FixedArray< double, Math::UnsignedPower(VSplineOrder+1, VSpaceDimension)>
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
using Superclass = Object
 
- 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
 
WeightsType Evaluate (const ContinuousIndexType &index) const override
 
virtual void Evaluate (const ContinuousIndexType &index, WeightsType &weights, IndexType &startIndex) const
 
virtual const char * GetNameOfClass () 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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::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 NumberOfWeights { WeightsType::Length }
 
static constexpr unsigned int SpaceDimension = VSpaceDimension
 
static constexpr unsigned int SplineOrder = VSplineOrder
 
static constexpr SizeType SupportSize { SizeType::Filled(VSplineOrder + 1) }
 

Protected Member Functions

 BSplineInterpolationWeightFunction ()=default
 
 ~BSplineInterpolationWeightFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >, FixedArray< double, Math::UnsignedPower(VSplineOrder+1, VSpaceDimension)> >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Types

using TableType = FixedArray< IndexType, NumberOfWeights >
 

Private Attributes

const TableType m_OffsetToIndexTable
 

Additional Inherited Members

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

Detailed Description

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
class itk::BSplineInterpolationWeightFunction< 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 48 of file itkBSplineInterpolationWeightFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 61 of file itkBSplineInterpolationWeightFunction.h.

◆ ContinuousIndexType

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

ContinuousIndex type alias support.

Definition at line 86 of file itkBSplineInterpolationWeightFunction.h.

◆ IndexType

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

Index and size type alias support.

Definition at line 82 of file itkBSplineInterpolationWeightFunction.h.

◆ Pointer

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

Definition at line 60 of file itkBSplineInterpolationWeightFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 56 of file itkBSplineInterpolationWeightFunction.h.

◆ SizeType

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

Definition at line 83 of file itkBSplineInterpolationWeightFunction.h.

◆ Superclass

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

Definition at line 58 of file itkBSplineInterpolationWeightFunction.h.

◆ TableType

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::TableType = FixedArray<IndexType, NumberOfWeights>
private

Lookup table type.

Definition at line 121 of file itkBSplineInterpolationWeightFunction.h.

◆ WeightsType

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
using itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::WeightsType = typename Superclass::OutputType

OutputType type alias support.

Definition at line 76 of file itkBSplineInterpolationWeightFunction.h.

Constructor & Destructor Documentation

◆ BSplineInterpolationWeightFunction()

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::BSplineInterpolationWeightFunction ( )
protecteddefault

◆ ~BSplineInterpolationWeightFunction()

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

Member Function Documentation

◆ CreateAnother()

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual::itk::LightObject::Pointer itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

◆ Evaluate() [1/2]

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
WeightsType itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::Evaluate ( const ContinuousIndexType index) const
overridevirtual

◆ Evaluate() [2/2]

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

Evaluate the weights at specified ContinuousIndex position. The weights are returned in the user specified container. This function assume that weights can hold (SplineOrder + 1)^(SpaceDimension) elements. For efficiency, no size checking is done. On return, startIndex contains the start index of the support region over which the weights are defined.

◆ GetNameOfClass()

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
virtual const char* itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::GetNameOfClass ( ) const
virtual

◆ New()

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
static Pointer itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::New ( )
static

New macro for creation of through the object factory.

Member Data Documentation

◆ m_OffsetToIndexTable

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
const TableType itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::m_OffsetToIndexTable
private
Initial value:
{ [] {
TableType table;
const auto supportSize = SupportSize;
std::copy_n(ZeroBasedIndexRange<SpaceDimension>(supportSize).cbegin(), NumberOfWeights, table.begin());
return table;
}() }

Table mapping linear offset to indices.

Definition at line 124 of file itkBSplineInterpolationWeightFunction.h.

◆ NumberOfWeights

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
constexpr unsigned int itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::NumberOfWeights { WeightsType::Length }
staticconstexpr

Number of weights.

Definition at line 79 of file itkBSplineInterpolationWeightFunction.h.

◆ SpaceDimension

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
constexpr unsigned int itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::SpaceDimension = VSpaceDimension
staticconstexpr

Space dimension.

Definition at line 70 of file itkBSplineInterpolationWeightFunction.h.

◆ SplineOrder

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
constexpr unsigned int itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::SplineOrder = VSplineOrder
staticconstexpr

Spline order.

Definition at line 73 of file itkBSplineInterpolationWeightFunction.h.

◆ SupportSize

template<typename TCoordRep = float, unsigned int VSpaceDimension = 2, unsigned int VSplineOrder = 3>
constexpr SizeType itk::BSplineInterpolationWeightFunction< TCoordRep, VSpaceDimension, VSplineOrder >::SupportSize { SizeType::Filled(VSplineOrder + 1) }
staticconstexpr

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

Definition at line 89 of file itkBSplineInterpolationWeightFunction.h.


The documentation for this class was generated from the following file:
itk::BSplineInterpolationWeightFunction::TableType
FixedArray< IndexType, NumberOfWeights > TableType
Definition: itkBSplineInterpolationWeightFunction.h:121
itk::BSplineInterpolationWeightFunction::SupportSize
static constexpr SizeType SupportSize
Definition: itkBSplineInterpolationWeightFunction.h:89
itk::BSplineInterpolationWeightFunction::NumberOfWeights
static constexpr unsigned int NumberOfWeights
Definition: itkBSplineInterpolationWeightFunction.h:79