itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType > Class Template Reference

#include <itkBSplineInterpolateImageFunction.h>

Detailed Description

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>
class itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >

Evaluates the B-Spline interpolation of an image. Spline order may be from 0 to 5.

This class defines N-Dimension B-Spline transformation. It is based on [141], [139] and [140]. Code obtained from bigwww.epfl.ch by Philippe Thevenaz

The B spline coefficients are calculated through the BSplineDecompositionImageFilter

Limitations: Spline order must be between 0 and 5. Spline order must be set before setting the image. Uses mirror boundary conditions. Requires the same order of Spline for each dimension. Spline is determined in all dimensions, cannot selectively pick dimension for calculating spline.

See also

BSplineDecompositionImageFilter

Examples

Examples/Filtering/ResampleImageFilter7.cxx.

Definition at line 69 of file itkBSplineInterpolateImageFunction.h.

Inheritance diagram for itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >:

Collaboration diagram for itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >:

Public Types
using	CoefficientDataType = TCoefficientType
using	CoefficientFilter = BSplineDecompositionImageFilter<TImageType, CoefficientImageType>
using	CoefficientFilterPointer = typename CoefficientFilter::Pointer
using	CoefficientImageType = Image<CoefficientDataType, Self::ImageDimension>
using	ConstPointer = SmartPointer<const Self>
using	CovariantVectorType = CovariantVector<OutputType, Self::ImageDimension>
using	Iterator = ImageLinearIteratorWithIndex<TImageType>
using	Pointer = SmartPointer<Self>
using	Self = BSplineInterpolateImageFunction
using	SizeType
using	Superclass = InterpolateImageFunction<TImageType, TCoordinate>
Public Types inherited from itk::InterpolateImageFunction< TImageType, double >
using	ConstPointer
typedef ContinuousIndex< double, Self::ImageDimension >	ContinuousIndexType
using	ContinuousIndexType
typedef typename InputImageType::IndexType	IndexType
using	IndexType
typedef typename InputImageType::IndexValueType	IndexValueType
using	IndexValueType
typedef TImageType	InputImageType
using	InputImageType
typedef TOutput	OutputType
using	OutputType
using	Pointer
typedef Point< double, Self::ImageDimension >	PointType
using	PointType
using	RealType
using	Self
using	SizeType
using	Superclass
Public Types inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >
using	ConstPointer
using	ContinuousIndexType
using	CoordinateType
using	IndexType
using	IndexValueType
using	InputImageConstPointer
using	InputImageType
using	InputPixelType
using	OutputType
using	Pointer
using	PointType
using	Self
using	Superclass
Public Types inherited from itk::FunctionBase< Point< double, TImageType::ImageDimension >, NumericTraits< TImageType::PixelType >::RealType >
using	ConstPointer
using	InputType
using	OutputType
using	Pointer
using	Self
using	Superclass
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
OutputType	Evaluate (const PointType &point) const override
virtual OutputType	Evaluate (const PointType &point, ThreadIdType threadId) const
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &x, ThreadIdType threadId) const
CovariantVectorType	EvaluateDerivative (const PointType &point) const
CovariantVectorType	EvaluateDerivative (const PointType &point, ThreadIdType threadId) const
CovariantVectorType	EvaluateDerivativeAtContinuousIndex (const ContinuousIndexType &x) const
CovariantVectorType	EvaluateDerivativeAtContinuousIndex (const ContinuousIndexType &x, ThreadIdType threadId) const
void	EvaluateValueAndDerivative (const PointType &point, OutputType &value, CovariantVectorType &deriv) const
void	EvaluateValueAndDerivative (const PointType &point, OutputType &value, CovariantVectorType &deriv, ThreadIdType threadId) const
void	EvaluateValueAndDerivativeAtContinuousIndex (const ContinuousIndexType &x, OutputType &value, CovariantVectorType &deriv) const
void	EvaluateValueAndDerivativeAtContinuousIndex (const ContinuousIndexType &x, OutputType &value, CovariantVectorType &derivativeValue, ThreadIdType threadId) const
virtual const char *	GetNameOfClass () const
virtual ThreadIdType	GetNumberOfWorkUnits () const
SizeType	GetRadius () const override
virtual unsigned int	GetSplineOrder () const
void	SetInputImage (const TImageType *inputData) override
void	SetNumberOfWorkUnits (ThreadIdType numWorkUnits)
void	SetSplineOrder (unsigned int SplineOrder)
virtual void	SetUseImageDirection (bool _arg)
virtual bool	GetUseImageDirection () const
virtual void	UseImageDirectionOn ()
virtual void	UseImageDirectionOff ()
Public Member Functions inherited from itk::InterpolateImageFunction< TImageType, double >
OutputType	Evaluate (const PointType &point) const override
OutputType	EvaluateAtIndex (const IndexType &index) const override
Public Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
virtual const ContinuousIndexType &	GetEndContinuousIndex () const
virtual const IndexType &	GetEndIndex () const
const InputImageType *	GetInputImage () const
virtual const ContinuousIndexType &	GetStartContinuousIndex () const
virtual const IndexType &	GetStartIndex () const
virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const
virtual bool	IsInsideBuffer (const IndexType &index) const
virtual bool	IsInsideBuffer (const PointType &point) const
Public Member Functions inherited from itk::FunctionBase< Point< double, TImageType::ImageDimension >, NumericTraits< TImageType::PixelType >::RealType >
virtual OutputType	Evaluate (const InputType &input) const=0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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
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) const
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	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::InterpolateImageFunction< TImageType, double >
static constexpr unsigned int	ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	BSplineInterpolateImageFunction ()
virtual OutputType	EvaluateAtContinuousIndexInternal (const ContinuousIndexType &x, vnl_matrix< long > &evaluateIndex, vnl_matrix< double > &weights) const
virtual CovariantVectorType	EvaluateDerivativeAtContinuousIndexInternal (const ContinuousIndexType &x, vnl_matrix< long > &evaluateIndex, vnl_matrix< double > &weights, vnl_matrix< double > &weightsDerivative) const
virtual void	EvaluateValueAndDerivativeAtContinuousIndexInternal (const ContinuousIndexType &x, OutputType &value, CovariantVectorType &derivativeValue, vnl_matrix< long > &evaluateIndex, vnl_matrix< double > &weights, vnl_matrix< double > &weightsDerivative) const
void	PrintSelf (std::ostream &os, Indent indent) const override
	~BSplineInterpolateImageFunction () override=default
