ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::BSplineControlPointImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkBSplineControlPointImageFunction.h>

+ Inheritance diagram for itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >:

Public Types

using ArrayType = FixedArray< unsigned, ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using ControlPointLatticeType = TInputImage
 
using CoordRepType = TCoordRep
 
using GradientType = VariableSizeMatrix< CoordRepType >
 
using HessianComponentType = VariableSizeMatrix< CoordRepType >
 
using IndexType = typename InputImageType::IndexType
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using KernelOrder0Type = BSplineKernelFunction< 0 >
 
using KernelOrder1Type = BSplineKernelFunction< 1 >
 
using KernelOrder2Type = BSplineKernelFunction< 2 >
 
using KernelOrder3Type = BSplineKernelFunction< 3 >
 
using KernelType = CoxDeBoorBSplineKernelFunction< 3 >
 
using OriginType = typename InputImageType::PointType
 
using OutputType = PixelType
 
using PixelType = typename InputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RealImagePointer = typename RealImageType::Pointer
 
using RealImageType = Image< CoordRepType, ImageDimension >
 
using RealType = float
 
using RegionType = typename InputImageType::RegionType
 
using Self = BSplineControlPointImageFunction
 
using SizeType = typename InputImageType::SizeType
 
using SpacingType = typename InputImageType::SpacingType
 
using Superclass = ImageFunction< TInputImage, typename TInputImage::PixelType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
 
using CoordRepType = TCoordRep
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, TInputImage::PixelType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TInputImage::PixelType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TInputImage::ImageDimension >
 
using OutputType = TInputImage::PixelType
 
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
 
virtual const ArrayTypeGetCloseDimension () const
 
virtual const char * GetNameOfClass () const
 
virtual const ArrayTypeGetSplineOrder () const
 
virtual void SetCloseDimension (ArrayType _arg)
 
void SetInputImage (const InputImageType *) override
 
void SetSplineOrder (const ArrayType &)
 
void SetSplineOrder (const unsigned int)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
TInputImage::PixelType Evaluate (const PointType &point) const override=0
 
virtual TInputImage::PixelType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
const InputImageTypeGetInputImage () const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
virtual const IndexTypeGetStartIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () 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
 
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
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 ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
static constexpr unsigned int ImageDimension
 
SizeType m_Size
 
SpacingType m_Spacing
 
OriginType m_Origin
 
ArrayType m_NumberOfControlPoints
 
ArrayType m_CloseDimension
 
ArrayType m_SplineOrder
 
RealImagePointer m_NeighborhoodWeightImage
 
KernelType::Pointer m_Kernel [ImageDimension]
 
KernelOrder0Type::Pointer m_KernelOrder0
 
KernelOrder1Type::Pointer m_KernelOrder1
 
KernelOrder2Type::Pointer m_KernelOrder2
 
KernelOrder3Type::Pointer m_KernelOrder3
 
CoordRepType m_BSplineEpsilon
 
virtual void SetSpacing (SpacingType _arg)
 
virtual SpacingType GetSpacing () const
 
virtual void SetOrigin (OriginType _arg)
 
virtual OriginType GetOrigin () const
 
virtual void SetSize (SizeType _arg)
 
virtual SizeType GetSize () const
 
virtual void SetBSplineEpsilon (RealType _arg)
 
virtual RealType GetBSplineEpsilon () const
 
OutputType EvaluateAtParametricPoint (const PointType &) const
 
OutputType EvaluateAtIndex (const IndexType &) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &) const override
 
OutputType Evaluate (const PointType &) const override
 
GradientType EvaluateGradientAtParametricPoint (const PointType &) const
 
GradientType EvaluateGradientAtIndex (const IndexType &) const
 
GradientType EvaluateGradientAtContinuousIndex (const ContinuousIndexType &) const
 
GradientType EvaluateGradient (const PointType &) const
 
HessianComponentType EvaluateHessianAtParametricPoint (const PointType &, const unsigned int) const
 
