ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::GaussianSpatialObject< TDimension > Class Template Reference

#include <itkGaussianSpatialObject.h>

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

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

Examples:
Examples/Filtering/SpatialObjectToImage2.cxx, and Examples/SpatialObjects/GaussianSpatialObject.cxx.

Definition at line 43 of file itkGaussianSpatialObject.h.

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 Types inherited from itk::SpatialObject< TDimension >
typedef
AffineGeometryFrameType::Pointer 
AffineGeometryFramePointer
 
typedef AffineGeometryFrame
< double, VDimension > 
AffineGeometryFrameType
 
typedef BoundingBoxType::Pointer BoundingBoxPointer
 
typedef BoundingBox
< IdentifierType, VDimension,
ScalarType,
VectorContainerType
BoundingBoxType
 
typedef ChildrenListTypeChildrenListPointer
 
typedef std::list< PointerChildrenListType
 
typedef SmartPointer< const SelfConstPointer
 
typedef CovariantVector
< ScalarType, VDimension > 
CovariantVectorType
 
typedef Index< VDimension > IndexType
 
typedef Point< ScalarType,
VDimension > 
InputType
 
typedef Offset< VDimension > OffsetType
 
typedef OutputVectorTypeOutputVectorPointer
 
typedef CovariantVector
< double, VDimension > 
OutputVectorType
 
typedef SmartPointer< SelfPointer
 
typedef PointTypePointPointer
 
typedef Point< ScalarType,
VDimension > 
PointType
 
typedef PropertyType::Pointer PropertyPointer
 
typedef SpatialObjectProperty
< float > 
PropertyType
 
typedef ImageRegion< VDimension > RegionType
 
typedef double ScalarType
 
typedef SpatialObject< VDimension > Self
 
typedef Size< VDimension > SizeType
 
typedef double * SpacingType
 
typedef DataObject Superclass
 
typedef const TransformTypeTransformConstPointer
 
typedef TransformType::Pointer TransformPointer
 
typedef
ScalableAffineTransform
< double, VDimension > 
TransformType
 
typedef SpatialObjectTreeNode
< VDimension > 
TreeNodeType
 
typedef VectorContainer
< IdentifierType, PointType
VectorContainerType
 
typedef VectorTypeVectorPointer
 
typedef Vector< ScalarType,
VDimension > 
VectorType
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject 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 bool ComputeLocalBoundingBox () const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
EllipseSpatialObject
< TDimension >::Pointer 
GetEllipsoid () const
 
virtual const char * GetNameOfClass () const
 
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const override
 
virtual bool IsInside (const PointType &point, unsigned int depth, char *name) const override
 
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=nullptr) const override
 
virtual void SetRadius (ScalarType _arg)
 
virtual const ScalarTypeGetRadius () const
 
virtual void SetSigma (ScalarType _arg)
 
virtual const ScalarTypeGetSigma () const
 
virtual void SetMaximum (ScalarType _arg)
 
virtual const ScalarTypeGetMaximum () const
 
- Public Member Functions inherited from itk::SpatialObject< TDimension >
void AddSpatialObject (Self *pointer)
 
virtual void Clear ()
 
virtual bool ComputeBoundingBox () const
 
void ComputeObjectToParentTransform ()
 
void ComputeObjectToWorldTransform ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=nullptr)
 
bool Evaluate (const PointType &point) const
 
virtual BoundingBoxTypeGetBoundingBox () const
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=nullptr) const
 
const TransformTypeGetIndexToObjectTransform () const
 
TransformTypeGetIndexToObjectTransform (void)
 
virtual const TransformTypeGetIndexToWorldTransform () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
unsigned int GetMaximumDepth () const
 
TransformTypeGetModifiableIndexToObjectTransform (void)
 
virtual TransformTypeGetModifiableIndexToWorldTransform ()
 
virtual TreeNodeTypeGetModifiableTreeNode ()
 
virtual ModifiedTimeType GetMTime (void) const override
 
TransformTypeGetNodeToParentNodeTransform ()
 
const TransformTypeGetNodeToParentNodeTransform () const
 
unsigned int GetNumberOfChildren (unsigned int depth=0, char *name=nullptr) const
 
unsigned int GetObjectDimension (void) const
 
ModifiedTimeType GetObjectMTime (void) const
 
TransformTypeGetObjectToParentTransform ()
 
const TransformTypeGetObjectToParentTransform () const
 
virtual const SelfGetParent () const
 
virtual SelfGetParent ()
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const double * GetSpacing () const
 
virtual std::string GetSpatialObjectTypeAsString () const
 
ModifiedTimeType GetTransformMTime ()
 
virtual const TreeNodeTypeGetTreeNode () const
 
virtual const char * GetTypeName (void) const
 
ModifiedTimeType GetWorldTransformMTime ()
 
