itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput > Class Template Reference
[Spatial Functions]

N-dimensional gaussian spatial function class. More...

#include <itkGaussianSpatialFunction.h>

Inheritance diagram for itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >:

[legend]Collaboration diagram for itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >:

[legend]List of all members.

Public Types
typedef GaussianSpatialFunction	Self
typedef SpatialFunction< TOutput, VImageDimension, TInput >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef FixedArray< double, VImageDimension >	ArrayType
Public Member Functions
virtual const char *	GetClassName () const
OutputType	Evaluate (const TInput &position) const
virtual void	SetScale (double _arg)
virtual double	GetScale ()
virtual void	SetNormalized (bool _arg)
virtual bool	GetNormalized ()
virtual void	SetSigma (ArrayType _arg)
virtual ArrayType	GetSigma ()
virtual void	SetMean (ArrayType _arg)
virtual ArrayType	GetMean ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	GaussianSpatialFunction ()
virtual	~GaussianSpatialFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
class itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >

N-dimensional gaussian spatial function class.

GaussianSpatialFunction implements a standard gaussian curve in N-d. m_Normalized determines whether or not the Gaussian is normalized (whether or not the sum over infinite space is 1.0)

m_Scale scales the output of the Gaussian to span a range larger than 0->1, and is often set to the maximum value of the output data type (for instance, 255 for uchars)

Definition at line 43 of file itkGaussianSpatialFunction.h.

---

Member Typedef Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef FixedArray<double, VImageDimension> itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::ArrayType

Type used to store gaussian parameters. Definition at line 65 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef SmartPointer<const Self> itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::ConstPointer

Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >. Definition at line 50 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef Superclass::InputType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::InputType

Input type for the function. Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >. Definition at line 59 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef Superclass::OutputType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::OutputType

Output type for the function. Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >. Definition at line 62 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef SmartPointer<Self> itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::Pointer

Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >. Definition at line 49 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef GaussianSpatialFunction itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::Self

Standard class typedefs. Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >. Definition at line 47 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> typedef SpatialFunction<TOutput, VImageDimension, TInput> itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::Superclass

Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >. Definition at line 48 of file itkGaussianSpatialFunction.h.

---

Constructor & Destructor Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GaussianSpatialFunction (   )  [protected]

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::~GaussianSpatialFunction (   )  [protected, virtual]

---

Member Function Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> OutputType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::Evaluate (  const TInput &  position  )  const

Evaluate the function at a given position.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual const char* itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetMean (   )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual bool itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetNormalized (   )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual double itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetScale (   )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetSigma (   )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> Pointer itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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::SpatialFunction< TOutput, VImageDimension, TInput >.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::SetMean (  ArrayType  _arg  )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::SetNormalized (  bool  _arg  )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::SetScale (  double  _arg  )  [virtual]

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::SetSigma (  ArrayType  _arg  )  [virtual]

Gets and sets for gaussian parameters

---

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

• itkGaussianSpatialFunction.h

---