HessianComponentType EvaluateHessianAtIndex (const IndexType &, const unsigned int) const
 
HessianComponentType EvaluateHessianAtContinuousIndex (const ContinuousIndexType &, const unsigned int) const
 
HessianComponentType EvaluateHessian (const PointType &, const unsigned int) const
 
 BSplineControlPointImageFunction ()
 
 ~BSplineControlPointImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TInputImage::PixelType >
 FunctionBase ()=default
 
 ~FunctionBase () 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 &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >
InputImageConstPointer m_Image
 
IndexType m_StartIndex
 
IndexType m_EndIndex
 
ContinuousIndexType m_StartContinuousIndex
 
ContinuousIndexType m_EndContinuousIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TCoordRep = double>
class itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >

Evaluate a B-spline object given a grid of control points.

The output of the class itkBSplineScatteredDataPointSetToImageFilter
is a control point grid defining a B-spline object. This class is used to hold various routines meant to operate on that control point grid. In addition to specifying the control point grid as the input, the user must also supply the spline order and the parametric domain (i.e. size, domain, origin, spacing).

Operations include

  1. Evaluation of the B-spline object at any point in the domain.
  2. Evaluation of the gradient of the B-spline object at any point in the domain.
  3. Evaluation of the Hessian of the B-spline object at any point in the domain.
Author
Nicholas J. Tustison

Definition at line 58 of file itkBSplineControlPointImageFunction.h.

Member Typedef Documentation

◆ ArrayType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::ArrayType = FixedArray<unsigned, ImageDimension>

Other type alias

Definition at line 98 of file itkBSplineControlPointImageFunction.h.

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 67 of file itkBSplineControlPointImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

Definition at line 101 of file itkBSplineControlPointImageFunction.h.

◆ ControlPointLatticeType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::ControlPointLatticeType = TInputImage

Image type alias support

Definition at line 79 of file itkBSplineControlPointImageFunction.h.

◆ CoordRepType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::CoordRepType = TCoordRep

Definition at line 81 of file itkBSplineControlPointImageFunction.h.

◆ GradientType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GradientType = VariableSizeMatrix<CoordRepType>

Definition at line 94 of file itkBSplineControlPointImageFunction.h.

◆ HessianComponentType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::HessianComponentType = VariableSizeMatrix<CoordRepType>

Definition at line 95 of file itkBSplineControlPointImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::IndexType = typename InputImageType::IndexType

Definition at line 84 of file itkBSplineControlPointImageFunction.h.

◆ InputImageRegionType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 86 of file itkBSplineControlPointImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::InputImageType = TInputImage

Definition at line 80 of file itkBSplineControlPointImageFunction.h.

◆ KernelOrder0Type

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::KernelOrder0Type = BSplineKernelFunction<0>

Definition at line 106 of file itkBSplineControlPointImageFunction.h.

◆ KernelOrder1Type

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::KernelOrder1Type = BSplineKernelFunction<1>

Definition at line 107 of file itkBSplineControlPointImageFunction.h.

◆ KernelOrder2Type

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::KernelOrder2Type = BSplineKernelFunction<2>

Definition at line 108 of file itkBSplineControlPointImageFunction.h.

◆ KernelOrder3Type

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::KernelOrder3Type = BSplineKernelFunction<3>

Definition at line 109 of file itkBSplineControlPointImageFunction.h.

◆ KernelType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::KernelType = CoxDeBoorBSplineKernelFunction<3>

Interpolation kernel type (default spline order = 3)

Definition at line 105 of file itkBSplineControlPointImageFunction.h.

◆ OriginType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::OriginType = typename InputImageType::PointType

Definition at line 89 of file itkBSplineControlPointImageFunction.h.

◆ OutputType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::OutputType = PixelType

Output type alias support

Definition at line 93 of file itkBSplineControlPointImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::PixelType = typename InputImageType::PixelType

