itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkGaussianInterpolateImageFunction.h>

Inheritance diagram for itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >:

Collaboration diagram for itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >:

Detailed Description

template<typename TInputImage, typename TCoordRep = double>
class itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >

Evaluates the Gaussian interpolation of an image.

This class defines an N-dimensional Gaussian interpolation function using the vnl error function. The two parameters associated with this function are:

1. Sigma - a scalar array of size ImageDimension determining the width of the interpolation function.
2. Alpha - a scalar specifying the cutoff distance over which the function is calculated.

This work was originally described in the Insight Journal article: P. Yushkevich, N. Tustison, J. Gee, Gaussian interpolation.

See Also

{https://hdl.handle.net/10380/3139}

Author

Paul Yushkevich

Nick Tustison

Definition at line 53 of file itkGaussianInterpolateImageFunction.h.

Public Types
typedef FixedArray< RealType, ImageDimension >	ArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef Superclass::IndexType	IndexType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Superclass::RealType	RealType
typedef GaussianInterpolateImageFunction	Self
typedef InterpolateImageFunction < TInputImage, TCoordRep >	Superclass
Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef NumericTraits < typename TInputImage::PixelType > ::RealType	RealType
typedef InterpolateImageFunction	Self
typedef ImageFunction < TInputImage, typename NumericTraits< typename TInputImage::PixelType > ::RealType, TCoordRep >	Superclass
Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < TCoordRep, itkGetStaticConstMacro(ImageDimension) >	ContinuousIndexType
typedef TCoordRep	CoordRepType
typedef InputImageType::IndexType	IndexType
typedef InputImageType::IndexValueType	IndexValueType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef NumericTraits < TInputImage::PixelType > ::RealType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) >	PointType
typedef ImageFunction	Self
typedef FunctionBase< Point < TCoordRep, itkGetStaticConstMacro(ImageDimension) > , NumericTraits < TInputImage::PixelType > ::RealType >	Superclass
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
typedef SmartPointer< const Self >	ConstPointer
typedef Point< TCoordRep, TInputImage::ImageDimension >	InputType
typedef NumericTraits < TInputImage::PixelType > ::RealType	OutputType
typedef SmartPointer< Self >	Pointer
typedef FunctionBase	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
virtual const char *	GetNameOfClass () const
virtual void	SetInputImage (const TInputImage *image) override
virtual void	SetSigma (const ArrayType s)
virtual void	SetSigma (RealType *s)
virtual ArrayType	GetSigma () const
virtual void	SetAlpha (const RealType a)
virtual RealType	GetAlpha () const
virtual void	SetParameters (RealType *sigma, RealType alpha)
Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
virtual OutputType	Evaluate (const PointType &point) const override
virtual OutputType	EvaluateAtIndex (const IndexType &index) const override
Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::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 NumericTraits < TInputImage::PixelType > ::RealType	Evaluate (const PointType &point) const override=0
virtual NumericTraits < TInputImage::PixelType > ::RealType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
virtual NumericTraits < TInputImage::PixelType > ::RealType	EvaluateAtIndex (const IndexType &index) const =0
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
Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::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
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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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 = TInputImage::ImageDimension
Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
static const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static const unsigned int	ImageDimension

Protected Member Functions
virtual void	ComputeBoundingBox ()
virtual void	ComputeErrorFunctionArray (unsigned int dimension, RealType cindex, vnl_vector< RealType > &erfArray, vnl_vector< RealType > &gerfArray, bool evaluateGradient=false) const
	GaussianInterpolateImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~GaussianInterpolateImageFunction () override
virtual void	SetBoundingBoxStart (ArrayType _arg)
virtual ArrayType	GetBoundingBoxStart () const
virtual void	SetBoundingBoxEnd (ArrayType _arg)
virtual ArrayType	GetBoundingBoxEnd () const
virtual void	SetCutOffDistance (ArrayType _arg)
virtual ArrayType	GetCutOffDistance () const
Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
	InterpolateImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~InterpolateImageFunction () override
Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
	ImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageFunction () override
Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
	FunctionBase ()
	~FunctionBase () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~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 Member Functions
virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &, OutputType *) const

Private Attributes
RealType	m_Alpha
ArrayType	m_BoundingBoxEnd
ArrayType	m_BoundingBoxStart
ArrayType	m_CutOffDistance
ArrayType	m_ScalingFactor
ArrayType	m_Sigma

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
ContinuousIndexType	m_EndContinuousIndex
IndexType	m_EndIndex
InputImageConstPointer	m_Image
ContinuousIndexType	m_StartContinuousIndex
IndexType	m_StartIndex
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage , typename TCoordRep = double>

