TrigHisto1D Class Reference

A very basic one dimensional histogram to provide storage of HLT distributions, allowing constraints but preventing excessive memory usage for busy events. The histogram data is compressed during persistification according to the type of template instantiated. More...

#include <TrigHisto1D.h>

Inheritance diagram for TrigHisto1D:

Collaboration diagram for TrigHisto1D:

Public Member Functions
	TrigHisto1D (void)
	Default constructor used by T/P converters.
	TrigHisto1D (unsigned int nbins_x, float min_x, float max_x)
	Standard constructor used by FEX algorithms.
	TrigHisto1D (unsigned int nbins_x, float min_x, float max_x, const std::vector< float > &contents)
	Constructor used by TrigHisto2D.
virtual	~TrigHisto1D (void)
	Destructor.
	TrigHisto1D (const TrigHisto1D &trigHisto)
	Copy Constructor.
	TrigHisto1D (TrigHisto1D &&trigHisto)
TrigHisto1D &	operator= (const TrigHisto1D &trigHisto)
	Assignment operator.
TrigHisto1D &	operator= (TrigHisto1D &&trigHisto)
void	fill (float value_x, float weight)
	Fill a 1D histogram.
double	sumEntries (float value_x, int cutType) const
	Sum the number of entries within the cut range.
void	clear (void)
	Zero all histogram bins.
unsigned int	nbins_x (void) const
	Return the number of bins along the y-axis, not including the under and overflow.
float	min_x (void) const
	Return the minimum along the x-axis.
float	max_x (void) const
	Return the maximum along the x-axis.
const std::vector< float > &	contents (void) const
	Return the bin contents of the histogram, including the under and overflow bins.

Protected Member Functions
unsigned int	findBin (unsigned int nbins, float h_min, float h_max, float binSize, float value) const

Protected Attributes
std::vector< float >	m_contents
std::vector< float >::iterator	m_itr {}
std::vector< float >::iterator	m_itr_end {}
unsigned int	m_nbins_x
unsigned int	m_underflowBin_x
unsigned int	m_overflowBin_x
float	m_min_x
float	m_max_x
float	m_binSize_x

Detailed Description

A very basic one dimensional histogram to provide storage of HLT distributions, allowing constraints but preventing excessive memory usage for busy events. The histogram data is compressed during persistification according to the type of template instantiated.

Author

W. H. Bell W.Bel.nosp@m.l@ce.nosp@m.rn.ch

Definition at line 23 of file TrigHisto1D.h.

Constructor & Destructor Documentation

TrigHisto1D() [1/5]

TrigHisto1D::TrigHisto1D

(

void

)

Default constructor used by T/P converters.

Definition at line 11 of file TrigHisto1D.cxx.

                        : TrigHisto() {
}

TrigHisto1D() [2/5]

TrigHisto1D::TrigHisto1D	(	unsigned int	nbins_x,
		float	min_x,
		float	max_x )

Standard constructor used by FEX algorithms.

Definition at line 16 of file TrigHisto1D.cxx.

                         : TrigHisto() {
  
  m_nbins_x = nbins_x;
  m_min_x = min_x;
  m_max_x = max_x;
  
  m_contents.clear();
  m_contents.resize(m_nbins_x+2, 0); // Two additional bins for under and overflow.
  
  if(m_nbins_x != 0) {
    m_binSize_x = (m_max_x - m_min_x)/((float)m_nbins_x); // Calculate bin size.
  }
  else {
    m_binSize_x = 0.;
  }
  
  m_underflowBin_x = 0; // Cache this to make the code more readable.
  m_overflowBin_x = m_nbins_x+1; // Cache this to make the code more readable and faster.
}

TrigHisto1D() [3/5]

TrigHisto1D::TrigHisto1D	(	unsigned int	nbins_x,
		float	min_x,
		float	max_x,
		const std::vector< float > &	contents )

Constructor used by TrigHisto2D.

