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

#include <itkGaussianDerivativeSpatialFunction.h>

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

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

[legend]List of all members.

---

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 44 of file itkGaussianDerivativeSpatialFunction.h.

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 GaussianDerivativeSpatialFunction	Self
typedef SpatialFunction< TOutput, VImageDimension, TInput >	Superclass
typedef Vector< double, VImageDimension >	VectorType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual OutputType	Evaluate (const InputType &input) const =0
OutputType	Evaluate (const TInput &position) const
VectorType	EvaluateVector (const TInput &position) const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual unsigned int	GetDirection ()
virtual ArrayType	GetMean ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual bool	GetNormalized ()
virtual int	GetReferenceCount () const
virtual double	GetScale ()
virtual ArrayType	GetSigma ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetDirection (unsigned int _arg)
virtual void	SetMean (ArrayType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNormalized (bool _arg)
virtual void	SetReferenceCount (int)
Gets and sets for gaussian parameters *virtual void	SetScale (double _arg)
virtual void	SetSigma (ArrayType _arg)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	GaussianDerivativeSpatialFunction ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~GaussianDerivativeSpatialFunction ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

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

Type used to store derivatives parameters. Definition at line 66 of file itkGaussianDerivativeSpatialFunction.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

Type used to return the derivatives in each direction Definition at line 69 of file itkGaussianDerivativeSpatialFunction.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> virtual OutputType itk::SpatialFunction< TOutput, VImageDimension, TInput >::Evaluate (  const InputType &  input  )  const [pure virtual, inherited]

Evaluate the function at a given position. Remember, position is represented by an n-d itk::Point object with data type double. Implements itk::FunctionBase< TInput, TOutput >. Implemented in itk::BinaryThresholdSpatialFunction< TFunction >, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::InteriorExteriorSpatialFunction< VDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >.

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

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

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

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

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

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

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

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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

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

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

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

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

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

template<typename TOutput, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> itk::SpatialFunction< TOutput, VImageDimension, TInput >::itkStaticConstMacro (  ImageDimension  , unsigned  int, VImageDimension  )  [inherited]

Spatial dimension.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

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

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

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]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

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

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<typename TOutput = double, unsigned int VImageDimension = 3, typename TInput = Point<double, VImageDimension>> Gets and sets for gaussian parameters* virtual void itk::GaussianDerivativeSpatialFunction< TOutput, VImageDimension, TInput >::SetScale (  double  _arg  )  [virtual]

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

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkGaussianDerivativeSpatialFunction.h

---