Objects used to configure the different axis types.
It can store the properties of all possible axis types, together with the type of the axis.
RODO: that's what a variant will be invented for!
Classes | |
struct | Grow_t |
Tag type signalling that an axis should be able to grow; used for calling the appropriate constructor. More... | |
Public Types | |
enum | EKind { kEquidistant , kGrow , kIrregular , kLabels , kNumKinds } |
Public Types inherited from ROOT::Experimental::RAxisBase | |
enum class | EFindStatus { kCanGrow , kValid } |
Status of FindBin(x) More... | |
Public Member Functions | |
RAxisConfig (const std::vector< double > &binborders) | |
Represents a RAxisIrregular with binborders . More... | |
RAxisConfig (const std::vector< std::string_view > &labels) | |
Represents a RAxisLabels with labels . More... | |
RAxisConfig (Grow_t, int nbins, double from, double to) | |
Represents a RAxisGrow with nbins from from to to . More... | |
RAxisConfig (int nbins, double from, double to) | |
Represents a RAxisEquidistant with nbins from from to to . More... | |
RAxisConfig (std::string_view title, const std::vector< double > &binborders) | |
Represents a RAxisIrregular with binborders and title. More... | |
RAxisConfig (std::string_view title, const std::vector< std::string_view > &labels) | |
Represents a RAxisLabels with labels and title. More... | |
RAxisConfig (std::string_view title, Grow_t, int nbins, double from, double to) | |
Represents a RAxisGrow with nbins from from to to , and axis title. More... | |
RAxisConfig (std::string_view title, int nbins, double from, double to) | |
Represents a RAxisEquidistant with nbins from from to to , and axis title. More... | |
RAxisConfig (std::string_view title, std::vector< double > &&binborders) noexcept | |
Represents a RAxisIrregular with binborders and title. More... | |
RAxisConfig (std::string_view title, std::vector< std::string > &&labels) | |
Represents a RAxisLabels with labels and title. More... | |
RAxisConfig (std::vector< double > &&binborders) noexcept | |
Represents a RAxisIrregular with binborders . More... | |
RAxisConfig (std::vector< std::string > &&labels) | |
Represents a RAxisLabels with labels . More... | |
const std::vector< double > & | GetBinBorders () const noexcept |
Get the bin borders; non-empty if the GetKind() == kIrregular. More... | |
const std::vector< std::string > & | GetBinLabels () const noexcept |
Get the bin labels; non-empty if the GetKind() == kLabels. More... | |
EKind | GetKind () const noexcept |
Get the axis kind represented by this RAxisConfig . More... | |
Public Member Functions inherited from ROOT::Experimental::RAxisBase | |
RAxisBase (int nbinsNoOver, bool canGrow) noexcept | |
Construct a RAxisBase. More... | |
RAxisBase (std::string_view title, int nbinsNoOver, bool canGrow) noexcept | |
Construct a RAxisBase. More... | |
int | GetNBins () const noexcept |
Get the number of bins, including under- and overflow. More... | |
int | GetNBinsNoOver () const noexcept |
Get the number of bins, excluding under- and overflow. More... | |
int | GetNOverflowBins () const noexcept |
Get the number of over- and underflow bins: 0 for growable axes, 2 otherwise. More... | |
int | GetOverflowBin () const noexcept |
Get the bin index for the underflow bin (or the next bin outside range if CanGrow()). More... | |
const std::string & | GetTitle () const |
int | GetUnderflowBin () const noexcept |
Get the bin index for the underflow bin. More... | |
bool | IsOverflowBin (int bin) const noexcept |
Whether the bin index is referencing a bin higher than the axis range. More... | |
bool | IsUnderflowBin (int bin) const noexcept |
Whether the bin index is referencing a bin lower than the axis range. More... | |
const_iterator | begin () const noexcept |
Get a const_iterator pointing to the first non-underflow bin. More... | |
const_iterator | begin_with_underflow () const noexcept |
Get a const_iterator pointing the underflow bin. More... | |
const_iterator | end () const noexcept |
Get a const_iterator pointing right beyond the last non-overflow bin (i.e. More... | |
const_iterator | end_with_overflow () const noexcept |
Get a const_iterator pointing right beyond the overflow bin. More... | |
Static Public Attributes | |
static constexpr const Grow_t | Grow {} |
Tag signalling that an axis should be able to grow; used for calling the appropriate constructor like so: RAxisConfig ac(RAxisConfig::Grow, 10, 0., 1.);. More... | |
Static Public Attributes inherited from ROOT::Experimental::RAxisBase | |
static constexpr const int | kIgnoreBin = -1 |
FindBin() returns this bin to signal that the bin number is invalid. More... | |
static constexpr const int | kNOverflowBins [4] = {0, 1, 1, 2} |
Extra bins for each EAxisOverflow value. More... | |
Private Member Functions | |
RAxisConfig (std::string_view title, int nbins, double from, double to, EKind kind) | |
Represents a RAxisEquidistant with nbins from from to to , and axis title. More... | |
Private Attributes | |
std::vector< double > | fBinBorders |
Bin borders of the RAxisIrregular. More... | |
EKind | fKind |
The kind of axis represented by this configuration. More... | |
std::vector< std::string > | fLabels |
Bin labels for a RAxisLabels. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ROOT::Experimental::RAxisBase | |
RAxisBase ()=default | |
Default construct a RAxisBase (for use by derived classes for I/O) More... | |
int | AdjustOverflowBinNumber (double rawbin) const |
Given rawbin (<0 for underflow, >= GetNBinsNoOver() for overflow), determine the actual bin number taking into account how over/underflow should be handled. More... | |
RAxisBase (const RAxisBase &)=default | |
RAxisBase (RAxisBase &&)=default | |
RAxisBase & | operator= (const RAxisBase &)=default |
RAxisBase & | operator= (RAxisBase &&)=default |
#include <ROOT/RAxis.hxx>
Enumerator | |
---|---|
kEquidistant | represents a RAxisEquidistant |
kGrow | represents a RAxisGrow |
kIrregular | represents a RAxisIrregular |
kLabels | represents a RAxisLabels |
kNumKinds |
|
inlineexplicitprivate |
Represents a RAxisEquidistant
with nbins
from from
to to
, and axis title.
|
inline |
Represents a RAxisEquidistant
with nbins
from from
to to
, and axis title.
|
inline |
Represents a RAxisEquidistant
with nbins
from from
to to
.
|
inline |
|
inline |
|
inline |
Represents a RAxisIrregular
with binborders
and title.
|
inline |
Represents a RAxisIrregular
with binborders
.
|
inlinenoexcept |
Represents a RAxisIrregular
with binborders
and title.
|
inlinenoexcept |
Represents a RAxisIrregular
with binborders
.
|
inline |
Represents a RAxisLabels
with labels
and title.
|
inline |
Represents a RAxisLabels
with labels
.
|
inline |
Represents a RAxisLabels
with labels
and title.
|
inline |
Represents a RAxisLabels
with labels
.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Get the axis kind represented by this RAxisConfig
.
|
private |
Bin borders of the RAxisIrregular.
|
private |
|
private |
Bin labels for a RAxisLabels.
|
staticconstexpr |
Tag signalling that an axis should be able to grow; used for calling the appropriate constructor like so: RAxisConfig ac(RAxisConfig::Grow, 10, 0., 1.);.