ITK  5.4.0
Insight 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>

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.

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

Public Types

using ArrayType = FixedArray< double, VImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = GaussianSpatialFunction
 
using Superclass = SpatialFunction< TOutput, VImageDimension, TInput >
 
- Public Types inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = SpatialFunction
 
using Superclass = FunctionBase< TInput, TOutput >
 
- Public Types inherited from itk::FunctionBase< TInput, TOutput >
using ConstPointer = SmartPointer< const Self >
 
using InputType = TInput
 
using OutputType = TOutput
 
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 TInput &position) const override
 
 itkOverrideGetNameOfClassMacro (GaussianSpatialFunction)
 
virtual void SetScale (double _arg)
 
virtual double GetScale () const
 
virtual void SetNormalized (bool _arg)
 
virtual bool GetNormalized () const
 
virtual void NormalizedOn ()
 
virtual void SetSigma (ArrayType _arg)
 
virtual ArrayType GetSigma () const
 
virtual void SetMean (ArrayType _arg)
 
virtual ArrayType GetMean () const
 
- Public Member Functions inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
 itkOverrideGetNameOfClassMacro (SpatialFunction)
 
- Public Member Functions inherited from itk::FunctionBase< TInput, TOutput >
 itkOverrideGetNameOfClassMacro (FunctionBase)
 
- 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
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

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

Private Attributes

ArrayType m_Mean { ArrayType::Filled(10.0) }
 
bool m_Normalized { false }
 
double m_Scale { 1.0 }
 
ArrayType m_Sigma { ArrayType::Filled(5.0) }
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
static constexpr unsigned int ImageDimension = VImageDimension
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ArrayType

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

Type used to store gaussian parameters.

Definition at line 68 of file itkGaussianSpatialFunction.h.

◆ ConstPointer

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

Definition at line 53 of file itkGaussianSpatialFunction.h.

◆ Pointer

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

Definition at line 52 of file itkGaussianSpatialFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 50 of file itkGaussianSpatialFunction.h.

◆ Superclass

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

Definition at line 51 of file itkGaussianSpatialFunction.h.

Constructor & Destructor Documentation

◆ GaussianSpatialFunction()

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

◆ ~GaussianSpatialFunction()

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

Member Function Documentation

◆ Evaluate()

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 >.

◆ GetMean()

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.

◆ GetNormalized()

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.

◆ GetScale()

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.

◆ GetSigma()

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.

◆ itkOverrideGetNameOfClassMacro()

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

Run-time type information (and related methods).

◆ New()

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.

◆ NormalizedOn()

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.

◆ PrintSelf()

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::LightObject.

◆ SetMean()

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.

◆ SetNormalized()

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.

◆ SetScale()

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.

◆ SetSigma()

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

◆ m_Mean

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<SpacePrecisionType, VImageDimension>>
ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Mean { ArrayType::Filled(10.0) }
private

Definition at line 104 of file itkGaussianSpatialFunction.h.

◆ m_Normalized

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

Definition at line 108 of file itkGaussianSpatialFunction.h.

◆ m_Scale

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

Definition at line 106 of file itkGaussianSpatialFunction.h.

◆ m_Sigma

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<SpacePrecisionType, VImageDimension>>
ArrayType itk::GaussianSpatialFunction< TOutput, VImageDimension, TInput >::m_Sigma { ArrayType::Filled(5.0) }
private

Definition at line 102 of file itkGaussianSpatialFunction.h.


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