itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput > Class Template Reference

#include <itkGaussianSpatialFunction.h>

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

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

List of all members.

Public Types
typedef FixedArray< double, VImageDimension >	ArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef GaussianSpatialFunction	Self
typedef SpatialFunction < TOutput, VImageDimension, TInput >	Superclass
Public Types inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
Public Types inherited from itk::FunctionBase< TInput, TOutput >
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
OutputType	Evaluate (const TInput &position) const
virtual const char *	GetNameOfClass () const

Static Public Member Functions
static Pointer	New ()
Protected Member Functions inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
	SpatialFunction ()
virtual	~SpatialFunction ()
Protected Member Functions inherited from itk::FunctionBase< TInput, TOutput >
	FunctionBase ()
	~FunctionBase ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
	GaussianSpatialFunction (const Self &)
void	operator= (const Self &)

Private Attributes
ArrayType	m_Mean
bool	m_Normalized
double	m_Scale
ArrayType	m_Sigma
virtual void	SetScale (double _arg)
virtual double	GetScale () const
virtual void	SetNormalized (bool _arg)
virtual bool	GetNormalized () const
virtual void	SetSigma (ArrayType _arg)
virtual ArrayType	GetSigma () const
virtual void	SetMean (ArrayType _arg)
virtual ArrayType	GetMean () const
	GaussianSpatialFunction ()
virtual	~GaussianSpatialFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members
Static Public Attributes inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
static const unsigned int	ImageDimension = VImageDimension

---

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 66 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 51 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 57 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 63 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 50 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 48 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 49 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

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

virtual itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::~GaussianSpatialFunction ( )

protectedvirtual

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GaussianSpatialFunction ( const Self &  )

private

---

Member Function Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

virtual::itk::LightObject::Pointer itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::CreateAnother ( void  ) 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.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

OutputType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::Evaluate ( const TInput &  position ) const

virtual

Evaluate the function at a given position.

Implements 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 ( ) const

virtual

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

virtual const char* itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetNameOfClass ( ) 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 bool itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetNormalized ( ) const

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

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

virtual

Gets and sets for gaussian parameters

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

static 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 >::operator= ( const Self &  )

private

Reimplemented from itk::SpatialFunction< TOutput, VImageDimension, TInput >.

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

protectedvirtual

Gets and sets for gaussian parameters

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

---

Member Data Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Mean

private

The mean in each direction.

Definition at line 94 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

bool itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Normalized

private

Whether or not to normalize the Gaussian.

Definition at line 100 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

double itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Scale

private

A scale factor multiplied by the true value of the Gaussian.

Definition at line 97 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< double, VImageDimension >>

ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Sigma

private

The standard deviation in each direction.

Definition at line 91 of file itkGaussianSpatialFunction.h.

---

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

• itkGaussianSpatialFunction.h