#include <itkGaussianDerivativeImageFunction.h>

Detailed Description

template<typename TInputImage, typename TOutput = double>
class itk::GaussianDerivativeImageFunction< TInputImage, TOutput >

Compute the Gaussian derivatives of an the image at a specific location in space, i.e. point, index or continuous index.

Note: From ITK 5, the Evaluate member functions of this class are concurrent thread safe: It is safe to have multiple simultaneous Evaluate calls on a GaussianDerivativeImageFunction object.

This class is templated over the input image type.

See also: NeighborhoodOperator; ImageFunction

Definition at line 50 of file itkGaussianDerivativeImageFunction.h.

Inheritance diagram for itk::GaussianDerivativeImageFunction< TInputImage, TOutput >:

Collaboration diagram for itk::GaussianDerivativeImageFunction< TInputImage, TOutput >:

Public Types
using	ConstPointer = SmartPointer< const Self >

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

using	GaussianDerivativeSpatialFunctionPointer = typename GaussianDerivativeSpatialFunctionType::Pointer

using	GaussianDerivativeSpatialFunctionType = GaussianDerivativeSpatialFunction< TOutput, 1 >

using	IndexType = typename InputImageType::IndexType

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	NeighborhoodType = Neighborhood< InputPixelType, Self::ImageDimension >

using	OperatorArrayType = FixedArray< OperatorNeighborhoodType, Self::ImageDimension >

using	OperatorNeighborhoodType = Neighborhood< TOutput, Self::ImageDimension >

using	Pointer = SmartPointer< Self >

using	PointType = typename InputImageType::PointType

using	Self = GaussianDerivativeImageFunction

using	Superclass = ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >

using	VectorType = Vector< TOutput, Self::ImageDimension >

Public Types inherited from itk::ImageFunction< TInputImage, Vector< double, TInputImage::ImageDimension >, 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 = Vector< double, TInputImage::ImageDimension >

using	Pointer = SmartPointer< Self >

using	PointType = Point< double, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< double, Self::ImageDimension >, Vector< double, TInputImage::ImageDimension > >

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

using	InputType = Point< double, TInputImage::ImageDimension >

using	OutputType = Vector< double, TInputImage::ImageDimension >

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	Evaluate (const PointType &point) const override

OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override

OutputType	EvaluateAtIndex (const IndexType &index) const override

const double *	GetExtent () const

const char *	GetNameOfClass () const override

const double *	GetSigma () const

void	SetExtent (const double *extent)

void	SetExtent (const double extent)

void	SetInputImage (const InputImageType *ptr) override

void	SetSigma (const double *sigma)

void	SetSigma (const double sigma)


void	SetUseImageSpacing (const bool val)

virtual void	UseImageSpacingOn ()

virtual bool	GetUseImageSpacing ()

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

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

Vector< double, TInputImage::ImageDimension >	Evaluate (const PointType &point) const override=0

virtual Vector< double, TInputImage::ImageDimension >	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0

virtual Vector< double, TInputImage::ImageDimension >	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 >, Vector< double, TInputImage::ImageDimension > >
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 *)

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

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)

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::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 = InputImageType::ImageDimension

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

Protected Member Functions
	GaussianDerivativeImageFunction ()

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

void	RecomputeGaussianKernel ()

	~GaussianDerivativeImageFunction () override=default

Protected Member Functions inherited from itk::ImageFunction< TInputImage, Vector< double, TInputImage::ImageDimension >, 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 >, Vector< double, TInputImage::ImageDimension > >
	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 Attributes
double	m_Extent [ImageDimension] {}

const GaussianDerivativeSpatialFunctionPointer	m_GaussianDerivativeSpatialFunction

std::vector< Offset< ImageDimension > >	m_ImageNeighborhoodOffsets [ImageDimension] {}

OperatorArrayType	m_OperatorArray {}

double	m_Sigma [ImageDimension] {}

bool	m_UseImageSpacing { true }

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, Vector< double, TInputImage::ImageDimension >, 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 TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 60 of file itkGaussianDerivativeImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::ContinuousIndexType = ContinuousIndex<SpacePrecisionType, Self::ImageDimension>

