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 Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef double	ScalarType

typedef GaussianSpatialObject	Self

typedef SpatialObject< TDimension >	Superclass

typedef SmartPointer< Superclass >	SuperclassPointer

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 ChildrenListType *	ChildrenListPointer

typedef std::list< Pointer >	ChildrenListType

typedef SmartPointer< const Self >	ConstPointer

typedef CovariantVector < ScalarType, VDimension >	CovariantVectorType

typedef Index< VDimension >	IndexType

typedef Point< ScalarType, VDimension >	InputType

typedef Offset< VDimension >	OffsetType

typedef OutputVectorType *	OutputVectorPointer

typedef CovariantVector < double, VDimension >	OutputVectorType

typedef SmartPointer< Self >	Pointer

typedef PointType *	PointPointer

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 TransformType *	TransformConstPointer

typedef TransformType::Pointer	TransformPointer

typedef ScalableAffineTransform < double, VDimension >	TransformType

typedef SpatialObjectTreeNode < VDimension >	TreeNodeType

typedef VectorContainer < IdentifierType, PointType >	VectorContainerType

typedef VectorType *	VectorPointer

typedef Vector< ScalarType, VDimension >	VectorType

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


virtual void	SetSigma (ScalarType _arg)

virtual const ScalarType &	GetSigma () const


virtual void	SetMaximum (ScalarType _arg)

virtual const ScalarType &	GetMaximum () 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 BoundingBoxType *	GetBoundingBox () const

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=nullptr) const

const TransformType *	GetIndexToObjectTransform () const

TransformType *	GetIndexToObjectTransform (void)

virtual const TransformType *	GetIndexToWorldTransform () const

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth () const

TransformType *	GetModifiableIndexToObjectTransform (void)

virtual TransformType *	GetModifiableIndexToWorldTransform ()

virtual TreeNodeType *	GetModifiableTreeNode ()

virtual ModifiedTimeType	GetMTime (void) const override

TransformType *	GetNodeToParentNodeTransform ()

const TransformType *	GetNodeToParentNodeTransform () const

unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=nullptr) const

unsigned int	GetObjectDimension (void) const

ModifiedTimeType	GetObjectMTime (void) const

TransformType *	GetObjectToNodeTransform ()

const TransformType *	GetObjectToNodeTransform () const

TransformType *	GetObjectToParentTransform ()

const TransformType *	GetObjectToParentTransform () const

virtual const Self *	GetParent () const

virtual Self *	GetParent ()

virtual const RegionType &	GetRequestedRegion () const

virtual const double *	GetSpacing () const

virtual std::string	GetSpatialObjectTypeAsString () const

ModifiedTimeType	GetTransformMTime ()

virtual const TreeNodeType *	GetTreeNode () const

virtual const char *	GetTypeName (void) const

ModifiedTimeType	GetWorldTransformMTime ()

virtual bool	HasParent () 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 void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)

virtual AffineGeometryFrameType *	GetModifiableAffineGeometryFrame ()

virtual const AffineGeometryFrameType *	GetAffineGeometryFrame () const

void	SetObjectToWorldTransform (TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const OffsetValueType *	GetOffsetTable () 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

PropertyType *	GetProperty ()

const PropertyType *	GetProperty (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

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::SpatialObject< TDimension >
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 ()

Protected Member Functions inherited from itk::SpatialObject< TDimension >
void	ComputeOffsetTable ()

virtual const BoundingBoxType *	GetBounds () const

virtual const unsigned int &	GetDimension () const

virtual const TransformType *	GetInternalInverseTransform () const

virtual BoundingBoxType *	GetModifiableBounds ()

virtual TransformType *	GetModifiableInternalInverseTransform ()

virtual void	SetDimension (unsigned int _arg)

bool	SetInternalInverseTransformToWorldToIndexTransform () const

virtual void	SetTypeName (std::string _arg)

	SpatialObject ()

virtual	~SpatialObject ()

Protected Attributes
ScalarType	m_Maximum

ScalarType	m_Radius

ScalarType	m_Sigma