ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkGaussianInterpolateImageFunction.h>

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

Public Types

using ArrayType = FixedArray< RealType, ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = GaussianInterpolateImageFunction
 
using Superclass = InterpolateImageFunction< TInputImage, TCoordRep >
 
- Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using RealType = typename NumericTraits< typename TInputImage::PixelType >::RealType
 
using Self = InterpolateImageFunction
 
using SizeType = typename InputImageType::SizeType
 
using Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::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 = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = NumericTraits< TInputImage::PixelType >::RealType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TInputImage::ImageDimension >
 
using OutputType = NumericTraits< TInputImage::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 &cindex) const override
 
virtual const char * GetNameOfClass () const
 
SizeType GetRadius () const override
 
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 >
OutputType EvaluateAtIndex (const IndexType &index) const override
 
OutputType Evaluate (const PointType &point) 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
 
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
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
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 = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static constexpr unsigned int ImageDimension
 

Protected Types

using RegionType = ImageRegion< ImageDimension >
 

Protected Member Functions

virtual void ComputeBoundingBox ()
 
virtual void ComputeErrorFunctionArray (const RegionType &region, unsigned int dimension, RealType cindex, vnl_vector< RealType > &erfArray, vnl_vector< RealType > &gerfArray, bool evaluateGradient=false) const
 
RegionType ComputeInterpolationRegion (const ContinuousIndexType &) const
 
 GaussianInterpolateImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GaussianInterpolateImageFunction () override=default
 
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 ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~InterpolateImageFunction () override=default
 
- 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=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::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 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
std::atomic< int > m_ReferenceCount
 

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://www.insight-journal.org/browse/publication/705}
Author
Paul Yushkevich
Nick Tustison

Definition at line 54 of file itkGaussianInterpolateImageFunction.h.

Member Typedef Documentation

◆ ArrayType

template<typename TInputImage , typename TCoordRep = double>
using itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ArrayType = FixedArray<RealType, ImageDimension>

Array type alias support

Definition at line 94 of file itkGaussianInterpolateImageFunction.h.

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = double>
using itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkGaussianInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double>
using itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 62 of file itkGaussianInterpolateImageFunction.h.

◆ RegionType

template<typename TInputImage , typename TCoordRep = double>
using itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::RegionType = ImageRegion<ImageDimension>
protected

Definition at line 171 of file itkGaussianInterpolateImageFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 60 of file itkGaussianInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = double>
using itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::Superclass = InterpolateImageFunction<TInputImage, TCoordRep>

Definition at line 61 of file itkGaussianInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ GaussianInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>
itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GaussianInterpolateImageFunction ( )
protected

◆ ~GaussianInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>
itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::~GaussianInterpolateImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ ComputeBoundingBox()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ComputeBoundingBox ( )
protectedvirtual

◆ ComputeErrorFunctionArray()

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

◆ ComputeInterpolationRegion()

template<typename TInputImage , typename TCoordRep = double>
RegionType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ComputeInterpolationRegion ( const ContinuousIndexType ) const
protected

Compute the region which we need to loop over.

◆ EvaluateAtContinuousIndex() [1/2]

template<typename TInputImage , typename TCoordRep = double>
virtual OutputType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType ,
OutputType  
) const
privatevirtual

◆ EvaluateAtContinuousIndex() [2/2]

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlineoverridevirtual

◆ GetAlpha()

template<typename TInputImage , typename TCoordRep = double>
virtual RealType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetAlpha ( ) const
virtual

Set/Get alpha.

◆ GetBoundingBoxEnd()

template<typename TInputImage , typename TCoordRep = double>
virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetBoundingBoxEnd ( ) const
protectedvirtual

Set/Get the bounding box end point.

◆ GetBoundingBoxStart()

template<typename TInputImage , typename TCoordRep = double>
virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetBoundingBoxStart ( ) const
protectedvirtual

Set/Get the bounding box starting point.

◆ GetCutOffDistance()

template<typename TInputImage , typename TCoordRep = double>
virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetCutOffDistance ( ) const
protectedvirtual

Set/Get the cut-off distance.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double>
virtual const char* itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

◆ GetRadius()

template<typename TInputImage , typename TCoordRep = double>
SizeType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetRadius ( ) const
overridevirtual

Get the radius required for interpolation.

This defines the number of surrounding pixels required to interpolate at a given point.

Implements itk::InterpolateImageFunction< TInputImage, TCoordRep >.

◆ GetSigma()

template<typename TInputImage , typename TCoordRep = double>
virtual ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::GetSigma ( ) const
virtual

Set/Get sigma.

◆ New()

template<typename TInputImage , typename TCoordRep = double>
static Pointer itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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.

◆ SetAlpha()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetAlpha ( const RealType  a)
inlinevirtual

Set/Get alpha.

Definition at line 131 of file itkGaussianInterpolateImageFunction.h.

References itk::Math::NotExactlyEquals().

◆ SetBoundingBoxEnd()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetBoundingBoxEnd ( ArrayType  _arg)
protectedvirtual

Set/Get the bounding box end point.

◆ SetBoundingBoxStart()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetBoundingBoxStart ( ArrayType  _arg)
protectedvirtual

Set/Get the bounding box starting point.

◆ SetCutOffDistance()

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetCutOffDistance ( ArrayType  _arg)
protectedvirtual

Set/Get the cut-off distance.

◆ SetInputImage()

template<typename TInputImage , typename TCoordRep = double>
void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetInputImage ( const TInputImage *  image)
inlineoverridevirtual

◆ SetParameters()

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 145 of file itkGaussianInterpolateImageFunction.h.

◆ SetSigma() [1/2]

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetSigma ( const ArrayType  s)
inlinevirtual

Set/Get sigma.

Definition at line 107 of file itkGaussianInterpolateImageFunction.h.

◆ SetSigma() [2/2]

template<typename TInputImage , typename TCoordRep = double>
virtual void itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetSigma ( RealType s)
inlinevirtual

Set/Get sigma.

Definition at line 117 of file itkGaussianInterpolateImageFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double>
constexpr unsigned int itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

ImageDimension constant.

Definition at line 72 of file itkGaussianInterpolateImageFunction.h.

◆ m_Alpha

template<typename TInputImage , typename TCoordRep = double>
RealType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_Alpha {}
private

Definition at line 207 of file itkGaussianInterpolateImageFunction.h.

◆ m_BoundingBoxEnd

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_BoundingBoxEnd {}
private

Definition at line 210 of file itkGaussianInterpolateImageFunction.h.

◆ m_BoundingBoxStart

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_BoundingBoxStart {}
private

Definition at line 209 of file itkGaussianInterpolateImageFunction.h.

◆ m_CutOffDistance

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_CutOffDistance {}
private

Definition at line 212 of file itkGaussianInterpolateImageFunction.h.

◆ m_ScalingFactor

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_ScalingFactor {}
private

Definition at line 211 of file itkGaussianInterpolateImageFunction.h.

◆ m_Sigma

template<typename TInputImage , typename TCoordRep = double>
ArrayType itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::m_Sigma {}
private

Definition at line 206 of file itkGaussianInterpolateImageFunction.h.


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