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 Ray &	bounds () 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

Private Attributes
Ray	m_bounds
bool	m_initialized = false

Detailed Description

A bounding box parallel to the Cartesian axes.

Definition at line 11 of file BoundingBox.h.

Constructor & Destructor Documentation

WireCell::BoundingBox::BoundingBox ( )

inline

Create a bounding box without an initial point or ray.

Definition at line 18 of file BoundingBox.h.

{ m_bounds = Ray();}

WireCell::BoundingBox::BoundingBox

(

const Point &

initial

)

Create a bounding box bounding an initial point.

Definition at line 3 of file BoundingBox.cxx.

: m_bounds(initial, initial), m_initialized(true) {}

WireCell::BoundingBox::BoundingBox

(

const Ray &

initial

)

Create a bounding box bounding an initial ray.

Definition at line 4 of file BoundingBox.cxx.

: m_bounds(initial), m_initialized(true) {}

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.

                                                                                    {
            for (auto it = begin; it != end; ++it) { (*this)(*it); }
        }

Member Function Documentation

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

inline

Return the ray representing the bounds.

Definition at line 36 of file BoundingBox.h.

{ return m_bounds; }

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

inline

Definition at line 49 of file BoundingBox.h.

{ return !m_initialized; }

bool WireCell::BoundingBox::inside

(

const Point &

point

)

const

Return true if point is inside bounding box.

Definition at line 29 of file BoundingBox.cxx.

{
    if (empty()) {
        return false;
    }
    for (int ind=0; ind<3; ++ind) {
        const double p = point[ind];
        const double b1 = m_bounds.first[ind];
        const double b2 = m_bounds.second[ind];

        if (b1 < b2) {
            if (p<b1 or p>b2) return false;
            continue;
        }
        if (b2 < b1) {
            if (p<b2 or p>b1) return false;
            continue;
        }

        // if equal, then zero width dimension, don't test.
        continue;
    }
    return true;
}

void WireCell::BoundingBox::operator()

(

const Point &

p

)

Enlarge bounds to hold point.

Definition at line 10 of file BoundingBox.cxx.

{ 
    if(empty()) {
        m_bounds.first = p;
        m_bounds.second = p;
        m_initialized=true;
        return;
    }

    for (int ind=0; ind<3; ++ind) {
        if (p[ind] < m_bounds.first[ind]) {
            m_bounds.first[ind] = p[ind];
        }
        if (p[ind] > m_bounds.second[ind]) {
            m_bounds.second[ind] = p[ind];
        }
    }
}

void WireCell::BoundingBox::operator()

(

const Ray &

r

)

Enlarge bounds to hold ray.

Definition at line 5 of file BoundingBox.cxx.

{
    (*this)(r.first);
    (*this)(r.second);
}

template<typename RayOrPointIterator >

void WireCell::BoundingBox::operator() ( const RayOrPointIterator &  begin, const RayOrPointIterator &  end  )

inline

Definition at line 45 of file BoundingBox.h.

                                                                                        {
            for (auto it = begin; it != end; ++it) { (*this)(*it); }
        }

Member Data Documentation

Ray WireCell::BoundingBox::m_bounds

private

Definition at line 12 of file BoundingBox.h.

bool WireCell::BoundingBox::m_initialized = false

private

Definition at line 13 of file BoundingBox.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/BoundingBox.h
• wire-cell-build/util/src/BoundingBox.cxx