#include <itkComplexBSplineInterpolateImageFunction.h>

Detailed Description

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

Complex wrapper around BSplineInterpolateImageFunction.

A complex wrapper class that splits complex input image in two real-type subimages containing real and imaginary parts, that are interpolated using the standard itkBSplineInterpolateImageFunction. The same requirements apply for this class: Set spline order before setting the input image! Derivative support is currently not implemented

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/z83ly1

Definition at line 44 of file itkComplexBSplineInterpolateImageFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

typedef ContinuousIndex< TCoordinate, Self::ImageDimension >	ContinuousIndexType

using	ImaginaryFilterType = ComplexToImaginaryImageFilter<InputImageType, InternalImageType>

typedef typename InputImageType::IndexType	IndexType

typedef TImageType	InputImageType

using	InternalImageType = Image<double, Self::ImageDimension>

using	InterpolatorType = BSplineInterpolateImageFunction<InternalImageType, TCoordinate, TCoefficientType>

typedef TOutput	OutputType

using	Pointer = SmartPointer<Self>

typedef Point< TCoordinate, Self::ImageDimension >	PointType

using	RealFilterType = ComplexToRealImageFilter<InputImageType, InternalImageType>

using	Self = ComplexBSplineInterpolateImageFunction

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	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override

const char *	GetNameOfClass () const override

SizeType	GetRadius () const override

virtual unsigned int	GetSplineOrder () const

void	SetInputImage (const TImageType *inputData) override

void	SetSplineOrder (unsigned int SplineOrder)

Public Member Functions inherited from itk::InterpolateImageFunction< TImageType, double >
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0

OutputType	EvaluateAtIndex (const IndexType &index) const override

const char *	GetNameOfClass () const override

OutputType	Evaluate (const PointType &point) 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

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 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

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

const char *	GetNameOfClass () const override

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

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ComplexBSplineInterpolateImageFunction () 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 ()

Private Attributes
ImaginaryFilterType::Pointer	m_ImaginaryFilter {}

InterpolatorType::Pointer	m_ImaginaryInterpolator {}

RealFilterType::Pointer	m_RealFilter {}

InterpolatorType::Pointer	m_RealInterpolator {}

unsigned int	m_SplineOrder {}

Additional Inherited Members
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 {}

Member Typedef Documentation

◆ ConstPointer

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

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

Standard class type alias.

Definition at line 60 of file itkComplexBSplineInterpolateImageFunction.h.

◆ ContinuousIndexType

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

ContinuousIndex Type.

◆ ImaginaryFilterType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::ImaginaryFilterType = ComplexToImaginaryImageFilter<InputImageType, InternalImageType>

Definition at line 94 of file itkComplexBSplineInterpolateImageFunction.h.

◆ IndexType

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

Index Type.

◆ InputImageType

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

InputImageType type alias support

◆ InternalImageType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::InternalImageType = Image<double, Self::ImageDimension>

Internal Real and imaginary image type

Definition at line 90 of file itkComplexBSplineInterpolateImageFunction.h.

◆ InterpolatorType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::InterpolatorType = BSplineInterpolateImageFunction<InternalImageType, TCoordinate, TCoefficientType>

Underlying real BSpline interpolator

Definition at line 97 of file itkComplexBSplineInterpolateImageFunction.h.

◆ OutputType

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

OutputType type alias support

◆ Pointer

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

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

Standard class type alias.

Definition at line 57 of file itkComplexBSplineInterpolateImageFunction.h.

◆ PointType

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

Point Type.

◆ RealFilterType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::RealFilterType = ComplexToRealImageFilter<InputImageType, InternalImageType>

Complex to Real filter type

Definition at line 93 of file itkComplexBSplineInterpolateImageFunction.h.

◆ Self

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

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

Standard class type alias.

Definition at line 51 of file itkComplexBSplineInterpolateImageFunction.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::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::Superclass = InterpolateImageFunction<TImageType, TCoordinate>

Standard class type alias.

Definition at line 54 of file itkComplexBSplineInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ ComplexBSplineInterpolateImageFunction()

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

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

protected

◆ ~ComplexBSplineInterpolateImageFunction()

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

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

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

virtual::itk::LightObject::Pointer itk::ComplexBSplineInterpolateImageFunction< 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.

◆ EvaluateAtContinuousIndex()

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

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

override

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 assumed to lie within the image buffer.

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

◆ GetNameOfClass()

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

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ GetRadius()

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

SizeType itk::ComplexBSplineInterpolateImageFunction< 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 136 of file itkComplexBSplineInterpolateImageFunction.h.

◆ GetSplineOrder()

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

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

virtual

◆ New()

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

static Pointer itk::ComplexBSplineInterpolateImageFunction< 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::ComplexBSplineInterpolateImageFunction< 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.

◆ SetInputImage()

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

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

overridevirtual

Set the input image. This must be set by the user, after setting the spline order!

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

◆ SetSplineOrder()

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

void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::SetSplineOrder ( unsigned int SplineOrder )

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

Member Data Documentation

◆ ImageDimension

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

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

staticconstexpr

Dimension underlying input image.

Definition at line 69 of file itkComplexBSplineInterpolateImageFunction.h.

◆ m_ImaginaryFilter

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

ImaginaryFilterType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_ImaginaryFilter {}

private

Definition at line 156 of file itkComplexBSplineInterpolateImageFunction.h.

◆ m_ImaginaryInterpolator

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

InterpolatorType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_ImaginaryInterpolator {}

private

Definition at line 152 of file itkComplexBSplineInterpolateImageFunction.h.

◆ m_RealFilter

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

RealFilterType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_RealFilter {}

private

Definition at line 154 of file itkComplexBSplineInterpolateImageFunction.h.

◆ m_RealInterpolator

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

InterpolatorType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::m_RealInterpolator {}

private

Definition at line 151 of file itkComplexBSplineInterpolateImageFunction.h.

◆ m_SplineOrder

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

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

private

Definition at line 149 of file itkComplexBSplineInterpolateImageFunction.h.

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

itkComplexBSplineInterpolateImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ ImaginaryFilterType

◆ IndexType

◆ InputImageType

◆ InternalImageType

◆ InterpolatorType

◆ OutputType

◆ Pointer

◆ PointType

◆ RealFilterType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ComplexBSplineInterpolateImageFunction()

◆ ~ComplexBSplineInterpolateImageFunction()

Member Function Documentation

◆ CreateAnother()

◆ EvaluateAtContinuousIndex()

◆ GetNameOfClass()

◆ GetRadius()

◆ GetSplineOrder()

◆ New()

◆ PrintSelf()

◆ SetInputImage()

◆ SetSplineOrder()

Member Data Documentation

◆ ImageDimension

◆ m_ImaginaryFilter

◆ m_ImaginaryInterpolator

◆ m_RealFilter

◆ m_RealInterpolator

◆ m_SplineOrder