Protected Member Functions inherited from itk::InterpolateImageFunction< TImageType, double >
	InterpolateImageFunction ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~InterpolateImageFunction () override=default
Protected Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >
	ImageFunction ()
	~ImageFunction () override=default
Protected Member Functions inherited from itk::FunctionBase< Point< double, TImageType::ImageDimension >, NumericTraits< TImageType::PixelType >::RealType >
	FunctionBase ()=default
	~FunctionBase () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
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
CoefficientImageType::ConstPointer	m_Coefficients {}
TImageType::SizeType	m_DataLength {}
std::vector< CoefficientDataType >	m_Scratch {}
unsigned int	m_SplineOrder {}
Protected Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >
ContinuousIndexType	m_EndContinuousIndex
IndexType	m_EndIndex
InputImageConstPointer	m_Image
ContinuousIndexType	m_StartContinuousIndex
IndexType	m_StartIndex
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Member Functions
void	ApplyMirrorBoundaryConditions (vnl_matrix< long > &evaluateIndex, unsigned int splineOrder) const
void	DetermineRegionOfSupport (vnl_matrix< long > &evaluateIndex, const ContinuousIndexType &x, unsigned int splineOrder) const
void	GeneratePointsToIndex ()
void	SetDerivativeWeights (const ContinuousIndexType &x, const vnl_matrix< long > &EvaluateIndex, vnl_matrix< double > &weights, unsigned int splineOrder) const
void	SetInterpolationWeights (const ContinuousIndexType &x, const vnl_matrix< long > &EvaluateIndex, vnl_matrix< double > &weights, unsigned int splineOrder) const

Private Attributes
Iterator	m_CIterator {}
CoefficientFilterPointer	m_CoefficientFilter {}
unsigned long	m_MaxNumberInterpolationPoints {}
ThreadIdType	m_NumberOfWorkUnits {}
std::vector< IndexType >	m_PointsToIndex {}
std::unique_ptr< vnl_matrix< long >[]>	m_ThreadedEvaluateIndex
std::unique_ptr< vnl_matrix< double >[]>	m_ThreadedWeights
std::unique_ptr< vnl_matrix< double >[]>	m_ThreadedWeightsDerivative
bool	m_UseImageDirection { true }

Member Typedef Documentation

