TrigHisto Class Reference

The base class for TrigHisto1D and TrigHisto2D. This class should never be stored or used directly. More...

#include <TrigHisto.h>

Inheritance diagram for TrigHisto:

Collaboration diagram for TrigHisto:

Public Member Functions
	TrigHisto ()=default
	TrigHisto (TrigHisto &&)=default
	User declared d'tor means we have to explicitly enable move operations.
TrigHisto &	operator= (TrigHisto &&)=default
virtual	~TrigHisto ()=default
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 () const
	Return the minimum along the x-axis.
float	max_x () const
	Return the maximum along the x-axis.
const std::vector< float > &	contents () 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
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

The base class for TrigHisto1D and TrigHisto2D. This class should never be stored or used directly.

Author

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

Definition at line 32 of file TrigHisto.h.

Constructor & Destructor Documentation

TrigHisto() [1/2]

TrigHisto::TrigHisto ( )

default

TrigHisto() [2/2]

TrigHisto::TrigHisto ( TrigHisto && )

default

User declared d'tor means we have to explicitly enable move operations.

~TrigHisto()

virtual TrigHisto::~TrigHisto ( )

virtualdefault

Member Function Documentation

clear()

void TrigHisto::clear

(

void

)

Zero all histogram bins.

Definition at line 12 of file TrigHisto.cxx.

                          {
  for (auto& v : m_contents) {
    v = 0.f;
  }
}

contents()

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

inline

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

Definition at line 61 of file TrigHisto.h.

                                           {
    return m_contents;
  }

findBin()

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

protected

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 21 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 ( ) const

inline

Return the maximum along the x-axis.

Definition at line 55 of file TrigHisto.h.

                      {
    return m_max_x;
  }

min_x()

float TrigHisto::min_x ( ) const

inline

Return the minimum along the x-axis.

Definition at line 50 of file TrigHisto.h.

                      {
    return m_min_x;
  }

nbins_x()

unsigned int TrigHisto::nbins_x ( void ) const

inline

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

Definition at line 45 of file TrigHisto.h.

                                   {
    return m_nbins_x;
  }

operator=()

TrigHisto & TrigHisto::operator= ( TrigHisto && )

default

Member Data Documentation

m_binSize_x

float TrigHisto::m_binSize_x {}

protected

Definition at line 82 of file TrigHisto.h.

{};

m_contents

std::vector<float> TrigHisto::m_contents

protected

Definition at line 74 of file TrigHisto.h.

m_max_x

float TrigHisto::m_max_x {}

protected

Definition at line 81 of file TrigHisto.h.

{};

m_min_x

float TrigHisto::m_min_x {}

protected

Definition at line 80 of file TrigHisto.h.

{};

m_nbins_x

unsigned int TrigHisto::m_nbins_x {}

protected

Definition at line 77 of file TrigHisto.h.

{};

m_overflowBin_x

unsigned int TrigHisto::m_overflowBin_x {}

protected

Definition at line 79 of file TrigHisto.h.

{};

m_underflowBin_x

unsigned int TrigHisto::m_underflowBin_x {}

protected

Definition at line 78 of file TrigHisto.h.

{};

---

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

• TrigHisto.h
• TrigHisto.cxx