Gaudi::Accumulators::Axis< Arithmetic > Class Template Reference

Definition of a default type of Histogram Axis It contains number of bins, min and max value plus a title and defines the basic type of Axis (non log) It may also contain labels for the bins. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Accumulators/StaticHistogram.h>

Collaboration diagram for Gaudi::Accumulators::Axis< Arithmetic >:

Public Types
using	ArithmeticType = Arithmetic

Public Member Functions
	Axis (unsigned int nBins=0, Arithmetic minValue=Arithmetic{}, Arithmetic maxValue=Arithmetic{}, std::string title={}, std::vector< std::string > labels={})
	Axis (Gaudi::Histo1DDef const &def)
unsigned int	index (Arithmetic value) const
	returns the bin number for a given value, ranging from 0 (underflow) to nBins+1 (overflow) More...
bool	inAcceptance (Arithmetic value) const
	says whether the given value is within the range of the axis More...
unsigned int	numBins () const
void	setNumBins (unsigned int n)
Arithmetic	minValue () const
void	setMinValue (Arithmetic v)
Arithmetic	maxValue () const
void	setMaxValue (Arithmetic v)
std::string const &	title () const
void	setTitle (std::string const &t)
std::vector< std::string > const	labels () const

Public Attributes
unsigned int	nBins
	number of bins for this Axis FIXME : should be private and called m_nBins but will break backward compatibility with previous implementation. More...

Private Member Functions
void	recomputeRatio ()

Private Attributes
std::string	m_title
	title of this axis More...
Arithmetic	m_minValue
	min and max values on this axis More...
Arithmetic	m_maxValue
Arithmetic	m_ratio
	precomputed ratio to convert a value into bin number equal to nBins/(maxValue-minValue). More...
std::vector< std::string >	m_labels
	labels for the bins More...

Friends
std::ostream &	operator<< (std::ostream &o, Axis const &axis)

Detailed Description

template<typename Arithmetic>
class Gaudi::Accumulators::Axis< Arithmetic >

Definition of a default type of Histogram Axis It contains number of bins, min and max value plus a title and defines the basic type of Axis (non log) It may also contain labels for the bins.

Definition at line 218 of file StaticHistogram.h.

Member Typedef Documentation

ArithmeticType

template<typename Arithmetic >

using Gaudi::Accumulators::Axis< Arithmetic >::ArithmeticType = Arithmetic

Definition at line 220 of file StaticHistogram.h.

Constructor & Destructor Documentation

Axis() [1/2]

template<typename Arithmetic >

Gaudi::Accumulators::Axis< Arithmetic >::Axis ( unsigned int  nBins = 0, Arithmetic  minValue = Arithmetic{}, Arithmetic  maxValue = Arithmetic{}, std::string  title = {}, std::vector< std::string >  labels = {}  )

inline

Definition at line 221 of file StaticHistogram.h.

                                                                  {}, Arithmetic maxValue = Arithmetic{},
          std::string title = {}, std::vector<std::string> labels = {} )
        : m_title( std::move( title ) )
        , nBins( nBins )
        , m_minValue( minValue )
        , m_maxValue( maxValue )
        , m_labels( std::move( labels ) ) {
      details::requireValidTitle( m_title );
      recomputeRatio();
      for ( const auto& s : m_labels ) details::requireValidTitle( s );
    };

Axis() [2/2]

template<typename Arithmetic >

Gaudi::Accumulators::Axis< Arithmetic >::Axis ( Gaudi::Histo1DDef const &  def )

inlineexplicit

Definition at line 232 of file StaticHistogram.h.

        : Axis( (unsigned int)def.bins(), def.lowEdge(), def.highEdge(), def.title() ){};

Member Function Documentation

inAcceptance()

template<typename Arithmetic >

bool Gaudi::Accumulators::Axis< Arithmetic >::inAcceptance ( Arithmetic  value ) const

inline

says whether the given value is within the range of the axis

Definition at line 258 of file StaticHistogram.h.

{ return value >= m_minValue && value <= m_maxValue; }

index()

template<typename Arithmetic >

unsigned int Gaudi::Accumulators::Axis< Arithmetic >::index ( Arithmetic  value ) const

inline

returns the bin number for a given value, ranging from 0 (underflow) to nBins+1 (overflow)

Definition at line 236 of file StaticHistogram.h.

                                                 {
      // In case we use integer as Arithmetic type, we cannot use ratio for computing indices,
      // as ratios < 1.0 will simply be 0, so we have to pay the division in such a case
      int idx;
      if constexpr ( std::is_integral_v<Arithmetic> ) {
        idx = ( ( value - m_minValue ) * nBins / ( m_maxValue - m_minValue ) ) + 1;
      } else {
        idx = std::floor( ( value - m_minValue ) * m_ratio ) + 1;
      }
      return idx < 0 ? 0 : ( (unsigned int)idx > numBins() ? numBins() + 1 : (unsigned int)idx );
    }

