itk::BoxSpatialObject< TDimension > Class Template Reference

The class may be used to represent N-dimensional boxes. In two dimensions it is a rectangle, In three dimensions it is a cuboid... More...

#include <itkBoxSpatialObject.h>

Inheritance diagram for itk::BoxSpatialObject< TDimension >:

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

[legend]List of all members.

Public Types
typedef BoxSpatialObject	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 Superclass::BoundingBoxType	BoundingBoxType
typedef FixedArray< double, TDimension >	SizeType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
Public Member Functions
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	SetSize (SizeType _arg)
virtual const SizeType &	GetSize ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	BoxSpatialObject (void)
	~BoxSpatialObject (void)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
SizeType	m_Size

---

Detailed Description

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

The class may be used to represent N-dimensional boxes. In two dimensions it is a rectangle, In three dimensions it is a cuboid...

Definition at line 37 of file itkBoxSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3> typedef Superclass::BoundingBoxType itk::BoxSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 51 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3> typedef SmartPointer< const Self > itk::BoxSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 46 of file itkBoxSpatialObject.h.

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

Definition at line 53 of file itkBoxSpatialObject.h.

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

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

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 49 of file itkBoxSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 44 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3> typedef BoxSpatialObject itk::BoxSpatialObject< TDimension >::Self

Standard class typedefs. Reimplemented from itk::SpatialObject< TDimension >. Definition at line 43 of file itkBoxSpatialObject.h.

template<unsigned int TDimension = 3> typedef FixedArray<double,TDimension> itk::BoxSpatialObject< TDimension >::SizeType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 52 of file itkBoxSpatialObject.h.

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

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

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

Definition at line 48 of file itkBoxSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 50 of file itkBoxSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3> itk::BoxSpatialObject< TDimension >::BoxSpatialObject (  void   )  [protected]

template<unsigned int TDimension = 3> itk::BoxSpatialObject< TDimension >::~BoxSpatialObject (  void   )  [protected]

---

Member Function Documentation

template<unsigned int TDimension = 3> virtual bool itk::BoxSpatialObject< TDimension >::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< TDimension >.

template<unsigned int TDimension = 3> virtual const char* itk::BoxSpatialObject< TDimension >::GetNameOfClass (   )  const [virtual]

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

template<unsigned int TDimension = 3> virtual const SizeType& itk::BoxSpatialObject< TDimension >::GetSize (   )  [virtual]

Set/Get the size of the box spatial object.

template<unsigned int TDimension = 3> virtual bool itk::BoxSpatialObject< TDimension >::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< TDimension >.

template<unsigned int TDimension = 3> virtual bool itk::BoxSpatialObject< 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::BoxSpatialObject< TDimension >::IsInside (  const PointType &  point, unsigned int  depth, char *  )  const [virtual]

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

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

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

template<unsigned int TDimension = 3> virtual void itk::BoxSpatialObject< 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::BoxSpatialObject< TDimension >::SetSize (  SizeType  _arg  )  [virtual]

Set/Get the size of the box spatial object.

template<unsigned int TDimension = 3> virtual bool itk::BoxSpatialObject< 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> SizeType itk::BoxSpatialObject< TDimension >::m_Size [protected]

Definition at line 95 of file itkBoxSpatialObject.h.

---

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

• itkBoxSpatialObject.h

---