CoefficientDataType

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::CoefficientDataType = TCoefficientType

Internal Coefficient type alias support

Definition at line 111 of file itkBSplineInterpolateImageFunction.h.

CoefficientFilter

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::CoefficientFilter = BSplineDecompositionImageFilter<TImageType, CoefficientImageType>

Define filter for calculating the BSpline coefficients

Definition at line 115 of file itkBSplineInterpolateImageFunction.h.

CoefficientFilterPointer

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::CoefficientFilterPointer = typename CoefficientFilter::Pointer

Definition at line 116 of file itkBSplineInterpolateImageFunction.h.

CoefficientImageType

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::CoefficientImageType = Image<CoefficientDataType, Self::ImageDimension>

Definition at line 112 of file itkBSplineInterpolateImageFunction.h.

ConstPointer

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::ConstPointer = SmartPointer<const Self>

Definition at line 78 of file itkBSplineInterpolateImageFunction.h.

CovariantVectorType

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::CovariantVectorType = CovariantVector<OutputType, Self::ImageDimension>

Derivative type alias support

Definition at line 119 of file itkBSplineInterpolateImageFunction.h.

Iterator

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Iterator = ImageLinearIteratorWithIndex<TImageType>

Iterator type alias support

Definition at line 108 of file itkBSplineInterpolateImageFunction.h.

Pointer

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Pointer = SmartPointer<Self>

Definition at line 77 of file itkBSplineInterpolateImageFunction.h.

Self

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Self = BSplineInterpolateImageFunction

Standard class type aliases.

Definition at line 75 of file itkBSplineInterpolateImageFunction.h.

SizeType

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::InterpolateImageFunction< TImageType, TCoordinate >::SizeType

Size type alias support

Definition at line 79 of file itkInterpolateImageFunction.h.

Superclass

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

using itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Superclass = InterpolateImageFunction<TImageType, TCoordinate>

Definition at line 76 of file itkBSplineInterpolateImageFunction.h.

Constructor & Destructor Documentation

BSplineInterpolateImageFunction()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::BSplineInterpolateImageFunction ( )

protected

~BSplineInterpolateImageFunction()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::~BSplineInterpolateImageFunction ( )

overrideprotecteddefault

Member Function Documentation

ApplyMirrorBoundaryConditions()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::ApplyMirrorBoundaryConditions ( vnl_matrix< long > & evaluateIndex, unsigned int splineOrder ) const

private

Set the indices in evaluateIndex at the boundaries based on mirror boundary conditions.

CreateAnother()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual::itk::LightObject::Pointer itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::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.

Reimplemented in itk::BSplineResampleImageFunction< TImageType, TCoordinate >.

DetermineRegionOfSupport()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::DetermineRegionOfSupport ( vnl_matrix< long > & evaluateIndex, const ContinuousIndexType & x, unsigned int splineOrder ) const

private

Determines the indices to use give the splines region of support

