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.

TODO: that's what a variant will be invented for!

Definition at line 562 of file TAxis.h.

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::TAxisBase
enum	EFindStatus { EFindStatus::kCanGrow, EFindStatus::kValid }
	Status of FindBin(x) More...

Public Member Functions
	TAxisConfig (int nbins, double from, double to)
	Represents a `TAxisEquidistant` with `nbins` from `from` to `to`. More...

	TAxisConfig (Grow_t, int nbins, double from, double to)
	Represents a `TAxisGrow` with `nbins` from `from` to `to`. More...

	TAxisConfig (const std::vector< double > &binborders)
	Represents a `TAxisIrregular` with `binborders`. More...

	TAxisConfig (std::vector< double > &&binborders) noexcept
	Represents a `TAxisIrregular` with `binborders`. More...

	TAxisConfig (const std::vector< std::string_view > &labels)
	Represents a `TAxisLabels` with `labels`. More...

	TAxisConfig (std::vector< std::string > &&labels)
	Represents a `TAxisLabels` with `labels`. More...

EKind	GetKind () const noexcept
	Get the axis kind represented by this `TAxisConfig`. 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...

Axis normalization
	TAxisConfig (const TAxisEquidistant &ax)
	Build a TAxisConfig from a TAxisEquidistant. More...

	TAxisConfig (const TAxisGrow &ax)
	Build a TAxisConfig from a TAxisGrow. More...

	TAxisConfig (const TAxisIrregular &ax)
	Build a TAxisConfig from a TAxisIrregular. More...

	TAxisConfig (const TAxisLabels &ax)
	Build a TAxisConfig from a TAxisLabels. More...

Public Member Functions inherited from ROOT::TAxisBase
constexpr	TAxisBase (int nbins) noexcept
	Construct a TAxisBase. More...

constexpr int	GetNBinsNoOver () const noexcept
	Get the number of bins, excluding under- and overflow. More...

constexpr int	GetNBins () const noexcept
	Get the number of bins, including under- and overflow. More...

constexpr int	GetUnderflowBin () const noexcept
	Get the bin index for the underflow bin. More...

constexpr int	GetOverflowBin () const noexcept
	Get the bin index for the underflow bin. More...

constexpr bool	IsUnderflowBin (int bin) const noexcept
	Whether the bin index is referencing a bin lower than the axis range. More...

constexpr bool	IsOverflowBin (int bin) const noexcept
	Whether the bin index is referencing a bin higher 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: TAxisConfig ac(TAxisConfig::Grow, 10, 0., 1.);. More...

Static Public Attributes inherited from ROOT::TAxisBase
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 Attributes
EKind	fKind
	The kind of axis represented by this configuration. More...

std::vector< double >	fBinBorders
	Bin borders of the TAxisIrregular. More...

std::vector< std::string >	fLabels
	Bin labels for a TAxisLabels. More...

