#include <itkSurfaceSpatialObject.h>

Inheritance diagram for itk::SurfaceSpatialObject< TDimension >:

Collaboration diagram for itk::SurfaceSpatialObject< TDimension >:

Detailed Description

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

Representation of a Surface based on the spatial object classes.

The Surface is basically defined by a set of points.

See Also: SurfaceSpatialObjectPoint

Examples:: Examples/SpatialObjects/SurfaceSpatialObject.cxx.

Definition at line 39 of file itkSurfaceSpatialObject.h.

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::CovariantVectorType	CovariantVectorType

typedef SmartPointer < PointContainerType >	PointContainerPointer

typedef VectorContainer < IdentifierType, PointType >	PointContainerType

typedef SmartPointer< Self >	Pointer

typedef std::vector < SurfacePointType >	PointListType

typedef Superclass::PointType	PointType

typedef double	ScalarType

typedef SurfaceSpatialObject	Self

typedef Superclass::SpatialObjectPointType	SpatialObjectPointType

typedef PointBasedSpatialObject < TDimension >	Superclass

typedef SurfaceSpatialObjectPoint < TDimension >	SurfacePointType

typedef Superclass::TransformType	TransformType

Public Types inherited from itk::PointBasedSpatialObject< TDimension >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::CovariantVectorType	CovariantVectorType

typedef SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef double	ScalarType

typedef PointBasedSpatialObject	Self

typedef SpatialObjectPoint < TDimension >	SpatialObjectPointType

typedef SpatialObject< TDimension >	Superclass

typedef Superclass::TransformType	TransformType

typedef Superclass::VectorType	VectorType

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 Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
bool	Approximate3DNormals ()

bool	ComputeLocalBoundingBox () const override

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

virtual const char *	GetNameOfClass () const

SizeValueType	GetNumberOfPoints (void) const override

const SpatialObjectPointType *	GetPoint (IdentifierType id) const override

SpatialObjectPointType *	GetPoint (IdentifierType id) override

bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const override

bool	IsInside (const PointType &point, unsigned int depth, char *name) const override

virtual bool	IsInside (const PointType &point) const

void	SetPoints (PointListType &newPoints)

bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const override


PointListType &	GetPoints ()

const PointListType &	GetPoints () const

Public Member Functions inherited from itk::PointBasedSpatialObject< TDimension >
virtual SpatialObjectPointType *	itkWarningMacro (<< "PointBasedSpatialObject::GetPoint() is not implemented"<< " in the base class"<< std::endl)

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

unsigned long	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

unsigned long	GetTransformMTime ()

virtual const TreeNodeType *	GetTreeNode () const

virtual const char *	GetTypeName (void) const

unsigned long	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 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

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

unsigned long	AddObserver (const EventObject &event, Command *) 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

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::PointBasedSpatialObject< TDimension >
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 ()

Protected Member Functions
void	operator= (const Self &) ITK_DELETE_FUNCTION

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

	SurfaceSpatialObject (const Self &) ITK_DELETE_FUNCTION

	SurfaceSpatialObject ()

virtual	~SurfaceSpatialObject ()

Protected Member Functions inherited from itk::PointBasedSpatialObject< TDimension >
void	operator= (const Self &) ITK_DELETE_FUNCTION

	PointBasedSpatialObject (const Self &) ITK_DELETE_FUNCTION

	PointBasedSpatialObject ()

virtual	~PointBasedSpatialObject ()

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 Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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
PointListType	m_Points

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Additional Inherited Members
Public Attributes inherited from itk::PointBasedSpatialObject< TDimension >
return	nullptr

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

static const unsigned int	ObjectDimension

Member Typedef Documentation

template<unsigned int TDimension = 3>

typedef Superclass::BoundingBoxType itk::SurfaceSpatialObject< TDimension >::BoundingBoxType

Definition at line 56 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< const Self > itk::SurfaceSpatialObject< TDimension >::ConstPointer

Definition at line 47 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::CovariantVectorType itk::SurfaceSpatialObject< TDimension >::CovariantVectorType

Definition at line 57 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< PointContainerType > itk::SurfaceSpatialObject< TDimension >::PointContainerPointer

Definition at line 55 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef VectorContainer< IdentifierType, PointType > itk::SurfaceSpatialObject< TDimension >::PointContainerType

Definition at line 54 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< Self > itk::SurfaceSpatialObject< TDimension >::Pointer

Definition at line 46 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef std::vector< SurfacePointType > itk::SurfaceSpatialObject< TDimension >::PointListType

Definition at line 50 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::PointType itk::SurfaceSpatialObject< TDimension >::PointType

