template<typename BinContentType>
class ROOT::Experimental::RHistAutoAxisFiller< BinContentType >

A histogram filler that automatically determines the axis interval.

This class allows filling a regular one-dimensional histogram without specifying an axis interval during construction. After a configurable number of buffered entries, or upon request, a RRegularAxis is constructed using the minimum and maximum values until that point. This ensures all initial entries are filled into normal bins. Note that this cannot be guaranteed for further calls to Fill.

ROOT::Experimental::RHistAutoAxisFiller<int> filler(20);
filler.Fill(1.0);
filler.Fill(1.5);
filler.Fill(2.0);
 
// The following will implicitly trigger the histogram creation
auto &hist = filler.GetHist();
// hist.GetNEntries() will return 3

Warning: This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is welcome!

Definition at line 50 of file RHistAutoAxisFiller.hxx.

Public Member Functions
	RHistAutoAxisFiller (std::uint64_t nNormalBins, std::size_t maxBufferSize=1024, double marginFraction=0.05)
	Create a filler object.

void	Fill (double x)
	Fill an entry into the histogram.

void	Fill (double x, RWeight weight)
	Fill an entry into the histogram with a weight.

void	Flush ()
	Flush the buffer of entries and construct the histogram.

RHist< BinContentType > &	GetHist ()
	Return the constructed histogram.

double	GetMarginFraction () const

std::size_t	GetMaxBufferSize () const

std::uint64_t	GetNNormalBins () const

Static Public Attributes
static constexpr bool	SupportsWeightedFilling = RHistEngine<BinContentType>::SupportsWeightedFilling

Private Types
using	BufferElement = std::conditional_t<SupportsWeightedFilling, std::pair<double, RWeight>, double>

Private Member Functions
void	BufferImpl (double x, RWeight weight)

Private Attributes
std::vector< BufferElement >	fBuffer
	The buffer of filled entries.

std::optional< RHist< BinContentType > >	fHist
	The filled histogram, after it has been constructed.

double	fMarginFraction
	The fraction of the axis interval to use as margin.

std::size_t	fMaxBufferSize
	The maximum buffer size until Flush() is automatically called.

double	fMaximum = -std::numeric_limits<double>::infinity()
	The maximum of the filled entries.

double	fMinimum = std::numeric_limits<double>::infinity()
	The minimum of the filled entries.

std::uint64_t	fNNormalBins
	The number of normal bins.

[in]	nNormalBins	the number of normal bins, must be > 0
[in]	maxBufferSize	the maximum buffer size, must be > 0
[in]	marginFraction	the fraction of the axis interval to use as margin, must be > 0

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ BufferElement

Constructor & Destructor Documentation

◆ RHistAutoAxisFiller()

Member Function Documentation

◆ BufferImpl()

◆ Fill() [1/2]

◆ Fill() [2/2]

◆ Flush()

◆ GetHist()

◆ GetMarginFraction()

◆ GetMaxBufferSize()

◆ GetNNormalBins()

Member Data Documentation

◆ fBuffer

◆ fHist

◆ fMarginFraction

◆ fMaxBufferSize

◆ fMaximum

◆ fMinimum

◆ fNNormalBins

◆ SupportsWeightedFilling