KLMHitRateCounter Class Reference

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

#include <KLMHitRateCounter.h>

Inheritance diagram for KLMHitRateCounter:

Classes
struct	TreeStruct
	Tree data structure. More...

Public Member Functions
	KLMHitRateCounter ()
	Constructor.
virtual void	initialize (TTree *tree) override
	Class initializer.
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 (i.e.

Private Attributes
TreeStruct	m_rates
	Tree data.
std::map< unsigned, TreeStruct >	m_buffer
	Buffer.
StoreArray< KLMDigit >	m_digits
	KLM digits.
const KLMElementNumbers *	m_ElementNumbers = nullptr
	KLM element numbers.
const KLMModuleArrayIndex *	m_ModuleArrayIndex = nullptr
	KLM module array index.
DBObjPtr< KLMChannelStatus >	m_ChannelStatus
	KLM channel status.

Detailed Description

Class for monitoring beam background hit rates of EKLM.

Definition at line 37 of file KLMHitRateCounter.h.

Constructor & Destructor Documentation

KLMHitRateCounter()

KLMHitRateCounter ( )

inline

Constructor.

Definition at line 75 of file KLMHitRateCounter.h.

{};

Member Function Documentation

accumulate()

void accumulate ( unsigned  timeStamp )

overridevirtual

Accumulate hits.

Parameters

[in]

timeStamp

Time stamp.

Implements HitRateBase.

Definition at line 35 of file KLMHitRateCounter.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
  for (const KLMDigit& klmDigit : m_digits) {
    if (!klmDigit.inRPC() && !klmDigit.isGood())
      continue;
    uint16_t moduleNumber =
      m_ElementNumbers->moduleNumber(
        klmDigit.getSubdetector(), klmDigit.getSection(), klmDigit.getSector(),
        klmDigit.getLayer());
    int module = m_ModuleArrayIndex->getIndex(moduleNumber);
    if (module >= 0 and module < KLMElementNumbers::getTotalModuleNumber()) {
      rates.moduleRates[module] += 1;
    } else {
      B2ERROR("KLMHitRateCounter: module number out of range"
              << LogVar("module", module));
    }
    rates.averageRate += 1;
  }
 
  // 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 30 of file KLMHitRateCounter.cc.

{
  m_buffer.clear();
}

initialize()

void initialize ( TTree *  tree )

overridevirtual

Class initializer.

Parameters

[in,out]

tree

Data tree.

Implements HitRateBase.

Definition at line 14 of file KLMHitRateCounter.cc.

{
  // register collection(s) as optional, your detector might be excluded in DAQ
  m_digits.isOptional();
  m_ElementNumbers = &(KLMElementNumbers::Instance());
  m_ModuleArrayIndex = &(KLMModuleArrayIndex::Instance());
 
  // set branch address
  std::string branches;
  branches =
    "moduleRates[" +
    std::to_string(KLMElementNumbers::getTotalModuleNumber()) +
    "]/F:averageRate/F:numEvents/I:valid/O";
  tree->Branch("klm", &m_rates, branches.c_str());
}

normalize()

void normalize ( unsigned  timeStamp )

overridevirtual

Normalize accumulated hits (i.e.

transform to rates).

Parameters

[in]

timeStamp

Time stamp.

Implements HitRateBase.

Definition at line 69 of file KLMHitRateCounter.cc.

{
  // copy buffer element
  m_rates = m_buffer[timeStamp];
 
  if (not m_rates.valid) return;
 
  // normalize
  m_rates.normalize();
 
  /* Normalize the hit rate per 1 strip. */
  for (int i = 0; i < KLMElementNumbers::getTotalModuleNumber(); ++i) {
    uint16_t module = m_ModuleArrayIndex->getNumber(i);
    int activeStrips = m_ChannelStatus->getActiveStripsInModule(module);
    if (activeStrips == 0)
      m_rates.moduleRates[i] = 0;
    else
      m_rates.moduleRates[i] /= activeStrips;
  }
}

Member Data Documentation

m_buffer

std::map<unsigned, TreeStruct> m_buffer

private

Buffer.

Definition at line 106 of file KLMHitRateCounter.h.

m_ChannelStatus

DBObjPtr<KLMChannelStatus> m_ChannelStatus

private

KLM channel status.

Definition at line 118 of file KLMHitRateCounter.h.

m_digits

StoreArray<KLMDigit> m_digits

private

KLM digits.

Definition at line 109 of file KLMHitRateCounter.h.

m_ElementNumbers

const KLMElementNumbers* m_ElementNumbers = nullptr

private

KLM element numbers.

Definition at line 112 of file KLMHitRateCounter.h.

m_ModuleArrayIndex

const KLMModuleArrayIndex* m_ModuleArrayIndex = nullptr

private

KLM module array index.

Definition at line 115 of file KLMHitRateCounter.h.

m_rates

TreeStruct m_rates

private

Tree data.

Definition at line 103 of file KLMHitRateCounter.h.

---

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

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