Definition at line 80 of file itkGaussianDerivativeImageFunction.h.

◆ GaussianDerivativeSpatialFunctionPointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GaussianDerivativeSpatialFunctionPointer = typename GaussianDerivativeSpatialFunctionType::Pointer

Definition at line 90 of file itkGaussianDerivativeImageFunction.h.

◆ GaussianDerivativeSpatialFunctionType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GaussianDerivativeSpatialFunctionType = GaussianDerivativeSpatialFunction<TOutput, 1>

Definition at line 89 of file itkGaussianDerivativeImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::IndexType = typename InputImageType::IndexType

Definition at line 71 of file itkGaussianDerivativeImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 69 of file itkGaussianDerivativeImageFunction.h.

◆ InputPixelType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::InputPixelType = typename InputImageType::PixelType

Definition at line 70 of file itkGaussianDerivativeImageFunction.h.

◆ NeighborhoodType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::NeighborhoodType = Neighborhood<InputPixelType, Self::ImageDimension>

Definition at line 82 of file itkGaussianDerivativeImageFunction.h.

◆ OperatorArrayType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::OperatorArrayType = FixedArray<OperatorNeighborhoodType, Self::ImageDimension>

Definition at line 87 of file itkGaussianDerivativeImageFunction.h.

◆ OperatorNeighborhoodType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::OperatorNeighborhoodType = Neighborhood<TOutput, Self::ImageDimension>

Definition at line 83 of file itkGaussianDerivativeImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Pointer = SmartPointer<Self>

Definition at line 59 of file itkGaussianDerivativeImageFunction.h.

◆ PointType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::PointType = typename InputImageType::PointType

Point type alias support

Definition at line 99 of file itkGaussianDerivativeImageFunction.h.

◆ Self

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Self = GaussianDerivativeImageFunction

Standard class type aliases.

Definition at line 57 of file itkGaussianDerivativeImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Superclass = ImageFunction<TInputImage, Vector<TOutput, TInputImage::ImageDimension>, TOutput>

Definition at line 58 of file itkGaussianDerivativeImageFunction.h.

◆ VectorType

template<typename TInputImage , typename TOutput = double>

using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::VectorType = Vector<TOutput, Self::ImageDimension>

Definition at line 85 of file itkGaussianDerivativeImageFunction.h.

Constructor & Destructor Documentation

◆ GaussianDerivativeImageFunction()

template<typename TInputImage , typename TOutput = double>

itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GaussianDerivativeImageFunction ( )

protected

◆ ~GaussianDerivativeImageFunction()

template<typename TInputImage , typename TOutput = double>

itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::~GaussianDerivativeImageFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TOutput = double>

OutputType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Evaluate ( const PointType & point ) const

override

Evaluate the function at the specified point.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TOutput = double>

OutputType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::EvaluateAtContinuousIndex ( const ContinuousIndexType & cindex ) const

override

Evaluate the function at specified ContinuousIndex position.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TOutput = double>

OutputType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::EvaluateAtIndex ( const IndexType & index ) const

overridevirtual

Evaluate the function at specified Index position.

Implements itk::ImageFunction< TInputImage, Vector< double, TInputImage::ImageDimension >, double >.

◆ GetExtent()

template<typename TInputImage , typename TOutput = double>

const double * itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetExtent ( ) const

inline

Definition at line 155 of file itkGaussianDerivativeImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutput = double>

const char * itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetSigma()

template<typename TInputImage , typename TOutput = double>

const double * itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetSigma ( ) const

inline

Definition at line 142 of file itkGaussianDerivativeImageFunction.h.

◆ GetUseImageSpacing()

template<typename TInputImage , typename TOutput = double>

virtual bool itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetUseImageSpacing ( )

virtual

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

◆ New()

template<typename TInputImage , typename TOutput = double>

static Pointer itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::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.

◆ RecomputeGaussianKernel()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel ( )

protected

Recompute the Gaussian kernel used to evaluate indexes. This should use a fastest Derivative Gaussian operator.

◆ SetExtent() [1/2]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetExtent ( const double * extent )

