itk::PlaneSpatialObject< TDimension > Class Template Reference

#include <itkPlaneSpatialObject.h>

Inheritance diagram for itk::PlaneSpatialObject< TDimension >:

Collaboration diagram for itk::PlaneSpatialObject< TDimension >:

List of all members.

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer < PointContainerType >	PointContainerPointer
typedef VectorContainer < IdentifierType, PointType >	PointContainerType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	ScalarType
typedef PlaneSpatialObject	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 ChildrenListType *	ChildrenListPointer
typedef std::list< Pointer >	ChildrenListType
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 PointType *	PointPointer
typedef PropertyType::Pointer	PropertyPointer
typedef SpatialObjectProperty < float >	PropertyType
typedef ImageRegion< VDimension >	RegionType
typedef Size< VDimension >	SizeType
typedef double *	SpacingType
typedef const TransformType *	TransformConstPointer
typedef TransformType::Pointer	TransformPointer
typedef SpatialObjectTreeNode < VDimension >	TreeNodeType
typedef VectorContainer < IdentifierType, PointType >	VectorContainerType
typedef VectorType *	VectorPointer
typedef Vector< ScalarType, VDimension >	VectorType
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual bool	ComputeLocalBoundingBox () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual PointType	GetLowerPoint ()
virtual const char *	GetNameOfClass () const
virtual PointType	GetUpperPoint ()
virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool	IsInside (const PointType &point, unsigned int depth, char *name) const
virtual bool	IsInside (const PointType &point) const
virtual void	SetLowerPoint (PointType _arg)
virtual void	SetUpperPoint (PointType _arg)
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
Public Member Functions inherited from itk::SpatialObject< TDimension >
void	AddSpatialObject (Self *pointer)
virtual void	Clear (void)
virtual bool	ComputeBoundingBox () const
void	ComputeObjectToParentTransform (void)
void	ComputeObjectToWorldTransform (void)
virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
bool	Evaluate (const PointType &point) const
virtual BoundingBoxType *	GetBoundingBox () const
virtual const RegionType &	GetBufferedRegion () const
virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=NULL) const
TransformType *	GetIndexToObjectTransform (void)
const TransformType *	GetIndexToObjectTransform (void) const
virtual TransformType *	GetIndexToWorldTransform ()
virtual const TransformType *	GetIndexToWorldTransform ()
virtual const RegionType &	GetLargestPossibleRegion () const
unsigned int	GetMaximumDepth () const
unsigned long	GetMTime (void) const
TransformType *	GetNodeToParentNodeTransform (void)
const TransformType *	GetNodeToParentNodeTransform (void) const
unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned int	GetObjectDimension (void) const
unsigned long	GetObjectMTime (void) const
TransformType *	GetObjectToNodeTransform (void)
const TransformType *	GetObjectToNodeTransform (void) const
TransformType *	GetObjectToParentTransform (void)
const TransformType *	GetObjectToParentTransform (void) const
virtual TransformType *	GetObjectToWorldTransform ()
virtual const TransformType *	GetObjectToWorldTransform ()
virtual const Self *	GetParent (void) const
virtual Self *	GetParent (void)
virtual const RegionType &	GetRequestedRegion () const
virtual const double *	GetSpacing () const
virtual std::string	GetSpatialObjectTypeAsString () const
unsigned long	GetTransformMTime (void)
virtual const char *	GetTypeName (void) const
unsigned long	GetWorldTransformMTime (void)
virtual bool	HasParent (void) const
virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) 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	SetObjectToWorldTransform (TransformType *transform)
void	SetParent (Self *parent)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const DataObject *data)
void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void	SetTreeNode (TreeNodeType *_arg)
virtual void	Update (void)
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
virtual const AffineGeometryFrameType *	GetAffineGeometryFrame ()
virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
const OffsetValueType *	GetOffsetTable () const
OffsetValueType	ComputeOffset (const IndexType &ind) const
IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	CopyInformation (const DataObject *data)
virtual void	UpdateOutputInformation ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool	VerifyRequestedRegion ()
PropertyType *	GetProperty (void)
const PropertyType *	GetProperty (void) const
void	SetProperty (PropertyType *property)
virtual const int &	GetId ()
virtual void	SetId (int _arg)
virtual void	SetParentId (int _arg)
virtual const int &	GetParentId ()
virtual TreeNodeType *	GetTreeNode ()
virtual const TreeNodeType *	GetTreeNode ()
virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual const unsigned int &	GetBoundingBoxChildrenDepth ()
virtual void	SetBoundingBoxChildrenName (std::string _arg)
virtual const std::string &	GetBoundingBoxChildrenName ()
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 ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
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 (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
virtual void	Graft (const DataObject *)
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) 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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 Attributes
static const unsigned int	NumberOfDimension = TDimension
Static Public Attributes inherited from itk::SpatialObject< TDimension >
static const unsigned int	MaximumDepth
static const unsigned int	ObjectDimension

