Interface to a histogram/profile. More...

#include <Histogram.h>

Inheritance diagram for cbm::algo::qa::Histogram< Axes, Storage, TotalSums >:

Collaboration diagram for cbm::algo::qa::Histogram< Axes, Storage, TotalSums >:

Public Member Functions
	~Histogram ()=default
	Destructor.

template<EAxis A, unsigned IA = static_cast<unsigned>(A), std::enable_if_t<(IA< Rank), bool > = true>
double	GetAxisMin () const
	Gets range lower bound of the selected axis.

template<EAxis A, unsigned IA = static_cast<unsigned>(A), std::enable_if_t<(IA< Rank), bool > = true>
double	GetAxisMax () const
	Gets range upper bound of the selected axis.

template<EAxis A, unsigned IA = static_cast<unsigned>(A), std::enable_if_t<(IA< Rank), bool > = true>
uint32_t	GetAxisNbins () const
	Gets number of bins in axis.

double	GetEntries () const
	Gets number of entries.

bool	GetFlag (EHistFlag key) const
	Get flag.

const std::string &	GetName () const
	Gets name.

const HistogramMetadata &	GetMetadata () const
	Gets metadata instance.

std::string	GetMetadataString () const
	Gets metadata string.

uint32_t	GetNbinsX () const
	Gets number of bins for x axis.

double	GetMinX () const
	Gets x-axis lower bound.

double	GetMaxX () const
	Gets x-axis lower bound.

template<unsigned RankCheck = Rank, std::enable_if_t<(RankCheck > 1), bool > = true>
uint32_t	GetNbinsY () const
	Gets number of bins for y axis.

template<unsigned RankCheck = Rank, std::enable_if_t<(RankCheck > 1), bool > = true>
double	GetMinY () const
	Gets y-axis lower bound.

template<unsigned RankCheck = Rank, std::enable_if_t<(RankCheck > 1), bool > = true>
double	GetMaxY () const
	Gets y-axis lower bound.

double	GetMaximum () const
	Gets maximum value.

double	GetMinimum () const
	Gets minimum value.

const std::string &	GetTitle () const
	Gets title.

void	Reset ()
	Resets the histogram.

void	SetFlag (EHistFlag key, bool flag=true)
	Get flag.

void	SetName (const std::string &name)
	Sets name.

void	SetTitle (const std::string &title)
	Sets title.

Protected Types
using	Hist_t = bh::histogram<Axes, Storage>

Protected Member Functions
	Histogram ()=default
	String representation of the histogram/profile.

	Histogram (const Histogram< Axes, Storage, TotalSums > &h)=default
	Copy constructor.

	Histogram (const Hist_t &bhist, const std::string &name, const std::string title)
	Constructor.

Static Protected Member Functions
static int	GetBinBH (uint32_t iBin)
	Gets bin index in underlying boost histogram.

Protected Attributes
Hist_t	fHistogram
	Underlying boost histogram.

std::string	fName = ""
	Name of the histogram.

std::string	fTitle = ""
	Title of the histogram.

int	fEntries = 0
	Number of histogram entries.

HistogramMetadata	fMetadata
	Meta-data for histogram.

Static Protected Attributes
static constexpr unsigned	Rank = std::tuple_size_v<Axes>

Private Member Functions
template<class Archive>
void	serialize (Archive &ar, const unsigned int)
	Serialization rule.

Friends
class	boost::serialization::access

Detailed Description

template<class Axes, class Storage, class TotalSums>
class cbm::algo::qa::Histogram< Axes, Storage, TotalSums >

Interface to a histogram/profile.

Template Parameters

Axes	The axes type
Storage	Storage type for the histogram
TotalSums	Class for storing the total sums of weights for axes (essential to calculate mean and std.dev.)

Definition at line 251 of file Histogram.h.

Member Typedef Documentation

◆ Hist_t

template<class Axes, class Storage, class TotalSums>

using cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Hist_t = bh::histogram<Axes, Storage>

protected

Definition at line 253 of file Histogram.h.

Constructor & Destructor Documentation

◆ ~Histogram()

template<class Axes, class Storage, class TotalSums>

cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::~Histogram ( )

default

Destructor.

◆ Histogram() [1/3]

template<class Axes, class Storage, class TotalSums>

cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Histogram ( )

protecteddefault

String representation of the histogram/profile.

Default constructor

◆ Histogram() [2/3]

template<class Axes, class Storage, class TotalSums>

cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Histogram ( const Histogram< Axes, Storage, TotalSums > & h )

explicitprotecteddefault

Copy constructor.

◆ Histogram() [3/3]

template<class Axes, class Storage, class TotalSums>

cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Histogram	(	const Hist_t &	bhist,
		const std::string &	name,
		const std::string	title )

