TOPHitRateCounter Class Reference

Class for monitoring beam background hit rates of TOP. More...

#include <TOPHitRateCounter.h>

Inheritance diagram for TOPHitRateCounter:

Collaboration diagram for TOPHitRateCounter:

Classes
struct	TreeStruct
	tree structure More...

Public Member Functions
	TOPHitRateCounter (double timeOffset, double timeWindow)
	Constructor.
virtual void	initialize (TTree *tree) override
	Class initializer: set branch addresses and other staf.
virtual void	clear () override
	Clear time-stamp buffer to prepare for 'accumulate'.
virtual void	accumulate (unsigned timeStamp) override
	Accumulate hits.
virtual void	normalize (unsigned timeStamp) override
	Normalize accumulated hits (e.g.

Private Member Functions
void	setActiveFractions ()
	Sets fractions of active channels.

Private Attributes
double	m_timeOffset = 0
	time offset of hits [ns]
double	m_timeWindow = 0
	time window in which to count hits [ns]
TreeStruct	m_rates
	tree variables
std::map< unsigned, TreeStruct >	m_buffer
	average rates in time stamps
StoreArray< TOPDigit >	m_digits
	collection of digits
DBObjPtr< TOPCalChannelMask >	m_channelMask
	channel mask
TH1F *	m_hits = 0
	time distribution of hits in wide range
TH1F *	m_hitsInWindow = 0
	time distribution of hits inside timeWindow
double	m_activeFractions [16] = {0}
	fractions of active channels in slots
double	m_activeTotal = 0
	total fraction of active channels

Detailed Description

Class for monitoring beam background hit rates of TOP.

Hit rates are given in MHz per PMT and are already corrected for different pixel efficiencies and masked-out pixels.

Definition at line 33 of file TOPHitRateCounter.h.

Constructor & Destructor Documentation

TOPHitRateCounter()

TOPHitRateCounter ( double  timeOffset, double  timeWindow  )

inline

Constructor.

Parameters

timeOffset	time offset to be subtracted from hit times [ns]
timeWindow	time window (full size) in which to count hits [ns]

Definition at line 63 of file TOPHitRateCounter.h.

                                                             :
        m_timeOffset(timeOffset), m_timeWindow(timeWindow)
      {}

Member Function Documentation

accumulate()

void accumulate ( unsigned  timeStamp )

overridevirtual

Accumulate hits.

Parameters

timeStamp

time stamp

Implements HitRateBase.

Definition at line 56 of file TOPHitRateCounter.cc.

    {
      // check if data are available
      if (not m_digits.isValid()) return;
 
      // get buffer element
      auto& rates = m_buffer[timeStamp];
 
      // increment event counter
      rates.numEvents++;
 
      // accumulate hits (weighted by efficiency correction)
      const auto* topgp = TOP::TOPGeometryPar::Instance();
      for (const auto& digit : m_digits) {
        if (digit.getHitQuality() != TOPDigit::c_Good) continue;
        m_hits->Fill(digit.getTime());
 
        if (fabs(digit.getTime() - m_timeOffset) > m_timeWindow / 2) continue;
        m_hitsInWindow->Fill(digit.getTime());
 
        auto effi = topgp->getRelativePixelEfficiency(digit.getModuleID(),
                                                      digit.getPixelID());
        float wt = std::min(1.0 / effi, 10.0);
        rates.slotRates[digit.getModuleID() - 1] += wt;
        rates.averageRate += wt;
      }
 
      // set flag to true to indicate the rates are valid
      rates.valid = true;
 
    }

clear()

void clear ( )

overridevirtual

Clear time-stamp buffer to prepare for 'accumulate'.

Implements HitRateBase.

Definition at line 51 of file TOPHitRateCounter.cc.

    {
      m_buffer.clear();
    }

initialize()

void initialize ( TTree *  tree )

overridevirtual

Class initializer: set branch addresses and other staf.

Parameters

tree	a valid TTree pointer

Implements HitRateBase.

Definition at line 28 of file TOPHitRateCounter.cc.

    {
      // register collection(s) as optional, your detector might be excluded in DAQ
      m_digits.isOptional();
 
      // set branch address
      tree->Branch("top", &m_rates, "slotRates[16]/F:averageRate/F:numEvents/I:valid/O");
 
      // create control histograms
      m_hits = new TH1F("top_hits", "time distribution of hits; digit.time [ns]",
                        1000, -500, 500);
      m_hitsInWindow = new TH1F("top_hitsInWindow",
                                "time distribution of hits; digit.time [ns]",
                                100, m_timeOffset - m_timeWindow / 2,
                                m_timeOffset + m_timeWindow / 2);
 
      // check parameters
      if (m_timeWindow <= 0) B2FATAL("invalid time window for TOP: " << m_timeWindow);
 
      // set fractions of active channels
      setActiveFractions();
    }

normalize()

void normalize ( unsigned  timeStamp )

overridevirtual

Normalize accumulated hits (e.g.

transform to rates) and prepare for TTree::Fill

Parameters

timeStamp

time stamp

Implements HitRateBase.

Definition at line 88 of file TOPHitRateCounter.cc.

    {
      // copy buffer element
      m_rates = m_buffer[timeStamp];
 
      if (not m_rates.valid) return;
 
      // normalize
      m_rates.normalize();
 
      // convert rates to [MHz/PMT]
      for (auto& slotRate : m_rates.slotRates) {
        slotRate /= m_timeWindow / Unit::us * 32; // 32 PMT's per slot
      }
      m_rates.averageRate /= m_timeWindow / Unit::us * 32 * 16; // 16 slots
 
      // check if DB object has changed and if so set fractions of active channels
      if (m_channelMask.hasChanged()) setActiveFractions();
 
      // correct rates for masked-out channels
      for (int m = 0; m < 16; m++) {
        double fraction = m_activeFractions[m];
        if (fraction > 0) {
          m_rates.slotRates[m] /= fraction;
        } else {
          m_rates.slotRates[m] = 0;
        }
      }
      m_rates.averageRate /= m_activeTotal; // we don't expect full TOP to be masked-out
 
    }

setActiveFractions()

void setActiveFractions ( )

private

Sets fractions of active channels.

Definition at line 120 of file TOPHitRateCounter.cc.

    {
      if (not m_channelMask.isValid()) {
        for (auto& fraction : m_activeFractions) fraction = 1;
        m_activeTotal = 1;
        B2WARNING("TOPHitRateCounter: no valid channel mask - active fractions set to 1");
        return;
      }
 
      for (int m = 0; m < 16; m++) {
        m_activeFractions[m] = m_channelMask->getActiveFraction(m + 1);
      }
      m_activeTotal = m_channelMask->getActiveFraction();
 
    }

Member Data Documentation

m_activeFractions

double m_activeFractions[16] = {0}

private

fractions of active channels in slots

Definition at line 118 of file TOPHitRateCounter.h.

m_activeTotal

double m_activeTotal = 0

private

total fraction of active channels

Definition at line 119 of file TOPHitRateCounter.h.

m_buffer

std::map<unsigned, TreeStruct> m_buffer

private

average rates in time stamps

Definition at line 105 of file TOPHitRateCounter.h.

m_channelMask

DBObjPtr<TOPCalChannelMask> m_channelMask

private

channel mask

Definition at line 111 of file TOPHitRateCounter.h.

m_digits

StoreArray<TOPDigit> m_digits

private

collection of digits

Definition at line 108 of file TOPHitRateCounter.h.

m_hits

TH1F* m_hits = 0

private

time distribution of hits in wide range

Definition at line 114 of file TOPHitRateCounter.h.

m_hitsInWindow

TH1F* m_hitsInWindow = 0

private

time distribution of hits inside timeWindow

Definition at line 115 of file TOPHitRateCounter.h.

m_rates

TreeStruct m_rates

private

tree variables

Definition at line 102 of file TOPHitRateCounter.h.

m_timeOffset

double m_timeOffset = 0

private

time offset of hits [ns]

Definition at line 98 of file TOPHitRateCounter.h.

m_timeWindow

double m_timeWindow = 0

private

time window in which to count hits [ns]

Definition at line 99 of file TOPHitRateCounter.h.

---

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

• background/modules/BeamBkgHitRateMonitor/include/TOPHitRateCounter.h
• background/modules/BeamBkgHitRateMonitor/src/TOPHitRateCounter.cc