CbmRoot
Loading...
Searching...
No Matches
cbm::algo::qa::Prof2D Class Reference

#include <Histogram.h>

Inheritance diagram for cbm::algo::qa::Prof2D:
[legend]
Collaboration diagram for cbm::algo::qa::Prof2D:
[legend]

Public Member Functions

 Prof2D (const std::string &name, const std::string &title, uint32_t nBinsX, double xMin, double xMax, uint32_t nBinsY, double yMin, double yMax, double zMin=0., double zMax=0.)
 Constructor for 2D-histogram.
 
 Prof2D ()=default
 Default constructor.
 
 Prof2D (const Prof2D &)=default
 Copy constructor.
 
 Prof2D (Prof2D &&)=default
 Move constructor.
 
Prof2Doperator= (const Prof2D &)=default
 Copy assignment operator.
 
Prof2Doperator= (Prof2D &&)=default
 Move assignment operator.
 
int Fill (double x, double y, double z, double w=1.)
 Fills histogram.
 
auto GetBinAccumulator (uint32_t iBinX, uint32_t iBinY) const
 Gets underlying bin accumulator.
 
double GetBinContent (uint32_t iBinX, uint32_t iBinY) const
 Gets bin content.
 
double GetBinCount (uint32_t iBinX, uint32_t iBinY) const
 Gets bin entries.
 
double GetBinError (uint32_t iBinX, uint32_t iBinY) const
 Gets bin error.
 
double GetMinZ () const
 Gets z-axis lower bound.
 
double GetMaxZ () const
 Gets z-axis lower bound.
 
double GetAxisMin () const
 Gets range lower bound of the selected axis.
 
double GetAxisMin () const
 Gets range lower bound of the selected axis.
 
double GetAxisMax () const
 Gets range upper bound of the selected axis.
 
double GetAxisMax () const
 Gets range upper bound of the selected axis.
 
uint32_t GetAxisNbins () const
 Gets number of bins in axis.
 
uint32_t GetAxisNbins () const
 Gets number of bins in axis.
 
double GetEntries () const
 Gets number of entries.
 
double GetEntries () const
 Gets number of entries.
 
bool GetFlag (EHistFlag key) const
 Get flag.
 
bool GetFlag (EHistFlag key) const
 Get flag.
 
const std::string & GetName () const
 Gets name.
 
const std::string & GetName () const
 Gets name.
 
const HistogramMetadataGetMetadata () const
 Gets metadata instance.
 
const HistogramMetadataGetMetadata () const
 Gets metadata instance.
 
std::string GetMetadataString () const
 Gets metadata string.
 
std::string GetMetadataString () const
 Gets metadata string.
 
uint32_t GetNbinsX () const
 Gets number of bins for x axis.
 
uint32_t GetNbinsX () const
 Gets number of bins for x axis.
 
double GetMinX () const
 Gets x-axis lower bound.
 
double GetMinX () const
 Gets x-axis lower bound.
 
double GetMaxX () const
 Gets x-axis lower bound.
 
double GetMaxX () const
 Gets x-axis lower bound.
 
uint32_t GetNbinsY () const
 Gets number of bins for y axis.
 
uint32_t GetNbinsY () const
 Gets number of bins for y axis.
 
double GetMinY () const
 Gets y-axis lower bound.
 
double GetMinY () const
 Gets y-axis lower bound.
 
double GetMaxY () const
 Gets y-axis lower bound.
 
double GetMaxY () const
 Gets y-axis lower bound.
 
double GetMaximum () const
 Gets maximum value.
 
double GetMaximum () const
 Gets maximum value.
 
double GetMinimum () const
 Gets minimum value.
 
double GetMinimum () const
 Gets minimum value.
 
const std::string & GetTitle () const
 Gets title.
 
const std::string & GetTitle () const
 Gets title.
 
void Reset ()
 Resets the histogram.
 
void Reset ()
 Resets the histogram.
 
void SetFlag (EHistFlag key, bool flag=true)
 Get flag.
 
void SetFlag (EHistFlag key, bool flag=true)
 Get flag.
 
void SetName (const std::string &name)
 Sets name.
 
void SetName (const std::string &name)
 Sets name.
 
void SetTitle (const std::string &title)
 Sets title.
 
void SetTitle (const std::string &title)
 Sets title.
 
double GetTotSumWXY () const
 Gets total sum of weight over squared y products.
 
