SVDDigitizerModule.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.                  *
 **************************************************************************/
 
#ifndef SVDDigitizerModule_H
#define SVDDigitizerModule_H
 
#include <framework/core/Module.h>
#include <svd/dataobjects/SVDSimHit.h>
#include <svd/simulation/SVDWaveform.h>
#include <svd/geometry/SensorInfo.h>
#include <svd/calibration/SVDNoiseCalibrations.h>
#include <svd/calibration/SVDPulseShapeCalibrations.h>
#include <svd/calibration/SVDChargeSimulationCalibrations.h>
#include <svd/calibration/SVDFADCMaskedStrips.h>
#include <svd/online/SVDOnlineToOfflineMap.h>
#include <framework/database/PayloadFile.h>
#include <svd/dataobjects/SVDEventInfo.h>
#include <framework/dbobjects/HardwareClockSettings.h>
 
#include <string>
 
#include <Math/Vector3D.h>
#include <root/TFile.h>
#include <root/TTree.h>
#include <root/TH1D.h>
#include <root/TH2F.h>
 
namespace Belle2 {
  namespace SVD {
 
    typedef std::map<short int, SVDWaveform> StripWaveforms;
 
    typedef std::pair<StripWaveforms, StripWaveforms> SensorWaveforms;
 
    typedef std::map<VxdID, SensorWaveforms> Waveforms;
 
    class SVDDigitizerModule : public Module {
    public:
      SVDDigitizerModule();
 
      void processHit();
 
      void driftCharge(const ROOT::Math::XYZVector& position, double carriers, SVD::SensorInfo::CarrierType carrierType);
 
      double addNoise(double charge, double noise);
 
      void saveDigits();
 
      void saveWaveforms();
 
      void saveSignals();
 
      virtual void initialize() override;
      virtual void beginRun() override;
      virtual void event() override;
      virtual void terminate() override;
 
    protected:
 
      // Members holding module parameters:
 
      // 1. Collections
      std::string m_storeMCParticlesName = "";
      std::string m_storeSimHitsName = "";
      std::string m_storeTrueHitsName = "";
      std::string m_relMCParticleSimHitName = "";
      std::string m_relTrueHitSimHitName = "";
      std::string m_storeShaperDigitsName = "";
      std::string m_relShaperDigitMCParticleName = "";
      std::string m_relShaperDigitTrueHitName = "";
      std::string m_svdEventInfoName = "SVDEventInfoSim";
 
      // 2. Physics
      double m_segmentLength = 0.020;
 
      // 3. Noise
      bool  m_applyPoisson = true;
      double m_SNAdjacent = 3.0;
      bool m_roundZS = true;
      int m_nSamplesOverZS = 1;
      double m_noiseFraction = 0.01;
 
      // 4. Timing
      DBObjPtr<HardwareClockSettings> m_hwClock;
      double m_betaPrimeDecayTimeU = 250.0;
      double m_betaPrimeDecayTimeV = 250.0;
      double m_samplingTime = -1;
      double m_startSampling = -2;
      double m_initTime = 0;
 
      bool m_randomizeEventTimes = false;
      float m_minTimeFrame = -300;
      float m_maxTimeFrame = 150;
      float m_currentEventTime = 0.0;
 
      // 5. 3-mixed-6 and 3-sample daqMode
      bool m_is3sampleEvent = false;
      int m_nAPV25Samples = 6;
 
      // 6. Reporting
      std::string m_rootFilename = "";
      bool m_storeWaveforms = false;
      std::string m_signalsList = "";
 
 
      // Other data members:
 
      Waveforms m_waveforms;
 
      const SVDSimHit*   m_currentHit = nullptr;
      int                m_currentParticle = -1;
      int                m_currentTrueHit = -1;
      SensorWaveforms*            m_currentSensorWaveforms = nullptr;
      const SensorInfo*  m_currentSensorInfo = nullptr;
      double m_currentTime = 0;
      double m_sensorThickness = 0.03;
 
      int m_relativeShift = 0;
      int m_startingSample = 0;
 
      int getFirstSample(int triggerBin, int relativShift);
 
      //payloads:
      SVDFADCMaskedStrips m_MaskedStr; 
      static std::string m_xmlFileName ;
      DBObjPtr<PayloadFile> m_mapping; 
      std::unique_ptr<SVDOnlineToOfflineMap> m_map; 
      SVDChargeSimulationCalibrations m_ChargeSimCal; 
      SVDNoiseCalibrations m_NoiseCal; 
      SVDPulseShapeCalibrations m_PulseShapeCal; 
      // ROOT stuff:
      TFile* m_rootFile = nullptr;
      TH1D*  m_histChargeSharing_u = nullptr;
      TH1D*  m_histChargeSharing_v = nullptr;
 
      TH1D*  m_histMobility_e = nullptr;
      TH1D*  m_histMobility_h = nullptr;
      TH1D*  m_histVelocity_e = nullptr;
      TH1D*  m_histVelocity_h = nullptr;
      TH1D*  m_histDistanceToPlane_e = nullptr;
      TH1D*  m_histDistanceToPlane_h = nullptr;
      TH1D*  m_histDriftTime_e = nullptr;
      TH1D*  m_histDriftTime_h = nullptr;
      TH1D*  m_histHitTime = nullptr;
      TH2F*  m_histHitTimeTB = nullptr;
 
      TH1D*  m_histLorentz_u = nullptr;
      TH1D*  m_histLorentz_v = nullptr;
      TH1D*  m_signalDist_u = nullptr;
      TH1D*  m_signalDist_v = nullptr;
      TTree* m_waveTree = nullptr;
 
    };//end class declaration
 
 
  } // end namespace SVD
} // end namespace Belle2
 
#endif // SVDDigitizerModule_H