ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
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 >:

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: http://hdl.handle.net/1926/585

Definition at line 44 of file itkComplexBSplineInterpolateImageFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef
ComplexToImaginaryImageFilter
< InputImageType,
InternalImageType
ImaginaryFilterType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::InputImageType InputImageType
 
typedef Image< double,
itkGetStaticConstMacro(ImageDimension) > 
InternalImageType
 
typedef
BSplineInterpolateImageFunction
< InternalImageType, TCoordRep,
TCoefficientType > 
InterpolatorType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef
ComplexToRealImageFilter
< InputImageType,
InternalImageType
RealFilterType
 
typedef
ComplexBSplineInterpolateImageFunction 
Self
 
typedef
InterpolateImageFunction
< TImageType, TCoordRep > 
Superclass
 
- Public Types inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef Superclass::InputImageType InputImageType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef NumericTraits
< typename
TImageType::PixelType >
::RealType 
RealType
 
typedef InterpolateImageFunction Self
 
typedef ImageFunction
< TImageType, typename
NumericTraits< typename
TImageType::PixelType >
::RealType, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TImageType InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef NumericTraits
< TImageType::PixelType >
::RealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, NumericTraits
< TImageType::PixelType >
::RealType > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TImageType::ImageDimension >, NumericTraits< TImageType::PixelType >::RealType >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TImageType::ImageDimension > 
InputType
 
typedef NumericTraits
< TImageType::PixelType >
::RealType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const
 
virtual const char * GetNameOfClass () const
 
virtual int GetSplineOrder () const
 
virtual void SetInputImage (const TImageType *inputData)
 
void SetSplineOrder (unsigned int SplineOrder)
 
- Public Member Functions inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
virtual OutputType Evaluate (const PointType &point) const
 
virtual OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual OutputType EvaluateAtIndex (const IndexType &index) const
 
- Public Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >
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 ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, 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 *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
static const unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

 ComplexBSplineInterpolateImageFunction ()
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~ComplexBSplineInterpolateImageFunction ()
 
- Protected Member Functions inherited from itk::InterpolateImageFunction< TImageType, TCoordRep >
 InterpolateImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 ~InterpolateImageFunction ()
 
- Protected Member Functions inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TImageType::ImageDimension >, NumericTraits< TImageType::PixelType >::RealType >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 Member Functions

 ComplexBSplineInterpolateImageFunction (const Self &)
 

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 Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ImageFunction< TImageType, NumericTraits< TImageType::PixelType >::RealType, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef SmartPointer< const Self > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ConstPointer

Standard class typedef.

Definition at line 59 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef Superclass::ContinuousIndexType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 80 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef ComplexToImaginaryImageFilter< InputImageType, InternalImageType > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ImaginaryFilterType

Definition at line 90 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef Superclass::IndexType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::IndexType

Index typedef support.

Definition at line 77 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef Superclass::InputImageType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::InputImageType

InputImageType typedef support.

Definition at line 74 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef Image< double, itkGetStaticConstMacro(ImageDimension) > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::InternalImageType

Internal Real and imaginary image type

Definition at line 86 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef BSplineInterpolateImageFunction< InternalImageType, TCoordRep, TCoefficientType > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::InterpolatorType

Underlying real BSpline interpolator

Definition at line 93 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef Superclass::OutputType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::OutputType

OutputType typedef support.

Definition at line 71 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef SmartPointer< Self > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::Pointer

Standard class typedef.

Definition at line 56 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef Superclass::PointType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::PointType

PointType typedef support

Definition at line 83 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef ComplexToRealImageFilter< InputImageType, InternalImageType > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::RealFilterType

Complex to Real filter type

Definition at line 89 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef ComplexBSplineInterpolateImageFunction itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::Self

Standard class typedef.

Definition at line 50 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
typedef InterpolateImageFunction< TImageType, TCoordRep > itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::Superclass

Standard class typedef.

Definition at line 53 of file itkComplexBSplineInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ComplexBSplineInterpolateImageFunction ( )
protected
template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
virtual itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::~ComplexBSplineInterpolateImageFunction ( )
inlineprotectedvirtual

Definition at line 130 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ComplexBSplineInterpolateImageFunction ( const Self )
private

Member Function Documentation

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
virtual::itk::LightObject::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::CreateAnother ( void  ) 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.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
virtual OutputType itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
virtual

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.

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

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
virtual int itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::GetSplineOrder ( ) const
virtual
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

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::operator= ( const Self )
protected
template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
virtual void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::SetInputImage ( const TImageType *  inputData)
virtual

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

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
void itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::SetSplineOrder ( unsigned int  SplineOrder)

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

Member Data Documentation

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
const unsigned int itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::ImageDimension = Superclass::ImageDimension
static

Dimension underlying input image.

Definition at line 68 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
ImaginaryFilterType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_ImaginaryFilter
private

Definition at line 146 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
InterpolatorType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_ImaginaryInterpolator
private

Definition at line 142 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
RealFilterType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_RealFilter
private

Definition at line 144 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
InterpolatorType::Pointer itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_RealInterpolator
private

Definition at line 141 of file itkComplexBSplineInterpolateImageFunction.h.

template<typename TImageType , typename TCoordRep = double, typename TCoefficientType = double>
unsigned int itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >::m_SplineOrder
private

Definition at line 139 of file itkComplexBSplineInterpolateImageFunction.h.


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