TrigHisto2D Class Reference

A very basic two 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 <TrigHisto2D.h>

Inheritance diagram for TrigHisto2D:

Collaboration diagram for TrigHisto2D:

Public Member Functions
	TrigHisto2D (void)
	Default constructor used by T/P converters.
	TrigHisto2D (unsigned int nbins_x, float min_x, float max_x, unsigned int nbins_y, float min_y, float max_y)
	Standard constructor used by FEX algorithms.
	TrigHisto2D (unsigned int nbins_x, float min_x, float max_x, unsigned int nbins_y, float min_y, float max_y, const std::vector< float > &contents)
virtual	~TrigHisto2D (void)
	Destructor.
	TrigHisto2D (const TrigHisto2D &trigHisto)
	Copy Constructor.
	TrigHisto2D (TrigHisto2D &&trigHisto)
TrigHisto2D &	operator= (const TrigHisto2D &trigHisto)
	Assignment operator.
TrigHisto2D &	operator= (TrigHisto2D &&trigHisto)
void	fill (float value_x, float value_y, float weight)
	Fill a 2D histogram.
double	sumEntries (float value_x, float value_y, int cutType) const
	Sum the number of entries within the cut range.
TrigHisto1D	profileX (void) const
	Collapse the y-axis and return a profile from the x-axis.
TrigHisto1D	profileY (void) const
	Collapse the x-axis and return a profile from the y-axis.
unsigned int	nbins_y (void) const
	Return the number of bins along the y-axis, not including the under and overflow.
float	min_y (void) const
	Return the minimum along the y-axis.
float	max_y (void) const
	Return the maximum along the y-axis.
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
unsigned int	m_nbins_y
unsigned int	m_underflowBin_y
unsigned int	m_overflowBin_y
float	m_min_y
float	m_max_y
float	m_binSize_y
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 two 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 24 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

Constructor & Destructor Documentation

TrigHisto2D() [1/5]

TrigHisto2D::TrigHisto2D

(

void

)

Default constructor used by T/P converters.

Definition at line 11 of file TrigHisto2D.cxx.

                        : TrigHisto(),
                m_nbins_y(0),
                m_underflowBin_y(0),
                m_overflowBin_y(0),
                m_min_y(0.),
                m_max_y(0.),
                m_binSize_y(0.) { 
}

TrigHisto2D() [2/5]

TrigHisto2D::TrigHisto2D	(	unsigned int	nbins_x,
		float	min_x,
		float	max_x,
		unsigned int	nbins_y,
		float	min_y,
		float	max_y )

Standard constructor used by FEX algorithms.

Definition at line 59 of file TrigHisto2D.cxx.

  : TrigHisto2D (nbins_x, min_x, max_x, nbins_y, min_y, max_y,
                 std::vector<float>())
{
}

TrigHisto2D() [3/5]

TrigHisto2D::TrigHisto2D	(	unsigned int	nbins_x,
		float	min_x,
		float	max_x,
		unsigned int	nbins_y,
		float	min_y,
		float	max_y,
		const std::vector< float > &	contents )

Definition at line 22 of file TrigHisto2D.cxx.

                                                  : TrigHisto(),
                            m_nbins_y(nbins_y),
                            m_min_y(min_y),
                            m_max_y(max_y) {
  m_nbins_x = nbins_x;
  m_min_x = min_x;
  m_max_x = max_x;
  
  unsigned int nbins = (nbins_x+2)*(nbins_y+2); // Two additional bins for under and overflow per 1d profile.
 
  m_contents = contents;
  m_contents.resize(nbins, 0.); // Two additional bins for under and overflow per 1d profile.
 
  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.;
  }
  if(m_nbins_y != 0) {
    m_binSize_y = (m_max_y - m_min_y)/((float)m_nbins_y); // Calculate bin size.
  }
  else {
    m_binSize_y = 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.
  m_underflowBin_y = 0; // Cache this to make the code more readable.
  m_overflowBin_y = m_nbins_y+1; // Cache this to make the code more readable and faster.
} 

~TrigHisto2D()

TrigHisto2D::~TrigHisto2D ( void )

virtual

Destructor.

Definition at line 71 of file TrigHisto2D.cxx.

                          {
}

TrigHisto2D() [4/5]

TrigHisto2D::TrigHisto2D

(

const TrigHisto2D &

trigHisto

)

Copy Constructor.

Definition at line 76 of file TrigHisto2D.cxx.

                                                    : TrigHisto() {  
  m_nbins_x = trigHisto.m_nbins_x;
  m_min_x = trigHisto.m_min_x;
  m_max_x = trigHisto.m_max_x;
  
  m_nbins_y = trigHisto.m_nbins_y;
  m_min_y = trigHisto.m_min_y;
  m_max_y = trigHisto.m_max_y;
  
  m_contents = trigHisto.m_contents;
 
  m_binSize_x = trigHisto.m_binSize_x;
  m_binSize_y = trigHisto.m_binSize_y;
 
  m_underflowBin_x = trigHisto.m_underflowBin_x;
  m_overflowBin_x = trigHisto.m_overflowBin_x; 
  m_underflowBin_y = trigHisto.m_underflowBin_y;
  m_overflowBin_y = trigHisto.m_overflowBin_y;
}

