ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
itk::GaussianSpatialObject< TDimension > Class Template Reference

#include <itkGaussianSpatialObject.h>

+ Inheritance diagram for itk::GaussianSpatialObject< TDimension >:
+ Collaboration diagram for itk::GaussianSpatialObject< TDimension >:

List of all members.

Public Types

typedef Superclass::BoundingBoxType BoundingBoxType
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Superclass::PointType PointType
typedef double ScalarType
typedef GaussianSpatialObject Self
typedef SpatialObject< TDimension > Superclass
typedef SmartPointer< SuperclassSuperclassPointer
typedef Superclass::TransformType TransformType

Public Member Functions

virtual bool ComputeLocalBoundingBox () const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
EllipseSpatialObject
< TDimension >::Pointer 
GetEllipsoid () const
virtual const char * GetNameOfClass () const
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool IsInside (const PointType &point, unsigned int depth, char *name) const
virtual bool IsInside (const PointType &point) const
ScalarType SquaredZScore (const PointType &point) const
virtual bool ValueAt (const PointType &point, ScalarType &value, unsigned int depth=0, char *name=NULL) const
virtual void SetRadius (ScalarType _arg)
virtual const ScalarTypeGetRadius ()
virtual void SetSigma (ScalarType _arg)
virtual const ScalarTypeGetSigma ()
virtual void SetMaximum (ScalarType _arg)
virtual const ScalarTypeGetMaximum ()

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int NumberOfDimensions = TDimension

Protected Member Functions

 GaussianSpatialObject (const Self &)
 GaussianSpatialObject (void)
void operator= (const Self &)
virtual void PrintSelf (std::ostream &os, Indent indent) const
 ~GaussianSpatialObject (void)

Protected Attributes

ScalarType m_Maximum
ScalarType m_Radius
ScalarType m_Sigma

Detailed Description

template<unsigned int TDimension = 3>
class itk::GaussianSpatialObject< TDimension >

Represents a multivariate Gaussian function.

The Gaussian function G(x) is given by

\[ G(\vec{x}) = m e^{-\|\S^{-1} \vec{x}\|^2 / 2}, \]

where m is a scaling factor set by SetMaximum(), and $\S$ is the (invertible) matrix associated to the IndexToObjectTransform of the object multiplied by the Sigma parameter. If $\S$ is symmetric and positive definite, and m is chosen so that the integral of G(x) is 1, then G will denote a normal distribution with mean 0 and covariance matrix $\S \times Sigma$.

Definition at line 43 of file itkGaussianSpatialObject.h.


Member Typedef Documentation

template<unsigned int TDimension = 3>
typedef Superclass::BoundingBoxType itk::GaussianSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 56 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< const Self > itk::GaussianSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 51 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< Self > itk::GaussianSpatialObject< TDimension >::Pointer

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 50 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::PointType itk::GaussianSpatialObject< TDimension >::PointType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 54 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef double itk::GaussianSpatialObject< TDimension >::ScalarType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 49 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef GaussianSpatialObject itk::GaussianSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 48 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SpatialObject< TDimension > itk::GaussianSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 52 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< Superclass > itk::GaussianSpatialObject< TDimension >::SuperclassPointer

Definition at line 53 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::TransformType itk::GaussianSpatialObject< TDimension >::TransformType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 55 of file itkGaussianSpatialObject.h.


Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::GaussianSpatialObject< TDimension >::GaussianSpatialObject ( const Self ) [protected]
template<unsigned int TDimension = 3>
itk::GaussianSpatialObject< TDimension >::GaussianSpatialObject ( void  ) [protected]
template<unsigned int TDimension = 3>
itk::GaussianSpatialObject< TDimension >::~GaussianSpatialObject ( void  ) [protected]

Member Function Documentation

template<unsigned int TDimension = 3>
virtual bool itk::GaussianSpatialObject< TDimension >::ComputeLocalBoundingBox ( ) const [virtual]

This function needs to be called every time one of the object's components is changed.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual::itk::LightObject::Pointer itk::GaussianSpatialObject< TDimension >::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::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
EllipseSpatialObject< TDimension >::Pointer itk::GaussianSpatialObject< TDimension >::GetEllipsoid ( ) const

Returns the sigma=m_Radius level set of the Gaussian function, as an EllipseSpatialObject.

template<unsigned int TDimension = 3>
virtual const ScalarType& itk::GaussianSpatialObject< TDimension >::GetMaximum ( ) [virtual]

The maximum value of the Gaussian (its value at the origin of the spatial object coordinate system).

template<unsigned int TDimension = 3>
virtual const char* itk::GaussianSpatialObject< TDimension >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual const ScalarType& itk::GaussianSpatialObject< TDimension >::GetRadius ( ) [virtual]

The Radius determines the bounding box, and which points are considered to be inside the SpatialObject. All points with z-score less than the radius are in the object.

template<unsigned int TDimension = 3>
virtual const ScalarType& itk::GaussianSpatialObject< TDimension >::GetSigma ( ) [virtual]

The Sigma parameter determines the fallout of the Gaussian inside of the region defined by the Radius parameter.

template<unsigned int TDimension = 3>
virtual bool itk::GaussianSpatialObject< TDimension >::IsEvaluableAt ( const PointType point,
unsigned int  depth = 0,
char *  name = NULL 
) const [virtual]

Return true if the object provides a method to evaluate the value at the specified point, false otherwise.

template<unsigned int TDimension = 3>
virtual bool itk::GaussianSpatialObject< TDimension >::IsInside ( const PointType point,
unsigned int  depth,
char *  name 
) const [virtual]

Test whether a point is inside or outside the object

template<unsigned int TDimension = 3>
virtual bool itk::GaussianSpatialObject< TDimension >::IsInside ( const PointType point) const [virtual]

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth

template<unsigned int TDimension = 3>
static Pointer itk::GaussianSpatialObject< TDimension >::New ( void  ) [static]

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
void itk::GaussianSpatialObject< TDimension >::operator= ( const Self ) [protected]

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Print the object information in a stream.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::SetMaximum ( ScalarType  _arg) [virtual]

The maximum value of the Gaussian (its value at the origin of the spatial object coordinate system).

template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::SetRadius ( ScalarType  _arg) [virtual]

The Radius determines the bounding box, and which points are considered to be inside the SpatialObject. All points with z-score less than the radius are in the object.

template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::SetSigma ( ScalarType  _arg) [virtual]

The Sigma parameter determines the fallout of the Gaussian inside of the region defined by the Radius parameter.

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::SquaredZScore ( const PointType point) const

If the matrix S is returned by this->GetIndexToObjectTransform()->GetMatrix(), then SquaredZScore(x) returns |Sx| squared.

template<unsigned int TDimension = 3>
virtual bool itk::GaussianSpatialObject< TDimension >::ValueAt ( const PointType point,
ScalarType value,
unsigned int  depth = 0,
char *  name = NULL 
) const [virtual]

Returns the value of the Gaussian at the given point.


Member Data Documentation

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::m_Maximum [protected]

Definition at line 124 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::m_Radius [protected]

Definition at line 125 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::m_Sigma [protected]

Definition at line 126 of file itkGaussianSpatialObject.h.

template<unsigned int TDimension = 3>
const unsigned int itk::GaussianSpatialObject< TDimension >::NumberOfDimensions = TDimension [static]

Definition at line 59 of file itkGaussianSpatialObject.h.


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