typedef FixedArray<RealType, ImageDimension> itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ArrayType

Array typedef support.

Definition at line 90 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef SmartPointer<const Self> itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 61 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::ContinuousIndexType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 87 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::IndexType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 84 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::InputImageType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 78 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::OutputType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typedef support.

Definition at line 75 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef SmartPointer<Self> itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 60 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::RealType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::RealType

RealType typedef support.

Definition at line 81 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef GaussianInterpolateImageFunction itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 58 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef InterpolateImageFunction<TInputImage, TCoordRep> itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::Superclass

Definition at line 59 of file itkGaussianInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = double>

itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GaussianInterpolateImageFunction ( )

protected

template<typename TInputImage , typename TCoordRep = double>

itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::~GaussianInterpolateImageFunction ( )

inlineoverrideprotected

Definition at line 152 of file itkGaussianInterpolateImageFunction.h.

Member Function Documentation

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ComputeBoundingBox ( )

protectedvirtual

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ComputeErrorFunctionArray ( unsigned int  dimension, RealType  cindex, vnl_vector< RealType > &  erfArray, vnl_vector< RealType > &  gerfArray, bool  evaluateGradient = false  ) const

protectedvirtual

template<typename TInputImage , typename TCoordRep = double>

virtual::itk::LightObject::Pointer itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::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.

Reimplemented in itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >.

template<typename TInputImage , typename TCoordRep = double>

virtual OutputType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  cindex ) const

inlineoverridevirtual

Evaluate at the given index.

Implements itk::InterpolateImageFunction< TInputImage, TCoordRep >.

Reimplemented in itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >.

Definition at line 144 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

virtual OutputType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  , OutputType *    ) const

privatevirtual

Evaluate function value.

Reimplemented in itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >.

template<typename TInputImage , typename TCoordRep = double>

virtual RealType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetAlpha ( ) const

virtual

Set/Get alpha.

template<typename TInputImage , typename TCoordRep = double>

virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetBoundingBoxEnd ( ) const

protectedvirtual

Set/Get the bounding box end point.

template<typename TInputImage , typename TCoordRep = double>

virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetBoundingBoxStart ( ) const

protectedvirtual

Set/Get the bounding box starting point.

template<typename TInputImage , typename TCoordRep = double>

virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetCutOffDistance ( ) const

protectedvirtual

Set/Get the cut-off distance.

template<typename TInputImage , typename TCoordRep = double>

virtual const char* itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

Reimplemented in itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >.

template<typename TInputImage , typename TCoordRep = double>

virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetSigma ( ) const

virtual

Set/Get sigma.

template<typename TInputImage , typename TCoordRep = double>

static Pointer itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage , typename TCoordRep = double>

void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::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.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetAlpha ( const RealType  a )

inlinevirtual

Set/Get alpha.

Definition at line 123 of file itkGaussianInterpolateImageFunction.h.

References itk::Math::NotExactlyEquals().

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetBoundingBoxEnd ( ArrayType  _arg )

protectedvirtual

Set/Get the bounding box end point.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetBoundingBoxStart ( ArrayType  _arg )

protectedvirtual

Set/Get the bounding box starting point.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetCutOffDistance ( ArrayType  _arg )

protectedvirtual

Set/Get the cut-off distance.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetInputImage ( const TInputImage *  image )

inlineoverridevirtual

Set input image.

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >.

Definition at line 93 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetParameters ( RealType *  sigma, RealType  alpha  )

inlinevirtual

Set/Get sigma and alpha.

Definition at line 136 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetSigma ( const ArrayType  s )

inlinevirtual

Set/Get sigma.

Definition at line 101 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetSigma ( RealType *  s )

inlinevirtual

Set/Get sigma.

Definition at line 110 of file itkGaussianInterpolateImageFunction.h.

Member Data Documentation

template<typename TInputImage , typename TCoordRep = double>

const unsigned int itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension

static

ImageDimension constant.

Definition at line 71 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

RealType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_Alpha

private

Definition at line 185 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_BoundingBoxEnd

private

Definition at line 188 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_BoundingBoxStart

private

Definition at line 187 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_CutOffDistance

private

Definition at line 190 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_ScalingFactor

private

Definition at line 189 of file itkGaussianInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_Sigma

private

Definition at line 184 of file itkGaussianInterpolateImageFunction.h.

---

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

• itkGaussianInterpolateImageFunction.h