TrigHisto2D() [5/5]

TrigHisto2D::TrigHisto2D

(

TrigHisto2D &&

trigHisto

)

Definition at line 98 of file TrigHisto2D.cxx.

                                               : TrigHisto() {  
  m_nbins_x = trigHisto.m_nbins_x;
  m_min_x = trigHisto.m_min_x;
  m_max_x = trigHisto.m_max_x;
  
  m_nbins_y = trigHisto.m_nbins_y;
  m_min_y = trigHisto.m_min_y;
  m_max_y = trigHisto.m_max_y;
  
  m_contents = std::move(trigHisto.m_contents);
 
  m_binSize_x = trigHisto.m_binSize_x;
  m_binSize_y = trigHisto.m_binSize_y;
 
  m_underflowBin_x = trigHisto.m_underflowBin_x;
  m_overflowBin_x = trigHisto.m_overflowBin_x; 
  m_underflowBin_y = trigHisto.m_underflowBin_y;
  m_overflowBin_y = trigHisto.m_overflowBin_y;
}

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 TrigHisto2D::fill	(	float	value_x,
		float	value_y,
		float	weight )

Fill a 2D histogram.

Definition at line 170 of file TrigHisto2D.cxx.

                                                                 {
  const unsigned int ibin_x = findBin(m_nbins_x, m_min_x, m_max_x, m_binSize_x, value_x);
  const unsigned int ibin_y = findBin(m_nbins_y, m_min_y, m_max_y, m_binSize_y, value_y);
  
  const unsigned int ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
 
  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;
  }

max_y()

float TrigHisto2D::max_y ( void ) const

inline

Return the maximum along the y-axis.

Definition at line 73 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

                          {
    return m_max_y;
  }

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;
  }

min_y()

float TrigHisto2D::min_y ( void ) const

inline

Return the minimum along the y-axis.

Definition at line 68 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

                          {
    return m_min_y;
  }

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;
  }

nbins_y()

unsigned int TrigHisto2D::nbins_y ( void ) const

inline

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

Definition at line 63 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

                                   {
    return m_nbins_y;
  }

operator=() [1/2]

TrigHisto2D & TrigHisto2D::operator=

(

const TrigHisto2D &

trigHisto

)

Assignment operator.

Definition at line 120 of file TrigHisto2D.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_nbins_y = trigHisto.m_nbins_y;
    m_min_y = trigHisto.m_min_y;
    m_max_y = trigHisto.m_max_y;
  
    m_contents = trigHisto.m_contents;
 
    m_binSize_x = trigHisto.m_binSize_x;
    m_binSize_y = trigHisto.m_binSize_y;
 
    m_underflowBin_x = trigHisto.m_underflowBin_x;
    m_overflowBin_x = trigHisto.m_overflowBin_x; 
    m_underflowBin_y = trigHisto.m_underflowBin_y;
    m_overflowBin_y = trigHisto.m_overflowBin_y;
  }
  return *this;
}

operator=() [2/2]

TrigHisto2D & TrigHisto2D::operator=

(

TrigHisto2D &&

trigHisto

)

Definition at line 145 of file TrigHisto2D.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_nbins_y = trigHisto.m_nbins_y;
    m_min_y = trigHisto.m_min_y;
    m_max_y = trigHisto.m_max_y;
  
    m_contents = std::move(trigHisto.m_contents);
 
    m_binSize_x = trigHisto.m_binSize_x;
    m_binSize_y = trigHisto.m_binSize_y;
 
    m_underflowBin_x = trigHisto.m_underflowBin_x;
    m_overflowBin_x = trigHisto.m_overflowBin_x; 
    m_underflowBin_y = trigHisto.m_underflowBin_y;
    m_overflowBin_y = trigHisto.m_overflowBin_y;
  }
  return *this;
}

profileX()

TrigHisto1D TrigHisto2D::profileX

(

void

)

const

Collapse the y-axis and return a profile from the x-axis.

Definition at line 238 of file TrigHisto2D.cxx.

                                            {
  unsigned int ibin, ibin_x, ibin_y;
 
  // Define size carefully to avoid memory problems in for loop.
  std::vector<float> contents((m_overflowBin_x-m_underflowBin_x+1),0.);
 
  // Sum all y bins for each x bin.
  for(ibin_x = m_underflowBin_x; ibin_x <= m_overflowBin_x; ibin_x++) {
    for(ibin_y = m_underflowBin_y; ibin_y <= m_overflowBin_y; ibin_y++) {
      ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
      contents[ibin_x] += m_contents[ibin];
    }
  }
 
  // Return a 1D histogram containing the profile contents.
  return TrigHisto1D(m_nbins_x, m_min_x, m_max_x, contents);
}