inlineprotected

Constructor.

Parameters

bhist	Boost histogram object
name	Name of the histogram
title	Title of the histogram

Definition at line 399 of file Histogram.h.

Member Function Documentation

◆ GetAxisMax()

template<class Axes, class Storage, class TotalSums>

template<EAxis A, unsigned IA = static_cast<unsigned>(A), std::enable_if_t<(IA< Rank), bool > = true>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetAxisMax ( ) const

inline

Gets range upper bound of the selected axis.

Template Parameters

AxisType An axis

Definition at line 271 of file Histogram.h.

Referenced by cbm::algo::qa::Histogram< Axes1D_t, HistStorage_t, TotalSums1D >::GetMaxX(), and cbm::algo::qa::Histogram< Axes1D_t, HistStorage_t, TotalSums1D >::GetMaxY().

◆ GetAxisMin()

template<class Axes, class Storage, class TotalSums>

template<EAxis A, unsigned IA = static_cast<unsigned>(A), std::enable_if_t<(IA< Rank), bool > = true>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetAxisMin ( ) const

inline

Gets range lower bound of the selected axis.

Template Parameters

AxisType An axis

Definition at line 263 of file Histogram.h.

Referenced by cbm::algo::qa::Histogram< Axes1D_t, HistStorage_t, TotalSums1D >::GetMinX(), and cbm::algo::qa::Histogram< Axes1D_t, HistStorage_t, TotalSums1D >::GetMinY().

◆ GetAxisNbins()

template<class Axes, class Storage, class TotalSums>

template<EAxis A, unsigned IA = static_cast<unsigned>(A), std::enable_if_t<(IA< Rank), bool > = true>

uint32_t cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetAxisNbins ( ) const

inline

Gets number of bins in axis.

Template Parameters

AxisT	An axis
D

Definition at line 280 of file Histogram.h.

Referenced by cbm::algo::qa::Histogram< Axes1D_t, HistStorage_t, TotalSums1D >::GetNbinsX(), and cbm::algo::qa::Histogram< Axes1D_t, HistStorage_t, TotalSums1D >::GetNbinsY().

◆ GetBinBH()

template<class Axes, class Storage, class TotalSums>

static int cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetBinBH ( uint32_t iBin )

inlinestaticprotected

Gets bin index in underlying boost histogram.

Parameters

iBin	Bin in histogram

Returns: Bin in boost histogram

Definition at line 411 of file Histogram.h.

◆ GetEntries()

template<class Axes, class Storage, class TotalSums>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetEntries ( ) const

inline

Gets number of entries.

Definition at line 287 of file Histogram.h.

Referenced by CbmTaskDigiEventQa::ToTH1D().

◆ GetFlag()

template<class Axes, class Storage, class TotalSums>

bool cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetFlag ( EHistFlag key ) const

inline

Get flag.

Parameters

key	Flag key from the EHistFlag enumeration

Definition at line 295 of file Histogram.h.

◆ GetMaximum()

template<class Axes, class Storage, class TotalSums>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMaximum ( ) const

inline

Gets maximum value.

Definition at line 337 of file Histogram.h.

◆ GetMaxX()

template<class Axes, class Storage, class TotalSums>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMaxX ( ) const

inline

Gets x-axis lower bound.

Definition at line 313 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), and CbmTaskDigiEventQa::ToTH1D().

◆ GetMaxY()

template<class Axes, class Storage, class TotalSums>

template<unsigned RankCheck = Rank, std::enable_if_t<(RankCheck > 1), bool > = true>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMaxY ( ) const

inline

Gets y-axis lower bound.

Definition at line 331 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), and cbm::qa::OnlineInterface::ROOTHistogram().

◆ GetMetadata()

template<class Axes, class Storage, class TotalSums>

const HistogramMetadata & cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMetadata ( ) const

inline

Gets metadata instance.

Definition at line 301 of file Histogram.h.

◆ GetMetadataString()

template<class Axes, class Storage, class TotalSums>

std::string cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMetadataString ( ) const

inline

Gets metadata string.

Definition at line 304 of file Histogram.h.

◆ GetMinimum()

template<class Axes, class Storage, class TotalSums>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMinimum ( ) const

inline

Gets minimum value.

Definition at line 343 of file Histogram.h.

◆ GetMinX()

template<class Axes, class Storage, class TotalSums>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMinX ( ) const

inline

Gets x-axis lower bound.

Definition at line 310 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), and CbmTaskDigiEventQa::ToTH1D().

◆ GetMinY()

template<class Axes, class Storage, class TotalSums>

template<unsigned RankCheck = Rank, std::enable_if_t<(RankCheck > 1), bool > = true>

double cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMinY ( ) const