double GetTotSumWY () const
 Gets total sum of weight over y products.
 
double GetTotSumWY2 () const
 Gets total sum of weight over squared y products.
 
double GetTotSumW () const
 Gets total sum of weights.
 
double GetTotSumW2 () const
 Gets total sum of squared weights.
 
double GetTotSumWX () const
 Gets total sum of weight over x products.
 
double GetTotSumWX2 () const
 Gets total sum of weight over squared x products.
 

Protected Types

using Hist_t
 

Protected Member Functions

void UpdateTotalSums (double x, double y, double w)
 Updates the sums.
 
void UpdateTotalSums (double x, double w)
 Updates the sums.
 

Static Protected Member Functions

static int GetBinBH (uint32_t iBin)
 Gets bin index in underlying boost histogram.
 
static int GetBinBH (uint32_t iBin)
 Gets bin index in underlying boost histogram.
 

Protected Attributes

Hist_t fHistogram
 Underlying boost histogram.
 
Hist_t fHistogram
 Underlying boost histogram.
 
std::string fName
 Name of the histogram.
 
std::string fName
 Name of the histogram.
 
std::string fTitle
 Title of the histogram.
 
std::string fTitle
 Title of the histogram.
 
int fEntries
 Number of histogram entries.
 
int fEntries
 Number of histogram entries.
 
HistogramMetadata fMetadata
 Meta-data for histogram.
 
HistogramMetadata fMetadata
 Meta-data for histogram.
 
double fTotSumWY = 0.
 Total sum (over all bins) of weight over y products.
 
double fTotSumWXY = 0.
 Total sum (over all bins) of weight over square x products.
 
double fTotSumWY2 = 0.
 Total sum (over all bins) of weight over x over y products.
 
double fTotSumW = 0.
 Total sum (over all bins) of weights.
 
double fTotSumW2 = 0.
 Total sum (over all bins) of squared weights.
 
double fTotSumWX = 0.
 Total sum (over all bins) of weight over x products.
 
double fTotSumWX2 = 0.
 Total sum (over all bins) of weight over square x products.
 

Static Protected Attributes

static constexpr unsigned Rank
 
static constexpr unsigned Rank
 

Private Member Functions

template<class Archive>
void serialize (Archive &ar, const unsigned int)
 

Private Attributes

double fZmin = 0.
 Lower bound of the profile z-axis.
 
double fZmax = 0.
 Upper bound of the profile z-axis.
 

Friends

class boost::serialization::access
 Serialization rule.
 

Detailed Description

Definition at line 700 of file Histogram.h.

Member Typedef Documentation

◆ Hist_t

using cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::Hist_t
protectedinherited

Definition at line 253 of file Histogram.h.

Constructor & Destructor Documentation

◆ Prof2D() [1/4]

cbm::algo::qa::Prof2D::Prof2D ( const std::string & name,
const std::string & title,
uint32_t nBinsX,
double xMin,
double xMax,
uint32_t nBinsY,
double yMin,
double yMax,
double zMin = 0.,
double zMax = 0. )
inline

Constructor for 2D-histogram.

Parameters
nameName of histogram
titleTitle of histogram
nBinsXNumber of x bins
xMinLower x bound
xMaxUpper x bound
nBinsYNumber of y bins
yMinLower y bound
yMaxUpper y bound
zMinLower z bound (optional)
zMaxUpper z bound (optional)
Note
If the zMin and zMax are defined (zMin != zMax), all the passed values outside the [zMin, zMax] range will be ignored.

Definition at line 716 of file Histogram.h.

References fZmax, and fZmin.

Referenced by operator=(), operator=(), Prof2D(), and Prof2D().

◆ Prof2D() [2/4]

cbm::algo::qa::Prof2D::Prof2D ( )
default

Default constructor.

◆ Prof2D() [3/4]

cbm::algo::qa::Prof2D::Prof2D ( const Prof2D & )
default

Copy constructor.

References Prof2D().

◆ Prof2D() [4/4]

cbm::algo::qa::Prof2D::Prof2D ( Prof2D && )
default

Move constructor.

References Prof2D().

Member Function Documentation

◆ Fill()

int cbm::algo::qa::Prof2D::Fill ( double x,
double y,
double z,
double w = 1. )
inline

Fills histogram.

Parameters
xValue along x-axis
yValue along y-axis
zValue along z-axis
wWeight
Returns
Bin number TODO: implement