Definition at line 82 of file itkBSplineControlPointImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 66 of file itkBSplineControlPointImageFunction.h.

◆ PointType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Definition at line 85 of file itkBSplineControlPointImageFunction.h.

◆ RealImagePointer

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::RealImagePointer = typename RealImageType::Pointer

Definition at line 100 of file itkBSplineControlPointImageFunction.h.

◆ RealImageType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::RealImageType = Image<CoordRepType, ImageDimension>

Definition at line 99 of file itkBSplineControlPointImageFunction.h.

◆ RealType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::RealType = float

Definition at line 102 of file itkBSplineControlPointImageFunction.h.

◆ RegionType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::RegionType = typename InputImageType::RegionType

Definition at line 83 of file itkBSplineControlPointImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::Self = BSplineControlPointImageFunction

Definition at line 64 of file itkBSplineControlPointImageFunction.h.

◆ SizeType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SizeType = typename InputImageType::SizeType

Definition at line 90 of file itkBSplineControlPointImageFunction.h.

◆ SpacingType

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SpacingType = typename InputImageType::SpacingType

Definition at line 88 of file itkBSplineControlPointImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = double>
using itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, typename TInputImage::PixelType, TCoordRep>

Definition at line 65 of file itkBSplineControlPointImageFunction.h.

Constructor & Destructor Documentation

◆ BSplineControlPointImageFunction()

template<typename TInputImage , typename TCoordRep = double>
itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::BSplineControlPointImageFunction ( )
protected

Parameters for the B-spline object domain

◆ ~BSplineControlPointImageFunction()

template<typename TInputImage , typename TCoordRep = double>
itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::~BSplineControlPointImageFunction ( )
overrideprotecteddefault

Parameters for the B-spline object domain

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TCoordRep = double>
virtual::itk::LightObject::Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::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::Object.

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType ) const
override

Evaluate the resulting B-spline object at a specified internal parametric point. Note that the internal parameterization over each dimension of the B-spline object is [0, 1).

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType ) const
override

Evaluate the resulting B-spline object at a specified continuous index in the parametric domain.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType ) const
overridevirtual

Evaluate the resulting B-spline object at a specified index in the parametric domain.

Implements itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >.

◆ EvaluateAtParametricPoint()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateAtParametricPoint ( const PointType ) const

Evaluate the resulting B-spline object at a specified point in the parametric domain.

◆ EvaluateGradient()

template<typename TInputImage , typename TCoordRep = double>
GradientType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateGradient ( const PointType ) const

Evaluate the gradient of the resulting B-spline object at a specified internal parametric point. Note that the internal parameterization over each dimension of the B-spline object is [0, 1).

◆ EvaluateGradientAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = double>
GradientType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateGradientAtContinuousIndex ( const ContinuousIndexType ) const

Evaluate the gradient of the resulting B-spline object at a specified continuous index in the parametric domain.

◆ EvaluateGradientAtIndex()

template<typename TInputImage , typename TCoordRep = double>
GradientType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateGradientAtIndex ( const IndexType ) const

Evaluate the gradient of the resulting B-spline object at a specified index in the parametric domain.

◆ EvaluateGradientAtParametricPoint()

template<typename TInputImage , typename TCoordRep = double>
GradientType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateGradientAtParametricPoint ( const PointType ) const

Evaluate the gradient of the resulting B-spline object at a specified point in the parametric domain.

◆ EvaluateHessian()

template<typename TInputImage , typename TCoordRep = double>
HessianComponentType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateHessian ( const PointType ,
const unsigned int   
) const

Evaluate the hessian of the resulting B-spline object at a specified internal parametric point. Note that the internal parameterization over each dimension of the B-spline object is [0, 1).

◆ EvaluateHessianAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = double>
HessianComponentType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateHessianAtContinuousIndex ( const ContinuousIndexType ,
const unsigned int   
) const

Evaluate the Hessian of the resulting B-spline object at a specified con- tinuous index within the parametric domain. Since the Hessian for a vector function is a 3-tensor, one must specify the component.

