itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer > Class Template Reference

#include <itkBoundingBox.h>

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

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

List of all members.

Public Types
typedef NumericTraits < CoordRepType > ::AccumulateType	AccumulateType
typedef FixedArray < CoordRepType, VPointDimension *2 >	BoundsArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef TCoordRep	CoordRepType
typedef SmartPointer< Self >	Pointer
typedef TPointIdentifier	PointIdentifier
typedef TPointsContainer	PointsContainer
typedef PointsContainer::ConstIterator	PointsContainerConstIterator
typedef PointsContainer::ConstPointer	PointsContainerConstPointer
typedef PointsContainer::Iterator	PointsContainerIterator
typedef PointsContainer::Pointer	PointsContainerPointer
typedef Point< CoordRepType, VPointDimension >	PointType
typedef BoundingBox	Self
typedef Object	Superclass
Public Member Functions
bool	ComputeBoundingBox (void) const
void	ConsiderPoint (const PointType &)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
Pointer	DeepCopy () const
virtual const BoundsArrayType &	GetBounds ()
PointType	GetCenter (void) const
const PointsContainer *	GetCorners (void)
AccumulateType	GetDiagonalLength2 (void) const
PointType	GetMaximum (void) const
PointType	GetMinimum (void) const
unsigned long	GetMTime (void) const
virtual const char *	GetNameOfClass () const
const PointsContainer *	GetPoints (void) const
bool	IsInside (const PointType &) const
void	SetMaximum (const PointType &)
void	SetMinimum (const PointType &)
void	SetPoints (const PointsContainer *)
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	PointDimension = VPointDimension
Protected Types
typedef PointsContainer::ConstIterator	ConstIterator
Protected Member Functions
	BoundingBox ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~BoundingBox ()
Private Member Functions
	BoundingBox (const Self &)
void	operator= (const Self &)
Private Attributes
BoundsArrayType	m_Bounds
TimeStamp	m_BoundsMTime
PointsContainerPointer	m_CornersContainer
PointsContainerConstPointer	m_PointsContainer

---

Detailed Description

template<typename TPointIdentifier = IdentifierType, 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.

Wiki Examples:

• All Examples

• Bounding box

Definition at line 77 of file itkBoundingBox.h.

---

Member Typedef Documentation

template<typename TPointIdentifier = IdentifierType, 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 160 of file itkBoundingBox.h.

template<typename TPointIdentifier = IdentifierType, 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 100 of file itkBoundingBox.h.

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

typedef PointsContainer::ConstIterator itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ConstIterator [protected]

Definition at line 198 of file itkBoundingBox.h.

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

typedef SmartPointer< const Self > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ConstPointer

Reimplemented from itk::Object.

Definition at line 84 of file itkBoundingBox.h.

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

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

Definition at line 94 of file itkBoundingBox.h.

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

typedef SmartPointer< Self > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Pointer

Reimplemented from itk::Object.

Definition at line 83 of file itkBoundingBox.h.

template<typename TPointIdentifier = IdentifierType, 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 90 of file itkBoundingBox.h.

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

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

Definition at line 95 of file itkBoundingBox.h.

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

typedef PointsContainer::ConstIterator itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerConstIterator

Convenient typedefs.

Definition at line 106 of file itkBoundingBox.h.

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

typedef PointsContainer::ConstPointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerConstPointer

Definition at line 97 of file itkBoundingBox.h.

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

typedef PointsContainer::Iterator itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerIterator

Definition at line 107 of file itkBoundingBox.h.

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

typedef PointsContainer::Pointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerPointer

Definition at line 96 of file itkBoundingBox.h.

template<typename TPointIdentifier = IdentifierType, 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 99 of file itkBoundingBox.h.

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

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

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 81 of file itkBoundingBox.h.

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

typedef Object itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Superclass

Reimplemented from itk::Object.

Definition at line 82 of file itkBoundingBox.h.

---

Constructor & Destructor Documentation

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

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

(

)

[protected]

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

virtual itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::~BoundingBox

(

)

[protected, virtual]

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

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

(

const Self &

)

[private]

---

Member Function Documentation

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

bool itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ComputeBoundingBox

(

void

)

const

Method that actually computes bounding box.

template<typename TPointIdentifier = IdentifierType, 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 = IdentifierType, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier, Point< TCoordRep, VPointDimension > >>

virtual::itk::LightObject::Pointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::CreateAnother

(

void

)

const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

Pointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::DeepCopy

(

)

const

Duplicates this bounding box

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

virtual const BoundsArrayType& itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetBounds

(

)

[virtual]

Get the bounding box. This method should only be invoked after ComputeBoundingBox(), otherwise the Bounds values will not be up to date. Note that many methods in this class invoke ComputeBoundingBox() internally, for example GetMinimum(), GetMaximum(), GetCenter(), GetDiagonalLength2(). Therefore it is safe to invoke GetBounds() after any of those methods.

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

PointType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetCenter

(

void

)

const

Get the center of the bounding box. Returns NULL if bounding box cannot be computed.

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

const PointsContainer* itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetCorners

(

void

)

Compute and return the corners of the bounding box

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

AccumulateType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetDiagonalLength2

(

void

)

const

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

PointType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMaximum

(

void

)

const

Get the maximum point of the bounding box. Returns NULL if bounding box cannot be computed.

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

PointType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMinimum

(

void

)

const

Get the minimum point of the bounding box. Returns NULL if bounding box cannot be computed.

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

unsigned long itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime

(

void

)

const [virtual]

Method Compute the Modified Time based on changed to the components.

Reimplemented from itk::Object.

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

virtual const char* itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

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

(

void

)

const

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

bool itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::IsInside

(

const PointType &

)

const

Method that checks if a point is inside the bounding box.

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

static Pointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

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

void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::operator=

(

const Self &

)

[private]

template<typename TPointIdentifier = IdentifierType, 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 = IdentifierType, 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 = IdentifierType, 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 = IdentifierType, 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.

---

Member Data Documentation

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

BoundsArrayType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::m_Bounds [mutable, private]

Definition at line 205 of file itkBoundingBox.h.

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

TimeStamp itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::m_BoundsMTime [mutable, private]

Definition at line 206 of file itkBoundingBox.h.

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

PointsContainerPointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::m_CornersContainer [private]

Definition at line 204 of file itkBoundingBox.h.

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

PointsContainerConstPointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::m_PointsContainer [private]

Definition at line 203 of file itkBoundingBox.h.

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

const unsigned int itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointDimension = VPointDimension [static]

Hold on to the dimensions specified by the template parameters.

Definition at line 103 of file itkBoundingBox.h.

---

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

• itkBoundingBox.h