#include <itkLabelImageGaussianInterpolateImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>
class itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >

Interpolation function for multi-label images that implicitly smooths each unique value in the image corresponding to each label set element and returns the corresponding label set element with the largest weight.

This filter is an alternative to nearest neighbor interpolation for multi-label images. Given a multi-label image I with label set L, this function returns a label at the non-voxel position I(x), based on the following rule

\[ I(x) = \arg\max_{l \in L} (G_\sigma * I_l)(x) \]

Where \( I_l \) is the l-th binary component of the multilabel image. In other words, each label in the multi-label image is convolved with a Gaussian, and the label for which the response is largest is returned. For sigma=0, this is just nearest neighbor interpolation.

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

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

Note: The input image can be of any type, but the number of unique intensity values in the image will determine the amount of memory needed to complete each interpolation.

Author: Paul Yushkevich; Nick Tustison

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 72 of file itkLabelImageGaussianInterpolateImageFunction.h.

Inheritance diagram for itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >:

Collaboration diagram for itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputPixelType = typename TInputImage::PixelType

using	Pointer = SmartPointer< Self >

using	Self = LabelImageGaussianInterpolateImageFunction

using	Superclass = GaussianInterpolateImageFunction< TInputImage, TCoordRep >

Public Types inherited from itk::GaussianInterpolateImageFunction< TInputImage, double >
using	ArrayType = FixedArray< RealType, ImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = GaussianInterpolateImageFunction

using	Superclass = InterpolateImageFunction< TInputImage, double >

Public Types inherited from itk::InterpolateImageFunction< TInputImage, double >
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, double >

Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< double, Self::ImageDimension >

using	CoordRepType = double

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< double, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< double, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >

Public Types inherited from itk::FunctionBase< Point< double, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< double, 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

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::GaussianInterpolateImageFunction< TInputImage, double >
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override

const char *	GetNameOfClass () const override

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, double >
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0

OutputType	EvaluateAtIndex (const IndexType &index) const override

const char *	GetNameOfClass () const override

virtual SizeType	GetRadius () const=0

OutputType	Evaluate (const PointType &point) const override

Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const

void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const

OutputType	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

const char *	GetNameOfClass () const override

virtual const ContinuousIndexType &	GetStartContinuousIndex () const

virtual const IndexType &	GetStartIndex () const

virtual void	SetInputImage (const InputImageType *ptr)

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::FunctionBase< Point< double, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
virtual OutputType	Evaluate (const InputType &input) const=0

const char *	GetNameOfClass () const override

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::GaussianInterpolateImageFunction< TInputImage, double >
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::GaussianInterpolateImageFunction< TInputImage, double >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, double >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	LabelImageGaussianInterpolateImageFunction ()=default

	~LabelImageGaussianInterpolateImageFunction () override=default

Protected Member Functions inherited from itk::GaussianInterpolateImageFunction< TInputImage, double >
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, double >
	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, double >
	ImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ImageFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< double, 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

void	PrintSelf (std::ostream &os, Indent indent) const override

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &, OutputType *) const override

Additional Inherited Members
Protected Types inherited from itk::GaussianInterpolateImageFunction< TInputImage, double >
using	RegionType = ImageRegion< ImageDimension >

Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
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 TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::ConstPointer = SmartPointer<const Self>

Definition at line 82 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ InputPixelType

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::InputPixelType = typename TInputImage::PixelType

Definition at line 83 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::Pointer = SmartPointer<Self>

Definition at line 81 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::Self = LabelImageGaussianInterpolateImageFunction

Standard class type aliases.

Definition at line 79 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

using itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::Superclass = GaussianInterpolateImageFunction<TInputImage, TCoordRep>

Definition at line 80 of file itkLabelImageGaussianInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ LabelImageGaussianInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::LabelImageGaussianInterpolateImageFunction ( )

protecteddefault

◆ ~LabelImageGaussianInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::~LabelImageGaussianInterpolateImageFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ EvaluateAtContinuousIndex() [1/2]

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

OutputType itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::EvaluateAtContinuousIndex	(	const ContinuousIndexType &	,
		OutputType *
	)		const

overrideprivatevirtual

Evaluate function value at the given index

Reimplemented from itk::GaussianInterpolateImageFunction< TInputImage, double >.

◆ EvaluateAtContinuousIndex() [2/2]

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

OutputType itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::EvaluateAtContinuousIndex ( const ContinuousIndexType & cindex ) const

inlineoverridevirtual

Evaluate at the given index

Implements itk::InterpolateImageFunction< TInputImage, double >.

Definition at line 116 of file itkLabelImageGaussianInterpolateImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

const char * itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

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

static

Method for creation through the object factory.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double, typename TPixelCompare = std::less<typename itk::NumericTraits<typename TInputImage::PixelType>::RealType>>

constexpr unsigned int itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constant

Definition at line 92 of file itkLabelImageGaussianInterpolateImageFunction.h.

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

itkLabelImageGaussianInterpolateImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InputPixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LabelImageGaussianInterpolateImageFunction()

◆ ~LabelImageGaussianInterpolateImageFunction()

Member Function Documentation

◆ EvaluateAtContinuousIndex() [1/2]

◆ EvaluateAtContinuousIndex() [2/2]

◆ GetNameOfClass()

◆ New()

Member Data Documentation

◆ ImageDimension