ROOT 6.18/05 Reference Guide |
Definition at line 362 of file RHistImpl.hxx.
Public Types | |
template<int NDIM = DATA::GetNDim()> | |
using | AxisIterRange_t = typename Hist::AxisIterRange_t< NDIM > |
using | CoordArray_t = typename ImplBase_t::CoordArray_t |
using | FillFunc_t = void(RHistImplBase::*)(const CoordArray_t &x, Weight_t w) |
Type of the Fill(x, w) function. More... | |
using | ImplBase_t = RHistImplBase< DATA > |
using | Weight_t = typename ImplBase_t::Weight_t |
Public Types inherited from ROOT::Experimental::Detail::RHistImplBase< DATA > | |
using | CoordArray_t = Hist::CoordArray_t< DATA::GetNDim()> |
Type of the coordinate: a DIMENSIONS-dimensional array of doubles. More... | |
using | FillFunc_t = void(RHistImplBase::*)(const CoordArray_t &x, Weight_t w) |
Type of the Fill(x, w) function. More... | |
using | Stat_t = DATA |
Type of the statistics (bin content, uncertainties etc). More... | |
using | Weight_t = typename DATA::Weight_t |
Type of the bin content (and thus weights). More... | |
Public Types inherited from ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()> | |
using | AxisIterRange_t = Hist::AxisIterRange_t< DIMENSIONS > |
Range type. More... | |
using | CoordArray_t = Hist::CoordArray_t< DIMENSIONS > |
Type of the coordinate: a DIMENSIONS-dimensional array of doubles. More... | |
Public Member Functions | |
RHistImpl (AXISCONFIG... axisArgs) | |
RHistImpl (std::string_view title, AXISCONFIG... axisArgs) | |
RHistImpl (TRootIOCtor *) | |
void | Apply (std::function< void(RHistBinRef< const ImplBase_t >)> op) const final |
Apply a function (lambda) to all bins of the histogram. More... | |
void | ApplyXC (std::function< void(const CoordArray_t &, Weight_t)> op) const final |
Apply a function (lambda) to all bins of the histogram. More... | |
virtual void | ApplyXCE (std::function< void(const CoordArray_t &, Weight_t, double)> op) const final |
Apply a function (lambda) to all bins of the histogram. More... | |
std::unique_ptr< ImplBase_t > | Clone () const override |
void | Fill (const CoordArray_t &x, Weight_t w=1.) |
Add a single weight w to the bin at coordinate x . More... | |
void | FillN (const std::span< CoordArray_t > xN) final |
Fill an array of weightN to the bins specified by coordinates xN . More... | |
void | FillN (const std::span< CoordArray_t > xN, const std::span< Weight_t > weightN) final |
Fill an array of weightN to the bins specified by coordinates xN . More... | |
const std::tuple< AXISCONFIG... > & | GetAxes () const |
Get the axes of this histogram. More... | |
RAxisView | GetAxis (int iAxis) const final |
Normalized axes access, converting the actual axis to RAxisConfig. More... | |
CoordArray_t | GetBinCenter (int binidx) const final |
Get the center coordinate of the bin. More... | |
Weight_t | GetBinContent (const CoordArray_t &x) const final |
Get the content of the bin at position x . More... | |
CoordArray_t | GetBinFrom (int binidx) const final |
Get the coordinate of the low limit of the bin. More... | |
int | GetBinIndex (const CoordArray_t &x) const final |
Gets the bin index for coordinate x ; returns -1 if there is no such bin, e.g. More... | |
int | GetBinIndexAndGrow (const CoordArray_t &x) final |
Gets the bin index for coordinate x , growing the axes as needed and possible. More... | |
CoordArray_t | GetBinTo (int binidx) const final |
Get the coordinate of the high limit of the bin. More... | |
double | GetBinUncertainty (const CoordArray_t &x) const final |
Get the bin uncertainty for the bin at coordinate x. More... | |
double | GetBinUncertainty (int binidx) const final |
Return the uncertainties for the given bin. More... | |
FillFunc_t | GetFillFunc () const final |
Retrieve the fill function for this histogram implementation, to prevent the virtual function call for high-frequency fills. More... | |
AxisIterRange_t< DATA::GetNDim()> | GetRange (const std::array< Hist::EOverflow, DATA::GetNDim()> &withOverUnder) const final |
Get the begin() and end() for each axis. More... | |
void | GrowAxis (int, double) |
Grow the axis number iAxis to fit the coordinate x . More... | |
bool | HasBinUncertainty () const final |
Whether this histogram's statistics provide storage for uncertainties, or whether uncertainties are determined as poisson uncertainty of the content. More... | |
Public Member Functions inherited from ROOT::Experimental::Detail::RHistImplBase< DATA > | |
RHistImplBase ()=default | |
RHistImplBase (const RHistImplBase &)=default | |
RHistImplBase (RHistImplBase &&)=default | |
RHistImplBase (size_t numBins) | |
RHistImplBase (std::string_view title, size_t numBins) | |
void | AddBinContent (int binidx, Weight_t w) |
Add w to the bin at index bin . More... | |
virtual void | Apply (std::function< void(RHistBinRef< const RHistImplBase >)>) const =0 |
Apply a function (lambda) to all bins of the histogram. More... | |
virtual void | ApplyXC (std::function< void(const CoordArray_t &, Weight_t)>) const =0 |
Apply a function (lambda) to all bins of the histogram. More... | |
virtual void | ApplyXCE (std::function< void(const CoordArray_t &, Weight_t, double)>) const =0 |
Apply a function (lambda) to all bins of the histogram. More... | |
virtual std::unique_ptr< RHistImplBase > | Clone () const =0 |
virtual void | FillN (const std::span< CoordArray_t > xN)=0 |
Interface function to fill a vector or array of coordinates. More... | |
virtual void | FillN (const std::span< CoordArray_t > xN, const std::span< Weight_t > weightN)=0 |
Interface function to fill a vector or array of coordinates with corresponding weights. More... | |
virtual Weight_t | GetBinContent (const CoordArray_t &x) const =0 |
Get the bin content (sum of weights) for the bin at coordinate x. More... | |
Weight_t & | GetBinContent (int binidx) |
Get the bin content (sum of weights) for bin index binidx (non-const). More... | |
Weight_t | GetBinContent (int binidx) const |
Get the bin content (sum of weights) for bin index binidx . More... | |
double | GetBinContentAsDouble (int binidx) const final |
Get the bin content (sum of weights) for bin index binidx , cast to double. More... | |
virtual double | GetBinUncertainty (const CoordArray_t &x) const =0 |
Get the bin uncertainty for the bin at coordinate x. More... | |
virtual FillFunc_t | GetFillFunc () const =0 |
Retrieve the pointer to the overridden Fill(x, w) function. More... | |
int | GetNBins () const noexcept final |
Get the number of bins in this histogram, including possible under- and overflow bins. More... | |
const Stat_t & | GetStat () const noexcept |
Const access to statistics. More... | |
Stat_t & | GetStat () noexcept |
Non-const access to statistics. More... | |
Public Member Functions inherited from ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()> | |
RHistImplPrecisionAgnosticBase ()=default | |
RHistImplPrecisionAgnosticBase (const RHistImplPrecisionAgnosticBase &)=default | |
RHistImplPrecisionAgnosticBase (RHistImplPrecisionAgnosticBase &&)=default | |
RHistImplPrecisionAgnosticBase (std::string_view title) | |
virtual | ~RHistImplPrecisionAgnosticBase () |
virtual RAxisView | GetAxis (int iAxis) const=0 |
Get a RAxisView on axis with index iAxis. More... | |
virtual CoordArray_t | GetBinCenter (int binidx) const=0 |
Get the center in all dimensions of the bin with index binidx . More... | |
virtual double | GetBinContentAsDouble (int binidx) const=0 |
The bin content, cast to double. More... | |
virtual CoordArray_t | GetBinFrom (int binidx) const=0 |
Get the lower edge in all dimensions of the bin with index binidx . More... | |
virtual int | GetBinIndex (const CoordArray_t &x) const=0 |
Given the coordinate x , determine the index of the bin. More... | |
virtual int | GetBinIndexAndGrow (const CoordArray_t &x)=0 |
Given the coordinate x , determine the index of the bin, possibly growing axes for which x is out of range. More... | |
virtual CoordArray_t | GetBinTo (int binidx) const=0 |
Get the upper edge in all dimensions of the bin with index binidx . More... | |
virtual double | GetBinUncertainty (int binidx) const=0 |
The bin's uncertainty. More... | |
virtual int | GetNBins () const noexcept=0 |
Number of bins of this histogram, including all overflow and underflow bins. More... | |
virtual AxisIterRange_t | GetRange (const std::array< Hist::EOverflow, DIMENSIONS > &withOverUnder) const=0 |
Get a AxisIterRange_t for the whole histogram, possibly restricting the range to non-overflow bins. More... | |
const std::string & | GetTitle () const |
Get the histogram title. More... | |
virtual bool | HasBinUncertainty () const=0 |
Whether this histogram's statistics provide storage for uncertainties, or whether uncertainties are determined as poisson uncertainty of the content. More... | |
Private Attributes | |
std::tuple< AXISCONFIG... > | fAxes |
The histogram's axes. More... | |
Iterator interface | |
using | const_iterator = RHistBinIter< const ImplBase_t > |
using | iterator = RHistBinIter< ImplBase_t > |
iterator | begin () noexcept |
const_iterator | begin () const noexcept |
iterator | end () noexcept |
const_iterator | end () const noexcept |
Additional Inherited Members | |
Static Public Member Functions inherited from ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()> | |
static constexpr int | GetNDim () |
Number of dimensions of the coordinates. More... | |
#include <ROOT/RHistImpl.hxx>
using ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::AxisIterRange_t = typename Hist::AxisIterRange_t<NDIM> |
Definition at line 373 of file RHistImpl.hxx.
using ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::const_iterator = RHistBinIter<const ImplBase_t> |
Definition at line 555 of file RHistImpl.hxx.
using ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::CoordArray_t = typename ImplBase_t::CoordArray_t |
Definition at line 369 of file RHistImpl.hxx.
using ROOT::Experimental::Detail::RHistImplBase< DATA >::FillFunc_t = void (RHistImplBase::*)(const CoordArray_t &x, Weight_t w) |
Type of the Fill(x, w) function.
Definition at line 151 of file RHistImpl.hxx.
using ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::ImplBase_t = RHistImplBase<DATA> |
Definition at line 368 of file RHistImpl.hxx.
using ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::iterator = RHistBinIter<ImplBase_t> |
Definition at line 556 of file RHistImpl.hxx.
using ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::Weight_t = typename ImplBase_t::Weight_t |
Definition at line 370 of file RHistImpl.hxx.
ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::RHistImpl | ( | TRootIOCtor * | ) |
Definition at line 565 of file RHistImpl.hxx.
ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::RHistImpl | ( | AXISCONFIG... | axisArgs | ) |
Definition at line 569 of file RHistImpl.hxx.
ROOT::Experimental::Detail::RHistImpl< DATA, AXISCONFIG >::RHistImpl | ( | std::string_view | title, |
AXISCONFIG... | axisArgs | ||
) |
Definition at line 574 of file RHistImpl.hxx.
|
inlinefinal |
Apply a function (lambda) to all bins of the histogram.
The function takes the bin reference.
Definition at line 393 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Apply a function (lambda) to all bins of the histogram.
The function takes the bin coordinate and content.
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 401 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Apply a function (lambda) to all bins of the histogram.
The function takes the bin coordinate, content and uncertainty ("error") of the content.
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 409 of file RHistImpl.hxx.
|
inlinenoexcept |
Definition at line 558 of file RHistImpl.hxx.
|
inlinenoexcept |
Definition at line 557 of file RHistImpl.hxx.
|
inlineoverridevirtual |
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 383 of file RHistImpl.hxx.
|
inlinenoexcept |
Definition at line 560 of file RHistImpl.hxx.
|
inlinenoexcept |
Definition at line 559 of file RHistImpl.hxx.
|
inline |
Add a single weight w
to the bin at coordinate x
.
Definition at line 502 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Fill an array of weightN
to the bins specified by coordinates xN
.
For each element i
, the weight weightN[i]
will be added to the bin at the coordinate xN[i]
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 494 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Fill an array of weightN
to the bins specified by coordinates xN
.
For each element i
, the weight weightN[i]
will be added to the bin at the coordinate xN[i]
xN
and weightN
must have the same size! Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 477 of file RHistImpl.hxx.
|
inline |
Get the axes of this histogram.
Definition at line 416 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Normalized axes access, converting the actual axis to RAxisConfig.
Implements ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()>.
Definition at line 419 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Get the center coordinate of the bin.
Implements ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()>.
Definition at line 447 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Get the content of the bin at position x
.
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 509 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Get the coordinate of the low limit of the bin.
Implements ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()>.
Definition at line 456 of file RHistImpl.hxx.
|
inlinefinal |
Gets the bin index for coordinate x
; returns -1 if there is no such bin, e.g.
for axes without over / underflow but coordinate out of range.
Definition at line 423 of file RHistImpl.hxx.
|
inlinefinal |
Gets the bin index for coordinate x
, growing the axes as needed and possible.
Returns -1 if there is no such bin, e.g. for axes without over / underflow but coordinate out of range.
Definition at line 436 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Get the coordinate of the high limit of the bin.
Implements ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()>.
Definition at line 465 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Get the bin uncertainty for the bin at coordinate x.
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 521 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Return the uncertainties for the given bin.
Implements ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()>.
Definition at line 518 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Retrieve the fill function for this histogram implementation, to prevent the virtual function call for high-frequency fills.
Implements ROOT::Experimental::Detail::RHistImplBase< DATA >.
Definition at line 389 of file RHistImpl.hxx.
|
inlinefinal |
Get the begin() and end() for each axis.
[in] | withOverUnder | - Whether the begin and end should contain over- or underflow. Ignored if the axis does not support over- / underflow. |
Definition at line 536 of file RHistImpl.hxx.
|
inline |
Grow the axis number iAxis
to fit the coordinate x
.
The histogram (conceptually) combines pairs of bins along this axis until x
is within the range of the axis. The axis must support growing for this to work (e.g. a RAxisGrow
).
Definition at line 548 of file RHistImpl.hxx.
|
inlinefinalvirtual |
Whether this histogram's statistics provide storage for uncertainties, or whether uncertainties are determined as poisson uncertainty of the content.
Implements ROOT::Experimental::Detail::RHistImplPrecisionAgnosticBase< DATA::GetNDim()>.
Definition at line 529 of file RHistImpl.hxx.
|
private |
The histogram's axes.
Definition at line 376 of file RHistImpl.hxx.