ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput > Class Template Reference

#include <itkGaussianDerivativeSpatialFunction.h>

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

Public Types

using ArrayType = FixedArray< double, VImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using Self = GaussianDerivativeSpatialFunction
 
using Superclass = SpatialFunction< TOutput, VImageDimension, TInput >
 
using VectorType = Vector< double, VImageDimension >
 
- Public Types inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
using ConstPointer = SmartPointer< const Self >
 
using InputType = typename Superclass::InputType
 
using OutputType = typename Superclass::OutputType
 
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputType Evaluate (const TInput &position) const override
 
VectorType EvaluateVector (const TInput &position) const
 
virtual const char * GetNameOfClass () const
 
- 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
 
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
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 ()
 
unsigned int m_Direction
 
ArrayType m_Sigma
 
ArrayType m_Mean
 
double m_Scale
 
bool m_Normalized
 
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
 
virtual void SetDirection (unsigned int _arg)
 
virtual unsigned int GetDirection () const
 
 GaussianDerivativeSpatialFunction ()
 
 ~GaussianDerivativeSpatialFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
static constexpr unsigned int ImageDimension = VImageDimension
 
- 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 ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

N-dimensional Gaussian spatial function class.

GaussianDerivativeSpatialFunction implements a standard derivative of Gaussian curve in N-d. m_Normalized determines whether or not the Derivative of 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 42 of file itkGaussianDerivativeSpatialFunction.h.

Member Typedef Documentation

◆ ArrayType

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

Type used to store derivatives parameters.

Definition at line 66 of file itkGaussianDerivativeSpatialFunction.h.

◆ ConstPointer

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

Definition at line 51 of file itkGaussianDerivativeSpatialFunction.h.

◆ InputType

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

Input type for the function.

Definition at line 60 of file itkGaussianDerivativeSpatialFunction.h.

◆ OutputType

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

Output type for the function.

Definition at line 63 of file itkGaussianDerivativeSpatialFunction.h.

◆ Pointer

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

Definition at line 50 of file itkGaussianDerivativeSpatialFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 48 of file itkGaussianDerivativeSpatialFunction.h.

◆ Superclass

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

Definition at line 49 of file itkGaussianDerivativeSpatialFunction.h.

◆ VectorType

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
using itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >::VectorType = Vector<double, VImageDimension>

Type used to return the derivatives in each direction

Definition at line 69 of file itkGaussianDerivativeSpatialFunction.h.

Constructor & Destructor Documentation

◆ GaussianDerivativeSpatialFunction()

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

Current direction

◆ ~GaussianDerivativeSpatialFunction()

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

Current direction

Member Function Documentation

◆ CreateAnother()

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
virtual::itk::LightObject::Pointer itk::GaussianDerivativeSpatialFunction< 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::LightObject.

◆ Evaluate()

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

Evaluate the function at a given position and return the value in the specific direction. SetDirection() should be used to set the direction.

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

◆ EvaluateVector()

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
VectorType itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >::EvaluateVector ( const TInput &  position) const

Evaluate the function at a given position and return a vector

◆ GetDirection()

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

Current direction

◆ GetMean()

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

Current direction

◆ GetNameOfClass()

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
virtual const char* itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

◆ GetNormalized()

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

Current direction

◆ GetScale()

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

Current direction

◆ GetSigma()

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

Current direction

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
void itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Current direction

Reimplemented from itk::LightObject.

◆ SetDirection()

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

Current direction

◆ SetMean()

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

Current direction

◆ SetNormalized()

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

Current direction

◆ SetScale()

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

Gets and sets for gaussian parameters

◆ SetSigma()

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

Current direction

Member Data Documentation

◆ m_Direction

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>>
unsigned int itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >::m_Direction
mutableprivate

Current direction

Definition at line 102 of file itkGaussianDerivativeSpatialFunction.h.

◆ m_Mean

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

The mean in each direction.

Definition at line 108 of file itkGaussianDerivativeSpatialFunction.h.

◆ m_Normalized

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

Whether or not to normalize the Gaussian.

Definition at line 114 of file itkGaussianDerivativeSpatialFunction.h.

◆ m_Scale

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

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

Definition at line 111 of file itkGaussianDerivativeSpatialFunction.h.

◆ m_Sigma

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

The standard deviation in each direction.

Definition at line 105 of file itkGaussianDerivativeSpatialFunction.h.


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