Project
Loading...
Searching...
No Matches
o2::framework::AxisSpec Struct Reference

#include <HistogramSpec.h>

Public Member Functions

 AxisSpec (std::vector< double > binEdges_, std::optional< std::string > title_=std::nullopt, std::optional< std::string > name_=std::nullopt)
 
 AxisSpec (int nBins_, double binMin_, double binMax_, std::optional< std::string > title_=std::nullopt, std::optional< std::string > name_=std::nullopt)
 
 AxisSpec (ConfigurableAxis binEdges_, std::optional< std::string > title_=std::nullopt, std::optional< std::string > name_=std::nullopt)
 
long getNbins () const
 
void makeLogarithmic ()
 Function to make the axis logarithmic.
 

Public Attributes

std::optional< intnBins {}
 Data members.
 
std::vector< double > binEdges {}
 Number of bins (only used for fixed bin width axis)
 
std::optional< std::string > title {}
 Edges of the bin. For fixed bin width these are the limits of the binning.
 
std::optional< std::string > name {}
 Optional title of the axis.
 

Detailed Description

Definition at line 86 of file HistogramSpec.h.

Constructor & Destructor Documentation

◆ AxisSpec() [1/3]

o2::framework::AxisSpec::AxisSpec ( std::vector< double >  binEdges_,
std::optional< std::string >  title_ = std::nullopt,
std::optional< std::string >  name_ = std::nullopt 
)
inline

Definition at line 87 of file HistogramSpec.h.

◆ AxisSpec() [2/3]

o2::framework::AxisSpec::AxisSpec ( int  nBins_,
double  binMin_,
double  binMax_,
std::optional< std::string >  title_ = std::nullopt,
std::optional< std::string >  name_ = std::nullopt 
)
inline

Definition at line 95 of file HistogramSpec.h.

◆ AxisSpec() [3/3]

o2::framework::AxisSpec::AxisSpec ( ConfigurableAxis  binEdges_,
std::optional< std::string >  title_ = std::nullopt,
std::optional< std::string >  name_ = std::nullopt 
)
inline

Definition at line 107 of file HistogramSpec.h.

Member Function Documentation

◆ getNbins()

long o2::framework::AxisSpec::getNbins ( ) const

Definition at line 43 of file HistogramSpec.cxx.

◆ makeLogarithmic()

void o2::framework::AxisSpec::makeLogarithmic ( )

Function to make the axis logarithmic.

Definition at line 18 of file HistogramSpec.cxx.

Member Data Documentation

◆ binEdges

std::vector<double> o2::framework::AxisSpec::binEdges {}

Number of bins (only used for fixed bin width axis)

Definition at line 130 of file HistogramSpec.h.

◆ name

std::optional<std::string> o2::framework::AxisSpec::name {}

Optional title of the axis.

Definition at line 132 of file HistogramSpec.h.

◆ nBins

std::optional<int> o2::framework::AxisSpec::nBins {}

Data members.

Definition at line 129 of file HistogramSpec.h.

◆ title

std::optional<std::string> o2::framework::AxisSpec::title {}

Edges of the bin. For fixed bin width these are the limits of the binning.

Definition at line 131 of file HistogramSpec.h.


The documentation for this struct was generated from the following files: