1D-histogram More...

#include <Histogram.h>

Inheritance diagram for cbm::algo::qa::H1D:

Collaboration diagram for cbm::algo::qa::H1D:

Public Member Functions
	H1D (const std::string &name, const std::string &title, uint32_t nBins, double xMin, double xMax)
	Constructor for 1D-histogram.

	H1D ()=default
	Default constructor.

	H1D (const H1D &)=default
	Copy constructor.

	H1D (H1D &&)=default
	Move constructor.

H1D &	operator= (const H1D &)=default
	Copy assignment operator.

H1D &	operator= (H1D &&)=default
	Move assignment operator.

int	Fill (double x, double w=1.)
	Fills histogram.

auto	GetBinAccumulator (uint32_t iBin) const
	Gets underlying bin accumulator.

double	GetBinContent (uint32_t iBin) const
	Gets bin content.

double	GetBinError (uint32_t iBin) const
	Gets bin error.

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>

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)

Friends
class	boost::serialization::access
	Serialization function.

Detailed Description

1D-histogram

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>

protectedinherited

Definition at line 252 of file Histogram.h.

Constructor & Destructor Documentation

◆ H1D() [1/4]

cbm::algo::qa::H1D::H1D	(	const std::string &	name,
		const std::string &	title,
		uint32_t	nBins,
		double	xMin,
		double	xMax )

inline

Constructor for 1D-histogram.

Parameters

name	Name of histogram
title	Title of histogram
nBins	Number of bins
xMin	Lower x bound
xMax	Upper x bound

Definition at line 449 of file Histogram.h.

◆ H1D() [2/4]

cbm::algo::qa::H1D::H1D ( )

default

Default constructor.

◆ H1D() [3/4]

cbm::algo::qa::H1D::H1D ( const H1D & )

default

Copy constructor.

◆ H1D() [4/4]

cbm::algo::qa::H1D::H1D ( H1D && )

default

Move constructor.

Member Function Documentation

◆ Fill()

int cbm::algo::qa::H1D::Fill	(	double	x,
		double	w = 1. )

inline

Fills histogram.

Parameters

x	Value
w	Weight

Returns: Bin number TODO: implement

Definition at line 473 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fEntries, cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram, cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetNbinsX(), and x.

Referenced by cbm::algo::ca::Qa::Exec(), cbm::algo::evbuild::DigiEventQa::FillDeltaT(), and cbm::algo::qa::RecoGeneralQa::operator()().

◆ 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

inlineinherited

Gets range upper bound of the selected axis.

Template Parameters

AxisType An axis

Definition at line 270 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram, and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetAxisNbins().