◆ EvaluateHessianAtIndex()

template<typename TInputImage , typename TCoordRep = double>
HessianComponentType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateHessianAtIndex ( const IndexType ,
const unsigned int   
) const

Evaluate the Hessian of the resulting B-spline object at a specified index within the parametric domain. Since the Hessian for a vector function is a 3-tensor, one must specify the component.

◆ EvaluateHessianAtParametricPoint()

template<typename TInputImage , typename TCoordRep = double>
HessianComponentType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::EvaluateHessianAtParametricPoint ( const PointType ,
const unsigned int   
) const

Evaluate the Hessian of the resulting B-spline object at a specified point within the parametric domain. Since the Hessian for a vector function is a 3-tensor, one must specify the component.

◆ GetBSplineEpsilon()

template<typename TInputImage , typename TCoordRep = double>
virtual RealType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetBSplineEpsilon ( ) const
virtual

Parameters for the B-spline object domain

◆ GetCloseDimension()

template<typename TInputImage , typename TCoordRep = double>
virtual const ArrayType& itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetCloseDimension ( ) const
virtual

Get the boolean array indicating which dimensions are closed.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double>
virtual const char* itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >.

◆ GetOrigin()

template<typename TInputImage , typename TCoordRep = double>
virtual OriginType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetOrigin ( ) const
virtual

Parameters for the B-spline object domain

◆ GetSize()

template<typename TInputImage , typename TCoordRep = double>
virtual SizeType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetSize ( ) const
virtual

Parameters for the B-spline object domain

◆ GetSpacing()

template<typename TInputImage , typename TCoordRep = double>
virtual SpacingType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetSpacing ( ) const
virtual

Parameters for the B-spline object domain

◆ GetSplineOrder()

template<typename TInputImage , typename TCoordRep = double>
virtual const ArrayType& itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::GetSplineOrder ( ) const
virtual

Get the spline order array of the B-spline object. Default = 3.

◆ New()

template<typename TInputImage , typename TCoordRep = double>
static Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = double>
void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Parameters for the B-spline object domain

Reimplemented from itk::Object.

◆ SetBSplineEpsilon()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetBSplineEpsilon ( RealType  _arg)
virtual

Set/Get the epsilon used for B-splines. The B-spline parametric domain in 1-D is defined on the half-closed interval [a,b). Extension to n-D is defined similarly. This presents some difficulty for defining the the image domain to be co-extensive with the parametric domain. We use the B-spline epsilon to push the edge of the image boundary inside the B-spline parametric domain.

◆ SetCloseDimension()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetCloseDimension ( ArrayType  _arg)
virtual

Set the boolean array indicating the periodicity of the B-spline object. This array of 0/1 values defines whether a particular dimension of the parametric space is to be considered periodic or not. For example, if you are using interpolating along a 1D closed curve, the array type will have size 1, and you should set the first element of this array to the value "1". In the case that you were interpolating in a planar surface with cylindrical topology, the array type will have two components, and you should set to "1" the component that goes around the cylinder, and set to "0" the component that goes from the top of the cylinder to the bottom. This will indicate the periodicity of that parameter to the filter. Internally, in order to make periodic the domain of the parameter, the filter will reuse some of the points at the beginning of the domain as if they were also located at the end of the domain. The number of points to be reused will depend on the spline order. As a user, you don't need to replicate the points, the filter will do this for you.

◆ SetInputImage()

template<typename TInputImage , typename TCoordRep = double>
void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetInputImage ( const InputImageType )
overridevirtual

Set the input image. Note that the size, spacing, origin, and spline order must be called prior to setting the input image.

Reimplemented from itk::ImageFunction< TInputImage, TInputImage::PixelType, TCoordRep >.

◆ SetOrigin()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetOrigin ( OriginType  _arg)
virtual

Set/Get the parametric origin of the B-spline object domain.

