ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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 >:

Detailed Description

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, 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 44 of file itkGaussianSpatialFunction.h.

Public Types

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

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputType Evaluate (const TInput &position) const override
 
virtual const char * GetNameOfClass () const
 
virtual void SetScale (double _arg)
 
virtual double GetScale () const
 
virtual void SetNormalized (bool _arg)
 
virtual bool GetNormalized () const
 
virtual void NormalizedOn ()
 
virtual void NormalizedOff ()
 
virtual void SetSigma (ArrayType _arg)
 
virtual ArrayType GetSigma () const
 
virtual void SetMean (ArrayType _arg)
 
virtual ArrayType GetMean () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 GaussianSpatialFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~GaussianSpatialFunction () override
 
- Protected Member Functions inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialFunction ()
 
virtual ~SpatialFunction () override
 
- Protected Member Functions inherited from itk::FunctionBase< TInput, TOutput >
 FunctionBase ()
 
 ~FunctionBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 Attributes

ArrayType m_Mean
 
bool m_Normalized
 
double m_Scale
 
ArrayType m_Sigma
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
static const unsigned int ImageDimension = VImageDimension
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Type used to store gaussian parameters.

Definition at line 67 of file itkGaussianSpatialFunction.h.

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

Definition at line 52 of file itkGaussianSpatialFunction.h.

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

Input type for the function.

Definition at line 58 of file itkGaussianSpatialFunction.h.

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

Output type for the function.

Definition at line 64 of file itkGaussianSpatialFunction.h.

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

Definition at line 51 of file itkGaussianSpatialFunction.h.

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

Standard class typedefs.

Definition at line 49 of file itkGaussianSpatialFunction.h.

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

Definition at line 50 of file itkGaussianSpatialFunction.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
virtual::itk::LightObject::Pointer itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::CreateAnother ( ) 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< SpacePrecisionType, VImageDimension >>
OutputType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::Evaluate ( const TInput &  position) const
overridevirtual

Evaluate the function at a given position.

Implements itk::SpatialFunction< TOutput, VImageDimension, TInput >.

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

Set/Get the mean in each direction.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, 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< SpacePrecisionType, VImageDimension >>
virtual bool itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::GetNormalized ( ) const
virtual

Set/Get whether or not to normalize the Gaussian. Default is false.

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

Set/Get the scale factor to multiply the true value of the Gaussian.

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

Set/Get the standard deviation in each direction.

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

Method for creation through the object factory.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
virtual void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::NormalizedOff ( )
virtual

Set/Get whether or not to normalize the Gaussian. Default is false.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
virtual void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::NormalizedOn ( )
virtual

Set/Get whether or not to normalize the Gaussian. Default is false.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
void itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::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.

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

Set/Get the mean in each direction.

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

Set/Get whether or not to normalize the Gaussian. Default is false.

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

Set/Get the scale factor to multiply the true value of the Gaussian.

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

Set/Get the standard deviation in each direction.

Member Data Documentation

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Mean
private

Definition at line 103 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
bool itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Normalized
private

Definition at line 107 of file itkGaussianSpatialFunction.h.

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

Definition at line 105 of file itkGaussianSpatialFunction.h.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point< SpacePrecisionType, VImageDimension >>
ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Sigma
private

Definition at line 99 of file itkGaussianSpatialFunction.h.


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