Referenced by cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMaxX(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::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

inlineinherited

Gets range lower bound of the selected axis.

Template Parameters

AxisType An axis

Definition at line 262 of file Histogram.h.

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

Referenced by cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMinX(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::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

inlineinherited

Gets number of bins in axis.

Template Parameters

AxisT	An axis
D

Definition at line 279 of file Histogram.h.

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

Referenced by cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetAxisMax(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetNbinsX(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetNbinsY().

◆ GetBinAccumulator()

auto cbm::algo::qa::H1D::GetBinAccumulator ( uint32_t iBin ) const

inline

Gets underlying bin accumulator.

Parameters

iBin Bin index

Definition at line 488 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram, and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetBinBH().

◆ GetBinBH()

template<class Axes , class Storage , class TotalSums >

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

inlinestaticprotectedinherited

Gets bin index in underlying boost histogram.

Parameters

iBin	Bin in histogram

Returns: Bin in boost histogram

Definition at line 410 of file Histogram.h.

◆ GetBinContent()

double cbm::algo::qa::H1D::GetBinContent ( uint32_t iBin ) const

inline

Gets bin content.

Parameters

iBin Bin index

Definition at line 492 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram, and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetBinBH().

Referenced by CbmTaskDigiEventQa::ToTH1D().

◆ GetBinError()

double cbm::algo::qa::H1D::GetBinError ( uint32_t iBin ) const

inline

Gets bin error.

Parameters

iBin Bin index

Definition at line 496 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram, and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetBinBH().

◆ GetEntries()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Gets number of entries.

Definition at line 286 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fEntries.

Referenced by CbmTaskDigiEventQa::ToTH1D().

◆ GetFlag()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Get flag.

Parameters

key	Flag key from the EHistFlag enumeration

Definition at line 294 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fMetadata, and cbm::algo::qa::HistogramMetadata::GetFlag().

◆ GetMaximum()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Gets maximum value.

Definition at line 336 of file Histogram.h.

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

◆ GetMaxX()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Gets x-axis lower bound.

Definition at line 312 of file Histogram.h.

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

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

inlineinherited

Gets y-axis lower bound.

Definition at line 330 of file Histogram.h.

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

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

inlineinherited

Gets metadata instance.

Definition at line 300 of file Histogram.h.

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

◆ GetMetadataString()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Gets metadata string.

Definition at line 303 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fMetadata, and cbm::algo::qa::HistogramMetadata::ToString().

◆ GetMinimum()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Gets minimum value.

Definition at line 342 of file Histogram.h.

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

◆ GetMinX()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Gets x-axis lower bound.

Definition at line 309 of file Histogram.h.

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

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

inlineinherited

Gets y-axis lower bound.

Definition at line 323 of file Histogram.h.

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

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

inlineinherited

Gets name.

Definition at line 297 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fName.

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

inlineinherited

Gets number of bins for x axis.

Definition at line 306 of file Histogram.h.

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

Referenced by Fill(), cbm::algo::qa::H2D::Fill(), cbm::algo::qa::Prof1D::Fill(), cbm::algo::qa::Prof2D::Fill(), 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

inlineinherited

Gets number of bins for y axis.

Definition at line 316 of file Histogram.h.

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

Referenced by cbm::algo::qa::H2D::Fill(), cbm::algo::qa::Prof2D::Fill(), 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

inlineinherited

Gets title.

Definition at line 348 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fTitle.

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

◆ operator=() [1/2]

H1D & cbm::algo::qa::H1D::operator= ( const H1D & )

default

Copy assignment operator.

◆ operator=() [2/2]

H1D & cbm::algo::qa::H1D::operator= ( H1D && )

default

Move assignment operator.

◆ Reset()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Resets the histogram.

Definition at line 351 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fEntries, and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fHistogram.

◆ serialize()

template<class Archive >

void cbm::algo::qa::H1D::serialize	(	Archive &	ar,
		const unsigned int	)

inlineprivate

Definition at line 502 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 )

inlineinherited

Get flag.

Parameters

key	Flag key from the EHistFlag enumeration
flag	Flag value

Definition at line 361 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fMetadata, and cbm::algo::qa::HistogramMetadata::SetFlag().

◆ SetName()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Sets name.

Parameters

name	Histogram name

Definition at line 365 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fName.

◆ SetTitle()

template<class Axes , class Storage , class TotalSums >

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

inlineinherited

Sets title.

Parameters

title Histogram title

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

Definition at line 370 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::fTitle.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Serialization function.

Definition at line 500 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

protectedinherited

Number of histogram entries.

Definition at line 415 of file Histogram.h.

Referenced by Fill(), cbm::algo::qa::H2D::Fill(), cbm::algo::qa::Prof1D::Fill(), cbm::algo::qa::Prof2D::Fill(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetEntries(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::Reset(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::serialize().

◆ fHistogram

template<class Axes , class Storage , class TotalSums >

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

protectedinherited

Underlying boost histogram.

Definition at line 412 of file Histogram.h.

◆ fMetadata

template<class Axes , class Storage , class TotalSums >

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

protectedinherited

Meta-data for histogram.

Definition at line 416 of file Histogram.h.

Referenced by cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetFlag(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMetadata(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetMetadataString(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::serialize(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::SetFlag().

◆ fName

template<class Axes , class Storage , class TotalSums >

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

protectedinherited

Name of the histogram.

Definition at line 413 of file Histogram.h.

Referenced by cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetName(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::serialize(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::SetName().

◆ fTitle

template<class Axes , class Storage , class TotalSums >

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

protectedinherited

Title of the histogram.

Definition at line 414 of file Histogram.h.

Referenced by cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::GetTitle(), cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::serialize(), and cbm::algo::qa::Histogram< Axes, Storage, TotalSums >::SetTitle().

◆ Rank

template<class Axes , class Storage , class TotalSums >

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

staticconstexprprotectedinherited

Definition at line 253 of file Histogram.h.

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

Histogram.h

Public Member Functions

Protected Types

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ Hist_t

Constructor & Destructor Documentation

◆ H1D() [1/4]

◆ H1D() [2/4]

◆ H1D() [3/4]

◆ H1D() [4/4]

Member Function Documentation

◆ Fill()

◆ GetAxisMax()

◆ GetAxisMin()

◆ GetAxisNbins()

◆ GetBinAccumulator()

◆ GetBinBH()

◆ GetBinContent()

◆ GetBinError()

◆ GetEntries()

◆ GetFlag()

◆ GetMaximum()

◆ GetMaxX()

◆ GetMaxY()

◆ GetMetadata()

◆ GetMetadataString()

◆ GetMinimum()

◆ GetMinX()

◆ GetMinY()

◆ GetName()

◆ GetNbinsX()

◆ GetNbinsY()

◆ GetTitle()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Reset()

◆ serialize()

◆ SetFlag()

◆ SetName()

◆ SetTitle()

Friends And Related Symbol Documentation

◆ boost::serialization::access

Member Data Documentation

◆ fEntries

◆ fHistogram

◆ fMetadata

◆ fName

◆ fTitle

◆ Rank