Skip measurement, if it goes beyond the defined [fYmin, fYmax] range

Definition at line 746 of file Histogram.h.

References cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fEntries, cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fHistogram, fZmax, fZmin, cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetNbinsX(), cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetNbinsY(), cbm::algo::qa::TotalSums1D::UpdateTotalSums(), x, and y.

◆ GetAxisMax() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetAxisMax ( ) const
inlineinherited

Gets range upper bound of the selected axis.

Template Parameters
AxisTypeAn axis

Definition at line 271 of file Histogram.h.

◆ GetAxisMax() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetAxisMax ( ) const
inlineinherited

Gets range upper bound of the selected axis.

Template Parameters
AxisTypeAn axis

Definition at line 271 of file Histogram.h.

◆ GetAxisMin() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetAxisMin ( ) const
inlineinherited

Gets range lower bound of the selected axis.

Template Parameters
AxisTypeAn axis

Definition at line 263 of file Histogram.h.

◆ GetAxisMin() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetAxisMin ( ) const
inlineinherited

Gets range lower bound of the selected axis.

Template Parameters
AxisTypeAn axis

Definition at line 263 of file Histogram.h.

◆ GetAxisNbins() [1/2]

uint32_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetAxisNbins ( ) const
inlineinherited

Gets number of bins in axis.

Template Parameters
AxisTAn axis
D

Definition at line 280 of file Histogram.h.

◆ GetAxisNbins() [2/2]

uint32_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetAxisNbins ( ) const
inlineinherited

Gets number of bins in axis.

Template Parameters
AxisTAn axis
D

Definition at line 280 of file Histogram.h.

◆ GetBinAccumulator()

auto cbm::algo::qa::Prof2D::GetBinAccumulator ( uint32_t iBinX,
uint32_t iBinY ) const
inline

Gets underlying bin accumulator.

Parameters
iBinXBin index along x-axis
iBinYBin index along y-axis

Definition at line 773 of file Histogram.h.

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

◆ GetBinBH() [1/2]

static int cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetBinBH ( uint32_t iBin)
inlinestaticprotectedinherited

Gets bin index in underlying boost histogram.

Parameters
iBinBin in histogram
Returns
Bin in boost histogram

Definition at line 411 of file Histogram.h.

◆ GetBinBH() [2/2]

static int cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetBinBH ( uint32_t iBin)
inlinestaticprotectedinherited

Gets bin index in underlying boost histogram.

Parameters
iBinBin in histogram
Returns
Bin in boost histogram

Definition at line 411 of file Histogram.h.

◆ GetBinContent()

double cbm::algo::qa::Prof2D::GetBinContent ( uint32_t iBinX,
uint32_t iBinY ) const
inline

Gets bin content.

Parameters
iBinXBin index along x-axis
iBinYBin index along y-axis

Definition at line 781 of file Histogram.h.

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

◆ GetBinCount()

double cbm::algo::qa::Prof2D::GetBinCount ( uint32_t iBinX,
uint32_t iBinY ) const
inline

Gets bin entries.

Parameters
iBinXBin index along x-axis
iBinYBin index along y-axis

Definition at line 789 of file Histogram.h.

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

◆ GetBinError()

double cbm::algo::qa::Prof2D::GetBinError ( uint32_t iBinX,
uint32_t iBinY ) const
inline

Gets bin error.

Parameters
iBinXBin index along x-axis
iBinYBin index along y-axis

Definition at line 797 of file Histogram.h.

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

◆ GetEntries() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetEntries ( ) const
inlineinherited

Gets number of entries.

Definition at line 287 of file Histogram.h.

◆ GetEntries() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetEntries ( ) const
inlineinherited

Gets number of entries.

Definition at line 287 of file Histogram.h.

◆ GetFlag() [1/2]

bool cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetFlag ( EHistFlag key) const
inlineinherited

Get flag.

Parameters
keyFlag key from the EHistFlag enumeration

Definition at line 295 of file Histogram.h.

◆ GetFlag() [2/2]

bool cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetFlag ( EHistFlag key) const
inlineinherited

Get flag.

Parameters
keyFlag key from the EHistFlag enumeration

Definition at line 295 of file Histogram.h.

◆ GetMaximum() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMaximum ( ) const
inlineinherited

Gets maximum value.

Definition at line 337 of file Histogram.h.

