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)
	~AxisSpec ()
	AxisSpec (AxisSpec const &)
	AxisSpec (AxisSpec &&) noexcept
AxisSpec &	operator= (AxisSpec const &)
AxisSpec &	operator= (AxisSpec &&) noexcept
long	getNbins () const
void	makeLogarithmic ()
	Function to make the axis logarithmic.

Public Attributes
std::optional< int >	nBins {}
	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/5]

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

Definition at line 19 of file HistogramSpec.cxx.

AxisSpec() [2/5]

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

Definition at line 27 of file HistogramSpec.cxx.

AxisSpec() [3/5]

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

Definition at line 38 of file HistogramSpec.cxx.

~AxisSpec()

o2::framework::AxisSpec::~AxisSpec ( )

default

AxisSpec() [4/5]

o2::framework::AxisSpec::AxisSpec ( AxisSpec const &  )

default

AxisSpec() [5/5]

o2::framework::AxisSpec::AxisSpec ( AxisSpec &&  )

defaultnoexcept

Member Function Documentation

getNbins()

long o2::framework::AxisSpec::getNbins

(

)

const

Definition at line 95 of file HistogramSpec.cxx.

makeLogarithmic()

void o2::framework::AxisSpec::makeLogarithmic

(

)

Function to make the axis logarithmic.

Definition at line 70 of file HistogramSpec.cxx.

operator=() [1/2]

AxisSpec & o2::framework::AxisSpec::operator= ( AxisSpec &&  )

defaultnoexcept

operator=() [2/2]

AxisSpec & o2::framework::AxisSpec::operator= ( AxisSpec const &  )

default

Member Data Documentation

binEdges

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

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

Definition at line 126 of file HistogramSpec.h.

name

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

Optional title of the axis.

Definition at line 128 of file HistogramSpec.h.

nBins

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

Data members.

Definition at line 125 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 127 of file HistogramSpec.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/Core/include/Framework/HistogramSpec.h
• /home/runner/work/AliceO2/AliceO2/Framework/Core/src/HistogramSpec.cxx