Definition at line 52 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef double itk::SurfaceSpatialObject< TDimension >::ScalarType

Definition at line 48 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SurfaceSpatialObject itk::SurfaceSpatialObject< TDimension >::Self

Definition at line 44 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::SpatialObjectPointType itk::SurfaceSpatialObject< TDimension >::SpatialObjectPointType

Definition at line 51 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef PointBasedSpatialObject< TDimension > itk::SurfaceSpatialObject< TDimension >::Superclass

Definition at line 45 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SurfaceSpatialObjectPoint< TDimension > itk::SurfaceSpatialObject< TDimension >::SurfacePointType

Definition at line 49 of file itkSurfaceSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::TransformType itk::SurfaceSpatialObject< TDimension >::TransformType

Definition at line 53 of file itkSurfaceSpatialObject.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

itk::SurfaceSpatialObject< TDimension >::SurfaceSpatialObject ( const Self & )

protected

template<unsigned int TDimension = 3>

itk::SurfaceSpatialObject< TDimension >::SurfaceSpatialObject ( )

protected

template<unsigned int TDimension = 3>

virtual itk::SurfaceSpatialObject< TDimension >::~SurfaceSpatialObject ( )

protectedvirtual

Member Function Documentation

template<unsigned int TDimension = 3>

bool itk::SurfaceSpatialObject< TDimension >::Approximate3DNormals ( )

Compute the normals to the surface from neighboring points

template<unsigned int TDimension = 3>

bool itk::SurfaceSpatialObject< TDimension >::ComputeLocalBoundingBox ( ) const

overridevirtual

Compute the boundaries of the Surface.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::SurfaceSpatialObject< 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::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual const char* itk::SurfaceSpatialObject< TDimension >::GetNameOfClass ( ) const

virtual

Method for creation through the object factory.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

SizeValueType itk::SurfaceSpatialObject< TDimension >::GetNumberOfPoints ( void ) const

inlineoverridevirtual

Return the number of points in the list

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 80 of file itkSurfaceSpatialObject.h.

References itk::SurfaceSpatialObject< TDimension >::m_Points.

template<unsigned int TDimension = 3>

const SpatialObjectPointType* itk::SurfaceSpatialObject< TDimension >::GetPoint ( IdentifierType id ) const

inlineoverridevirtual

Return a point in the list given the index

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 71 of file itkSurfaceSpatialObject.h.

References itk::SurfaceSpatialObject< TDimension >::m_Points.

template<unsigned int TDimension = 3>

SpatialObjectPointType* itk::SurfaceSpatialObject< TDimension >::GetPoint ( IdentifierType id )

inlineoverride

Return a point in the list given the index

Definition at line 77 of file itkSurfaceSpatialObject.h.

References itk::SurfaceSpatialObject< TDimension >::m_Points.

template<unsigned int TDimension = 3>

PointListType& itk::SurfaceSpatialObject< TDimension >::GetPoints ( )

Returns a reference to the list of the Surface points.

template<unsigned int TDimension = 3>

const PointListType& itk::SurfaceSpatialObject< TDimension >::GetPoints ( ) const

Returns a reference to the list of the Surface points.

template<unsigned int TDimension = 3>

bool itk::SurfaceSpatialObject< TDimension >::IsEvaluableAt	(	const PointType &	point,
		unsigned int	depth = `0`,
		char *	name = `nullptr`
	)		const

override

Returns true if the Surface is evaluable at the requested point, false otherwise.

template<unsigned int TDimension = 3>

bool itk::SurfaceSpatialObject< TDimension >::IsInside	(	const PointType &	point,
		unsigned int	depth,
		char *	name
	)		const

override

Returns true if the point is inside the Surface, false otherwise.

template<unsigned int TDimension = 3>

virtual bool itk::SurfaceSpatialObject< 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::SurfaceSpatialObject< TDimension >::New ( )

static

Method for creation through the object factory.

template<unsigned int TDimension = 3>

void itk::SurfaceSpatialObject< TDimension >::operator= ( const Self & )

protected

template<unsigned int TDimension = 3>

virtual void itk::SurfaceSpatialObject< TDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Method to print the object.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

void itk::SurfaceSpatialObject< TDimension >::SetPoints ( PointListType & newPoints )

Set the list of Surface points.

template<unsigned int TDimension = 3>

bool itk::SurfaceSpatialObject< TDimension >::ValueAt	(	const PointType &	point,
		double &	value,
		unsigned int	depth = `0`,
		char *	name = `nullptr`
	)		const

override

Returns the value of the Surface at that point. Currently this function returns a binary value, but it might want to return a degree of membership in case of fuzzy Surfaces.