ITK
6.0.0
Insight 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 70 of file itkBoundingBox.h.
Public Member Functions | |
std::array< PointType, NumberOfCorners > | ComputeCorners () const |
void | ConsiderPoint (const PointType &) |
Pointer | DeepCopy () const |
virtual const BoundsArrayType & | GetBounds () const |
PointType | GetCenter () const |
AccumulateType | GetDiagonalLength2 () const |
PointType | GetMaximum () const |
PointType | GetMinimum () const |
ModifiedTimeType | GetMTime () const override |
const char * | GetNameOfClass () const override |
const PointsContainer * | GetPoints () const |
bool | IsInside (const PointType &) const |
itkLegacyMacro (const PointsContainer *GetCorners();) bool ComputeBoundingBox() 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 *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
const char * | GetNameOfClass () const override |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) const |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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 val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Static Public Attributes | |
static constexpr SizeValueType | NumberOfCorners = SizeValueType{ 1 } << VPointDimension |
static constexpr unsigned int | PointDimension = VPointDimension |
Protected Types | |
using | ConstIterator = typename PointsContainer::ConstIterator |
Protected Member Functions | |
BoundingBox ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~BoundingBox () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
BoundsArrayType | m_Bounds {} |
TimeStamp | m_BoundsMTime {} |
PointsContainerConstPointer | m_PointsContainer {} |
Additional Inherited Members | |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::AccumulateType = typename NumericTraits<CoordRepType>::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 175 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::BoundsArrayType = FixedArray<CoordRepType, VPointDimension * 2> |
Definition at line 98 of file itkBoundingBox.h.
|
protected |
Definition at line 197 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ConstPointer = SmartPointer<const Self> |
Definition at line 79 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::CoordRepType = TCoordRep |
Definition at line 92 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Pointer = SmartPointer<Self> |
Definition at line 78 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointIdentifier = TPointIdentifier |
Hold on to the type information specified by the template parameters.
Definition at line 91 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainer = TPointsContainer |
Definition at line 93 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerConstIterator = typename PointsContainer::ConstIterator |
Convenient type alias.
Definition at line 104 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerConstPointer = typename PointsContainer::ConstPointer |
Definition at line 95 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerIterator = typename PointsContainer::Iterator |
Definition at line 105 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerPointer = typename PointsContainer::Pointer |
Definition at line 94 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointType = Point<CoordRepType, VPointDimension> |
Definition at line 97 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Self = BoundingBox |
Standard class type aliases.
Definition at line 76 of file itkBoundingBox.h.
using itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Superclass = Object |
Definition at line 77 of file itkBoundingBox.h.
|
protecteddefault |
|
overrideprotecteddefault |
std::array< PointType, NumberOfCorners > itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ComputeCorners | ( | ) | const |
Compute and return the corners of the bounding box.
GetCorners()
, but it is const
, and it avoids dynamic memory allocation by using std::array
. 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.
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 | ( | ) | const |
Get the center of the bounding box. Returns a point at the origin when the bounding box object is just default-initialized.
AccumulateType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetDiagonalLength2 | ( | ) | const |
PointType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMaximum | ( | ) | const |
Get the maximum point of the bounding box. Returns a point at the origin when the bounding box object is just default-initialized.
PointType itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMinimum | ( | ) | const |
Get the minimum point of the bounding box. Returns a point at the origin when the bounding box object is just default-initialized.
|
overridevirtual |
Method Compute the Modified Time based on changed to the components.
Reimplemented from itk::Object.
|
overridevirtual |
Reimplemented from itk::LightObject.
const PointsContainer * itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetPoints | ( | ) | const |
bool itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::IsInside | ( | const PointType & | ) | const |
Method that checks if a point is inside the bounding box.
itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::itkLegacyMacro | ( | const PointsContainer *GetCorners(); | ) | const |
Compute and return the corners of the bounding box Method that actually computes bounding box.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
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::LightObject.
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 204 of file itkBoundingBox.h.
|
mutableprivate |
Definition at line 205 of file itkBoundingBox.h.
|
private |
Definition at line 200 of file itkBoundingBox.h.
|
staticconstexpr |
Definition at line 88 of file itkBoundingBox.h.
|
staticconstexpr |
Hold on to the dimensions specified by the template parameters.
Definition at line 101 of file itkBoundingBox.h.