itk::SlicerBoxSpatialObject< 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 <itkSlicerBoxSpatialObject.h>

Inheritance diagram for itk::SlicerBoxSpatialObject< TDimension >:
SpatialObject

List of all members.

Public Types

typedef Superclass::BoundingBoxType BoundingBoxType
typedef SmartPointer< const SelfConstPointer
typedef VectorContainer
< unsigned long, PointType
PointContainerType
typedef SmartPointer< SelfPointer
typedef Superclass::PointType PointType
typedef double ScalarType
typedef SlicerBoxSpatialObject Self
typedef FixedArray< double,
TDimension > 
SizeType
typedef SpatialObject< TDimension > Superclass
typedef SmartPointer< SuperclassSuperclassPointer
typedef Superclass::TransformType TransformType

Public Member Functions

virtual bool ComputeLocalBoundingBox () const
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool IsInside (const PointType &point) const
virtual bool IsInside (const PointType &point, unsigned int depth, char *) const
 itkGetConstReferenceMacro (Size, SizeType)
 itkNewMacro (Self)
 itkSetMacro (Size, SizeType)
 itkTypeMacro (SlicerBoxSpatialObject, SpatialObject)
virtual bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const

Protected Member Functions

void operator= (const Self &)
virtual void PrintSelf (std::ostream &os, Indent indent) const
 SlicerBoxSpatialObject (void)
 SlicerBoxSpatialObject (const Self &)
 ~SlicerBoxSpatialObject (void)

Protected Attributes

SizeType m_Size

Detailed Description

template<unsigned int TDimension = 3>
class itk::SlicerBoxSpatialObject< 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...

This is a locally modified version itk::BoxSpatialObject TODO: This should be removed when the version after ITK 3.18 is released


Member Typedef Documentation

template<unsigned int TDimension = 3>
typedef Superclass::BoundingBoxType itk::SlicerBoxSpatialObject< TDimension >::BoundingBoxType
template<unsigned int TDimension = 3>
typedef SmartPointer< const Self > itk::SlicerBoxSpatialObject< TDimension >::ConstPointer
template<unsigned int TDimension = 3>
typedef VectorContainer<unsigned long,PointType> itk::SlicerBoxSpatialObject< TDimension >::PointContainerType
template<unsigned int TDimension = 3>
typedef SmartPointer< Self > itk::SlicerBoxSpatialObject< TDimension >::Pointer
template<unsigned int TDimension = 3>
typedef Superclass::PointType itk::SlicerBoxSpatialObject< TDimension >::PointType
template<unsigned int TDimension = 3>
typedef double itk::SlicerBoxSpatialObject< TDimension >::ScalarType
template<unsigned int TDimension = 3>
typedef SlicerBoxSpatialObject itk::SlicerBoxSpatialObject< TDimension >::Self
template<unsigned int TDimension = 3>
typedef FixedArray<double,TDimension> itk::SlicerBoxSpatialObject< TDimension >::SizeType
template<unsigned int TDimension = 3>
typedef SpatialObject< TDimension > itk::SlicerBoxSpatialObject< TDimension >::Superclass
template<unsigned int TDimension = 3>
typedef SmartPointer<Superclass> itk::SlicerBoxSpatialObject< TDimension >::SuperclassPointer
template<unsigned int TDimension = 3>
typedef Superclass::TransformType itk::SlicerBoxSpatialObject< TDimension >::TransformType

Constructor & Destructor Documentation

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

Member Function Documentation

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

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

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

Test whether a point is inside or outside the object

Referenced by ConvertSlicerROIToRegionTest().

template<unsigned int TDimension = 3>
itk::SlicerBoxSpatialObject< TDimension >::itkGetConstReferenceMacro ( Size  ,
SizeType   
)
template<unsigned int TDimension = 3>
itk::SlicerBoxSpatialObject< TDimension >::itkNewMacro ( Self   ) 
template<unsigned int TDimension = 3>
itk::SlicerBoxSpatialObject< TDimension >::itkSetMacro ( Size  ,
SizeType   
)

Set/Get the size of the box spatial object.

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

Print the object informations in a stream.

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

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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1