Logo ROOT   6.14/05
Reference Guide
Namespaces | Classes | Typedefs | Enumerations | Functions
ROOT::Experimental Namespace Reference

Namespaces

 Detail
 
 Hist
 
 Internal
 

Classes

class  TAxisBase
 Histogram axis base class. More...
 
class  TAxisConfig
 Objects used to configure the different axis types. More...
 
class  TAxisEquidistant
 Axis with equidistant bin borders. More...
 
class  TAxisGrow
 An axis that can extend its range, keeping the number of its bins unchanged. More...
 
class  TAxisIrregular
 An axis with non-equidistant bins (also known as "variable binning"). More...
 
class  TAxisLabels
 A TAxisGrow that has a label assigned to each bin and a bin width of 1. More...
 
class  TAxisView
 Common view on a TAxis, no matter what its kind. More...
 
class  TBufferMerger
 TBufferMerger is a class to facilitate writing data in parallel from multiple threads, while writing to a single output file. More...
 
class  TBufferMergerFile
 
class  TCanvas
 A window's topmost TPad. More...
 
class  TDirectory
 Key/value store of objects. More...
 
class  TDirectoryTypeMismatch
 Objects of this class are thrown to signal that the value known under the given name . More...
 
class  TDirectoryUnknownKey
 Objects of this class are thrown to signal that no key with that name exists. More...
 
class  TDrawable
 Base class for drawable entities: objects that can be painted on a TPad. More...
 
class  TDrawableBase
 
class  TFile
 A ROOT file. More...
 
class  TFilePtr
 Points to an object that stores or reads objects in ROOT's binary format. More...
 
class  TFitResult
 
class  TFrame
 Holds a user coordinate system with a palette. More...
 
class  TFunction
 
class  TFuture
 A TFuture class. It can wrap an std::future. More...
 
class  THist
 Histogram class for histograms with DIMENSIONS dimensions, where each bin count is stored by a value of type PRECISION. More...
 
class  THist< DIMENSIONS, PRECISION >
 THist with no STAT parameter uses THistStatContent by default. More...
 
class  THistBufferedFill
 Buffers calls to Fill(). More...
 
class  THistConcurrentFiller
 Buffers a thread's Fill calls and submits them to the THistConcurrentFillManager. More...
 
class  THistConcurrentFillManager
 Manages the synchronization of calls to FillN(). More...
 
class  THistDataMomentUncert
 For now do as TH1: calculate first (xw) and second (x^2w) moment. More...
 
class  THistDrawable
 
class  THistDrawableBase
 
class  THistDrawingOpts
 
class  THistDrawingOpts< 1 >
 Drawing options for a 1D histogram. More...
 
class  THistDrawingOpts< 2 >
 Drawing options for a 2D histogram. More...
 
class  THistDrawingOpts< 3 >
 Drawing options for a 3D histogram. More...
 
class  THistStatContent
 Basic histogram statistics, keeping track of the bin content and the total number of calls to Fill(). More...
 
class  THistStatRuntime
 Interface implementing a pure virtual functions DoFill(), DoFillN(). More...
 
class  THistStatTotalSumOfSquaredWeights
 Keeps track of the histogram's total sum of squared weights. More...
 
class  THistStatTotalSumOfWeights
 Keeps track of the histogram's total sum of weights. More...
 
class  THistStatUncertainty
 Histogram statistics to keep track of the Poisson uncertainty per bin. More...
 
class  THistView
 A view on a histogram, selecting a range on a subset of dimensions. More...
 
struct  THistViewOutOfRange
 
class  TLogDiagCounter
 Object to count the number of warnings and errors emitted by a section of code, after construction of this type. More...
 
class  TLogEntry
 A diagnostic, emitted by the TLogManager upon destruction of the TLogEntry. More...
 
class  TLogHandler
 Abstract TLogHandler base class. More...
 
class  TLogManager
 A TLogHandler that multiplexes diagnostics to different client TLogHandlers. More...
 