◆ GetMaximum() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMaximum ( ) const
inlineinherited

Gets maximum value.

Definition at line 337 of file Histogram.h.

◆ GetMaxX() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMaxX ( ) const
inlineinherited

Gets x-axis lower bound.

Definition at line 313 of file Histogram.h.

◆ GetMaxX() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMaxX ( ) const
inlineinherited

Gets x-axis lower bound.

Definition at line 313 of file Histogram.h.

◆ GetMaxY() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMaxY ( ) const
inlineinherited

Gets y-axis lower bound.

Definition at line 331 of file Histogram.h.

◆ GetMaxY() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMaxY ( ) const
inlineinherited

Gets y-axis lower bound.

Definition at line 331 of file Histogram.h.

◆ GetMaxZ()

double cbm::algo::qa::Prof2D::GetMaxZ ( ) const
inline

Gets z-axis lower bound.

Definition at line 806 of file Histogram.h.

References fZmax.

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

◆ GetMetadata() [1/2]

const HistogramMetadata & cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMetadata ( ) const
inlineinherited

Gets metadata instance.

Definition at line 301 of file Histogram.h.

◆ GetMetadata() [2/2]

const HistogramMetadata & cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMetadata ( ) const
inlineinherited

Gets metadata instance.

Definition at line 301 of file Histogram.h.

◆ GetMetadataString() [1/2]

std::string cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMetadataString ( ) const
inlineinherited

Gets metadata string.

Definition at line 304 of file Histogram.h.

◆ GetMetadataString() [2/2]

std::string cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMetadataString ( ) const
inlineinherited

Gets metadata string.

Definition at line 304 of file Histogram.h.

◆ GetMinimum() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMinimum ( ) const
inlineinherited

Gets minimum value.

Definition at line 343 of file Histogram.h.

◆ GetMinimum() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMinimum ( ) const
inlineinherited

Gets minimum value.

Definition at line 343 of file Histogram.h.

◆ GetMinX() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMinX ( ) const
inlineinherited

Gets x-axis lower bound.

Definition at line 310 of file Histogram.h.

◆ GetMinX() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMinX ( ) const
inlineinherited

Gets x-axis lower bound.

Definition at line 310 of file Histogram.h.

