WireCell::Binning Class Reference

#include <Binning.h>

Public Member Functions
	Binning (int nbins, double minval, double maxval)
	Binning ()
void	set (int nbins, double minval, double maxval)
int	nbins () const
double	min () const
double	max () const
double	span () const
	Return the max-min. More...
std::pair< double, double >	range () const
std::pair< int, int >	irange () const
double	binsize () const
int	bin (double val) const
double	center (int ind) const
int	edge_index (double val) const
double	edge (int ind) const
bool	inside (double val) const
bool	inbounds (int bin) const
	Return true if bin is in bounds. More...
std::pair< int, int >	sample_bin_range (double minval, double maxval) const

Private Attributes
int	m_nbins
double	m_minval
double	m_maxval
double	m_binsize

Detailed Description

A binning is a uniform discretization of a linear space.

This class largely provides methods that give semantic labels to various calculations related to a binned region.

Definition at line 15 of file Binning.h.

Constructor & Destructor Documentation

WireCell::Binning::Binning ( int  nbins, double  minval, double  maxval  )

inline

Create a binning

Parameters

nbins	gives the number of uniform, discrete separation between bounds.
minval	gives the lower bound of the linear space (low edge of bin 0)
maxval	gives the upper bound of the linear space (high edge of bin nbins-1)

Definition at line 26 of file Binning.h.

            : m_nbins(0), m_minval(0), m_maxval(0), m_binsize(0)
            { set(nbins, minval, maxval); }

WireCell::Binning::Binning ( )

inline

Definition at line 29 of file Binning.h.

            : m_nbins(0), m_minval(0), m_maxval(0), m_binsize(0)
            { }

Member Function Documentation

int WireCell::Binning::bin ( double  val ) const

inline

Return the bin containing value. If val is in range, return value is [0,nbins-1] but no range checking is performed.

Definition at line 80 of file Binning.h.

                                  {
            return int((val-m_minval)/m_binsize);
        }

double WireCell::Binning::binsize ( ) const

inline

Definition at line 73 of file Binning.h.

                               {
            return m_binsize;
        }

double WireCell::Binning::center ( int  ind ) const

inline

Return the center value of given bin. Range checking is not done.

Definition at line 86 of file Binning.h.

                                     {
            return m_minval + (ind+0.5)*m_binsize;
        }    

double WireCell::Binning::edge ( int  ind ) const

inline

Return the position of the given bin edge. Range checking is not done.

Definition at line 99 of file Binning.h.

                                   {
            return m_minval + ind*m_binsize;
        }

int WireCell::Binning::edge_index ( double  val ) const

inline

Return the edge, nominally in [0,nbins] closest to the given value. Range checking is not done so returned edge may be outside of range.

Definition at line 93 of file Binning.h.

                                         {
            return int(round((val-m_minval)/m_binsize));
        }

bool WireCell::Binning::inbounds ( int  bin ) const

inline

Return true if bin is in bounds.

Definition at line 110 of file Binning.h.

                                     {
            return 0 <= bin && bin < m_nbins;
        }

bool WireCell::Binning::inside ( double  val ) const

inline

Return true value is in range. Range is considered half open. Ig, edge(nbins) is not inside range.

Definition at line 105 of file Binning.h.

                                      {
            return m_minval <= val && val < m_maxval;
        }

std::pair<int, int> WireCell::Binning::irange ( ) const

inline

Definition at line 68 of file Binning.h.

                                         {
            return std::make_pair(0, m_nbins);
        }

double WireCell::Binning::max ( void  ) const

inline

Definition at line 52 of file Binning.h.

                           {
            return m_maxval;
        }

double WireCell::Binning::min ( void  ) const

inline

Definition at line 47 of file Binning.h.

                           {
            return m_minval;
        }

int WireCell::Binning::nbins ( ) const

inline

Definition at line 42 of file Binning.h.

                          {
            return m_nbins;
        }

std::pair<double, double> WireCell::Binning::range ( ) const

inline

Definition at line 62 of file Binning.h.

                                              {
            return std::make_pair(m_minval, m_maxval);
        }

std::pair<int,int> WireCell::Binning::sample_bin_range ( double  minval, double  maxval  ) const

inline

Return half-open bin range which covers the range of values. Bounds are forced to return values in [0,nbins].

Definition at line 116 of file Binning.h.

                                                                              {
            return std::make_pair(std::max(bin(minval), 0),
                                  std::min(bin(maxval)+1, m_nbins));
        }

void WireCell::Binning::set ( int  nbins, double  minval, double  maxval  )

inline

Definition at line 34 of file Binning.h.

                                                          {
            m_nbins = nbins;
            m_minval = minval;
            m_maxval = maxval;
            m_binsize = ((maxval-minval)/nbins);
        }

double WireCell::Binning::span ( ) const

inline

Return the max-min.

Definition at line 57 of file Binning.h.

                            {
            return m_maxval - m_minval;
        }

Member Data Documentation

double WireCell::Binning::m_binsize

private

Definition at line 18 of file Binning.h.

double WireCell::Binning::m_maxval

private

Definition at line 18 of file Binning.h.

double WireCell::Binning::m_minval

private

Definition at line 18 of file Binning.h.

int WireCell::Binning::m_nbins

private

Definition at line 17 of file Binning.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/Binning.h