itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType > Class Template Reference

#include <itkComplexBSplineInterpolateImageFunction.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	ImaginaryFilterType = ComplexToImaginaryImageFilter< InputImageType, InternalImageType >
using	IndexType = typename Superclass::IndexType
using	InputImageType = typename Superclass::InputImageType
using	InternalImageType = Image< double, Self::ImageDimension >
using	InterpolatorType = BSplineInterpolateImageFunction< InternalImageType, TCoordRep, TCoefficientType >
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
using	RealFilterType = ComplexToRealImageFilter< InputImageType, InternalImageType >
using	Self = ComplexBSplineInterpolateImageFunction
using	SizeType = typename Superclass::SizeType
using	Superclass = InterpolateImageFunction< TImageType, TCoordRep >
Public Types inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	IndexValueType = typename Superclass::IndexValueType
using	InputImageType = typename Superclass::InputImageType
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
using	RealType = typename NumericTraits< typename TImageType ::PixelType >::RealType
using	Self = InterpolateImageFunction
using	SizeType = typename InputImageType::SizeType
using	Superclass = ImageFunction< TImageType, typename NumericTraits< typename TImageType ::PixelType >::RealType, TCoordRep >
Public Types inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, 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 = TImageType
using	InputPixelType = typename InputImageType::PixelType
using	OutputType = NumericTraits< TImageType ::PixelType >::RealType
using	Pointer = SmartPointer< Self >
using	PointType = Point< TCoordRep, Self::ImageDimension >
using	Self = ImageFunction
using	Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TImageType ::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
using	ConstPointer = SmartPointer< const Self >
using	InputType = Point< TCoordRep, TImageType ::ImageDimension >
using	OutputType = NumericTraits< TImageType ::PixelType >::RealType
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
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
virtual const char *	GetNameOfClass () const
SizeType	GetRadius () const override
virtual int	GetSplineOrder () const
void	SetInputImage (const TImageType *inputData) override
void	SetSplineOrder (unsigned int SplineOrder)
Public Member Functions inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
OutputType	Evaluate (const PointType &point) const override
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
OutputType	EvaluateAtIndex (const IndexType &index) const override
Public Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
const InputImageType *	GetInputImage () 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 IndexType &	GetStartIndex () const
virtual const IndexType &	GetEndIndex () const
virtual const ContinuousIndexType &	GetStartContinuousIndex () const
virtual const ContinuousIndexType &	GetEndContinuousIndex () 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
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)
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, TCoordRep >
static constexpr unsigned int	ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
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, TCoordRep >
	InterpolateImageFunction ()=default
	~InterpolateImageFunction () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
Protected Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordRep >
	ImageFunction ()
	~ImageFunction () override=default
Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TImageType ::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
	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 &timeStamp)
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private 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, 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 TImageType, typename TCoordRep = double, typename TCoefficientType = double>
class itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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://hdl.handle.net/1926/585

Definition at line 44 of file itkComplexBSplineInterpolateImageFunction.h.

Member Typedef Documentation

ConstPointer

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

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

Standard class type alias.

Definition at line 60 of file itkComplexBSplineInterpolateImageFunction.h.

ContinuousIndexType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 84 of file itkComplexBSplineInterpolateImageFunction.h.

ImaginaryFilterType

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

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

Definition at line 94 of file itkComplexBSplineInterpolateImageFunction.h.

IndexType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 78 of file itkComplexBSplineInterpolateImageFunction.h.

InputImageType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::InputImageType = typename Superclass::InputImageType

InputImageType type alias support

Definition at line 75 of file itkComplexBSplineInterpolateImageFunction.h.

InternalImageType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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 TCoordRep = double, typename TCoefficientType = double>

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

Underlying real BSpline interpolator

Definition at line 97 of file itkComplexBSplineInterpolateImageFunction.h.

OutputType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::OutputType = typename Superclass::OutputType

OutputType type alias support

Definition at line 72 of file itkComplexBSplineInterpolateImageFunction.h.

Pointer

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

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

Standard class type alias.

Definition at line 57 of file itkComplexBSplineInterpolateImageFunction.h.

PointType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::PointType = typename Superclass::PointType

PointType type alias support

Definition at line 87 of file itkComplexBSplineInterpolateImageFunction.h.

RealFilterType

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

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

Complex to Real filter type

Definition at line 93 of file itkComplexBSplineInterpolateImageFunction.h.

Self

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

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

Standard class type alias.

Definition at line 51 of file itkComplexBSplineInterpolateImageFunction.h.

SizeType

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::SizeType = typename Superclass::SizeType

Size type alias support

Definition at line 81 of file itkComplexBSplineInterpolateImageFunction.h.

Superclass

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

using itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::Superclass = InterpolateImageFunction<TImageType, TCoordRep>

Standard class type alias.

Definition at line 54 of file itkComplexBSplineInterpolateImageFunction.h.

Constructor & Destructor Documentation

ComplexBSplineInterpolateImageFunction()

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

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

protected

~ComplexBSplineInterpolateImageFunction()

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

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

overrideprotecteddefault

Member Function Documentation

CreateAnother()

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

virtual::itk::LightObject::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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::Object.

EvaluateAtContinuousIndex()

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

OutputType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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 TCoordRep = double, typename TCoefficientType = double>

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

virtual

Run-time type information (and related methods).

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

GetRadius()

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

SizeType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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, TCoordRep >.

Definition at line 136 of file itkComplexBSplineInterpolateImageFunction.h.

GetSplineOrder()

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

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

virtual

New()

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

static Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::New ( )

static

New macro for creation of through a Smart Pointer

PrintSelf()

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

void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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::Object.

SetInputImage()

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

void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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, TCoordRep >.

SetSplineOrder()

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

void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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 TCoordRep = double, typename TCoefficientType = double>

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

staticconstexpr

Dimension underlying input image.

Definition at line 69 of file itkComplexBSplineInterpolateImageFunction.h.

m_ImaginaryFilter

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

ImaginaryFilterType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_ImaginaryFilter

private

Definition at line 156 of file itkComplexBSplineInterpolateImageFunction.h.

m_ImaginaryInterpolator

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

InterpolatorType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_ImaginaryInterpolator

private

Definition at line 152 of file itkComplexBSplineInterpolateImageFunction.h.

m_RealFilter

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

RealFilterType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_RealFilter

private

Definition at line 154 of file itkComplexBSplineInterpolateImageFunction.h.

m_RealInterpolator

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

InterpolatorType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_RealInterpolator

private

Definition at line 151 of file itkComplexBSplineInterpolateImageFunction.h.

m_SplineOrder

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

unsigned int itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, 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