Additional Inherited Members
Protected Member Functions inherited from ROOT::TAxisBase
constexpr int	AdjustOverflowBinNumber (int 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...

	TAxisBase (const TAxisBase &)=default

	TAxisBase (TAxisBase &&)=default

TAxisBase &	operator= (const TAxisBase &)=default

TAxisBase &	operator= (TAxisBase &&)=default

#include <ROOT/TAxis.h>

Inheritance diagram for ROOT::TAxisConfig:

Collaboration diagram for ROOT::TAxisConfig:

Member Enumeration Documentation

§ EKind

enum ROOT::TAxisConfig::EKind

Enumerator
kEquidistant	represents a TAxisEquidistant
kGrow	represents a TAxisGrow
kIrregular	represents a TAxisIrregular
kLabels	represents a TAxisLabels
kNumKinds

Definition at line 564 of file TAxis.h.

Constructor & Destructor Documentation

§ TAxisConfig() [1/10]

ROOT::TAxisConfig::TAxisConfig	(	int	nbins,
		double	from,
		double	to
	)

inline

Represents a TAxisEquidistant with nbins from from to to.

Definition at line 588 of file TAxis.h.

§ TAxisConfig() [2/10]

ROOT::TAxisConfig::TAxisConfig	(	Grow_t	,
		int	nbins,
		double	from,
		double	to
	)

inline

Represents a TAxisGrow with nbins from from to to.

Definition at line 593 of file TAxis.h.

§ TAxisConfig() [3/10]

ROOT::TAxisConfig::TAxisConfig ( const std::vector< double > & binborders )

inline

Represents a TAxisIrregular with binborders.

Definition at line 598 of file TAxis.h.

§ TAxisConfig() [4/10]

ROOT::TAxisConfig::TAxisConfig ( std::vector< double > && binborders )

inlinenoexcept

Represents a TAxisIrregular with binborders.

Definition at line 603 of file TAxis.h.

§ TAxisConfig() [5/10]

ROOT::TAxisConfig::TAxisConfig ( const std::vector< std::string_view > & labels )

inline

Represents a TAxisLabels with labels.

Definition at line 608 of file TAxis.h.

§ TAxisConfig() [6/10]

ROOT::TAxisConfig::TAxisConfig ( std::vector< std::string > && labels )

inline

Represents a TAxisLabels with labels.

Definition at line 614 of file TAxis.h.

§ TAxisConfig() [7/10]

ROOT::TAxisConfig::TAxisConfig ( const TAxisEquidistant & ax )

inline

Build a TAxisConfig from a TAxisEquidistant.

Definition at line 623 of file TAxis.h.

§ TAxisConfig() [8/10]

ROOT::TAxisConfig::TAxisConfig ( const TAxisGrow & ax )

inline

Build a TAxisConfig from a TAxisGrow.

Definition at line 628 of file TAxis.h.

§ TAxisConfig() [9/10]

ROOT::TAxisConfig::TAxisConfig ( const TAxisIrregular & ax )

inline

Build a TAxisConfig from a TAxisIrregular.

Definition at line 632 of file TAxis.h.

§ TAxisConfig() [10/10]

ROOT::TAxisConfig::TAxisConfig ( const TAxisLabels & ax )

inline

Build a TAxisConfig from a TAxisLabels.

Definition at line 636 of file TAxis.h.

Member Function Documentation

§ GetBinBorders()

const std::vector<double>& ROOT::TAxisConfig::GetBinBorders ( ) const

inlinenoexcept

Get the bin borders; non-empty if the GetKind() == kIrregular.

Definition at line 648 of file TAxis.h.

Referenced by ROOT::Internal::AxisConfigToType< TAxisConfig::kIrregular >::operator()().

§ GetBinLabels()

const std::vector<std::string>& ROOT::TAxisConfig::GetBinLabels ( ) const

inlinenoexcept

Get the bin labels; non-empty if the GetKind() == kLabels.

Definition at line 650 of file TAxis.h.

Referenced by ROOT::Internal::AxisConfigToType< TAxisConfig::kLabels >::operator()().

§ GetKind()

EKind ROOT::TAxisConfig::GetKind ( ) const

inlinenoexcept

Get the axis kind represented by this TAxisConfig.

Definition at line 645 of file TAxis.h.

Member Data Documentation

§ fBinBorders

std::vector<double> ROOT::TAxisConfig::fBinBorders

private

Bin borders of the TAxisIrregular.

Definition at line 574 of file TAxis.h.

§ fKind

EKind ROOT::TAxisConfig::fKind

private

The kind of axis represented by this configuration.

Definition at line 573 of file TAxis.h.

§ fLabels

std::vector<std::string> ROOT::TAxisConfig::fLabels

private

Bin labels for a TAxisLabels.

Definition at line 575 of file TAxis.h.

§ Grow

constexpr const Grow_t ROOT::TAxisConfig::Grow {}

static

Tag signalling that an axis should be able to grow; used for calling the appropriate constructor like so: TAxisConfig ac(TAxisConfig::Grow, 10, 0., 1.);.

Definition at line 585 of file TAxis.h.

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

hist/hist/v7/inc/ROOT/TAxis.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

§ EKind

Constructor & Destructor Documentation

§ TAxisConfig() [1/10]

§ TAxisConfig() [2/10]

§ TAxisConfig() [3/10]

§ TAxisConfig() [4/10]

§ TAxisConfig() [5/10]

§ TAxisConfig() [6/10]

§ TAxisConfig() [7/10]

§ TAxisConfig() [8/10]

§ TAxisConfig() [9/10]

§ TAxisConfig() [10/10]

Member Function Documentation

§ GetBinBorders()

§ GetBinLabels()

§ GetKind()

Member Data Documentation

§ fBinBorders

§ fKind

§ fLabels

§ Grow