Histogram Class Reference

Generic text-based plotting utility. More...

#include <CepGen/Utils/Histogram.h>

Inheritance diagram for Histogram:

Public Types
enum	BinMode { low = 0 , high , both }

Public Member Functions
	Histogram ()=default
virtual	~Histogram ()=default
virtual void	clear ()=0
	Reset the histogram.
virtual void	scale (double)=0
	Rescale all histogram bins by a constant factor.
virtual double	integral (bool include_out_of_range=false) const =0
	Compute the histogram integral.
virtual double	minimum () const =0
	Retrieve the maximum bin value.
virtual double	maximum () const =0
	Retrieve the minimum bin value.
void	normalise (double integ=1.)
	Normalise the histogram to a given constant.

Protected Member Functions
std::set< double >	extractBins (BinMode mode, size_t num_bins, const std::function< Limits(size_t)> &bins_extractor) const
	Extract the list of bin limits.

Detailed Description

Author

Laurent Forthomme laure.nosp@m.nt.f.nosp@m.ortho.nosp@m.mme@.nosp@m.cern..nosp@m.ch

Date

Jul 2019

Definition at line 41 of file Histogram.h.

Member Enumeration Documentation

BinMode

enum BinMode

Enumerator
low
high
both

Definition at line 46 of file Histogram.h.

Constructor & Destructor Documentation

Histogram()

Histogram ( )

default

~Histogram()

virtual ~Histogram ( )

virtualdefault

Member Function Documentation

clear()

virtual void clear ( )

pure virtual

Implemented in Hist1D, and Hist2D.

extractBins()

std::set< double > extractBins ( BinMode  mode, size_t  num_bins, const std::function< Limits(size_t)> &  bins_extractor  ) const

protected

Parameters

[in]	mode	type of extraction (low/high/low-high)
[in]	num_bins	total number of bins
[in]	bins_extractor	method used to extract range of one single bin

Definition at line 26 of file Histogram.cpp.

integral()

virtual double integral ( bool  include_out_of_range = false ) const

pure virtual

Implemented in Hist1D, and Hist2D.

maximum()

virtual double maximum ( ) const

pure virtual

Implemented in Hist1D, and Hist2D.

minimum()

virtual double minimum ( ) const

pure virtual

Implemented in Hist1D, and Hist2D.

normalise()

void normalise

(

double

integ = 1.

)

Definition at line 24 of file Histogram.cpp.

scale()

virtual void scale ( double  )

pure virtual

Implemented in Hist1D, and Hist2D.