Set the extent of the discrete Gaussian kernel.

◆ SetExtent() [2/2]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetExtent ( const double extent )

◆ SetInputImage()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetInputImage ( const InputImageType * ptr )

overridevirtual

Set the input image.

Warning: this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputImage again to update cached values.

Reimplemented from itk::ImageFunction< TInputImage, Vector< double, TInputImage::ImageDimension >, double >.

◆ SetSigma() [1/2]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetSigma ( const double * sigma )

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v). The default is 0.0 in each dimension. The extent of the kernel is controlled by UseImageSpacing.

◆ SetSigma() [2/2]

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetSigma ( const double sigma )

◆ SetUseImageSpacing()

template<typename TInputImage , typename TOutput = double>

void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetUseImageSpacing ( const bool val )

inline

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

Definition at line 118 of file itkGaussianDerivativeImageFunction.h.

◆ UseImageSpacingOn()

template<typename TInputImage , typename TOutput = double>

virtual void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::UseImageSpacingOn ( )

virtual

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutput = double>

constexpr unsigned int itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::ImageDimension = InputImageType::ImageDimension

staticconstexpr

Dimension of the underlying image.

Definition at line 74 of file itkGaussianDerivativeImageFunction.h.

◆ m_Extent

template<typename TInputImage , typename TOutput = double>

double itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_Extent[ImageDimension] {}

private

Definition at line 189 of file itkGaussianDerivativeImageFunction.h.

◆ m_GaussianDerivativeSpatialFunction

template<typename TInputImage , typename TOutput = double>

const GaussianDerivativeSpatialFunctionPointer itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_GaussianDerivativeSpatialFunction

private

Initial value:

{
    GaussianDerivativeSpatialFunctionType::New()
  }

Neighborhood Image Function.

Definition at line 195 of file itkGaussianDerivativeImageFunction.h.

◆ m_ImageNeighborhoodOffsets

template<typename TInputImage , typename TOutput = double>

std::vector<Offset<ImageDimension> > itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_ImageNeighborhoodOffsets[ImageDimension] {}

private

Definition at line 187 of file itkGaussianDerivativeImageFunction.h.

◆ m_OperatorArray

template<typename TInputImage , typename TOutput = double>

OperatorArrayType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_OperatorArray {}

private

Array of 1D operators. Contains a derivative kernel for each dimension. Note: A future version of ITK could extend this array to include a Gaussian blurring kernel for each dimension.

Definition at line 185 of file itkGaussianDerivativeImageFunction.h.

◆ m_Sigma

template<typename TInputImage , typename TOutput = double>

double itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_Sigma[ImageDimension] {}

private

Definition at line 180 of file itkGaussianDerivativeImageFunction.h.

◆ m_UseImageSpacing

template<typename TInputImage , typename TOutput = double>

bool itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_UseImageSpacing { true }

private

Flag to indicate whether to use image spacing.

Definition at line 192 of file itkGaussianDerivativeImageFunction.h.

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

itkGaussianDerivativeImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ GaussianDerivativeSpatialFunctionPointer

◆ GaussianDerivativeSpatialFunctionType

◆ IndexType

◆ InputImageType

◆ InputPixelType

◆ NeighborhoodType

◆ OperatorArrayType

◆ OperatorNeighborhoodType

◆ Pointer

◆ PointType

◆ Self

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ GaussianDerivativeImageFunction()

◆ ~GaussianDerivativeImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetExtent()

◆ GetNameOfClass()

◆ GetSigma()

◆ GetUseImageSpacing()

◆ New()

◆ PrintSelf()

◆ RecomputeGaussianKernel()

◆ SetExtent() [1/2]

◆ SetExtent() [2/2]

◆ SetInputImage()

◆ SetSigma() [1/2]

◆ SetSigma() [2/2]

◆ SetUseImageSpacing()

◆ UseImageSpacingOn()

Member Data Documentation

◆ ImageDimension

◆ m_Extent

◆ m_GaussianDerivativeSpatialFunction

◆ m_ImageNeighborhoodOffsets

◆ m_OperatorArray

◆ m_Sigma

◆ m_UseImageSpacing