ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private 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 >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = double
 
using Self = GaussianSpatialObject
 
using Superclass = SpatialObject< TDimension >
 
using SuperclassPointer = SmartPointer< Superclass >
 
- Public Types inherited from itk::SpatialObject< TDimension >
using BoundingBoxPointer = typename BoundingBoxType::Pointer
 
using BoundingBoxType = BoundingBox< IdentifierType, VDimension, ScalarType, VectorContainerType >
 
using ChildrenConstListPointer = ChildrenConstListType *
 
using ChildrenConstListType = std::list< ConstPointer >
 
using ChildrenListPointer = ChildrenListType *
 
using ChildrenListType = std::list< Pointer >
 
using ConstPointer = SmartPointer< const Self >
 
using CovariantVectorType = CovariantVector< ScalarType, VDimension >
 
using DerivativeOffsetType = Vector< double, VDimension >
 
using DerivativeVectorPointer = DerivativeVectorType *
 
using DerivativeVectorType = CovariantVector< ScalarType, VDimension >
 
using IndexType = Index< VDimension >
 
using InputType = Point< ScalarType, VDimension >
 
using ObjectConstListType = std::list< ConstPointer >
 
using ObjectDimensionType = unsigned int
 
using ObjectListType = std::list< Pointer >
 
using Pointer = SmartPointer< Self >
 
using PointPointer = PointType *
 
using PointType = Point< ScalarType, VDimension >
 
using PropertyType = SpatialObjectProperty
 
using RegionType = ImageRegion< VDimension >
 
using ScalarType = double
 
using Self = SpatialObject< VDimension >
 
using SizeType = Size< VDimension >
 
using Superclass = DataObject
 
using TransformConstPointer = const TransformType *
 
using TransformPointer = typename TransformType::Pointer
 
using TransformType = AffineTransform< ScalarType, VDimension >
 
using VectorContainerType = VectorContainer< IdentifierType, PointType >
 
using VectorPointer = VectorType *
 
using VectorType = Vector< ScalarType, VDimension >
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
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

void Clear () override
 
virtual const PointTypeGetCenterInObjectSpace () const
 
EllipseSpatialObject< TDimension >::Pointer GetEllipsoid () const
 
virtual const char * GetNameOfClass () const
 
bool IsInsideInObjectSpace (const PointType &point) const override
 
virtual void SetCenterInObjectSpace (PointType _arg)
 
ScalarType SquaredZScoreInObjectSpace (const PointType &point) const
 
ScalarType SquaredZScoreInWorldSpace (const PointType &point) const
 
bool ValueAtInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const override
 
virtual void SetRadiusInObjectSpace (ScalarType _arg)
 
virtual const ScalarTypeGetRadiusInObjectSpace () const
 
virtual void SetSigmaInObjectSpace (ScalarType _arg)
 
virtual const ScalarTypeGetSigmaInObjectSpace () const
 
virtual void SetMaximum (ScalarType _arg)
 
virtual const ScalarTypeGetMaximum () const
 
- Public Member Functions inherited from itk::SpatialObject< TDimension >
void AddChild (Self *pointer)
 
virtual void AddChildrenToConstList (ChildrenConstListType *childrenList, unsigned int depth=0, const std::string &name="") const
 
virtual void AddChildrenToList (ChildrenListType *childrenList, unsigned int depth=0, const std::string &name="") const
 
bool CheckIdValidity () const
 
virtual bool ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const
 
void ComputeObjectToParentTransform ()
 
void CopyInformation (const DataObject *data) override
 
virtual void DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))
 
virtual void DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))
 
bool Evaluate (const PointType &point) const
 
void FixIdValidity ()
 
bool FixParentChildHierarchyUsingParentIds ()
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual ChildrenListTypeGetChildren (unsigned int depth=0, const std::string &name="") const
 
virtual std::string GetClassNameAndDimension () const
 
virtual ChildrenConstListTypeGetConstChildren (unsigned int depth=0, const std::string &name="") const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInWorldSpace () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
unsigned int GetMaximumDepth () const
 
ModifiedTimeType GetMTime () const override
 
virtual const BoundingBoxTypeGetMyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetMyBoundingBoxInWorldSpace () const
 
ModifiedTimeType GetMyMTime () const
 
int GetNextAvailableId () const
 
unsigned int GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const
 
SpatialObject< VDimension > * GetObjectById (int id)
 
unsigned int GetObjectDimension () const
 
virtual SelfGetParent ()
 
virtual const SelfGetParent () const
 
PropertyTypeGetProperty ()
 
const PropertyTypeGetProperty () const
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const std::string GetTypeName () const
 
virtual bool HasParent () const
 
virtual bool IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsInsideChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
bool IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const
 
virtual bool IsInsideInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
void RemoveAllChildren (unsigned int depth=MaximumDepth)
 
bool RemoveChild (Self *pointer)
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetBufferedRegion (const RegionType &region)
 
void SetChildren (ChildrenListType &children)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
void SetParent (Self *parent)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegionToLargestPossibleRegion () override
 
virtual void SetTypeName (std::string _arg)
 
void Update () override
 
void UpdateOutputInformation () override
 
virtual bool ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
bool VerifyRequestedRegion () override
 
void SetId (int id)
 
virtual const int & GetId () const
 
void SetProperty (const PropertyType &property)
 
void SetObjectToWorldTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToWorldTransform ()
 
const TransformTypeGetObjectToWorldTransformInverse () const
 
void SetObjectToParentTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToParentTransform ()
 
const TransformTypeGetObjectToParentTransformInverse () const
 
virtual void SetDefaultInsideValue (double _arg)
 
virtual double GetDefaultInsideValue () const
 
virtual void SetDefaultOutsideValue (double _arg)
 
virtual double GetDefaultOutsideValue () const
 
virtual void SetParentId (int _arg)
 
virtual const int & GetParentId () const
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () 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 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
 
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 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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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 Pointer New ()
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ObjectDimensions = TDimension
 
- Static Public Attributes inherited from itk::SpatialObject< TDimension >
static constexpr unsigned int MaximumDepth
 
static constexpr ObjectDimensionType ObjectDimension
 

Protected Member Functions

void ComputeMyBoundingBox () override
 
 GaussianSpatialObject ()
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GaussianSpatialObject () override=default
 
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
BoundingBoxTypeGetModifiableMyBoundingBoxInObjectSpace ()
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ProtectedComputeObjectToWorldTransform ()
 
 SpatialObject ()=default
 
 ~SpatialObject () override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- 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
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

PointType m_CenterInObjectSpace
 
ScalarType m_Maximum
 
ScalarType m_RadiusInObjectSpace
 
ScalarType m_SigmaInObjectSpace
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 52 of file itkGaussianSpatialObject.h.

◆ Pointer

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

Definition at line 51 of file itkGaussianSpatialObject.h.

◆ ScalarType

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

Definition at line 50 of file itkGaussianSpatialObject.h.

◆ Self

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

Definition at line 49 of file itkGaussianSpatialObject.h.

◆ Superclass

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

Definition at line 53 of file itkGaussianSpatialObject.h.

◆ SuperclassPointer

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

Definition at line 54 of file itkGaussianSpatialObject.h.

Constructor & Destructor Documentation

◆ GaussianSpatialObject()

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

◆ ~GaussianSpatialObject()

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

Member Function Documentation

◆ Clear()

template<unsigned int TDimension = 3>
void itk::GaussianSpatialObject< TDimension >::Clear ( )
overridevirtual

Reset the spatial object to its initial condition, yet preserves Id, Parent, and Child information

Reimplemented from itk::SpatialObject< TDimension >.

◆ ComputeMyBoundingBox()

template<unsigned int TDimension = 3>
void itk::GaussianSpatialObject< TDimension >::ComputeMyBoundingBox ( )
overrideprotectedvirtual

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

Reimplemented from itk::SpatialObject< TDimension >.

◆ GetCenterInObjectSpace()

template<unsigned int TDimension = 3>
virtual const PointType& itk::GaussianSpatialObject< TDimension >::GetCenterInObjectSpace ( ) const
virtual

◆ GetEllipsoid()

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.

◆ GetMaximum()

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

◆ GetNameOfClass()

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

◆ GetRadiusInObjectSpace()

template<unsigned int TDimension = 3>
virtual const ScalarType& itk::GaussianSpatialObject< TDimension >::GetRadiusInObjectSpace ( ) 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.

◆ GetSigmaInObjectSpace()

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

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

◆ InternalClone()

template<unsigned int TDimension = 3>
LightObject::Pointer itk::GaussianSpatialObject< TDimension >::InternalClone ( ) const
overrideprotectedvirtual

Actual implementation of the clone method. This method should be reimplemented in subclasses to clone the extra required parameters.

Reimplemented from itk::LightObject.

◆ IsInsideInObjectSpace()

template<unsigned int TDimension = 3>
bool itk::GaussianSpatialObject< TDimension >::IsInsideInObjectSpace ( const PointType point) const
overridevirtual

Test whether a point is inside or outside the object

Reimplemented from itk::SpatialObject< TDimension >.

◆ New()

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

◆ PrintSelf()

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

Print the object information in a stream.

Reimplemented from itk::DataObject.

◆ SetCenterInObjectSpace()

template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::SetCenterInObjectSpace ( PointType  _arg)
virtual

◆ SetMaximum()

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

◆ SetRadiusInObjectSpace()

template<unsigned int TDimension = 3>
virtual void itk::GaussianSpatialObject< TDimension >::SetRadiusInObjectSpace ( 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.

◆ SetSigmaInObjectSpace()

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

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

◆ SquaredZScoreInObjectSpace()

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

◆ SquaredZScoreInWorldSpace()

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

◆ ValueAtInObjectSpace()

template<unsigned int TDimension = 3>
bool itk::GaussianSpatialObject< TDimension >::ValueAtInObjectSpace ( const PointType point,
double &  value,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
overridevirtual

Returns the value of the Gaussian at the given point.

Reimplemented from itk::SpatialObject< TDimension >.

Member Data Documentation

◆ m_CenterInObjectSpace

template<unsigned int TDimension = 3>
PointType itk::GaussianSpatialObject< TDimension >::m_CenterInObjectSpace
private

Definition at line 141 of file itkGaussianSpatialObject.h.

◆ m_Maximum

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::m_Maximum
private

Definition at line 138 of file itkGaussianSpatialObject.h.

◆ m_RadiusInObjectSpace

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::m_RadiusInObjectSpace
private

Definition at line 139 of file itkGaussianSpatialObject.h.

◆ m_SigmaInObjectSpace

template<unsigned int TDimension = 3>
ScalarType itk::GaussianSpatialObject< TDimension >::m_SigmaInObjectSpace
private

Definition at line 140 of file itkGaussianSpatialObject.h.

◆ ObjectDimensions

template<unsigned int TDimension = 3>
constexpr unsigned int itk::GaussianSpatialObject< TDimension >::ObjectDimensions = TDimension
staticconstexpr

Definition at line 59 of file itkGaussianSpatialObject.h.


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