class  TMenuItems
 
class  TObjectDisplayItem
 
class  TObjectDrawable
 
class  TObjectDrawingOpts
 
class  TPad
 Graphic container for TDrawable-s. More...
 
class  TPadBase
 Base class for graphic containers for TDrawable-s. More...
 
class  TPadCartesianUserAxis
 
class  TPadDisplayItem
 Display item for the pad Includes different graphical properties of the pad itself plus list of created items for all primitives. More...
 
class  TPadDrawable
 Draw a TPad, by drawing its contained graphical elements at the pad offset in the parent pad. More...
 
class  TPadDrawingOpts
 Drawing options for a TPad. More...
 
class  TPadExtent
 An extent / size (horizontal and vertical) in a TPad. More...
 
class  TPadLength
 A coordinate in a TPad. More...
 
class  TPadPos
 A position (horizontal and vertical) in a TPad. More...
 
class  TPadUserAxisBase
 
class  TTaskGroup
 A class to manage the asynchronous execution of work items. More...
 

Typedefs

using CanvasCallback_t = std::function< void(bool)>
 
THist Typedefs

Convenience typedefs (ROOT6-compatible type names)

using TH1D = THist< 1, double, THistStatContent, THistStatUncertainty >
 
using TH1F = THist< 1, float, THistStatContent, THistStatUncertainty >
 
using TH1C = THist< 1, char, THistStatContent >
 
using TH1I = THist< 1, int, THistStatContent >
 
using TH1LL = THist< 1, int64_t, THistStatContent >
 
using TH2D = THist< 2, double, THistStatContent, THistStatUncertainty >
 
using TH2F = THist< 2, float, THistStatContent, THistStatUncertainty >
 
using TH2C = THist< 2, char, THistStatContent >
 
using TH2I = THist< 2, int, THistStatContent >
 
using TH2LL = THist< 2, int64_t, THistStatContent >
 
using TH3D = THist< 3, double, THistStatContent, THistStatUncertainty >
 
using TH3F = THist< 3, float, THistStatContent, THistStatUncertainty >
 
using TH3C = THist< 3, char, THistStatContent >
 
using TH3I = THist< 3, int, THistStatContent >
 
using TH3LL = THist< 3, int64_t, THistStatContent >
 

Enumerations

enum  EIOFeatures { EIOFeatures::kGenerateOffsetMap = BIT(0), EIOFeatures::kSupported = kGenerateOffsetMap }
 
enum  EIOUnsupportedFeatures { EIOUnsupportedFeatures::kUnsupported = 0 }
 
enum  ELogLevel {
  ELogLevel::kDebug, ELogLevel::kInfo, ELogLevel::kWarning, ELogLevel::kError,
  ELogLevel::kFatal
}
 Kinds of diagnostics. More...
 

Functions

template<int DIMENSIONS, class PRECISION_TO , class PRECISION_FROM , template< int D_, class P_, template< class P__ > class S_ > class... STAT_TO, template< int D_, class P_, template< class P__ > class S_ > class... STAT_FROM>
void Add (THist< DIMENSIONS, PRECISION_TO, STAT_TO... > &to, const THist< DIMENSIONS, PRECISION_FROM, STAT_FROM... > &from)
 Add two histograms. More...
 
template<class Function , class... Args>
TFuture< typename std::result_of< typename std::decay< Function >::type(typename std::decay< Args >::type...)>::typeAsync (Function &&f, Args &&... args)
 Runs a function asynchronously potentially in a new thread and returns a ROOT TFuture that will hold the result. More...
 
template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
TFitResult FitTo (const THist< DIMENSIONS, PRECISION, STAT... > &hist, const TFunction< DIMENSIONS > &func, std::span< double > paramInit)
 
template<class... ARGS>
std::shared_ptr< TPadDrawableGetDrawable (std::unique_ptr< TPad > &&pad, ARGS... args)
 
