Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer > Class Template Reference
[Data Representation Objects, Image Representation Objects]

Represent and compute information about bounding boxes. More...

#include <itkBoundingBox.h>

Inheritance diagram for itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >:

[legend]Collaboration diagram for itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >:

[legend]List of all members.


Public Types
typedef BoundingBox	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TPointIdentifier	PointIdentifier
typedef TCoordRep	CoordRepType
typedef TPointsContainer	PointsContainer
typedef PointsContainer::Pointer	PointsContainerPointer
typedef PointsContainer::ConstPointer	PointsContainerConstPointer
typedef Point< CoordRepType, VPointDimension >	PointType
typedef FixedArray< CoordRepType, VPointDimension *2 >	BoundsArrayType
typedef PointsContainer::ConstIterator	PointsContainerConstIterator
typedef PointsContainer::Iterator	PointsContainerIterator
typedef NumericTraits< CoordRepType >::AccumulateType	AccumulateType
Public Member Functions
	itkStaticConstMacro (PointDimension, unsigned int, VPointDimension)
bool	ComputeBoundingBox (void)
virtual BoundsArrayType	GetBounds () const
PointType	GetCenter (void)
PointType	GetMinimum (void)
void	SetMinimum (const PointType &)
PointType	GetMaximum (void)
void	SetMaximum (const PointType &)
void	ConsiderPoint (const PointType &)
AccumulateType	GetDiagonalLength2 (void)
bool	IsInside (const PointType &)
unsigned long	GetMTime (void) const

void	SetPoints (const PointsContainer *)
const PointsContainer *	GetPoints (void) const
Static Public Member Functions
Pointer	New ()
Protected Types
typedef PointsContainer::ConstIterator	ConstIterator
Protected Member Functions
	BoundingBox ()
virtual	~BoundingBox ()
void	PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>
class itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >

Represent and compute information about bounding boxes.

BoundingBox is a supporting class that represents, computes, and caches information about bounding boxes. The bounding box can be computed from several sources, including manual specification and computation from an input points container.

This is a templated, n-dimensional version of the bounding box. Bounding boxes are represented by n pairs of (min,max) pairs, where min is the minimum coordinate value and max is the maximum coordinate value for coordinate axis i.

Template parameters for BoundingBox:

TPointIdentifier = The type used to access a particular point (i.e., a point's id)

TCoordRep = Numerical type with which to represent each coordinate value.

VPointDimension = Geometric dimension of space.

Definition at line 68 of file itkBoundingBox.h.

Member Typedef Documentation

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

typedef NumericTraits<CoordRepType>::AccumulateType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::AccumulateType

Get the length squared of the diagonal of the bounding box. Returns zero if bounding box cannot be computed. Note that the Accumulate type is used to represent the length. Definition at line 144 of file itkBoundingBox.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

typedef FixedArray< CoordRepType, VPointDimension*2 > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::BoundsArrayType

Definition at line 87 of file itkBoundingBox.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

typedef TPointIdentifier itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointIdentifier

Hold on to the type information specified by the template parameters. Definition at line 81 of file itkBoundingBox.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

typedef Point< CoordRepType, VPointDimension > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointType

Definition at line 86 of file itkBoundingBox.h.

Constructor & Destructor Documentation

Member Function Documentation

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ConsiderPoint ( const PointType & )

Adjust bounds (if necessary) as if the given point was in the set of points being considered. Does not add the given point to the set. Therefore, this point not considered in future computeboundingbox/gets once the point set is changed.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

virtual BoundsArrayType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetBounds ( ) const [virtual]

Get the bounding box. NULL is returned if the bounding box cannot be computed. (This may happen if the user never specifies something to compute the bounding box from.)

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

const PointsContainer* itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetPoints ( void ) const

Set/Get the points from which the bounding box should be computed. The bounding box is cached and is not recomputed if the points are not changed.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PrintSelf ( std::ostream & os,

Indent indent

) const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::Object.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetMaximum ( const PointType & )

Set the maximum point of the bounding box. May not be valid for the given set of points. Will be preserved until this filter's (i.e., the point set's) modified time changes.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetMinimum ( const PointType & )

Set the minimum point of the bounding box. May not be valid for the given set of points. Will be preserved until this filter's (i.e., the point set's) modified time changes.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep, VPointDimension> >>

void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetPoints ( const PointsContainer * )

Set/Get the points from which the bounding box should be computed. The bounding box is cached and is not recomputed if the points are not changed.

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

itkBoundingBox.h

Generated at Sat Mar 31 02:51:26 2007 for ITK by

itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer > Class Template Reference [Data Representation Objects, Image Representation Objects]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types