itk::CylinderSpatialObject Class Reference

This class describe a cylinder in 3D only. More...

#include <itkCylinderSpatialObject.h>

Inheritance diagram for itk::CylinderSpatialObject:

[legend]Collaboration diagram for itk::CylinderSpatialObject:

[legend]List of all members.

Public Types
typedef CylinderSpatialObject	Self
typedef double	ScalarType
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef SpatialObject< 3 >	Superclass
typedef SmartPointer< Superclass >	SuperclassPointer
typedef Superclass::PointType	PointType
typedef Superclass::TransformType	TransformType
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
typedef SmartPointer< PointContainerType >	PointContainerPointer
Public Member Functions
	itkStaticConstMacro (NumberOfDimension, unsigned int, 3)
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 *) const
virtual bool	IsInside (const PointType &point) const
virtual bool	ComputeLocalBoundingBox () const
virtual void	SetRadius (double _arg)
virtual const double &	GetRadius ()
virtual void	SetHeight (double _arg)
virtual const double &	GetHeight ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	CylinderSpatialObject (void)
	~CylinderSpatialObject (void)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
double	m_Radius
double	m_Height

---

Detailed Description

This class describe a cylinder in 3D only.

Definition at line 32 of file itkCylinderSpatialObject.h.

---

Member Typedef Documentation

typedef Superclass::BoundingBoxType itk::CylinderSpatialObject::BoundingBoxType

Reimplemented from itk::SpatialObject< 3 >. Definition at line 46 of file itkCylinderSpatialObject.h.

typedef SmartPointer< const Self > itk::CylinderSpatialObject::ConstPointer

Reimplemented from itk::SpatialObject< 3 >. Definition at line 41 of file itkCylinderSpatialObject.h.

typedef SmartPointer<PointContainerType> itk::CylinderSpatialObject::PointContainerPointer

Definition at line 48 of file itkCylinderSpatialObject.h.

typedef VectorContainer<unsigned long,PointType> itk::CylinderSpatialObject::PointContainerType

Definition at line 47 of file itkCylinderSpatialObject.h.

typedef SmartPointer< Self > itk::CylinderSpatialObject::Pointer

Reimplemented from itk::SpatialObject< 3 >. Definition at line 40 of file itkCylinderSpatialObject.h.

typedef Superclass::PointType itk::CylinderSpatialObject::PointType

Reimplemented from itk::SpatialObject< 3 >. Definition at line 44 of file itkCylinderSpatialObject.h.

typedef double itk::CylinderSpatialObject::ScalarType

Reimplemented from itk::SpatialObject< 3 >. Definition at line 39 of file itkCylinderSpatialObject.h.

typedef CylinderSpatialObject itk::CylinderSpatialObject::Self

Standard class typedefs. Reimplemented from itk::SpatialObject< 3 >. Definition at line 38 of file itkCylinderSpatialObject.h.

typedef SpatialObject< 3 > itk::CylinderSpatialObject::Superclass

Reimplemented from itk::SpatialObject< 3 >. Definition at line 42 of file itkCylinderSpatialObject.h.

typedef SmartPointer<Superclass> itk::CylinderSpatialObject::SuperclassPointer

Definition at line 43 of file itkCylinderSpatialObject.h.

typedef Superclass::TransformType itk::CylinderSpatialObject::TransformType

Reimplemented from itk::SpatialObject< 3 >. Definition at line 45 of file itkCylinderSpatialObject.h.

---

Constructor & Destructor Documentation

itk::CylinderSpatialObject::CylinderSpatialObject (  void   )  [protected]

itk::CylinderSpatialObject::~CylinderSpatialObject (  void   )  [protected]

---

Member Function Documentation

virtual bool itk::CylinderSpatialObject::ComputeLocalBoundingBox (   )  const [virtual]

Get the boundaries of a specific object. This function needs to be called every time one of the object's components is changed. Reimplemented from itk::SpatialObject< 3 >.

virtual const double& itk::CylinderSpatialObject::GetHeight (   )  [virtual]

Set/Get the height

virtual const char* itk::CylinderSpatialObject::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::SpatialObject< 3 >.

virtual const double& itk::CylinderSpatialObject::GetRadius (   )  [virtual]

Set/Get the radius

virtual bool itk::CylinderSpatialObject::IsEvaluableAt (  const PointType &  point, unsigned int  depth = 0, char *  name = NULL )  const [virtual]

Return true if the object provides a method to evaluate the value at the specified point, false otherwise. Reimplemented from itk::SpatialObject< 3 >.

virtual bool itk::CylinderSpatialObject::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

virtual bool itk::CylinderSpatialObject::IsInside (  const PointType &  point, unsigned int  depth, char *  )  const [virtual]

Test whether a point is inside or outside the object Reimplemented from itk::SpatialObject< 3 >.

itk::CylinderSpatialObject::itkStaticConstMacro (  NumberOfDimension  , unsigned  int, 3  )

Pointer itk::CylinderSpatialObject::New (  void   )  [static]

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

virtual void itk::CylinderSpatialObject::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Print the object informations in a stream. Reimplemented from itk::SpatialObject< 3 >.

virtual void itk::CylinderSpatialObject::SetHeight (  double  _arg  )  [virtual]

Set/Get the height

virtual void itk::CylinderSpatialObject::SetRadius (  double  _arg  )  [virtual]

Set/Get the radius

virtual bool itk::CylinderSpatialObject::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< 3 >.

---

Member Data Documentation

double itk::CylinderSpatialObject::m_Height [protected]

Definition at line 100 of file itkCylinderSpatialObject.h.

double itk::CylinderSpatialObject::m_Radius [protected]

Definition at line 99 of file itkCylinderSpatialObject.h.

---

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

• itkCylinderSpatialObject.h

---