template<class... ARGS>
std::shared_ptr< TPadDrawableGetDrawable (const std::shared_ptr< TPad > &pad, ARGS... args)
 
template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
std::shared_ptr< THistDrawable< DIMENSIONS > > GetDrawable (const std::shared_ptr< THist< DIMENSIONS, PRECISION, STAT... >> &hist, const THistDrawingOpts< DIMENSIONS > &opts={})
 Interface to graphics taking a shared_ptr<THist>. More...
 
template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
std::shared_ptr< THistDrawable< DIMENSIONS > > GetDrawable (std::unique_ptr< THist< DIMENSIONS, PRECISION, STAT... >> &&hist, const THistDrawingOpts< DIMENSIONS > &opts={})
 Interface to graphics taking a unique_ptr<THist>. More...
 
template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
THist< DIMENSIONS, PRECISION, STAT... > HistFromImpl (std::unique_ptr< typename THist< DIMENSIONS, PRECISION, STAT... >::ImplBase_t > pHistImpl)
 Adopt an external, stand-alone THistImpl. The THist will take ownership. More...
 
template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
class THist< DIMENSIONS, PRECISION, STAT... > HistFromImpl (std::unique_ptr< typename THist< DIMENSIONS, PRECISION, STAT... >::ImplBase_t > pHistImpl)
 Adopt an external, stand-alone THistImpl. The THist will take ownership. More...
 
void InitializeAttrFromString (const std::string &name, const std::string &attrStrVal, TPadPos &val)
 Initialize a TPadPos from a style string. More...
 
void InitializeAttrFromString (const std::string &name, const std::string &attrStrVal, TPadExtent &val)
 Initialize a TPadExtent from a style string. More...
 
TPadLength::Normal operator"" _normal (long double val)
 User-defined literal for TPadLength::Normal More...
 
TPadLength::Normal operator"" _normal (unsigned long long int val)
 
TPadLength::Pixel operator"" _px (long double val)
 User-defined literal for TPadLength::Pixel More...
 
TPadLength::Pixel operator"" _px (unsigned long long int val)
 
TPadLength::User operator"" _user (long double val)
 User-defined literal for TPadLength::User More...
 
TPadLength::User operator"" _user (unsigned long long int val)
 
bool operator== (const TAxisEquidistant &lhs, const TAxisEquidistant &rhs) noexcept
 Equality-compare two TAxisEquidistant. More...
 
template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
void swap (THist< DIMENSIONS, PRECISION, STAT... > &a, THist< DIMENSIONS, PRECISION, STAT... > &b) noexcept
 Swap two histograms. More...
 
TAxisBase::const_iterator comparison operators
bool operator< (TAxisBase::const_iterator lhs, TAxisBase::const_iterator rhs) noexcept
 i < j More...
 
bool operator> (TAxisBase::const_iterator lhs, TAxisBase::const_iterator rhs) noexcept
 i > j More...
 
bool operator<= (TAxisBase::const_iterator lhs, TAxisBase::const_iterator rhs) noexcept
 i <= j More...
 
bool operator>= (TAxisBase::const_iterator lhs, TAxisBase::const_iterator rhs) noexcept
 i >= j More...
 
bool operator== (TAxisBase::const_iterator lhs, TAxisBase::const_iterator rhs) noexcept
 i == j More...
 
bool operator!= (TAxisBase::const_iterator lhs, TAxisBase::const_iterator rhs) noexcept
 i != j More...
 

Axis Compatibility

enum  EAxisCompatibility { EAxisCompatibility::kIdentical, EAxisCompatibility::kContains, EAxisCompatibility::kSampling, EAxisCompatibility::kIncompatible }
 
EAxisCompatibility CanMap (TAxisEquidistant &target, TAxisEquidistant &source) noexcept
 Whether (and how) the source axis can be merged into the target axis. More...
 

Typedef Documentation

◆ CanvasCallback_t

