WireCell::BufferedHistogram2D Class Reference

#include <BufferedHistogram2D.h>

Public Member Functions
	BufferedHistogram2D (double xbinsize=1.0, double ybinsize=1.0, double xmin=0.0, double ymin=0.0)
bool	fill (double x, double y, double v=1.0)
	Add v to the bin holding x,y. Return false if point is out of bounds. More...
std::vector< double >	popx ()
int	size () const
	popy is not yet implemented. More...
int	xsize () const
int	ysize () const
double	xmin () const
double	ymin () const
double	xmax () const
double	ymax () const
double	xbinsize () const
double	ybinsize () const

Private Types
typedef std::vector< double >	XBin
typedef std::deque< XBin >	XBinDeque

Private Attributes
double	m_xmin
double	m_ymin
double	m_xbinsize
double	m_ybinsize
XBinDeque	m_xbindeque

Detailed Description

A 2D histogram which can expand its range based on filling and have its edge sliced off.

Definition at line 12 of file BufferedHistogram2D.h.

Member Typedef Documentation

typedef std::vector<double> WireCell::BufferedHistogram2D::XBin

private

Definition at line 16 of file BufferedHistogram2D.h.

typedef std::deque<XBin> WireCell::BufferedHistogram2D::XBinDeque

private

Definition at line 17 of file BufferedHistogram2D.h.

Constructor & Destructor Documentation

BufferedHistogram2D::BufferedHistogram2D	(	double	xbinsize = 1.0,
		double	ybinsize = 1.0,
		double	xmin = 0.0,
		double	ymin = 0.0
	)

Create a buffered 2d histogram with lower corner at xmin, ymin and with bins of given sizes.

Definition at line 7 of file BufferedHistogram2D.cxx.

    : m_xmin(xmin), m_ymin(ymin), m_xbinsize(xbinsize), m_ybinsize(ybinsize)
{
}

Member Function Documentation

bool BufferedHistogram2D::fill	(	double	x,
		double	y,
		double	v = 1.0
	)

Add v to the bin holding x,y. Return false if point is out of bounds.

Definition at line 31 of file BufferedHistogram2D.cxx.

{
    int ybin = (y - m_ymin)/m_ybinsize;
    if (ybin < 0) {
        return false;
    }
    int xbin = (x - m_xmin)/m_xbinsize;
    if (xbin < 0) {
        return false;
    }

    if ((int)m_xbindeque.size() < xbin+1) {
        m_xbindeque.resize(xbin+1);
    }
    XBin& vec = m_xbindeque[xbin];
    if ((int)vec.size() < ybin+1) {
        vec.resize(ybin+1, 0.0);
    }
    vec[ybin] += v;

    return true;
}

std::vector< double > BufferedHistogram2D::popx

(

)

Slice off the lowest X bin and return it as a vector. Note, the zeroth element of the vector corresponds to the bin starting at ymin but the length of vector may not represent the global ymax.

Definition at line 54 of file BufferedHistogram2D.cxx.

{
    std::vector<double> ret;

    if (!m_xbindeque.size()) { return ret; }

    ret = m_xbindeque.front();
    m_xbindeque.pop_front();
    m_xmin += m_xbinsize;
    return ret;
}

int WireCell::BufferedHistogram2D::size ( void  ) const

inline

popy is not yet implemented.

Definition at line 39 of file BufferedHistogram2D.h.

{ return m_xbindeque.size(); }

double WireCell::BufferedHistogram2D::xbinsize ( ) const

inline

Definition at line 48 of file BufferedHistogram2D.h.

{ return m_xbinsize; }

double BufferedHistogram2D::xmax

(

)

const

Definition at line 13 of file BufferedHistogram2D.cxx.

{
    return xmin() + m_xbinsize * m_xbindeque.size();
}

double WireCell::BufferedHistogram2D::xmin ( ) const

inline

Definition at line 44 of file BufferedHistogram2D.h.

{ return m_xmin; }

int WireCell::BufferedHistogram2D::xsize ( ) const

inline

Definition at line 40 of file BufferedHistogram2D.h.

{ return size(); }

double WireCell::BufferedHistogram2D::ybinsize ( ) const

inline

Definition at line 49 of file BufferedHistogram2D.h.

{ return m_ybinsize; }

double BufferedHistogram2D::ymax

(

)

const

Definition at line 17 of file BufferedHistogram2D.cxx.

{
    return ymin() + m_ybinsize * ysize();
}

double WireCell::BufferedHistogram2D::ymin ( ) const

inline

Definition at line 45 of file BufferedHistogram2D.h.

{ return m_ymin; }

int BufferedHistogram2D::ysize

(

)

const

Definition at line 21 of file BufferedHistogram2D.cxx.

{
    int imax = 0;
    for (auto v: m_xbindeque) {
        imax = std::max((int)v.size(), imax);
    }
    return imax;
}

Member Data Documentation

XBinDeque WireCell::BufferedHistogram2D::m_xbindeque

private

Definition at line 18 of file BufferedHistogram2D.h.

double WireCell::BufferedHistogram2D::m_xbinsize

private

Definition at line 13 of file BufferedHistogram2D.h.

double WireCell::BufferedHistogram2D::m_xmin

private

Definition at line 13 of file BufferedHistogram2D.h.

double WireCell::BufferedHistogram2D::m_ybinsize

private

Definition at line 13 of file BufferedHistogram2D.h.

double WireCell::BufferedHistogram2D::m_ymin

private

Definition at line 13 of file BufferedHistogram2D.h.

---

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

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