Definition at line 40 of file TrigHisto1D.cxx.

                                               {
  m_nbins_x = nbins_x;
  m_min_x = min_x;
  m_max_x = max_x;
 
  m_contents = contents;
  m_contents.resize(m_nbins_x+2, 0); // Resize if it not the correct size.
  
  m_binSize_x = (m_max_x - m_min_x)/((float)m_nbins_x); // Calculate bin size.
  
  m_underflowBin_x = 0; // Cache this to make the code more readable.
  m_overflowBin_x = m_nbins_x+1; // Cache this to make the code more readable and faster.
}

~TrigHisto1D()

TrigHisto1D::~TrigHisto1D ( void )

virtual

Destructor.

Definition at line 59 of file TrigHisto1D.cxx.

                          {
}

TrigHisto1D() [4/5]

TrigHisto1D::TrigHisto1D

(

const TrigHisto1D &

trigHisto

)

Copy Constructor.

Definition at line 64 of file TrigHisto1D.cxx.

                                                    : TrigHisto() {
  m_nbins_x = trigHisto.m_nbins_x;
  m_min_x = trigHisto.m_min_x;
  m_max_x = trigHisto.m_max_x;
  m_contents = trigHisto.m_contents;
  m_binSize_x = trigHisto.m_binSize_x;
  m_underflowBin_x = trigHisto.m_underflowBin_x;
  m_overflowBin_x = trigHisto.m_overflowBin_x;
}

TrigHisto1D() [5/5]

TrigHisto1D::TrigHisto1D

(

TrigHisto1D &&

trigHisto

)

Definition at line 76 of file TrigHisto1D.cxx.

                                               : TrigHisto() {
  m_nbins_x = trigHisto.m_nbins_x;
  m_min_x = trigHisto.m_min_x;
  m_max_x = trigHisto.m_max_x;
  m_contents = std::move(trigHisto.m_contents);
  m_binSize_x = trigHisto.m_binSize_x;
  m_underflowBin_x = trigHisto.m_underflowBin_x;
  m_overflowBin_x = trigHisto.m_overflowBin_x;
}

Member Function Documentation

clear()

void TrigHisto::clear ( void )

inherited

Zero all histogram bins.

Definition at line 24 of file TrigHisto.cxx.

                          {
  m_itr = m_contents.begin();
  m_itr_end = m_contents.end();
  for(; m_itr != m_itr_end; ++m_itr) (*m_itr) = 0.; 
}

contents()

const std::vector< float > & TrigHisto::contents ( void ) const

inlineinherited

Return the bin contents of the histogram, including the under and overflow bins.

Definition at line 58 of file TrigHisto.h.

                                               {
    return m_contents;
  }

fill()

void TrigHisto1D::fill	(	float	value_x,
		float	weight )

Fill a 1D histogram.

Definition at line 118 of file TrigHisto1D.cxx.

                                                  {
  const unsigned int ibin = findBin(m_nbins_x, m_min_x, m_max_x, m_binSize_x, value_x);
  
  m_contents[ibin] += weight; // Append the weight to this bin.
}

findBin()

unsigned int TrigHisto::findBin ( unsigned int nbins, float h_min, float h_max, float binSize, float value ) const

protectedinherited

Returns

which bin this value corresponds to. (Supply bin limits such that it might be used for 1D or 2D derived class.)

Definition at line 33 of file TrigHisto.cxx.

                                   {
  unsigned int ibin = 0;
  
  if(value < h_min) { // Underflow
    ibin = 0;
  }
  else if( !(value < h_max)) { // Overflow (catches NaN)
    ibin = nbins+1;
  }
  else {
    while(value > (ibin*binSize+h_min) && ibin <= nbins) { // None under/overflow from 1 to nbins
      ibin++;
    }
  }
  
  return ibin;
}

max_x()

float TrigHisto::max_x ( void ) const

inlineinherited

Return the maximum along the x-axis.

Definition at line 52 of file TrigHisto.h.

                          {
    return m_max_x;
  }

min_x()

float TrigHisto::min_x ( void ) const

inlineinherited

Return the minimum along the x-axis.

Definition at line 47 of file TrigHisto.h.

                          {
    return m_min_x;
  }