using ROOT::Experimental::CanvasCallback_t = typedef std::function<void(bool)>

Definition at line 27 of file TVirtualCanvasPainter.hxx.

◆ TH1C

using ROOT::Experimental::TH1C = typedef THist<1, char, THistStatContent>

Definition at line 286 of file THist.hxx.

◆ TH1D

Definition at line 284 of file THist.hxx.

◆ TH1F

Definition at line 285 of file THist.hxx.

◆ TH1I

Definition at line 287 of file THist.hxx.

◆ TH1LL

using ROOT::Experimental::TH1LL = typedef THist<1, int64_t, THistStatContent>

Definition at line 288 of file THist.hxx.

◆ TH2C

using ROOT::Experimental::TH2C = typedef THist<2, char, THistStatContent>

Definition at line 292 of file THist.hxx.

◆ TH2D

Definition at line 290 of file THist.hxx.

◆ TH2F

Definition at line 291 of file THist.hxx.

◆ TH2I

Definition at line 293 of file THist.hxx.

◆ TH2LL

using ROOT::Experimental::TH2LL = typedef THist<2, int64_t, THistStatContent>

Definition at line 294 of file THist.hxx.

◆ TH3C

using ROOT::Experimental::TH3C = typedef THist<3, char, THistStatContent>

Definition at line 298 of file THist.hxx.

◆ TH3D

Definition at line 296 of file THist.hxx.

◆ TH3F

Definition at line 297 of file THist.hxx.

◆ TH3I

Definition at line 299 of file THist.hxx.

◆ TH3LL

using ROOT::Experimental::TH3LL = typedef THist<3, int64_t, THistStatContent>

Definition at line 300 of file THist.hxx.

Enumeration Type Documentation

◆ EAxisCompatibility

Enumerator
kIdentical 

Source and target axes are identical.

kContains 

The source is a subset of bins of the target axis.

kSampling 

The bins of the source axis have finer granularity, but the bin borders are compatible.

Example: source: 0., 1., 2., 3., 4., 5., 6.; target: 0., 2., 5., 6. Note that this is not a symmetrical property: only one of CanMerge(source, target), CanMap(target, source) can return kContains.

kIncompatible 

The source axis and target axis have different binning.

Example: source: 0., 1., 2., 3., 4., target: 0., 0.1, 0.2, 0.3, 0.4

Definition at line 906 of file TAxis.hxx.

◆ EIOFeatures

Enumerator
kGenerateOffsetMap 
kSupported 

Definition at line 45 of file TIOFeatures.hxx.

◆ EIOUnsupportedFeatures

Enumerator
kUnsupported 

Definition at line 54 of file TIOFeatures.hxx.

◆ ELogLevel

Kinds of diagnostics.

Enumerator
kDebug 

Debug information; only useful for developers.

kInfo 

Informational messages; used for instance for tracing.

kWarning 

Warnings about likely unexpected behavior.

kError 
kFatal 

Definition at line 31 of file TLogger.hxx.

Function Documentation

◆ Add()

template<int DIMENSIONS, class PRECISION_TO , class PRECISION_FROM , template< int D_, class P_, template< class P__ > class S_ > class... STAT_TO, template< int D_, class P_, template< class P__ > class S_ > class... STAT_FROM>
void ROOT::Experimental::Add ( THist< DIMENSIONS, PRECISION_TO, STAT_TO... > &  to,
const THist< DIMENSIONS, PRECISION_FROM, STAT_FROM... > &  from 
)

Add two histograms.

This is the generic, inefficient version for now; it assumes no matching axes.

Definition at line 308 of file THist.hxx.

◆ Async()

template<class Function , class... Args>
TFuture<typename std::result_of<typename std::decay<Function>::type(typename std::decay<Args>::type...)>::type> ROOT::Experimental::Async ( Function &&  f,
Args &&...  args 
)

Runs a function asynchronously potentially in a new thread and returns a ROOT TFuture that will hold the result.

