SVDHitRateCounter.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <background/modules/BeamBkgHitRateMonitor/HitRateBase.h>
#include <framework/datastore/StoreArray.h>
#include <framework/database/DBObjPtr.h>
#include <framework/dbobjects/HardwareClockSettings.h>
#include <mdst/dataobjects/SoftwareTriggerResult.h>
#include <svd/dataobjects/SVDShaperDigit.h>
#include <svd/dataobjects/SVDCluster.h>
#include <svd/dataobjects/SVDEventInfo.h>
#include <svd/calibration/SVDHotStripsCalibrations.h>
#include <svd/calibration/SVDFADCMaskedStrips.h>
#include <TTree.h>
#include <map>
#include <string>
 
 
namespace Belle2 {
  namespace Background {
 
    class SVDHitRateCounter: public HitRateBase {
 
    public:
 
      struct TreeStruct {
        float layerAverageRates[4] = {0}; 
        float layerLadderAverageRates[4][16] = {{0}}; 
        float layerSensorAverageRates[4][5] = {{0}}; 
        float averageRate = 0; 
        float l3LadderSensorAverageRates[7][2] = {{0}}; 
        int numEvents = 0; 
        bool valid = false;  
        void normalize()
        {
          if (numEvents == 0) return;
          averageRate /= numEvents;
          for (auto& rate : layerAverageRates) rate /= numEvents;
          for (auto& row : layerLadderAverageRates) {
            for (auto& rate : row) {
              rate /= numEvents;
            }
          }
          for (auto& row : layerSensorAverageRates) {
            for (auto& rate : row) {
              rate /= numEvents;
            }
          }
          for (auto& row : l3LadderSensorAverageRates) {
            for (auto& rate : row) {
              rate /= numEvents;
            }
          }
        }
      };
 
      SVDHitRateCounter(const std::string& svdShaperDigitsName, double thrCharge,
                        bool ignoreHotStripsPayload = false,
                        bool ignoreMaskedStripsPayload = false):
        m_svdShaperDigitsName(svdShaperDigitsName), m_thrCharge(thrCharge),
        m_ignoreHotStripsPayload(ignoreHotStripsPayload),
        m_ignoreMaskedStripsPayload(ignoreMaskedStripsPayload)
      {}
 
      virtual void initialize(TTree* tree) override;
 
      virtual void clear() override;
 
      virtual void accumulate(unsigned timeStamp) override;
 
      virtual void normalize(unsigned timeStamp) override;
 
      void normalizeRates(TreeStruct& rates, bool isU = false, bool isV = false);
 
      void normalizeEnergyRates(TreeStruct& rates);
 
      int nStripsOnLayerSide(int layer, bool isU)
      {
        if (!isU && layer > 0) return 512; // V side on Layer 4,5,6
        else return 768;
      }
 
      double massOfSensor(int layer, int ladder, int sensor);
 
      bool isStripActive(const VxdID& sensorID, const bool& isU, const unsigned short& strip);
 
    private:
 
      // class parameters: to be set via constructor or setters
      int m_nLayers = 4; 
      int m_nLadders[4] = {7, 10, 12, 16}; 
      int m_nSensors[4] = {2, 3, 4, 5}; 
      // tree structure
      TreeStruct m_rates; 
      TreeStruct m_ratesU; 
      TreeStruct m_ratesV; 
      TreeStruct m_rates_highE; 
      TreeStruct m_rates_lowE; 
      TreeStruct m_clustersU; 
      TreeStruct m_clustersV; 
      TreeStruct m_rates_energyU; 
      TreeStruct m_rates_energyV; 
      // buffer
      std::map<unsigned, TreeStruct> m_buffer; 
      std::map<unsigned, TreeStruct> m_bufferU; 
      std::map<unsigned, TreeStruct> m_bufferV; 
      std::map<unsigned, TreeStruct> m_buffer_highE; 
      std::map<unsigned, TreeStruct> m_buffer_lowE; 
      std::map<unsigned, TreeStruct> m_buffer_clustersU; 
      std::map<unsigned, TreeStruct> m_buffer_clustersV; 
      std::map<unsigned, TreeStruct> m_buffer_energyU; 
      std::map<unsigned, TreeStruct> m_buffer_energyV; 
      // collections
      StoreArray<SVDShaperDigit> m_digits;  
      StoreArray<SVDCluster> m_clusters;  
      // store object
      StoreObjPtr<SoftwareTriggerResult> m_resultStoreObjectPointer; 
      StoreObjPtr<SVDEventInfo> m_eventInfo; 
      // DB payloads
      SVDHotStripsCalibrations m_HotStripsCalib; 
      SVDFADCMaskedStrips m_FADCMaskedStrips; 
      OptionalDBObjPtr<HardwareClockSettings> m_clockSettings; 
      // other
      std::string m_svdShaperDigitsName; 
      int m_activeStrips = 0; 
      int m_layerActiveStrips[4] = {0}; 
      int m_layerLadderActiveStrips[4][16] = {{0}}; 
      int m_layerSensorActiveStrips[4][5] = {{0}}; 
      int m_l3LadderSensorActiveStrips[7][2] = {{0}}; 
      int m_activeStripsU = 0; 
      int m_layerActiveStripsU[4] = {0}; 
      int m_layerLadderActiveStripsU[4][16] = {{0}}; 
      int m_layerSensorActiveStripsU[4][5] = {{0}}; 
      int m_l3LadderSensorActiveStripsU[7][2] = {{0}}; 
      int m_activeStripsV = 0; 
      int m_layerActiveStripsV[4] = {0}; 
      int m_layerLadderActiveStripsV[4][16] = {{0}}; 
      int m_layerSensorActiveStripsV[4][5] = {{0}}; 
      int m_l3LadderSensorActiveStripsV[7][2] = {{0}}; 
      double m_thrCharge = 0; 
      bool m_ignoreHotStripsPayload; 
      bool m_ignoreMaskedStripsPayload; 
      double m_massKg = 0; 
      double m_layerMassKg[4] = {0}; 
      double m_layerLadderMassKg[4][16] = {{0}}; 
      double m_layerSensorMassKg[4][5] = {{0}}; 
      // No need for m_l3LadderSensorMassKg, massOfSensor() can be used.
 
      static constexpr double c_SVDSamplingClockFrequency = 0.03175;
    };
 
  } // Background namespace
} // Belle2 namespace