ActsUtils::StatHist Class Reference

Extend Stat helper by an equidistant binned histogram. More...

#include <StatUtils.h>

Inheritance diagram for ActsUtils::StatHist:

Collaboration diagram for ActsUtils::StatHist:

Public Member Functions
	StatHist ()=default
	The default constructor will disable histogramming. More...
	StatHist (unsigned int n_bins, float xmin, float xmax)
	Set up class to also fill a histogram. More...
void	setBinning (unsigned int n_bins, float xmin, float xmax)
	Define histogramm bins and enable histogramming. More...
StatHist	createEmptyClone ()
void	add (double val)
	Gather statistics and fill the histogram if not disabled. More...
void	reset ()
	Set histogram contents and statistics to zero. More...
StatHist &	operator+= (const StatHist &b)
	Add the statistucs and histogrammed data fro the given object. More...
double	lowerEdge (unsigned int i) const
	Get the lower edge of the given bin. More...
std::string	histogramToString () const
	Create a string showing the contents of the histogram The string. More...
unsigned int	n () const
double	min () const
double	max () const
double	mean () const
double	rms2 () const
double	rms () const
Stat &	operator+= (const Stat &b)
	@breif Add the statistics gathered in the Stat object b More...

Public Attributes
double	m_xmin {}
double	m_scale {1.0}
std::vector< unsigned int >	m_histogram
unsigned int	m_n =0
double	m_sum =0.
double	m_sum2 =0.
double	m_min =std::numeric_limits<double>::max()
double	m_max =-std::numeric_limits<double>::max()

Detailed Description

Extend Stat helper by an equidistant binned histogram.

Definition at line 81 of file StatUtils.h.

Constructor & Destructor Documentation

StatHist() [1/2]

ActsUtils::StatHist::StatHist ( )

default

The default constructor will disable histogramming.

StatHist() [2/2]

ActsUtils::StatHist::StatHist ( unsigned int  n_bins, float  xmin, float  xmax  )

inline

Set up class to also fill a histogram.

Parameters

n_bins	number of bins without over and underflow
the	value at the lower edge of the first bin
the	value at the upper edge of the last bin

Definition at line 90 of file StatUtils.h.

   {
      setBinning(n_bins,xmin,xmax);
   }

Member Function Documentation

add()

void ActsUtils::StatHist::add ( double  val )

inline

Gather statistics and fill the histogram if not disabled.

Definition at line 117 of file StatUtils.h.

                        {
      Stat::add(val);
      if (!m_histogram.empty()) {
         unsigned int bin = std::min( static_cast<unsigned int>(m_histogram.size()-1),
                                      static_cast<unsigned int>( std::max(0.,(val - m_xmin)*m_scale)) );
         ++m_histogram.at(bin) ;
      }
   }

createEmptyClone()

StatHist ActsUtils::StatHist::createEmptyClone ( )

inline

Definition at line 108 of file StatUtils.h.

                               {
      StatHist tmp;
      tmp.m_histogram.resize( m_histogram.size());
      tmp.m_xmin = m_xmin;
      tmp.m_scale = m_scale;
      return tmp;
   }

histogramToString()

std::string ActsUtils::StatHist::histogramToString ( ) const

inline

Create a string showing the contents of the histogram The string.

Definition at line 153 of file StatUtils.h.

                                       {
      std::stringstream msg;
      if (m_histogram.size()>2) {
         const unsigned int max_val = *std::max_element(m_histogram.begin(), m_histogram.end());
         const double bin_width = 1. / m_scale;
         const unsigned int w = max_val > 0 ? static_cast<unsigned int>(log(1.*max_val) / log(10.))+1 : 1;
         const unsigned int wtitle = std::max(10u, w);
         msg << (m_xmin+bin_width) << " .. " << ((m_histogram.size()-2)/m_scale + m_xmin+bin_width) << " : "
             << std::setw(wtitle) << "lower edge"  << " |";
         for (unsigned int i=1; i<m_histogram.size()-1; ++i) {
            msg << " " << std::setw(w) << lowerEdge(i);
         }
         msg << " | " << std::endl;
         msg << (m_xmin+bin_width) << " .. " << ((m_histogram.size()-2)/m_scale + m_xmin+bin_width) << " : "
 
            << std::setw(wtitle) << m_histogram[0] << " |";
         for (unsigned int i=1; i<m_histogram.size()-1; ++i) {
            msg << " " << std::setw(w) << m_histogram[i];
         }
         msg << " | " << std::setw(w) << m_histogram.back();
      }
      return msg.str();
   }