Definition at line 152 of file TFuture.hxx.

◆ CanMap()

ROOT::Experimental::EAxisCompatibility ROOT::Experimental::CanMap ( TAxisEquidistant target,
TAxisEquidistant source 
)
noexcept

Whether (and how) the source axis can be merged into the target axis.

Definition at line 50 of file TAxis.cxx.

◆ FitTo()

template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
TFitResult ROOT::Experimental::FitTo ( const THist< DIMENSIONS, PRECISION, STAT... > &  hist,
const TFunction< DIMENSIONS > &  func,
std::span< double >  paramInit 
)

Definition at line 39 of file TFit.hxx.

◆ GetDrawable() [1/4]

template<class... ARGS>
std::shared_ptr<TPadDrawable> ROOT::Experimental::GetDrawable ( std::unique_ptr< TPad > &&  pad,
ARGS...  args 
)
inline

Definition at line 287 of file TPad.hxx.

◆ GetDrawable() [2/4]

template<class... ARGS>
std::shared_ptr<TPadDrawable> ROOT::Experimental::GetDrawable ( const std::shared_ptr< TPad > &  pad,
ARGS...  args 
)
inline

Definition at line 293 of file TPad.hxx.

◆ GetDrawable() [3/4]

template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
std::shared_ptr<THistDrawable<DIMENSIONS> > ROOT::Experimental::GetDrawable ( const std::shared_ptr< THist< DIMENSIONS, PRECISION, STAT... >> &  hist,
const THistDrawingOpts< DIMENSIONS > &  opts = {} 
)

Interface to graphics taking a shared_ptr<THist>.

Definition at line 325 of file THist.hxx.

◆ GetDrawable() [4/4]

template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
std::shared_ptr<THistDrawable<DIMENSIONS> > ROOT::Experimental::GetDrawable ( std::unique_ptr< THist< DIMENSIONS, PRECISION, STAT... >> &&  hist,
const THistDrawingOpts< DIMENSIONS > &  opts = {} 
)

Interface to graphics taking a unique_ptr<THist>.

Definition at line 334 of file THist.hxx.

◆ HistFromImpl() [1/2]

template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
THist<DIMENSIONS, PRECISION, STAT...> ROOT::Experimental::HistFromImpl ( std::unique_ptr< typename THist< DIMENSIONS, PRECISION, STAT... >::ImplBase_t >  pHistImpl)

Adopt an external, stand-alone THistImpl. The THist will take ownership.

Definition at line 272 of file THist.hxx.

◆ HistFromImpl() [2/2]

template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
class THist< DIMENSIONS, PRECISION, STAT... > ROOT::Experimental::HistFromImpl ( std::unique_ptr< typename THist< DIMENSIONS, PRECISION, STAT... >::ImplBase_t >  pHistImpl)

Adopt an external, stand-alone THistImpl. The THist will take ownership.

Definition at line 272 of file THist.hxx.

◆ InitializeAttrFromString() [1/2]

void ROOT::Experimental::InitializeAttrFromString ( const std::string &  name,
const std::string &  attrStrVal,
TPadPos val 
)

Initialize a TPadPos from a style string.

Syntax: X, Y where X and Y are a series of numbers separated by "+", where each number is followed by one of px, user, normal to specify an extent in pixel, user or normal coordinates. Spaces between any part is allowed. Example: 100 px + 0.1 user, 0.5 normal is a TPadPos{100_px + 0.1_user, 0.5_normal}.

Definition at line 28 of file TPadPos.cxx.

◆ InitializeAttrFromString() [2/2]

void ROOT::Experimental::InitializeAttrFromString ( const std::string &  name,
const std::string &  attrStrVal,
TPadExtent val 
)

Initialize a TPadExtent from a style string.

Syntax: X, Y where X and Y are a series of numbers separated by "+", where each number is followed by one of px, user, normal to specify an extent in pixel, user or normal coordinates. Spaces between any part is allowed. Example: 100 px + 0.1 user, 0.5 normal is a TPadExtent{100_px + 0.1_user, 0.5_normal}.