◆ GetMinY() [1/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMinY ( ) const
inlineinherited

Gets y-axis lower bound.

Definition at line 324 of file Histogram.h.

◆ GetMinY() [2/2]

double cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetMinY ( ) const
inlineinherited

Gets y-axis lower bound.

Definition at line 324 of file Histogram.h.

◆ GetMinZ()

double cbm::algo::qa::Prof2D::GetMinZ ( ) const
inline

Gets z-axis lower bound.

Definition at line 803 of file Histogram.h.

References fZmin.

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

◆ GetName() [1/2]

const std::string & cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetName ( ) const
inlineinherited

Gets name.

Definition at line 298 of file Histogram.h.

◆ GetName() [2/2]

const std::string & cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetName ( ) const
inlineinherited

Gets name.

Definition at line 298 of file Histogram.h.

◆ GetNbinsX() [1/2]

uint32_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetNbinsX ( ) const
inlineinherited

Gets number of bins for x axis.

Definition at line 307 of file Histogram.h.

Referenced by cbm::algo::qa::Prof2D::Fill().

◆ GetNbinsX() [2/2]

uint32_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetNbinsX ( ) const
inlineinherited

Gets number of bins for x axis.

Definition at line 307 of file Histogram.h.

◆ GetNbinsY() [1/2]

uint32_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetNbinsY ( ) const
inlineinherited

Gets number of bins for y axis.

Definition at line 317 of file Histogram.h.

Referenced by cbm::algo::qa::Prof2D::Fill().

◆ GetNbinsY() [2/2]

uint32_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetNbinsY ( ) const
inlineinherited

Gets number of bins for y axis.

Definition at line 317 of file Histogram.h.

◆ GetTitle() [1/2]

const std::string & cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetTitle ( ) const
inlineinherited

Gets title.

Definition at line 349 of file Histogram.h.

◆ GetTitle() [2/2]

const std::string & cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::GetTitle ( ) const
inlineinherited

Gets title.

Definition at line 349 of file Histogram.h.

◆ GetTotSumW()

double cbm::algo::qa::TotalSums1D::GetTotSumW ( ) const
inlineinherited

Gets total sum of weights.

Definition at line 142 of file Histogram.h.

References fTotSumW.

◆ GetTotSumW2()

double cbm::algo::qa::TotalSums1D::GetTotSumW2 ( ) const
inlineinherited

Gets total sum of squared weights.

Definition at line 145 of file Histogram.h.

References fTotSumW2.

◆ GetTotSumWX()

double cbm::algo::qa::TotalSums1D::GetTotSumWX ( ) const
inlineinherited

Gets total sum of weight over x products.

Definition at line 148 of file Histogram.h.

References fTotSumWX.

◆ GetTotSumWX2()

double cbm::algo::qa::TotalSums1D::GetTotSumWX2 ( ) const
inlineinherited

Gets total sum of weight over squared x products.

Definition at line 151 of file Histogram.h.

References fTotSumWX2.

◆ GetTotSumWXY()

double cbm::algo::qa::TotalSums2D::GetTotSumWXY ( ) const
inlineinherited

Gets total sum of weight over squared y products.

Definition at line 197 of file Histogram.h.

References fTotSumWXY.

◆ GetTotSumWY()

double cbm::algo::qa::TotalSums2D::GetTotSumWY ( ) const
inlineinherited

Gets total sum of weight over y products.

Definition at line 200 of file Histogram.h.

References fTotSumWY.

◆ GetTotSumWY2()

double cbm::algo::qa::TotalSums2D::GetTotSumWY2 ( ) const
inlineinherited

Gets total sum of weight over squared y products.

Definition at line 203 of file Histogram.h.

References fTotSumWY2.

◆ operator=() [1/2]

Prof2D & cbm::algo::qa::Prof2D::operator= ( const Prof2D & )
default

Copy assignment operator.

References Prof2D().

◆ operator=() [2/2]

Prof2D & cbm::algo::qa::Prof2D::operator= ( Prof2D && )
default

Move assignment operator.

References Prof2D().

◆ Reset() [1/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::Reset ( )
inlineinherited

Resets the histogram.

Definition at line 352 of file Histogram.h.

◆ Reset() [2/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::Reset ( )
inlineinherited

Resets the histogram.

Definition at line 352 of file Histogram.h.

◆ serialize()

template<class Archive>
void cbm::algo::qa::Prof2D::serialize ( Archive & ar,
const unsigned int  )
inlineprivate

Definition at line 812 of file Histogram.h.

References fZmax, and fZmin.

◆ SetFlag() [1/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::SetFlag ( EHistFlag key,
bool flag = true )
inlineinherited

Get flag.

Parameters
keyFlag key from the EHistFlag enumeration
flagFlag value

Definition at line 362 of file Histogram.h.

◆ SetFlag() [2/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::SetFlag ( EHistFlag key,
bool flag = true )
inlineinherited

Get flag.

Parameters
keyFlag key from the EHistFlag enumeration
flagFlag value

Definition at line 362 of file Histogram.h.

◆ SetName() [1/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::SetName ( const std::string & name)
inlineinherited

Sets name.

Parameters
nameHistogram name

Definition at line 366 of file Histogram.h.

◆ SetName() [2/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::SetName ( const std::string & name)
inlineinherited

Sets name.

Parameters
nameHistogram name

Definition at line 366 of file Histogram.h.

◆ SetTitle() [1/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::SetTitle ( const std::string & title)
inlineinherited

Sets title.

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

Definition at line 371 of file Histogram.h.

◆ SetTitle() [2/2]

void cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::SetTitle ( const std::string & title)
inlineinherited

Sets title.

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

Definition at line 371 of file Histogram.h.

◆ UpdateTotalSums() [1/2]

void cbm::algo::qa::TotalSums1D::UpdateTotalSums ( double x,
double w )
inlineprotectedinherited

◆ UpdateTotalSums() [2/2]

void cbm::algo::qa::TotalSums2D::UpdateTotalSums ( double x,
double y,
double w )
inlineprotectedinherited

Updates the sums.

Parameters
xX value
yY value
wweight

Definition at line 219 of file Histogram.h.

References fTotSumWXY, fTotSumWY, fTotSumWY2, cbm::algo::qa::TotalSums1D::UpdateTotalSums(), x, and y.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Serialization rule.

Definition at line 810 of file Histogram.h.

References boost::serialization::access.

Referenced by boost::serialization::access.

Member Data Documentation

◆ fEntries [1/2]

int cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fEntries
protectedinherited

Number of histogram entries.

Definition at line 416 of file Histogram.h.

Referenced by cbm::algo::qa::Prof2D::Fill().

◆ fEntries [2/2]

int cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fEntries
protectedinherited

Number of histogram entries.

Definition at line 416 of file Histogram.h.

◆ fHistogram [1/2]

◆ fHistogram [2/2]

Hist_t cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fHistogram
protectedinherited

Underlying boost histogram.

Definition at line 413 of file Histogram.h.

◆ fMetadata [1/2]

Meta-data for histogram.

Definition at line 417 of file Histogram.h.

◆ fMetadata [2/2]

Meta-data for histogram.

Definition at line 417 of file Histogram.h.

◆ fName [1/2]

std::string cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fName
protectedinherited

Name of the histogram.

Definition at line 414 of file Histogram.h.

◆ fName [2/2]

std::string cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fName
protectedinherited

Name of the histogram.

Definition at line 414 of file Histogram.h.

◆ fTitle [1/2]

std::string cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fTitle
protectedinherited

Title of the histogram.

Definition at line 415 of file Histogram.h.

◆ fTitle [2/2]

std::string cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::fTitle
protectedinherited

Title of the histogram.

Definition at line 415 of file Histogram.h.

◆ fTotSumW

double cbm::algo::qa::TotalSums1D::fTotSumW = 0.
protectedinherited

Total sum (over all bins) of weights.

Definition at line 174 of file Histogram.h.

Referenced by GetTotSumW(), Reset(), serialize(), and UpdateTotalSums().

◆ fTotSumW2

double cbm::algo::qa::TotalSums1D::fTotSumW2 = 0.
protectedinherited

Total sum (over all bins) of squared weights.

Definition at line 175 of file Histogram.h.

Referenced by GetTotSumW2(), Reset(), serialize(), and UpdateTotalSums().

◆ fTotSumWX

double cbm::algo::qa::TotalSums1D::fTotSumWX = 0.
protectedinherited

Total sum (over all bins) of weight over x products.

Definition at line 176 of file Histogram.h.

Referenced by GetTotSumWX(), Reset(), serialize(), and UpdateTotalSums().

◆ fTotSumWX2

double cbm::algo::qa::TotalSums1D::fTotSumWX2 = 0.
protectedinherited

Total sum (over all bins) of weight over square x products.

Definition at line 177 of file Histogram.h.

Referenced by GetTotSumWX2(), Reset(), serialize(), and UpdateTotalSums().

◆ fTotSumWXY

double cbm::algo::qa::TotalSums2D::fTotSumWXY = 0.
protectedinherited

Total sum (over all bins) of weight over square x products.

Definition at line 228 of file Histogram.h.

Referenced by GetTotSumWXY(), Reset(), serialize(), and UpdateTotalSums().

◆ fTotSumWY

double cbm::algo::qa::TotalSums2D::fTotSumWY = 0.
protectedinherited

Total sum (over all bins) of weight over y products.

Definition at line 227 of file Histogram.h.

Referenced by GetTotSumWY(), Reset(), serialize(), and UpdateTotalSums().

◆ fTotSumWY2

double cbm::algo::qa::TotalSums2D::fTotSumWY2 = 0.
protectedinherited

Total sum (over all bins) of weight over x over y products.

Definition at line 229 of file Histogram.h.

Referenced by GetTotSumWY2(), Reset(), serialize(), and UpdateTotalSums().

◆ fZmax

double cbm::algo::qa::Prof2D::fZmax = 0.
private

Upper bound of the profile z-axis.

Definition at line 820 of file Histogram.h.

Referenced by Fill(), GetMaxZ(), Prof2D(), and serialize().

◆ fZmin

double cbm::algo::qa::Prof2D::fZmin = 0.
private

Lower bound of the profile z-axis.

Definition at line 819 of file Histogram.h.

Referenced by Fill(), GetMinZ(), Prof2D(), and serialize().

◆ Rank [1/2]

unsigned cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::Rank
staticconstexprprotectedinherited

Definition at line 254 of file Histogram.h.

◆ Rank [2/2]

unsigned cbm::algo::qa::Histogram< Axes2D_t, ProfStorage_t, TotalSums2D >::Rank
staticconstexprprotectedinherited

Definition at line 254 of file Histogram.h.


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