inline

Gets y-axis lower bound.

Definition at line 324 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), and cbm::qa::OnlineInterface::ROOTHistogram().

◆ GetName()

template<class Axes, class Storage, class TotalSums>

const std::string & cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetName ( ) const

inline

Gets name.

Definition at line 298 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), and CbmTaskDigiEventQa::ToTH1D().

◆ GetNbinsX()

template<class Axes, class Storage, class TotalSums>

uint32_t cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetNbinsX ( ) const

inline

Gets number of bins for x axis.

Definition at line 307 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), and CbmTaskDigiEventQa::ToTH1D().

◆ GetNbinsY()

template<class Axes, class Storage, class TotalSums>

template<unsigned RankCheck = Rank, std::enable_if_t<(RankCheck > 1), bool > = true>

uint32_t cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetNbinsY ( ) const

inline

Gets number of bins for y axis.

Definition at line 317 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), and cbm::qa::OnlineInterface::ROOTHistogram().

◆ GetTitle()

template<class Axes, class Storage, class TotalSums>

const std::string & cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetTitle ( ) const

inline

Gets title.

Definition at line 349 of file Histogram.h.

Referenced by cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), cbm::qa::OnlineInterface::ROOTHistogram(), and cbm::qa::OnlineInterface::ROOTHistogram().

◆ Reset()

template<class Axes, class Storage, class TotalSums>

void cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Reset ( )

inline

Resets the histogram.

Definition at line 352 of file Histogram.h.

◆ serialize()

template<class Axes, class Storage, class TotalSums>

template<class Archive>

void cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::serialize	(	Archive &	ar,
		const unsigned int	)

inlineprivate

Serialization rule.

Definition at line 424 of file Histogram.h.

◆ SetFlag()

template<class Axes, class Storage, class TotalSums>

void cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::SetFlag	(	EHistFlag	key,
		bool	flag = true )

inline

Get flag.

Parameters

key	Flag key from the EHistFlag enumeration
flag	Flag value

Definition at line 362 of file Histogram.h.

◆ SetName()

template<class Axes, class Storage, class TotalSums>

void cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::SetName ( const std::string & name )

inline

Sets name.

Parameters

name	Histogram name

Definition at line 366 of file Histogram.h.

◆ SetTitle()

template<class Axes, class Storage, class TotalSums>

void cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::SetTitle ( const std::string & title )

inline

Sets title.

Parameters

title Histogram title

Note: ROOT axes convention is applicable: "<main title>;<x-axis title>;<y-axis title>"

Definition at line 371 of file Histogram.h.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<class Axes, class Storage, class TotalSums>

friend class boost::serialization::access

friend

Definition at line 421 of file Histogram.h.

Member Data Documentation

◆ fEntries

template<class Axes, class Storage, class TotalSums>

int cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fEntries = 0

protected

Number of histogram entries.

Definition at line 416 of file Histogram.h.

◆ fHistogram

template<class Axes, class Storage, class TotalSums>

Hist_t cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram

protected

Underlying boost histogram.

Definition at line 413 of file Histogram.h.

◆ fMetadata

template<class Axes, class Storage, class TotalSums>

HistogramMetadata cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fMetadata

protected

Meta-data for histogram.

Definition at line 417 of file Histogram.h.

◆ fName

template<class Axes, class Storage, class TotalSums>

std::string cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fName = ""

protected

Name of the histogram.

Definition at line 414 of file Histogram.h.

◆ fTitle

template<class Axes, class Storage, class TotalSums>

std::string cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fTitle = ""

protected

Title of the histogram.

Definition at line 415 of file Histogram.h.

◆ Rank

template<class Axes, class Storage, class TotalSums>

unsigned cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Rank = std::tuple_size_v<Axes>

staticconstexprprotected

Definition at line 254 of file Histogram.h.

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

Histogram.h

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ Hist_t

Constructor & Destructor Documentation

◆ ~Histogram()

◆ Histogram() [1/3]

◆ Histogram() [2/3]

◆ Histogram() [3/3]

Member Function Documentation

◆ GetAxisMax()

◆ GetAxisMin()

◆ GetAxisNbins()

◆ GetBinBH()

◆ GetEntries()

◆ GetFlag()

◆ GetMaximum()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMetadata()

◆ GetMetadataString()

◆ GetMinimum()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetNbinsX()

◆ GetNbinsY()

◆ GetTitle()

◆ Reset()

◆ serialize()

◆ SetFlag()

◆ SetName()

◆ SetTitle()

Friends And Related Symbol Documentation

◆ boost::serialization::access

Member Data Documentation

◆ fEntries

◆ fHistogram

◆ fMetadata

◆ fName

◆ fTitle

◆ Rank