Protected Member Functions
void	operator= (const Self &)
	PlaneSpatialObject (const Self &)
	PlaneSpatialObject (void)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	~PlaneSpatialObject (void)
Protected Member Functions inherited from itk::SpatialObject< TDimension >
void	ComputeOffsetTable ()
virtual const BoundingBoxType *	GetBounds ()
virtual const unsigned int &	GetDimension ()
virtual const TransformType *	GetInternalInverseTransform ()
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
virtual void	PropagateResetPipeline ()
	DataObject ()
	~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
PointType	m_LowerPoint
PointType	m_UpperPoint

---

Detailed Description

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

A plane spatial object is defined by two points

Wiki Examples:

• All Examples

• Plane spatial object

Definition at line 37 of file itkPlaneSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3>

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 53 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 46 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Definition at line 52 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Definition at line 51 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 45 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 49 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 44 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

typedef PlaneSpatialObject itk::PlaneSpatialObject< TDimension >::Self

Standard typedefs

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 43 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SpatialObject< TDimension > itk::PlaneSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 47 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< Superclass > itk::PlaneSpatialObject< TDimension >::SuperclassPointer

Definition at line 48 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 50 of file itkPlaneSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

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

protected

template<unsigned int TDimension = 3>

itk::PlaneSpatialObject< TDimension >::PlaneSpatialObject ( void  )

protected

template<unsigned int TDimension = 3>

itk::PlaneSpatialObject< TDimension >::~PlaneSpatialObject ( void  )

protected

---

Member Function Documentation

template<unsigned int TDimension = 3>

virtual bool itk::PlaneSpatialObject< TDimension >::ComputeLocalBoundingBox ( ) const

virtual

provide a method to get the boundaries of a specific object. Basically, this function need to be called every time one of the object component is changed.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::PlaneSpatialObject< TDimension >::CreateAnother ( void  ) 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::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual PointType itk::PlaneSpatialObject< TDimension >::GetLowerPoint ( )

virtual

template<unsigned int TDimension = 3>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual PointType itk::PlaneSpatialObject< TDimension >::GetUpperPoint ( )

virtual

template<unsigned int TDimension = 3>

virtual bool itk::PlaneSpatialObject< TDimension >::IsEvaluableAt ( const PointType &  point, unsigned int  depth = 0, char *  name = NULL  ) const

virtual

return ture if the object provides a method to evaluate the value at the specified point, else otherwise.

template<unsigned int TDimension = 3>

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

virtual

Test whether a point is inside or outside the object

template<unsigned int TDimension = 3>

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

static

Method for creation through the object factory.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

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

protected

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

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

protectedvirtual

Print the object informations in a stream.

Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::PlaneSpatialObject< TDimension >::SetLowerPoint ( PointType  _arg )

virtual

template<unsigned int TDimension = 3>

virtual void itk::PlaneSpatialObject< TDimension >::SetUpperPoint ( PointType  _arg )

virtual

template<unsigned int TDimension = 3>

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

virtual

Returns a degree of membership to the object. That's useful for fuzzy objects.

---

Member Data Documentation

template<unsigned int TDimension = 3>

PointType itk::PlaneSpatialObject< TDimension >::m_LowerPoint

protected

Definition at line 96 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

PointType itk::PlaneSpatialObject< TDimension >::m_UpperPoint

protected

Definition at line 97 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3>

const unsigned int itk::PlaneSpatialObject< TDimension >::NumberOfDimension = TDimension

static

Definition at line 56 of file itkPlaneSpatialObject.h.

---

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

• itkPlaneSpatialObject.h