Definition at line 28 of file TPadExtent.cxx.

◆ operator!=()

i != j

Definition at line 287 of file TAxis.hxx.

◆ operator"" _normal() [1/2]

TPadLength::Normal ROOT::Experimental::operator"" _normal ( long double  val)
inline

User-defined literal for TPadLength::Normal

Use as

using namespace ROOT::Experimental;
TLine(0.1_normal, 0.0_normal, TLineExtent(0.2_normal, 0.5_normal));

Definition at line 170 of file TPadLength.hxx.

◆ operator"" _normal() [2/2]

TPadLength::Normal ROOT::Experimental::operator"" _normal ( unsigned long long int  val)
inline

Definition at line 174 of file TPadLength.hxx.

◆ operator"" _px() [1/2]

TPadLength::Pixel ROOT::Experimental::operator"" _px ( long double  val)
inline

User-defined literal for TPadLength::Pixel

Use as

using namespace ROOT::Experimental;
TLine(100_px, 0_px, TLineExtent(20_px, 50_px));

Definition at line 186 of file TPadLength.hxx.

◆ operator"" _px() [2/2]

TPadLength::Pixel ROOT::Experimental::operator"" _px ( unsigned long long int  val)
inline

Definition at line 190 of file TPadLength.hxx.

◆ operator"" _user() [1/2]

TPadLength::User ROOT::Experimental::operator"" _user ( long double  val)
inline

User-defined literal for TPadLength::User

Use as

using namespace ROOT::Experimental;
TLine(0.1_user, 0.0_user, TLineExtent(0.2_user, 0.5_user));

Definition at line 202 of file TPadLength.hxx.

◆ operator"" _user() [2/2]

TPadLength::User ROOT::Experimental::operator"" _user ( unsigned long long int  val)
inline

Definition at line 206 of file TPadLength.hxx.

◆ operator<()

bool ROOT::Experimental::operator< ( TAxisBase::const_iterator  lhs,
TAxisBase::const_iterator  rhs 
)
inlinenoexcept

i < j

Definition at line 257 of file TAxis.hxx.

◆ operator<=()

bool ROOT::Experimental::operator<= ( TAxisBase::const_iterator  lhs,
TAxisBase::const_iterator  rhs 
)
inlinenoexcept

i <= j

Definition at line 269 of file TAxis.hxx.

◆ operator==() [1/2]

bool ROOT::Experimental::operator== ( TAxisBase::const_iterator  lhs,
TAxisBase::const_iterator  rhs 
)
inlinenoexcept

i == j

Definition at line 281 of file TAxis.hxx.

◆ operator==() [2/2]

bool ROOT::Experimental::operator== ( const TAxisEquidistant lhs,
const TAxisEquidistant rhs 
)
inlinenoexcept

Equality-compare two TAxisEquidistant.

Definition at line 513 of file TAxis.hxx.

◆ operator>()

bool ROOT::Experimental::operator> ( TAxisBase::const_iterator  lhs,
TAxisBase::const_iterator  rhs 
)
inlinenoexcept

i > j

Definition at line 263 of file TAxis.hxx.

◆ operator>=()

bool ROOT::Experimental::operator>= ( TAxisBase::const_iterator  lhs,
TAxisBase::const_iterator  rhs 
)
inlinenoexcept

i >= j

Definition at line 275 of file TAxis.hxx.

◆ swap()

template<int DIMENSIONS, class PRECISION , template< int D_, class P_, template< class P__ > class S_ > class... STAT>
void ROOT::Experimental::swap ( THist< DIMENSIONS, PRECISION, STAT... > &  a,
THist< DIMENSIONS, PRECISION, STAT... > &  b 
)
noexcept

Swap two histograms.

Very efficient; swaps the fImpl pointers.

Definition at line 190 of file THist.hxx.