sTgcDigitMaker.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef STGCDIGITMAKER_H
#define STGCDIGITMAKER_H
 
#include "AthenaBaseComps/AthMessaging.h"
#include "MuonSimEvent/sTGCSimHit.h"
#include "MuonSimEvent/sTgcHitIdHelper.h"
#include "MuonCondData/DigitEffiData.h"
#include "MuonCondData/NswCalibDbThresholdData.h"
#include "MuonReadoutGeometry/sTgcReadoutElement.h"
#include "MuonReadoutGeometry/MuonDetectorManager.h"
#include "CxxUtils/ArrayHelper.h"
#include "MuonDigitContainer/sTgcDigit.h"
namespace CLHEP {
  class HepRandomEngine;
  class HepRandom;
}
 
 
class sTgcDigitCollection;
class sTgcHitIdHelper;
class sTgcIdHelper;
 
//--- class description
class sTgcDigitMaker : public AthMessaging {
  //------ for public
 public:
 
  sTgcDigitMaker(const Muon::IMuonIdHelperSvc* idHelperSvc,
                 const int channelTypes,
                 double meanGasGain, 
                 bool doPadChargeSharing,
                 double stripChargeScale);
 
  virtual ~sTgcDigitMaker();
 
  StatusCode initialize();
 
  struct DigiConditions {
     const MuonGM::MuonDetectorManager* detMgr{nullptr};
     const Muon::DigitEffiData* efficiencies{nullptr};
     const NswCalibDbThresholdData* thresholdData{nullptr};
     CLHEP::HepRandomEngine* rndmEngine{nullptr};
  };
 
  using sTgcDigitVec = std::vector<std::unique_ptr<sTgcDigit>>;
  sTgcDigitVec executeDigi(const DigiConditions& condContainers, const sTGCSimHit& hit) const;
 
  //====== for private
 private:
 
  struct GammaParameter {
    double lowEdge{0.}; // low side of the interval in ns
    double kParameter{0.};
    double thetaParameter{0.};
  };
 
  struct Ionization {
    double distance{-9.99}; //smallest distance bet the wire and particle trajectory
    Amg::Vector3D posOnSegment{Amg::Vector3D::Zero()}; // Point of closest approach
    Amg::Vector3D posOnWire{Amg::Vector3D::Zero()}; // Position on the wire
  };
 
  //uint16_t bcTagging(const double digittime, const int channelType) const;
  static void addDigit(sTgcDigitVec& digits, 
                const Identifier& id, 
                const uint16_t bctag, 
                const double digittime, 
                const double charge) ;
 
  StatusCode readFileOfTimeArrival();
  StatusCode readFileOfTimeOffsetStrip();
 
  
  
  Ionization pointClosestApproach(const MuonGM::sTgcReadoutElement* readoutEle,
                                  const Identifier& id, 
                                  int wireNumber, 
                                  const Amg::Vector3D& preStepPos,
                                  const Amg::Vector3D& postStepPos) const;
 
  double getTimeOffsetStrip(size_t neighbor_index) const;
 
  static double getPadChargeFraction(double distance) ;
 
  GammaParameter getGammaParameter(double distance) const;
  double getMostProbableArrivalTime(double distance) const;
 
  // Parameters of the gamma pdf required for determining digit time
  std::vector<GammaParameter> m_gammaParameter;
  // 4th-order polymonial describing the most probable time as function of the distance of closest approach
  std::array<double, 5> m_mostProbableArrivalTime{make_array<double, 5>(0.)};
 
  // Time offset to add to Strip timing
  std::array<double, 6> m_timeOffsetStrip{make_array<double, 6>(0.)};
 
  const Muon::IMuonIdHelperSvc* m_idHelperSvc{nullptr};
 
  int m_channelTypes{3}; // 1 -> strips, 2 -> strips+wires, 3 -> strips/wires/pads
  double m_theta{0.8}; // theta=0.8 value best matches the PDF
  double m_meanGasGain{5.e4};  // mean gain estimated from ATLAS note "ATL-MUON-PUB-2014-001"
  bool m_doPadSharing{false};
 
 
  // Flag to enable strip time offset
  bool m_doTimeOffsetStrip{false};
  // Angular strip resolution parameter
  double m_StripResolution{0.0949};
  double m_posResIncident{1.};
  double m_posResAngular{0.305/m_StripResolution};
  // Strip cluster charge profile: [0] = norm of inner Gaussian, [1] = sigma of inner Gaussian,
  //   [2] = norm of outer Gaussian, [3] = sigma of outer Gaussian
  static constexpr std::array<double, 4> m_clusterProfile{0.350, 0.573, 0.186, 1.092};
  // Dependence of energy deposited on incident angle
  double m_chargeAngularFactor{4.0};
  // Overall factor to scale the total strip cluster charge
  double m_stripChargeScale{0.4};
};
 
#endif