virtual bool HasParent () const
 
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const
 
virtual bool IsInside (const PointType &point, unsigned int depth=0, char *name=nullptr) const
 
void RemoveSpatialObject (Self *object)
 
virtual void SetBufferedRegion (const RegionType &region)
 
void SetChildren (ChildrenListType &children)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
void SetNodeToParentNodeTransform (TransformType *transform)
 
void SetObjectToParentTransform (TransformType *transform)
 
void SetParent (Self *parent)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegion (const DataObject *data) override
 
void SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
 
virtual void SetTreeNode (TreeNodeType *_arg)
 
virtual void Update (void) override
 
virtual bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const
 
virtual void SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
 
virtual AffineGeometryFrameTypeGetModifiableAffineGeometryFrame ()
 
virtual const
AffineGeometryFrameType
GetAffineGeometryFrame () const
 
void SetObjectToWorldTransform (TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToWorldTransform ()
 
virtual const TransformTypeGetObjectToWorldTransform () const
 
const OffsetValueTypeGetOffsetTable () const
 
OffsetValueType ComputeOffset (const IndexType &ind) const
 
IndexType ComputeIndex (OffsetValueType offset) const
 
virtual void CopyInformation (const DataObject *data) override
 
virtual void UpdateOutputInformation () override
 
virtual void SetRequestedRegionToLargestPossibleRegion () override
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual bool VerifyRequestedRegion () override
 
PropertyTypeGetProperty ()
 
const PropertyTypeGetProperty (void) const
 
void SetProperty (PropertyType *property)
 
virtual const int & GetId () const
 
virtual void SetId (int _arg)
 
virtual void SetParentId (int _arg)
 
virtual const int & GetParentId () const
 
 itkLegacyMacro (TransformType *GetObjectToNodeTransform())
 
TransformTypeGetModifiableObjectToNodeTransform ()
 
const TransformTypeGetObjectToNodeTransform () const
 
virtual void SetBoundingBoxChildrenDepth (unsigned int _arg)
 
virtual const unsigned int & GetBoundingBoxChildrenDepth () const
 
virtual void SetBoundingBoxChildrenName (std::string _arg)
 
virtual const std::string & GetBoundingBoxChildrenName () const
 
virtual void SetDefaultInsideValue (double _arg)
 
virtual double GetDefaultInsideValue () const
 
virtual void SetDefaultOutsideValue (double _arg)
 
virtual double GetDefaultOutsideValue () const
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void UpdateOutputData ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () 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 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::SpatialObject< TDimension >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- 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 ()
 

Static Public Attributes

static const unsigned int NumberOfDimensions = TDimension
 
- Static Public Attributes inherited from itk::SpatialObject< TDimension >
static const unsigned int MaximumDepth
 
static const unsigned int ObjectDimension
 

Protected Member Functions

 GaussianSpatialObject ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GaussianSpatialObject () override
 
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
void ComputeOffsetTable ()
 
virtual const BoundingBoxTypeGetBounds () const
 
virtual const unsigned int & GetDimension () const
 
virtual const TransformTypeGetInternalInverseTransform () const
 
virtual BoundingBoxTypeGetModifiableBounds ()
 
virtual TransformTypeGetModifiableInternalInverseTransform ()
 
virtual void SetDimension (unsigned int _arg)
 
bool SetInternalInverseTransformToWorldToIndexTransform () const
 
virtual void SetTypeName (std::string _arg)
 
 SpatialObject ()
 
virtual ~SpatialObject () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
virtual ~DataObject () 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 ()
 

Protected Attributes

ScalarType m_Maximum
 
ScalarType m_Radius
 
ScalarType m_Sigma
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 56 of file itkGaussianSpatialObject.h.

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

Definition at line 51 of file itkGaussianSpatialObject.h.

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

Definition at line 50 of file itkGaussianSpatialObject.h.

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

Definition at line 54 of file itkGaussianSpatialObject.h.

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

Definition at line 49 of file itkGaussianSpatialObject.h.

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

Definition at line 48 of file itkGaussianSpatialObject.h.

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

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

Definition at line 55 of file itkGaussianSpatialObject.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::GaussianSpatialObject< TDimension >::GaussianSpatialObject ( )
protected
template<unsigned int TDimension = 3>
itk::GaussianSpatialObject< TDimension >::~GaussianSpatialObject ( )
overrideprotected

Member Function Documentation

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

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 ( ) 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<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 ( ) const
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 ( ) const
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 ( ) const
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 = nullptr 
) const
overridevirtual

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
overridevirtual

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 ( )
static
template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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 = nullptr 
) const
overridevirtual

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 123 of file itkGaussianSpatialObject.h.

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

Definition at line 124 of file itkGaussianSpatialObject.h.

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

Definition at line 125 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: