#include <itkGaussianSpatialObject.h>

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.

Inheritance diagram for itk::GaussianSpatialObject< TDimension >:

Collaboration diagram for itk::GaussianSpatialObject< TDimension >:

Public Types
using	BoundingBoxType

using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	PointType

using	ScalarType = double

using	Self = GaussianSpatialObject

using	Superclass = SpatialObject<TDimension>

using	SuperclassPointer = SmartPointer<Superclass>

using	TransformType

Public Types inherited from itk::SpatialObject< 3 >
using	BoundingBoxPointer

using	BoundingBoxType

using	ChildrenConstListPointer

using	ChildrenConstListType

using	ChildrenListPointer

using	ChildrenListType

using	ConstPointer

using	CovariantVectorType

using	DerivativeOffsetType

using	DerivativeVectorPointer

using	DerivativeVectorType

using	IndexType

using	InputType

using	ObjectConstListType

using	ObjectDimensionType

using	ObjectListType

using	Pointer

using	PointPointer

using	PointType

using	PropertyType

using	RegionType

using	ScalarType

using	Self

using	SizeType

using	Superclass

using	TransformConstPointer

using	TransformPointer

using	TransformType

using	VectorContainerType

using	VectorPointer

using	VectorType

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::itk::LightObject::Pointer	CreateAnother () const

virtual const PointType &	GetCenterInObjectSpace () const

EllipseSpatialObject< TDimension >::Pointer	GetEllipsoid () const

const char *	GetNameOfClass () const override

bool	IsInsideInObjectSpace (const PointType &point) const override

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

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 ScalarType &	GetRadiusInObjectSpace () const


virtual void	SetSigmaInObjectSpace (ScalarType _arg)

virtual const ScalarType &	GetSigmaInObjectSpace () const


virtual void	SetMaximum (ScalarType _arg)

virtual const ScalarType &	GetMaximum () const

Public Member Functions inherited from itk::SpatialObject< 3 >
void	AddChild (Self *pointer)

void	AddChild (Self *pointer)

virtual void	AddChildrenToConstList (ChildrenConstListType *childrenCList, unsigned int depth=0, const std::string &name="") const

virtual void	AddChildrenToConstList (ChildrenConstListType *childrenCList, unsigned int depth=0, const std::string &name="") const

virtual void	AddChildrenToList (ChildrenListType *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

bool	CheckIdValidity () const

virtual bool	ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const

virtual bool	ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const

void	ComputeObjectToParentTransform ()

void	ComputeObjectToParentTransform ()

void	CopyInformation (const DataObject *data) override

void	CopyInformation (const DataObject *data) override

virtual::itk::LightObject::Pointer	CreateAnother () const

virtual::itk::LightObject::Pointer	CreateAnother () const

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	DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

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

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

bool	Evaluate (const PointType &point) const

void	FixIdValidity ()

void	FixIdValidity ()

bool	FixParentChildHierarchyUsingParentIds ()

bool	FixParentChildHierarchyUsingParentIds ()

virtual const RegionType &	GetBufferedRegion () const

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, const std::string &name="") const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, const std::string &name="") const

virtual std::string	GetClassNameAndDimension () const

virtual std::string	GetClassNameAndDimension () const

virtual ChildrenConstListType *	GetConstChildren (unsigned int depth=0, const std::string &name="") const

virtual ChildrenConstListType *	GetConstChildren (unsigned int depth=0, const std::string &name="") const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInWorldSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInWorldSpace () const

virtual const RegionType &	GetLargestPossibleRegion () const

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth () const

unsigned int	GetMaximumDepth () const

ModifiedTimeType	GetMTime () const override

ModifiedTimeType	GetMTime () const override

virtual const BoundingBoxType *	GetMyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInWorldSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInWorldSpace () const

ModifiedTimeType	GetMyMTime () const

ModifiedTimeType	GetMyMTime () const

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

int	GetNextAvailableId () const

int	GetNextAvailableId () const

unsigned int	GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const

unsigned int	GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const

SpatialObject< VDimension > *	GetObjectById (int id)

SpatialObject< VDimension > *	GetObjectById (int id)

unsigned int	GetObjectDimension () const

unsigned int	GetObjectDimension () const

virtual Self *	GetParent ()

