Logo ROOT   6.08/07
Reference Guide
List of all members | Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
ROOT::Experimental::TAxisBase Class Reference

Histogram axis base class.

Keeps track of the number of bins and overflow handling. Offers bin iteration.

Bin indices are starting from 0 for the underflow bin (representing values that are lower than the axis range). Starting at index 1 are the actual bins of the axis, up to N + 1 for an axis with N bins. Index N + 2 is the overflow bin for values larger than the axis range.

Definition at line 40 of file TAxis.hxx.

Classes

class  const_iterator
 Random const_iterator through bins. More...
 

Public Types

enum  EFindStatus { EFindStatus::kCanGrow, EFindStatus::kValid }
 Status of FindBin(x) More...
 

Public Member Functions

 TAxisBase (int nbinsNoOver, bool canGrow) noexcept
 Construct a TAxisBase. More...
 
 TAxisBase (std::string_view title, int nbinsNoOver, bool canGrow) noexcept
 Construct a TAxisBase. 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...
 
Iterator interfaces
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 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...
 

Protected Member Functions

 TAxisBase ()
 Default construct a TAxisBase (for use by derived classes for I/O) More...
 
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...
 
Inaccessible copy, assignment

The copy and move constructors and assignment operators are protected to prevent slicing.

 TAxisBase (const TAxisBase &)=default
 
 TAxisBase (TAxisBase &&)=default
 
TAxisBaseoperator= (const TAxisBase &)=default
 
TAxisBaseoperator= (TAxisBase &&)=default
 

Private Attributes

const bool fCanGrow
 Whether this axis can grow (and thus has no overflow bins). More...
 
unsigned int fNBins
 Number of bins including under- and overflow. More...
 
std::string fTitle
 Title of this axis, used for graphics / text. More...
 

#include <ROOT/TAxis.hxx>

Inheritance diagram for ROOT::Experimental::TAxisBase:
[legend]

Member Enumeration Documentation

◆ EFindStatus

Status of FindBin(x)

Enumerator
kCanGrow 

Coordinate could fit after growing the axis.

kValid 

The returned bin index is valid.

Definition at line 43 of file TAxis.hxx.

Constructor & Destructor Documentation

◆ TAxisBase() [1/5]

ROOT::Experimental::TAxisBase::TAxisBase ( const TAxisBase )
protecteddefault

◆ TAxisBase() [2/5]

ROOT::Experimental::TAxisBase::TAxisBase ( TAxisBase &&  )
protecteddefault

◆ TAxisBase() [3/5]

ROOT::Experimental::TAxisBase::TAxisBase ( )
inlineprotected

Default construct a TAxisBase (for use by derived classes for I/O)

Definition at line 60 of file TAxis.hxx.

◆ TAxisBase() [4/5]

ROOT::Experimental::TAxisBase::TAxisBase ( int  nbinsNoOver,
bool  canGrow 
)
inlinenoexcept

Construct a TAxisBase.

Parameters
[in]nbins- number of bins in this axis, excluding under- and overflow bins.
[in]canGrow- whether this axis can extend its range.

Definition at line 181 of file TAxis.hxx.

◆ TAxisBase() [5/5]

ROOT::Experimental::TAxisBase::TAxisBase ( std::string_view  title,
int  nbinsNoOver,
bool  canGrow 
)
inlinenoexcept

Construct a TAxisBase.

Parameters
[in]title- axis title used for graphics and text representation.
[in]nbins- number of bins in this axis, excluding under- and overflow bins.
[in]canGrow- whether this axis can extend its range.

Definition at line 190 of file TAxis.hxx.

Member Function Documentation

◆ AdjustOverflowBinNumber()

int ROOT::Experimental::TAxisBase::AdjustOverflowBinNumber ( int  rawbin) const
inlineprotected

Given rawbin (<0 for underflow, >= GetNBinsNoOver() for overflow), determine the actual bin number taking into account how over/underflow should be handled.

Parameters
[out]statusresult status of the bin determination.
Returns
Returns the bin number adjusted for potential over- and underflow bins. Returns kIgnoreBin if the axis cannot handle the over- / underflow, in which case status will tell how to deal with this overflow.

Definition at line 72 of file TAxis.hxx.

◆ begin()

const_iterator ROOT::Experimental::TAxisBase::begin ( ) const
inlinenoexcept

Get a const_iterator pointing to the first non-underflow bin.

Definition at line 236 of file TAxis.hxx.

◆ begin_with_underflow()

const_iterator ROOT::Experimental::TAxisBase::begin_with_underflow ( ) const
inlinenoexcept

Get a const_iterator pointing the underflow bin.

Definition at line 239 of file TAxis.hxx.

◆ end()

const_iterator ROOT::Experimental::TAxisBase::end ( ) const
inlinenoexcept

Get a const_iterator pointing right beyond the last non-overflow bin (i.e.

pointing to the overflow bin).

Definition at line 245 of file TAxis.hxx.

◆ end_with_overflow()

const_iterator ROOT::Experimental::TAxisBase::end_with_overflow ( ) const
inlinenoexcept

Get a const_iterator pointing right beyond the overflow bin.

Definition at line 250 of file TAxis.hxx.

◆ GetNBins()

int ROOT::Experimental::TAxisBase::GetNBins ( ) const
inlinenoexcept

Get the number of bins, including under- and overflow.

Definition at line 201 of file TAxis.hxx.

◆ GetNBinsNoOver()

int ROOT::Experimental::TAxisBase::GetNBinsNoOver ( ) const
inlinenoexcept

Get the number of bins, excluding under- and overflow.

Definition at line 196 of file TAxis.hxx.

◆ GetNOverflowBins()

int ROOT::Experimental::TAxisBase::GetNOverflowBins ( ) const
inlinenoexcept

Get the number of over- and underflow bins: 0 for growable axes, 2 otherwise.

Definition at line 206 of file TAxis.hxx.

◆ GetOverflowBin()

int ROOT::Experimental::TAxisBase::GetOverflowBin ( ) const
inlinenoexcept

Get the bin index for the underflow bin (or the next bin outside range if CanGrow()).

Definition at line 218 of file TAxis.hxx.

◆ GetTitle()

const std::string& ROOT::Experimental::TAxisBase::GetTitle ( ) const
inline

Definition at line 193 of file TAxis.hxx.

◆ GetUnderflowBin()

int ROOT::Experimental::TAxisBase::GetUnderflowBin ( ) const
inlinenoexcept

Get the bin index for the underflow bin.

Definition at line 214 of file TAxis.hxx.

◆ IsOverflowBin()

bool ROOT::Experimental::TAxisBase::IsOverflowBin ( int  bin) const
inlinenoexcept

Whether the bin index is referencing a bin higher than the axis range.

Definition at line 228 of file TAxis.hxx.

◆ IsUnderflowBin()

bool ROOT::Experimental::TAxisBase::IsUnderflowBin ( int  bin) const
inlinenoexcept

Whether the bin index is referencing a bin lower than the axis range.

Definition at line 223 of file TAxis.hxx.

◆ operator=() [1/2]

TAxisBase& ROOT::Experimental::TAxisBase::operator= ( const TAxisBase )
protecteddefault

◆ operator=() [2/2]

TAxisBase& ROOT::Experimental::TAxisBase::operator= ( TAxisBase &&  )
protecteddefault

Member Data Documentation

◆ fCanGrow

const bool ROOT::Experimental::TAxisBase::fCanGrow
private

Whether this axis can grow (and thus has no overflow bins).

Definition at line 258 of file TAxis.hxx.

◆ fNBins

unsigned int ROOT::Experimental::TAxisBase::fNBins
private

Number of bins including under- and overflow.

Definition at line 256 of file TAxis.hxx.

◆ fTitle

std::string ROOT::Experimental::TAxisBase::fTitle
private

Title of this axis, used for graphics / text.

Definition at line 257 of file TAxis.hxx.

◆ kIgnoreBin

constexpr const int ROOT::Experimental::TAxisBase::kIgnoreBin = -1
static

FindBin() returns this bin to signal that the bin number is invalid.

Definition at line 171 of file TAxis.hxx.

◆ kNOverflowBins

constexpr const int ROOT::Experimental::TAxisBase::kNOverflowBins = {0, 1, 1, 2}
static

Extra bins for each EAxisOverflow value.

Definition at line 174 of file TAxis.hxx.


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