◆ SetSize()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetSize ( SizeType  _arg)
virtual

Set/Get the parametric size of the B-spline object domain.

◆ SetSpacing()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetSpacing ( SpacingType  _arg)
virtual

Set/Get the parametric spacing of the B-spline object domain.

◆ SetSplineOrder() [1/2]

template<typename TInputImage , typename TCoordRep = double>
void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetSplineOrder ( const ArrayType )

Set the spline order array where each element of the array corresponds to a single parametric dimension of the B-spline object. Default = 3.

◆ SetSplineOrder() [2/2]

template<typename TInputImage , typename TCoordRep = double>
void itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::SetSplineOrder ( const unsigned int  )

Set the spline order of the B-spline object for all parametric dimensions. Default = 3.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double>
constexpr unsigned int itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Extract dimension from input image.

Definition at line 76 of file itkBSplineControlPointImageFunction.h.

◆ m_BSplineEpsilon

template<typename TInputImage , typename TCoordRep = double>
CoordRepType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_BSplineEpsilon
private

Parameters for the B-spline object domain

Definition at line 307 of file itkBSplineControlPointImageFunction.h.

◆ m_CloseDimension

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_CloseDimension
private

Parameters for the B-spline object domain

Definition at line 296 of file itkBSplineControlPointImageFunction.h.

◆ m_Kernel

template<typename TInputImage , typename TCoordRep = double>
KernelType::Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_Kernel[ImageDimension]
private

Parameters for the B-spline object domain

Definition at line 301 of file itkBSplineControlPointImageFunction.h.

◆ m_KernelOrder0

template<typename TInputImage , typename TCoordRep = double>
KernelOrder0Type::Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_KernelOrder0
private

Parameters for the B-spline object domain

Definition at line 302 of file itkBSplineControlPointImageFunction.h.

◆ m_KernelOrder1

template<typename TInputImage , typename TCoordRep = double>
KernelOrder1Type::Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_KernelOrder1
private

Parameters for the B-spline object domain

Definition at line 303 of file itkBSplineControlPointImageFunction.h.

◆ m_KernelOrder2

template<typename TInputImage , typename TCoordRep = double>
KernelOrder2Type::Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_KernelOrder2
private

Parameters for the B-spline object domain

Definition at line 304 of file itkBSplineControlPointImageFunction.h.

◆ m_KernelOrder3

template<typename TInputImage , typename TCoordRep = double>
KernelOrder3Type::Pointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_KernelOrder3
private

Parameters for the B-spline object domain

Definition at line 305 of file itkBSplineControlPointImageFunction.h.

◆ m_NeighborhoodWeightImage

template<typename TInputImage , typename TCoordRep = double>
RealImagePointer itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_NeighborhoodWeightImage
private

Parameters for the B-spline object domain

Definition at line 299 of file itkBSplineControlPointImageFunction.h.

◆ m_NumberOfControlPoints

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_NumberOfControlPoints
private

Parameters for the B-spline object domain

Definition at line 295 of file itkBSplineControlPointImageFunction.h.

◆ m_Origin

template<typename TInputImage , typename TCoordRep = double>
OriginType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_Origin
private

Parameters for the B-spline object domain

Definition at line 293 of file itkBSplineControlPointImageFunction.h.

◆ m_Size

template<typename TInputImage , typename TCoordRep = double>
SizeType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_Size
private

Parameters for the B-spline object domain

Definition at line 291 of file itkBSplineControlPointImageFunction.h.

◆ m_Spacing

template<typename TInputImage , typename TCoordRep = double>
SpacingType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_Spacing
private

Parameters for the B-spline object domain

Definition at line 292 of file itkBSplineControlPointImageFunction.h.

◆ m_SplineOrder

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::BSplineControlPointImageFunction< TInputImage, TCoordRep >::m_SplineOrder
private

Parameters for the B-spline object domain

Definition at line 297 of file itkBSplineControlPointImageFunction.h.


The documentation for this class was generated from the following file: