ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType > Class Template Reference
Data Processing Objects » Functions » Image Functions » Image InterpolatorsGroup Nonunit » | Module ITKReview

#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 >
 
using ImaginaryFilterType = ComplexToImaginaryImageFilter< InputImageType, InternalImageType >
 
using InternalImageType = Image< double, Self::ImageDimension >
 
using InterpolatorType = BSplineInterpolateImageFunction< InternalImageType, TCoordinate, TCoefficientType >
 
using Pointer = SmartPointer< Self >
 
using RealFilterType = ComplexToRealImageFilter< InputImageType, InternalImageType >
 
using Self = ComplexBSplineInterpolateImageFunction
 
using Superclass = InterpolateImageFunction< TImageType, TCoordinate >
 
- Public Types inherited from itk::InterpolateImageFunction< TImageType, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
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, TCoordinate >
 
- Public Types inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordinate, Self::ImageDimension >
 
using CoordinateType = TCoordinate
 
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< TCoordinate, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordinate, Self::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordinate, TImageType ::ImageDimension >, NumericTraits< TImageType ::PixelType >::RealType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordinate, 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

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, TCoordinate >
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, TCoordinate >
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::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, TCoordinate >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType ::PixelType >::RealType, TCoordinate >
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, TCoordinate >
 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, TCoordinate >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordinate, 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
 
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, TCoordinate >
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.

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

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

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

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

◆ 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

◆ EvaluateAtContinuousIndex()

template<typename TImageType , typename TCoordinate = double, typename TCoefficientType = double>
OutputType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordinate, TCoefficientType >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  index) const
overridevirtual

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.

Implements itk::InterpolateImageFunction< TImageType, TCoordinate >.

◆ 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::Object.

◆ 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, TCoordinate >.

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::Object.

◆ 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, TCoordinate >.

◆ 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>
constexpr 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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16