WireCellToolkit
Wire Cell Simulation, Signal Process and Reconstruction Toolki for Liquid Argon Detectors
WireCell::BoundingBox Class Reference

#include <BoundingBox.h>

Public Member Functions

 BoundingBox ()
 Create a bounding box without an initial point or ray. More...
 
 BoundingBox (const Point &initial)
 Create a bounding box bounding an initial point. More...
 
 BoundingBox (const Ray &initial)
 Create a bounding box bounding an initial ray. More...
 
template<typename RayOrPointIterator >
 BoundingBox (const RayOrPointIterator &begin, const RayOrPointIterator &end)
 Create a bounding box from an iterator pair. More...
 
bool inside (const Point &point) const
 Return true if point is inside bounding box. More...
 
const Raybounds () const
 Return the ray representing the bounds. More...
 
void operator() (const Point &p)
 Enlarge bounds to hold point. More...
 
void operator() (const Ray &r)
 Enlarge bounds to hold ray. More...
 
template<typename RayOrPointIterator >
void operator() (const RayOrPointIterator &begin, const RayOrPointIterator &end)
 
bool empty () const
 

Detailed Description

A bounding box parallel to the Cartesian axes.

Definition at line 11 of file BoundingBox.h.

Constructor & Destructor Documentation

◆ BoundingBox() [1/4]

WireCell::BoundingBox::BoundingBox ( )
inline

Create a bounding box without an initial point or ray.

Definition at line 18 of file BoundingBox.h.

◆ BoundingBox() [2/4]

WireCell::BoundingBox::BoundingBox ( const Point initial)

Create a bounding box bounding an initial point.

Definition at line 3 of file BoundingBox.cxx.

◆ BoundingBox() [3/4]

WireCell::BoundingBox::BoundingBox ( const Ray initial)

Create a bounding box bounding an initial ray.

Definition at line 4 of file BoundingBox.cxx.

◆ BoundingBox() [4/4]

template<typename RayOrPointIterator >
WireCell::BoundingBox::BoundingBox ( const RayOrPointIterator &  begin,
const RayOrPointIterator &  end 
)
inline

Create a bounding box from an iterator pair.

Definition at line 28 of file BoundingBox.h.

Here is the call graph for this function:

Member Function Documentation

◆ bounds()

const Ray& WireCell::BoundingBox::bounds ( ) const
inline

Return the ray representing the bounds.

Definition at line 36 of file BoundingBox.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ empty()

bool WireCell::BoundingBox::empty ( ) const
inline

Definition at line 49 of file BoundingBox.h.

Here is the caller graph for this function:

◆ inside()

bool WireCell::BoundingBox::inside ( const Point point) const

Return true if point is inside bounding box.

Definition at line 29 of file BoundingBox.cxx.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator()() [1/3]

void WireCell::BoundingBox::operator() ( const Point p)

Enlarge bounds to hold point.

Definition at line 10 of file BoundingBox.cxx.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator()() [2/3]

void WireCell::BoundingBox::operator() ( const Ray r)

Enlarge bounds to hold ray.

Definition at line 5 of file BoundingBox.cxx.

◆ operator()() [3/3]

template<typename RayOrPointIterator >
void WireCell::BoundingBox::operator() ( const RayOrPointIterator &  begin,
const RayOrPointIterator &  end 
)
inline

Definition at line 45 of file BoundingBox.h.

Here is the call graph for this function:

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