profileY()

TrigHisto1D TrigHisto2D::profileY

(

void

)

const

Collapse the x-axis and return a profile from the y-axis.

Definition at line 258 of file TrigHisto2D.cxx.

                                            {
  // Define size carefully to avoid memory problems in for loop.
  std::vector<float> contents((m_overflowBin_y-m_underflowBin_y+1),0.);
 
  // Sum all x bins for each y bin.
  for(unsigned int ibin_y = m_underflowBin_y; ibin_y <= m_overflowBin_y; ibin_y++) {
    for(unsigned int ibin_x = m_underflowBin_x; ibin_x <= m_overflowBin_x; ibin_x++) {
      const unsigned int ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
      contents[ibin_y] += m_contents[ibin];
    }
  }
 
  // Return a 1D histogram containing the profile contents.
  return TrigHisto1D(m_nbins_y, m_min_y, m_max_y, contents);
}

sumEntries()

double TrigHisto2D::sumEntries	(	float	value_x,
		float	value_y,
		int	cutType ) const

Sum the number of entries within the cut range.

Definition at line 181 of file TrigHisto2D.cxx.

                                                                              {
  // Find the x bin index that the cut corresponds to.
  const unsigned int ibin_x_selected = findBin(m_nbins_x, m_min_x, m_max_x, m_binSize_x, value_x);
  
  // Find the y bin index that the cut corresponds to.
  const unsigned int ibin_y_selected = findBin(m_nbins_y, m_min_y, m_max_y, m_binSize_y, value_y);
  
  double entries = 0.;
  
  
  if( m_nbins_x==0 || m_nbins_y==0 ){
    return 0;
  }
  else{
 
    if(cutType == BELOW_X_BELOW_Y) {
      for(unsigned int ibin_x = m_underflowBin_x; ibin_x <= ibin_x_selected; ibin_x++) {
    for(unsigned int ibin_y = m_underflowBin_y; ibin_y <= ibin_y_selected; ibin_y++) {
      const unsigned int ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
      entries += m_contents[ibin];
    }
      }
    }
    else if(cutType == ABOVE_X_BELOW_Y) {
      for(unsigned int ibin_x = ibin_x_selected; ibin_x <= m_overflowBin_x; ibin_x++) {
    for(unsigned int ibin_y = m_underflowBin_y; ibin_y <= ibin_y_selected; ibin_y++) {
      const unsigned int ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
      entries += m_contents[ibin];
    }
      }
    }
    else if(cutType == BELOW_X_ABOVE_Y) {
      for(unsigned int ibin_x = m_underflowBin_x; ibin_x <= ibin_x_selected; ibin_x++) {
    for(unsigned int ibin_y = ibin_y_selected; ibin_y <= m_overflowBin_y; ibin_y++) {
      const unsigned int ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
      entries += m_contents[ibin];
    }
      }
    }
    else if(cutType == ABOVE_X_ABOVE_Y) {   
      for(unsigned int ibin_x = ibin_x_selected; ibin_x <= m_overflowBin_x; ibin_x++) {
    for(unsigned int ibin_y = ibin_y_selected; ibin_y <= m_overflowBin_y; ibin_y++) {
      const unsigned int ibin = ibin_y*(m_nbins_x+2) + ibin_x; // Find position in 1d data array
      entries += m_contents[ibin];
    }
      }
    }
    else {
      return 0;
    }
  }// else of m_nbins!=0
  
  return entries;
}

Member Data Documentation

m_binSize_x

float TrigHisto::m_binSize_x

protectedinherited

Definition at line 81 of file TrigHisto.h.

m_binSize_y

float TrigHisto2D::m_binSize_y

protected

Definition at line 85 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.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_max_y

float TrigHisto2D::m_max_y

protected

Definition at line 84 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

m_min_x

float TrigHisto::m_min_x

protectedinherited

Definition at line 79 of file TrigHisto.h.

m_min_y

float TrigHisto2D::m_min_y

protected

Definition at line 83 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

m_nbins_x

unsigned int TrigHisto::m_nbins_x

protectedinherited

Definition at line 76 of file TrigHisto.h.

m_nbins_y

unsigned int TrigHisto2D::m_nbins_y

protected

Definition at line 80 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

m_overflowBin_x

unsigned int TrigHisto::m_overflowBin_x

protectedinherited

Definition at line 78 of file TrigHisto.h.

m_overflowBin_y

unsigned int TrigHisto2D::m_overflowBin_y

protected

Definition at line 82 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

m_underflowBin_x

unsigned int TrigHisto::m_underflowBin_x

protectedinherited

Definition at line 77 of file TrigHisto.h.

m_underflowBin_y

unsigned int TrigHisto2D::m_underflowBin_y

protected

Definition at line 81 of file Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h.

---

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

• Trigger/TrigEvent/TrigInDetEvent/TrigInDetEvent/TrigHisto2D.h
• TrigHisto2D.cxx