labels()

template<typename Arithmetic >

std::vector<std::string> const Gaudi::Accumulators::Axis< Arithmetic >::labels ( ) const

inline

Definition at line 278 of file StaticHistogram.h.

{ return m_labels; }

maxValue()

template<typename Arithmetic >

Arithmetic Gaudi::Accumulators::Axis< Arithmetic >::maxValue ( ) const

inline

Definition at line 271 of file StaticHistogram.h.

{ return m_maxValue; };

minValue()

template<typename Arithmetic >

Arithmetic Gaudi::Accumulators::Axis< Arithmetic >::minValue ( ) const

inline

Definition at line 266 of file StaticHistogram.h.

{ return m_minValue; };

numBins()

template<typename Arithmetic >

unsigned int Gaudi::Accumulators::Axis< Arithmetic >::numBins ( ) const

inline

Definition at line 261 of file StaticHistogram.h.

{ return nBins; };

recomputeRatio()

template<typename Arithmetic >

void Gaudi::Accumulators::Axis< Arithmetic >::recomputeRatio ( )

inlineprivate

Definition at line 300 of file StaticHistogram.h.

                          {
      m_ratio = ( m_maxValue == m_minValue ) ? Arithmetic{} : nBins / ( m_maxValue - m_minValue );
    }

setMaxValue()

template<typename Arithmetic >

void Gaudi::Accumulators::Axis< Arithmetic >::setMaxValue ( Arithmetic  v )

inline

Definition at line 272 of file StaticHistogram.h.

                                           {
      m_maxValue = v;
      recomputeRatio();
    }

setMinValue()

template<typename Arithmetic >

void Gaudi::Accumulators::Axis< Arithmetic >::setMinValue ( Arithmetic  v )

inline

Definition at line 267 of file StaticHistogram.h.

                                           {
      m_minValue = v;
      recomputeRatio();
    }

setNumBins()

template<typename Arithmetic >

void Gaudi::Accumulators::Axis< Arithmetic >::setNumBins ( unsigned int  n )

inline

Definition at line 262 of file StaticHistogram.h.

                                              {
      nBins = n;
      recomputeRatio();
    }

setTitle()

template<typename Arithmetic >

void Gaudi::Accumulators::Axis< Arithmetic >::setTitle ( std::string const &  t )

inline

Definition at line 277 of file StaticHistogram.h.

{ m_title = t; };

title()

template<typename Arithmetic >

std::string const& Gaudi::Accumulators::Axis< Arithmetic >::title ( ) const

inline

Definition at line 276 of file StaticHistogram.h.

{ return m_title; }

Friends And Related Function Documentation

operator<<

template<typename Arithmetic >

std::ostream& operator<< ( std::ostream &  o, Axis< Arithmetic > const &  axis  )

friend

Definition at line 248 of file StaticHistogram.h.

                                                                     {
      // Note that we print python code here, as the generic toStream implementation uses this
      // operator to generate python code.
      o << "(" << axis.numBins() << ", " << axis.minValue() << ", " << axis.maxValue() << ", "
        << "\"" << axis.m_title << "\", (";
      for ( auto const& label : axis.m_labels ) { o << "\"" << label << "\", "; }
      return o << "))";
    }

Member Data Documentation

m_labels

template<typename Arithmetic >

std::vector<std::string> Gaudi::Accumulators::Axis< Arithmetic >::m_labels

private

labels for the bins

Definition at line 298 of file StaticHistogram.h.

m_maxValue

template<typename Arithmetic >

Arithmetic Gaudi::Accumulators::Axis< Arithmetic >::m_maxValue

private

Definition at line 291 of file StaticHistogram.h.

m_minValue

template<typename Arithmetic >

Arithmetic Gaudi::Accumulators::Axis< Arithmetic >::m_minValue

private

min and max values on this axis

Definition at line 291 of file StaticHistogram.h.

m_ratio

template<typename Arithmetic >

Arithmetic Gaudi::Accumulators::Axis< Arithmetic >::m_ratio

private

precomputed ratio to convert a value into bin number equal to nBins/(maxValue-minValue).

Only used for floating Arithmetic

Definition at line 296 of file StaticHistogram.h.

m_title

template<typename Arithmetic >

std::string Gaudi::Accumulators::Axis< Arithmetic >::m_title

private

title of this axis

Definition at line 282 of file StaticHistogram.h.

nBins

template<typename Arithmetic >

unsigned int Gaudi::Accumulators::Axis< Arithmetic >::nBins

number of bins for this Axis FIXME : should be private and called m_nBins but will break backward compatibility with previous implementation.

Definition at line 287 of file StaticHistogram.h.

---

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

• GaudiKernel/include/Gaudi/Accumulators/StaticHistogram.h