lowerEdge()

double ActsUtils::StatHist::lowerEdge ( unsigned int  i ) const

inline

Get the lower edge of the given bin.

Parameters

i	the bin (0: underflow; n+1 overflow)

Definition at line 147 of file StatUtils.h.

                                          {
      return m_xmin + i/m_scale;
   }

max()

double ActsUtils::Stat::max ( ) const

inlineinherited

Definition at line 30 of file StatUtils.h.

{ return m_max; }

mean()

double ActsUtils::Stat::mean ( ) const

inlineinherited

Definition at line 31 of file StatUtils.h.

{ return m_n>0 ? m_sum/m_n : 0.; }

min()

double ActsUtils::Stat::min ( ) const

inlineinherited

Definition at line 29 of file StatUtils.h.

{ return m_min; }

n()

unsigned int ActsUtils::Stat::n ( ) const

inlineinherited

Definition at line 28 of file StatUtils.h.

{ return m_n; }

operator+=() [1/2]

Stat& ActsUtils::Stat::operator+= ( const Stat &  b )

inlineinherited

@breif Add the statistics gathered in the Stat object b

Definition at line 45 of file StatUtils.h.

                                    {
      m_n += b.m_n;
      m_sum += b.m_sum;
      m_sum2 += b.m_sum2;
      m_min = std::min(m_min, b.m_min);
      m_max = std::max(m_max, b.m_max);
      return *this;
   }

operator+=() [2/2]

StatHist& ActsUtils::StatHist::operator+= ( const StatHist &  b )

inline

Add the statistucs and histogrammed data fro the given object.

Definition at line 135 of file StatUtils.h.

                                            {
      Stat::operator+=(b);
      if (m_histogram.size() == b.m_histogram.size()) {
         for (unsigned int bin_i=0; bin_i< m_histogram.size(); ++bin_i) {
            m_histogram[bin_i] += b.m_histogram[bin_i];
         }
      }
      return *this;
   }

reset()

void ActsUtils::StatHist::reset ( )

inline

Set histogram contents and statistics to zero.

Definition at line 127 of file StatUtils.h.

                {
      Stat::reset();
      for (unsigned int &bin : m_histogram) {
         bin = 0u;
      }
   }

rms()

double ActsUtils::Stat::rms ( ) const

inlineinherited

Definition at line 33 of file StatUtils.h.

{ return std::sqrt( rms2() ); }

rms2()

double ActsUtils::Stat::rms2 ( ) const

inlineinherited

Definition at line 32 of file StatUtils.h.

{ return m_n>1 ? (m_sum2 - m_sum *m_sum/m_n)/(m_n-1) : 0.; }

setBinning()

void ActsUtils::StatHist::setBinning ( unsigned int  n_bins, float  xmin, float  xmax  )

inline

Define histogramm bins and enable histogramming.

Parameters

n_bins	number of bins without over and underflow
the	value at the lower edge of the first bin
the	value at the upper edge of the last bin

Definition at line 99 of file StatUtils.h.

   {
      m_xmin=xmin;
      m_scale = ( n_bins / (xmax-xmin) );
      m_xmin -= 1./m_scale;
      m_histogram.resize(n_bins+2,0u);
   }

Member Data Documentation

m_histogram

std::vector<unsigned int> ActsUtils::StatHist::m_histogram

Definition at line 179 of file StatUtils.h.

m_max

double ActsUtils::Stat::m_max =-std::numeric_limits<double>::max()

inherited

Definition at line 58 of file StatUtils.h.

m_min

double ActsUtils::Stat::m_min =std::numeric_limits<double>::max()

inherited

Definition at line 57 of file StatUtils.h.

m_n

unsigned int ActsUtils::Stat::m_n =0

inherited

Definition at line 54 of file StatUtils.h.

m_scale

double ActsUtils::StatHist::m_scale {1.0}

Definition at line 178 of file StatUtils.h.

m_sum

double ActsUtils::Stat::m_sum =0.

inherited

Definition at line 55 of file StatUtils.h.

m_sum2

double ActsUtils::Stat::m_sum2 =0.

inherited

Definition at line 56 of file StatUtils.h.

m_xmin

double ActsUtils::StatHist::m_xmin {}

Definition at line 177 of file StatUtils.h.

---

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

• StatUtils.h