virtual Self *	GetParent ()

virtual const Self *	GetParent () const

virtual const Self *	GetParent () const

PropertyType &	GetProperty ()

PropertyType &	GetProperty ()

const PropertyType &	GetProperty () const

const PropertyType &	GetProperty () const

virtual const RegionType &	GetRequestedRegion () const

virtual const RegionType &	GetRequestedRegion () const

virtual std::string	GetTypeName () const

virtual std::string	GetTypeName () const

virtual bool	HasParent () const

virtual bool	HasParent () const

virtual bool	IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") 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	IsEvaluableAtInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

bool	IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

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

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

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInWorldSpace (const PointType &point) const

bool	IsInsideInWorldSpace (const PointType &point) const

bool	IsInsideInWorldSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInWorldSpace (const PointType &point, unsigned int depth, const std::string &name="") const

void	RemoveAllChildren (unsigned int depth=MaximumDepth)

void	RemoveAllChildren (unsigned int depth=MaximumDepth)

bool	RemoveChild (Self *pointer)

bool	RemoveChild (Self *pointer)

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual void	SetBufferedRegion (const RegionType &region)

virtual void	SetBufferedRegion (const RegionType &region)

void	SetChildren (ChildrenListType &children)

void	SetChildren (ChildrenListType &children)

virtual void	SetLargestPossibleRegion (const RegionType &region)

virtual void	SetLargestPossibleRegion (const RegionType &region)

void	SetParent (Self *parent)

void	SetParent (Self *parent)

void	SetRequestedRegion (const DataObject *data) override

void	SetRequestedRegion (const DataObject *data) override

virtual void	SetRequestedRegion (const RegionType &region)

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegionToLargestPossibleRegion () override

void	SetRequestedRegionToLargestPossibleRegion () override

virtual void	SetTypeName (std::string _arg)

virtual void	SetTypeName (std::string _arg)

void	Update () override

void	Update () override

void	UpdateOutputInformation () override

void	UpdateOutputInformation () override

virtual bool	ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

virtual bool	ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	VerifyRequestedRegion () override

bool	VerifyRequestedRegion () override

void	SetId (int id)

virtual const int &	GetId () const

void	SetId (int id)

virtual const int &	GetId () const

void	SetProperty (const PropertyType &property)

void	SetProperty (const PropertyType &property)

void	SetObjectToWorldTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const TransformType *	GetObjectToWorldTransformInverse () const

void	SetObjectToWorldTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const TransformType *	GetObjectToWorldTransformInverse () const

void	SetObjectToParentTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToParentTransform ()

virtual const TransformType *	GetObjectToParentTransform () const

const TransformType *	GetObjectToParentTransformInverse () const

void	SetObjectToParentTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToParentTransform ()

virtual const TransformType *	GetObjectToParentTransform () const

const TransformType *	GetObjectToParentTransformInverse () const

virtual void	SetDefaultInsideValue (double _arg)

virtual double	GetDefaultInsideValue () const

virtual void	SetDefaultInsideValue (double _arg)

virtual double	GetDefaultInsideValue () const

virtual void	SetDefaultOutsideValue (double _arg)

virtual double	GetDefaultOutsideValue () const

virtual void	SetDefaultOutsideValue (double _arg)

virtual double	GetDefaultOutsideValue () const

virtual void	SetParentId (int _arg)

virtual const int &	GetParentId () 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< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () 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	UpdateSource () const

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual const TimeStamp &	GetTimeStamp () 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) const

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< 3 >
static Pointer	New ()

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< 3 >
static constexpr unsigned int	MaximumDepth

static constexpr unsigned int	MaximumDepth

static constexpr ObjectDimensionType	ObjectDimension

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< 3 >
BoundingBoxType *	GetModifiableMyBoundingBoxInObjectSpace ()

BoundingBoxType *	GetModifiableMyBoundingBoxInObjectSpace ()

LightObject::Pointer	InternalClone () const override

LightObject::Pointer	InternalClone () const override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ProtectedComputeObjectToWorldTransform ()

void	ProtectedComputeObjectToWorldTransform ()

	SpatialObject ()=default

	SpatialObject ()=default

	~SpatialObject () override

	~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 {}

Member Typedef Documentation

