Pottu
Public Member Functions | List of all members
pottu::RateHistogrammer< Selector > Class Template Reference

Rate histogramming stage. More...

#include <RateHistogrammer.hpp>

Inheritance diagram for pottu::RateHistogrammer< Selector >:
Inheritance graph
[legend]
Collaboration diagram for pottu::RateHistogrammer< Selector >:
Collaboration graph
[legend]

Public Member Functions

 RateHistogrammer (_result_tree_type results, Selector selector, const std::string &name, uint64_t divider=60 *100000000ULL, uint64_t low=0, uint64_t high=30ULL *24ULL *60ULL, uint64_t binCount=30UL *24UL *60ULL)
 Constructs the rate histogrammer. More...
 
 RateHistogrammer (_result_tree_type results, Selector selector, const std::string &name, uint64_t divider=60 *100000000ULL, uint64_t low=0, uint64_t binCount=30UL *24UL *60ULL)
 Constructs the rate histogrammer. More...
 
virtual void process (std::vector< DetectorEvent > &data) noexcept
 Fills rate histograms with filtered detector events. More...
 
const Selector & getSelector () const noexcept
 Returns the constant selector instance. More...
 
Selector & getSelector () noexcept
 Returns the constant selector instance. More...
 
- Public Member Functions inherited from pottu::StageDetectorEvent
virtual ~StageDetectorEvent ()
 Virtual desctructor.
 

Detailed Description

template<class Selector>
class pottu::RateHistogrammer< Selector >

Rate histogramming stage.

Template Parameters
SelectorClass to be used to filter detector events. See for example SelectorGroupEnergy.

The channels are selected by the Selector template class. See examples in DetectorEvent.hpp (for example SelectorGroup etc.)

Constructor & Destructor Documentation

◆ RateHistogrammer() [1/2]

template<class Selector >
pottu::RateHistogrammer< Selector >::RateHistogrammer ( _result_tree_type  results,
Selector  selector,
const std::string &  name,
uint64_t  divider = 60*100000000ULL,
uint64_t  low = 0,
uint64_t  high = 30ULL*24ULL*60ULL,
uint64_t  binCount = 30UL*24UL*60ULL 
)
inline

Constructs the rate histogrammer.

Deprecated:
This constructor is depracated. Please use the other one without explicit parameter high.
Parameters
resultsPointer to the directory where the histogram will be created.
selectorSelector instance to be used to filter the detector events.
nameName of the histogram.
dividerDAQ tics to be used to divide the time stamp of an event before filling the histogram. Default is 60 seconds for 100 MHz DAQ.
lowLow of the rate histogram. The unit is same as divider.
highHigh end of the histogram. The unit is same as divider.
binCountNumber of bins in the histogram. high should be low+binCount, otherwise the histogram will have some defects.

◆ RateHistogrammer() [2/2]

template<class Selector >
pottu::RateHistogrammer< Selector >::RateHistogrammer ( _result_tree_type  results,
Selector  selector,
const std::string &  name,
uint64_t  divider = 60*100000000ULL,
uint64_t  low = 0,
uint64_t  binCount = 30UL*24UL*60ULL 
)
inline

Constructs the rate histogrammer.

Parameters
resultsPointer to the directory where the histogram will be created.
selectorSelector instance to be used to filter the detector events.
nameName of the histogram.
dividerDAQ tics to be used to divide the time stamp of an event before filling the histogram. Default is 60 seconds for 100 MHz DAQ.
lowLow of the rate histogram. The unit is same as divider.
binCountNumber of bins in the histogram. The high of the histogram is set to be low+binCount.

This constructor should be used instead of the other which sets high explicitly.

Member Function Documentation

◆ getSelector() [1/2]

template<class Selector >
const Selector& pottu::RateHistogrammer< Selector >::getSelector ( ) const
inlinenoexcept

Returns the constant selector instance.

Returns
The reference to the constant selector instance.

◆ getSelector() [2/2]

template<class Selector >
Selector& pottu::RateHistogrammer< Selector >::getSelector ( )
inlinenoexcept

Returns the constant selector instance.

Returns
The reference to the selector instance.

This can be used to modify the Selector.

◆ process()

template<class Selector >
virtual void pottu::RateHistogrammer< Selector >::process ( std::vector< DetectorEvent > &  data)
inlinevirtualnoexcept

Fills rate histograms with filtered detector events.

Parameters
dataDetector events to be used. Detector events are not modified.

Implements pottu::StageDetectorEvent.


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