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]

#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.

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.

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 LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

Pointer DeepCopy () const

virtual void Delete ()

virtual const BoundsArrayType & GetBounds ()

PointType GetCenter (void) const

Command * GetCommand (unsigned long tag)

const PointsContainer * GetCorners (void)

bool GetDebug () const

AccumulateType GetDiagonalLength2 (void) const

PointType GetMaximum (void) const

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

PointType GetMinimum (void) const

unsigned long GetMTime (void) const

virtual const char * GetNameOfClass () const

const PointsContainer * GetPoints (void) const

virtual int GetReferenceCount () const

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

bool IsInside (const PointType &) const

itkStaticConstMacro (PointDimension, unsigned int, VPointDimension)

virtual void Modified () const

void Print (std::ostream &os, Indent indent=0) const

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

void SetDebug (bool debugFlag) const

void SetMaximum (const PointType &)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

void SetMinimum (const PointType &)

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
*void SetPoints (const PointsContainer *)

virtual void SetReferenceCount (int)

virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static Pointer New ()

This is a global flag that
controls whether any warning
*or error messages are displayed
*static void SetGlobalWarningDisplay (bool flag)

Public Attributes

Allow people to add remove
invoke observers(callbacks)
to any ITK *object.This is
an implementation of the subject/observer design *pattern.An
observer is added by specifying
an event to respond to *and
an itk unsigned lon AddObserver )(const EventObject &event, Command *) const

This is a global flag that
controls whether any debug

Protected Types

typedef PointsContainer::ConstIterator ConstIterator

Protected Member Functions

BoundingBox ()

bool PrintObservers (std::ostream &os, Indent indent) const

void PrintSelf (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

virtual ~BoundingBox ()

Protected Attributes

int m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Methods invoked by virtual
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.*/virtual
void PrintSelf(std voi PrintHeader )(std::ostream &os, Indent indent) const

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 150 of file itkBoundingBox.h.

Constructor & Destructor Documentation

Member Function Documentation

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:
A reference to this objects MetaDataDictionary.

Warning:
This reference may be changed.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.
Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

void itk::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers ( std::ostream & os,

Indent indent

) const [protected, inherited]

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.

virtual void itk::LightObject::PrintTrailer ( std::ostream & os,

Indent indent

) const [protected, virtual, inherited]

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).
Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:
Set the MetaDataDictionary

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> >>

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* void itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetPoints ( const PointsContainer * )

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)
Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.
Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count
Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

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

itkBoundingBox.h

Generated at Sun Jul 9 19:05:00 2006 for ITK by


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 LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
Pointer	DeepCopy () const
virtual void	Delete ()
virtual const BoundsArrayType &	GetBounds ()
PointType	GetCenter (void) const
Command *	GetCommand (unsigned long tag)
const PointsContainer *	GetCorners (void)
bool	GetDebug () const
AccumulateType	GetDiagonalLength2 (void) const
PointType	GetMaximum (void) const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
PointType	GetMinimum (void) const
unsigned long	GetMTime (void) const
virtual const char *	GetNameOfClass () const
const PointsContainer *	GetPoints (void) const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
bool	IsInside (const PointType &) const
	itkStaticConstMacro (PointDimension, unsigned int, VPointDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMaximum (const PointType &)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMinimum (const PointType &)
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 *void	SetPoints (const PointsContainer *)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK object.This is an implementation of the subject/observer design pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Types
typedef PointsContainer::ConstIterator	ConstIterator
Protected Member Functions
	BoundingBox ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~BoundingBox ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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./virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

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

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 >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types