Evaluate() [1/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

OutputType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Evaluate ( const PointType & point ) const

inlineoverridevirtual

Evaluate the function at a ContinuousIndex position.

Returns the B-Spline interpolated image intensity at a specified point position. No bounds checking is done. The point is assume to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >.

Definition at line 130 of file itkBSplineInterpolateImageFunction.h.

Evaluate() [2/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual OutputType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Evaluate ( const PointType & point, ThreadIdType threadId ) const

inlinevirtual

Definition at line 139 of file itkBSplineInterpolateImageFunction.h.

EvaluateAtContinuousIndex() [1/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

OutputType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const

inlineoverridevirtual

Interpolate the image at a continuous index position

Returns the interpolated image intensity at a specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

Subclasses must override this method.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::InterpolateImageFunction< TImageType, double >.

Definition at line 147 of file itkBSplineInterpolateImageFunction.h.

EvaluateAtContinuousIndex() [2/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual OutputType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateAtContinuousIndex ( const ContinuousIndexType & x, ThreadIdType threadId ) const

inlinevirtual

Definition at line 160 of file itkBSplineInterpolateImageFunction.h.

EvaluateAtContinuousIndexInternal()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual OutputType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateAtContinuousIndexInternal ( const ContinuousIndexType & x, vnl_matrix< long > & evaluateIndex, vnl_matrix< double > & weights ) const

protectedvirtual

The following methods take working space (evaluateIndex, weights, weightsDerivative) that is managed by the caller. If threadId is known, the working variables are looked up in the thread indexed arrays. If threadId is not known, working variables are made on the stack and passed to these methods. The stack allocation should be ok since these methods do not store the working variables, i.e. they are not expected to be available beyond the scope of the function call.

This was done to allow for two types of re-entrancy. The first is when a threaded filter, e.g. InterpolateImagePointsFilter calls EvaluateAtContinuousIndex from multiple threads without passing a threadId. So, EvaluateAtContinuousIndex must be thread safe. This is handled with the stack-based allocation of the working space.

The second form of re-entrancy involves methods that call EvaluateAtContinuousIndex from multiple threads, but pass a threadId. In this case, we can gain a little efficiency (hopefully) by looking up pre-allocated working space in arrays that are indexed by thread. The efficiency gain is likely dependent on the size of the working variables, which are in-turn dependent on the dimensionality of the image and the order of the spline.

EvaluateDerivative() [1/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

CovariantVectorType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateDerivative ( const PointType & point ) const

inline

Definition at line 167 of file itkBSplineInterpolateImageFunction.h.

EvaluateDerivative() [2/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

CovariantVectorType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateDerivative ( const PointType & point, ThreadIdType threadId ) const

inline

Definition at line 177 of file itkBSplineInterpolateImageFunction.h.

EvaluateDerivativeAtContinuousIndex() [1/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

CovariantVectorType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateDerivativeAtContinuousIndex ( const ContinuousIndexType & x ) const

inline

Definition at line 185 of file itkBSplineInterpolateImageFunction.h.

EvaluateDerivativeAtContinuousIndex() [2/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

CovariantVectorType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateDerivativeAtContinuousIndex ( const ContinuousIndexType & x, ThreadIdType threadId ) const

inline

Definition at line 202 of file itkBSplineInterpolateImageFunction.h.

EvaluateDerivativeAtContinuousIndexInternal()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual CovariantVectorType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateDerivativeAtContinuousIndexInternal ( const ContinuousIndexType & x, vnl_matrix< long > & evaluateIndex, vnl_matrix< double > & weights, vnl_matrix< double > & weightsDerivative ) const

protectedvirtual

EvaluateValueAndDerivative() [1/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateValueAndDerivative ( const PointType & point, OutputType & value, CovariantVectorType & deriv ) const

inline

Definition at line 209 of file itkBSplineInterpolateImageFunction.h.

EvaluateValueAndDerivative() [2/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateValueAndDerivative ( const PointType & point, OutputType & value, CovariantVectorType & deriv, ThreadIdType threadId ) const

inline

Definition at line 219 of file itkBSplineInterpolateImageFunction.h.

EvaluateValueAndDerivativeAtContinuousIndex() [1/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateValueAndDerivativeAtContinuousIndex ( const ContinuousIndexType & x, OutputType & value, CovariantVectorType & deriv ) const

inline

Definition at line 230 of file itkBSplineInterpolateImageFunction.h.

EvaluateValueAndDerivativeAtContinuousIndex() [2/2]

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateValueAndDerivativeAtContinuousIndex ( const ContinuousIndexType & x, OutputType & value, CovariantVectorType & derivativeValue, ThreadIdType threadId ) const

inline

Definition at line 250 of file itkBSplineInterpolateImageFunction.h.

EvaluateValueAndDerivativeAtContinuousIndexInternal()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateValueAndDerivativeAtContinuousIndexInternal ( const ContinuousIndexType & x, OutputType & value, CovariantVectorType & derivativeValue, vnl_matrix< long > & evaluateIndex, vnl_matrix< double > & weights, vnl_matrix< double > & weightsDerivative ) const

protectedvirtual

GeneratePointsToIndex()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::GeneratePointsToIndex ( )

private

Precomputation for converting the 1D index of the interpolation neighborhood to an N-dimensional index.

GetNameOfClass()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual const char * itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::GetNameOfClass ( ) const

virtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::InterpolateImageFunction< TImageType, double >.

Reimplemented in itk::BSplineResampleImageFunction< TImageType, TCoordinate >.

GetNumberOfWorkUnits()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual ThreadIdType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::GetNumberOfWorkUnits ( ) const

virtual

GetRadius()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

SizeType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::GetRadius ( ) const

inlineoverridevirtual

Get the radius required for interpolation.

This defines the number of surrounding pixels required to interpolate at a given point.

Implements itk::InterpolateImageFunction< TImageType, double >.

Definition at line 296 of file itkBSplineInterpolateImageFunction.h.

GetSplineOrder()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual unsigned int itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::GetSplineOrder ( ) const

virtual

GetUseImageDirection()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual bool itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::GetUseImageDirection ( ) const

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

New()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

static Pointer itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::New ( )

static

New macro for creation of through a Smart Pointer

PrintSelf()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::PrintSelf ( std::ostream & os, Indent indent ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

SetDerivativeWeights()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetDerivativeWeights ( const ContinuousIndexType & x, const vnl_matrix< long > & EvaluateIndex, vnl_matrix< double > & weights, unsigned int splineOrder ) const

private

Determines the weights for the derivative portion of the value x

SetInputImage()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetInputImage ( const TImageType * inputData )

overridevirtual

Set the input image. This must be set by the user.

Reimplemented from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, double >.

Reimplemented in itk::BSplineResampleImageFunction< TImageType, TCoordinate >.

SetInterpolationWeights()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetInterpolationWeights ( const ContinuousIndexType & x, const vnl_matrix< long > & EvaluateIndex, vnl_matrix< double > & weights, unsigned int splineOrder ) const

private

Determines the weights for interpolation of the value x

SetNumberOfWorkUnits()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetNumberOfWorkUnits

(

ThreadIdType

numWorkUnits

)

SetSplineOrder()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetSplineOrder

(

unsigned int

SplineOrder

)

Get/Sets the Spline Order, supports 0th - 5th order splines. The default is a 3rd order spline.

SetUseImageDirection()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetUseImageDirection ( bool _arg )

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

UseImageDirectionOff()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::UseImageDirectionOff ( )

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

UseImageDirectionOn()

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

virtual void itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::UseImageDirectionOn ( )

virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.

Member Data Documentation

ImageDimension

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

unsigned int itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimension underlying input image.

Definition at line 93 of file itkBSplineInterpolateImageFunction.h.

m_CIterator

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

Iterator itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_CIterator {}

private

Definition at line 386 of file itkBSplineInterpolateImageFunction.h.

m_CoefficientFilter

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

CoefficientFilterPointer itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_CoefficientFilter {}

private

Definition at line 398 of file itkBSplineInterpolateImageFunction.h.

m_Coefficients

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

CoefficientImageType::ConstPointer itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_Coefficients {}

protected

Definition at line 353 of file itkBSplineInterpolateImageFunction.h.

m_DataLength

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

TImageType::SizeType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_DataLength {}

protected

Definition at line 348 of file itkBSplineInterpolateImageFunction.h.

m_MaxNumberInterpolationPoints

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

unsigned long itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_MaxNumberInterpolationPoints {}

private

Definition at line 389 of file itkBSplineInterpolateImageFunction.h.

m_NumberOfWorkUnits

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

ThreadIdType itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_NumberOfWorkUnits {}

private

Definition at line 404 of file itkBSplineInterpolateImageFunction.h.

m_PointsToIndex

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

std::vector<IndexType> itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_PointsToIndex {}

private

Definition at line 393 of file itkBSplineInterpolateImageFunction.h.

m_Scratch

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

std::vector<CoefficientDataType> itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_Scratch {}

protected

Definition at line 346 of file itkBSplineInterpolateImageFunction.h.

m_SplineOrder

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

unsigned int itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_SplineOrder {}

protected

Definition at line 350 of file itkBSplineInterpolateImageFunction.h.

m_ThreadedEvaluateIndex

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

std::unique_ptr<vnl_matrix<long>[]> itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_ThreadedEvaluateIndex

private

Definition at line 405 of file itkBSplineInterpolateImageFunction.h.

m_ThreadedWeights

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

std::unique_ptr<vnl_matrix<double>[]> itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_ThreadedWeights

private

Definition at line 406 of file itkBSplineInterpolateImageFunction.h.

m_ThreadedWeightsDerivative

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

std::unique_ptr<vnl_matrix<double>[]> itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_ThreadedWeightsDerivative

private

Definition at line 407 of file itkBSplineInterpolateImageFunction.h.

m_UseImageDirection

template<typename TImageType, typename TCoordinate = double, typename TCoefficientType = double>

bool itk::BSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_UseImageDirection { true }

private

Definition at line 402 of file itkBSplineInterpolateImageFunction.h.

---

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

• itkBSplineInterpolateImageFunction.h