◆ BoundingBoxType

template<unsigned int TDimension = 3>

using itk::SpatialObject< VDimension >::BoundingBoxType

Definition at line 106 of file itkSpatialObject.h.

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

◆ PointType

template<unsigned int TDimension = 3>

using itk::SpatialObject< VDimension >::PointType

Definition at line 89 of file itkSpatialObject.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.

◆ TransformType

template<unsigned int TDimension = 3>

using itk::SpatialObject< VDimension >::TransformType

Definition at line 100 of file itkSpatialObject.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< 3 >.

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

◆ CreateAnother()

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

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

const char * itk::GaussianSpatialObject< TDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::DataObject.

◆ 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() [1/2]

template<unsigned int TDimension = 3>

bool itk::GaussianSpatialObject< TDimension >::IsInsideInObjectSpace ( const PointType & point ) const

overridevirtual

Test whether a point is inside the object.

For computational speed purposes, it is faster if the method does not check the name of the class and the current depth.

Reimplemented from itk::SpatialObject< 3 >.

◆ IsInsideInObjectSpace() [2/2]

template<unsigned int TDimension = 3>

bool itk::SpatialObject< VDimension >::IsInsideInObjectSpace	(	const PointType &	point,
		unsigned int	depth,
		const std::string &	name = "" ) const

Returns true if a point is inside the object or its children in object space.

◆ 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

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

Compute the z-score in object space.

The z-score is the root mean square of the z-scores along each principal axis.

◆ SquaredZScoreInWorldSpace()

template<unsigned int TDimension = 3>

ScalarType itk::GaussianSpatialObject< TDimension >::SquaredZScoreInWorldSpace ( const PointType & point ) const

Compute the z-score in world space.

The z-score is the root mean square of the z-scores along each principal axis.

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

Member Data Documentation

◆ m_CenterInObjectSpace

template<unsigned int TDimension = 3>

PointType itk::GaussianSpatialObject< TDimension >::m_CenterInObjectSpace {}

private

Definition at line 158 of file itkGaussianSpatialObject.h.

◆ m_Maximum

template<unsigned int TDimension = 3>

ScalarType itk::GaussianSpatialObject< TDimension >::m_Maximum {}

private

Definition at line 155 of file itkGaussianSpatialObject.h.

◆ m_RadiusInObjectSpace

template<unsigned int TDimension = 3>

ScalarType itk::GaussianSpatialObject< TDimension >::m_RadiusInObjectSpace {}

private

Definition at line 156 of file itkGaussianSpatialObject.h.

◆ m_SigmaInObjectSpace

template<unsigned int TDimension = 3>

ScalarType itk::GaussianSpatialObject< TDimension >::m_SigmaInObjectSpace {}

private

Definition at line 157 of file itkGaussianSpatialObject.h.

◆ ObjectDimensions

template<unsigned int TDimension = 3>

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:

itkGaussianSpatialObject.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BoundingBoxType

◆ ConstPointer

◆ Pointer

◆ PointType

◆ ScalarType

◆ Self

◆ Superclass

◆ SuperclassPointer

◆ TransformType

Constructor & Destructor Documentation

◆ GaussianSpatialObject()

◆ ~GaussianSpatialObject()

Member Function Documentation

◆ Clear()

◆ ComputeMyBoundingBox()

◆ CreateAnother()

◆ GetCenterInObjectSpace()

◆ GetEllipsoid()

◆ GetMaximum()

◆ GetNameOfClass()

◆ GetRadiusInObjectSpace()

◆ GetSigmaInObjectSpace()

◆ InternalClone()

◆ IsInsideInObjectSpace() [1/2]

◆ IsInsideInObjectSpace() [2/2]

◆ New()

◆ PrintSelf()

◆ SetCenterInObjectSpace()

◆ SetMaximum()

◆ SetRadiusInObjectSpace()

◆ SetSigmaInObjectSpace()

◆ SquaredZScoreInObjectSpace()

◆ SquaredZScoreInWorldSpace()

◆ ValueAtInObjectSpace()

Member Data Documentation

◆ m_CenterInObjectSpace

◆ m_Maximum

◆ m_RadiusInObjectSpace

◆ m_SigmaInObjectSpace

◆ ObjectDimensions