itk::PlaneSpatialObject< TDimension > Class Template Reference

#include <itkPlaneSpatialObject.h>

Inheritance diagram for itk::PlaneSpatialObject< TDimension >:

[legend]Collaboration diagram for itk::PlaneSpatialObject< TDimension >:

[legend]List of all members.

Public Types
typedef PlaneSpatialObject	Self
typedef double	ScalarType
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef SpatialObject< TDimension >	Superclass
typedef SmartPointer< Superclass >	SuperclassPointer
typedef Superclass::PointType	PointType
typedef Superclass::TransformType	TransformType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
typedef SmartPointer< PointContainerType >	PointContainerPointer
typedef Superclass::BoundingBoxType	BoundingBoxType
Public Member Functions
	itkStaticConstMacro (NumberOfDimension, unsigned int, TDimension)
virtual const char *	GetNameOfClass () const
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
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 bool	ComputeLocalBoundingBox () const
virtual void	SetLowerPoint (PointType _arg)
virtual void	SetUpperPoint (PointType _arg)
virtual PointType	GetLowerPoint ()
virtual PointType	GetUpperPoint ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	PlaneSpatialObject (void)
	~PlaneSpatialObject (void)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
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

Definition at line 34 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 51 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 44 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef SmartPointer<PointContainerType> itk::PlaneSpatialObject< TDimension >::PointContainerPointer

Definition at line 50 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef VectorContainer<unsigned long,PointType> itk::PlaneSpatialObject< TDimension >::PointContainerType

Definition at line 49 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef SmartPointer< Self > itk::PlaneSpatialObject< TDimension >::Pointer

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 43 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef Superclass::PointType itk::PlaneSpatialObject< TDimension >::PointType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 47 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef double itk::PlaneSpatialObject< TDimension >::ScalarType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 42 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 41 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef SpatialObject< TDimension > itk::PlaneSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 45 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef SmartPointer<Superclass> itk::PlaneSpatialObject< TDimension >::SuperclassPointer

Definition at line 46 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> typedef Superclass::TransformType itk::PlaneSpatialObject< TDimension >::TransformType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 48 of file itkPlaneSpatialObject.h.

---

Constructor & Destructor Documentation

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 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. Reimplemented from itk::SpatialObject< TDimension >.

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> 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 Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> itk::PlaneSpatialObject< TDimension >::itkStaticConstMacro (  NumberOfDimension  , unsigned  int, TDimension  )

template<unsigned int TDimension = 3> Pointer itk::PlaneSpatialObject< TDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual void itk::PlaneSpatialObject< TDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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. Reimplemented from itk::SpatialObject< TDimension >.

---

Member Data Documentation

template<unsigned int TDimension = 3> PointType itk::PlaneSpatialObject< TDimension >::m_LowerPoint [protected]

Definition at line 94 of file itkPlaneSpatialObject.h.

template<unsigned int TDimension = 3> PointType itk::PlaneSpatialObject< TDimension >::m_UpperPoint [protected]

Definition at line 95 of file itkPlaneSpatialObject.h.

---

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

• itkPlaneSpatialObject.h

---