nbins_x()

unsigned int TrigHisto::nbins_x ( void ) const

inlineinherited

Return the number of bins along the y-axis, not including the under and overflow.

Definition at line 42 of file TrigHisto.h.

                                   {
    return m_nbins_x;
  }

operator=() [1/2]

TrigHisto1D & TrigHisto1D::operator=

(

const TrigHisto1D &

trigHisto

)

Assignment operator.

Definition at line 88 of file TrigHisto1D.cxx.

                                                                {
  if (this != &trigHisto) {
    m_nbins_x = trigHisto.m_nbins_x;
    m_min_x = trigHisto.m_min_x;
    m_max_x = trigHisto.m_max_x;
    m_contents = trigHisto.m_contents;
    m_binSize_x = trigHisto.m_binSize_x;
    m_underflowBin_x = trigHisto.m_underflowBin_x;
    m_overflowBin_x = trigHisto.m_overflowBin_x;
  }
  return *this;
}

operator=() [2/2]

TrigHisto1D & TrigHisto1D::operator=

(

TrigHisto1D &&

trigHisto

)

Definition at line 103 of file TrigHisto1D.cxx.

                                                           {
  if (this != &trigHisto) {
    m_nbins_x = trigHisto.m_nbins_x;
    m_min_x = trigHisto.m_min_x;
    m_max_x = trigHisto.m_max_x;
    m_contents = std::move(trigHisto.m_contents);
    m_binSize_x = trigHisto.m_binSize_x;
    m_underflowBin_x = trigHisto.m_underflowBin_x;
    m_overflowBin_x = trigHisto.m_overflowBin_x;
  }
  return *this;
}

sumEntries()

double TrigHisto1D::sumEntries	(	float	value_x,
		int	cutType ) const

Sum the number of entries within the cut range.

Definition at line 126 of file TrigHisto1D.cxx.

                                                               {
  // Find which bin contains the value_x.
  const unsigned int ibin_x_selected = findBin(m_nbins_x, m_min_x, m_max_x, m_binSize_x, value_x);
  
  double entries = 0.;
 
  if( m_nbins_x==0 ){
    return 0;
  }
  else{
 
    if (cutType == BELOW_X) {
      for(unsigned int ibin_x = m_underflowBin_x; ibin_x <= ibin_x_selected; ibin_x++) {
    entries += m_contents[ibin_x];
      }
    }
    else if(cutType == ABOVE_X) {
      for(unsigned int ibin_x = ibin_x_selected; ibin_x <= m_overflowBin_x; ibin_x++) {
    entries += m_contents[ibin_x];
      }
    }
    else {
      return 0; //<! Should report error message.
    }
  }
 
  return entries;
}

Member Data Documentation

m_binSize_x

float TrigHisto::m_binSize_x

protectedinherited

Definition at line 81 of file TrigHisto.h.

m_contents

std::vector<float> TrigHisto::m_contents

protectedinherited

Definition at line 71 of file TrigHisto.h.

m_itr

std::vector<float>::iterator TrigHisto::m_itr {}

protectedinherited

Definition at line 72 of file TrigHisto.h.

{};

m_itr_end

std::vector<float>::iterator TrigHisto::m_itr_end {}

protectedinherited

Definition at line 73 of file TrigHisto.h.

{};

m_max_x

float TrigHisto::m_max_x

protectedinherited

Definition at line 80 of file TrigHisto.h.

m_min_x

float TrigHisto::m_min_x

protectedinherited

Definition at line 79 of file TrigHisto.h.

m_nbins_x

unsigned int TrigHisto::m_nbins_x

protectedinherited

Definition at line 76 of file TrigHisto.h.

m_overflowBin_x

unsigned int TrigHisto::m_overflowBin_x

protectedinherited

Definition at line 78 of file TrigHisto.h.

m_underflowBin_x

unsigned int TrigHisto::m_underflowBin_x

protectedinherited

Definition at line 77 of file TrigHisto.h.

---

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

• TrigHisto1D.h
• TrigHisto1D.cxx