ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkBoundingBox.h>
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 77 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 Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
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 () const |
PointType | GetCenter (void) const |
const PointsContainer * | GetCorners (void) |
AccumulateType | GetDiagonalLength2 (void) const |
PointType | GetMaximum (void) const |
PointType | GetMinimum (void) const |
virtual ModifiedTimeType | GetMTime (void) const ITK_OVERRIDE |
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 *) |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) const |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static const unsigned int | PointDimension = VPointDimension |
Protected Types | |
typedef PointsContainer::ConstIterator | ConstIterator |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Member Functions | |
BoundingBox () | |
virtual void | PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE |
virtual | ~BoundingBox () |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Member Functions | |
BoundingBox (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
BoundsArrayType | m_Bounds |
TimeStamp | m_BoundsMTime |
PointsContainerPointer | m_CornersContainer |
PointsContainerConstPointer | m_PointsContainer |
Additional Inherited Members | |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
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.
typedef FixedArray< CoordRepType, VPointDimension *2 > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::BoundsArrayType |
Definition at line 100 of file itkBoundingBox.h.
|
protected |
Definition at line 177 of file itkBoundingBox.h.
typedef SmartPointer< const Self > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ConstPointer |
Definition at line 84 of file itkBoundingBox.h.
typedef TCoordRep itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::CoordRepType |
Definition at line 94 of file itkBoundingBox.h.
typedef SmartPointer< Self > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Pointer |
Definition at line 83 of file itkBoundingBox.h.
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.
typedef TPointsContainer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainer |
Definition at line 95 of file itkBoundingBox.h.
typedef PointsContainer::ConstIterator itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerConstIterator |
Convenient typedefs.
Definition at line 106 of file itkBoundingBox.h.
typedef PointsContainer::ConstPointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerConstPointer |
Definition at line 97 of file itkBoundingBox.h.
typedef PointsContainer::Iterator itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerIterator |
Definition at line 107 of file itkBoundingBox.h.
typedef PointsContainer::Pointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerPointer |
Definition at line 96 of file itkBoundingBox.h.
typedef Point< CoordRepType, VPointDimension > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointType |
Definition at line 99 of file itkBoundingBox.h.
typedef BoundingBox itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Self |
Standard class typedefs.
Definition at line 81 of file itkBoundingBox.h.
typedef Object itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Superclass |
Definition at line 82 of file itkBoundingBox.h.
|
protected |
|
protectedvirtual |
|
private |
bool itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ComputeBoundingBox | ( | void | ) | const |
Method that actually computes bounding box.
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 |
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.
Pointer itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::DeepCopy | ( | ) | const |
Duplicates this bounding box
|
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.
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.
const PointsContainer* itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetCorners | ( | void | ) |
Compute and return the corners of the bounding box
AccumulateType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetDiagonalLength2 | ( | void | ) | const |
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.
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.
|
virtual |
Method Compute the Modified Time based on changed to the components.
Reimplemented from itk::Object.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::Object.
const PointsContainer* itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetPoints | ( | void | ) | const |
bool itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::IsInside | ( | const PointType & | ) | const |
Method that checks if a point is inside the bounding box.
|
static |
Method for creation through the object factory.
|
private |
|
protectedvirtual |
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.
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::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.
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.
|
mutableprivate |
Definition at line 185 of file itkBoundingBox.h.
|
mutableprivate |
Definition at line 186 of file itkBoundingBox.h.
|
private |
Definition at line 184 of file itkBoundingBox.h.
|
private |
Definition at line 183 of file itkBoundingBox.h.
|
static |
Hold on to the dimensions specified by the template parameters.
Definition at line 103 of file itkBoundingBox.h.