Update StMuEpdHit to include the DEP information

Author: plexoos

StRoot/StMuDSTMaker/COMMON/StMuEpdHit.cxx

@@ -24,31 +24,37 @@
  *  the StEpdHit object in StEvent
  *
  * - Mike Lisa Jan 2018
+ *
+ * - Updated March 2023 - Mike Lisa - see header for details.
+ *
  ************************************************/
 
 #include "StEvent/StEpdHit.h"
 #include "StMuEpdHit.h"
 
 ClassImp(StMuEpdHit)
 
-StMuEpdHit::StMuEpdHit() : StMuEpdHit(0, 0, 0, 0, 0, 0, false, 0.0, false, 0){
+StMuEpdHit::StMuEpdHit() : StMuEpdHit(0, 0, 0, 0, 0, 0, false, 0.0, false, 0, 0, 0.0){
   /* no-op */
 }
 
 StMuEpdHit::StMuEpdHit(Int_t position, Int_t tile,
 		       Short_t EW, Int_t ADC, Int_t TAC,
-		       Int_t TDC, bool hasTAC, Float_t nMIP,
-		       bool statusIsGood, Int_t truthId) :
+		       Int_t TDC, bool hasTAC, Float_t nMIP_QT,
+		       bool statusIsGood, Int_t truthId,
+		       UShort_t DEPdata, Float_t nMIP_DEP) :
   mId( (100*position + tile)*EW ),
   mQTdata( (ADC & 0x0FFF) | (TAC & 0x0FFF) << 12 | (TDC & 0x001F) << 24 | hasTAC << 29 | statusIsGood << 30 ),
-  mnMIP(nMIP),
-  mTruthId(truthId)
+  mnMIP_QT(nMIP_QT),
+  mTruthId(truthId),
+  mDEPdata(DEPdata),
+  mnMIP_DEP(nMIP_DEP)
 {
   /* no-op */
 }
 
 StMuEpdHit::StMuEpdHit(StEpdHit* epdHit) :
-  mId(epdHit->id()),  mQTdata(epdHit->qtData()), mnMIP(epdHit->nMIP()), mTruthId(epdHit->idTruth())
+  mId(epdHit->id()),  mQTdata(epdHit->qtData()), mnMIP_QT(epdHit->nMIP_QT()), mTruthId(epdHit->idTruth()), mDEPdata(epdHit->depData()), mnMIP_DEP(epdHit->nMIP_DEP())
 {
   /* no-op */
 }

StRoot/StMuDSTMaker/COMMON/StMuEpdHit.h

@@ -27,6 +27,17 @@
  *  the StEpdHit object in StEvent
  *
  * - Mike Lisa Jan 2018
+ *
+ *
+ * Update March 2023 (More than 5 years later.  Not bad.)  Mike Lisa
+ * - We now have the DAQ upgrade and DEP readout on the West side.
+ *   DEP information will *always* be there.  QT only at low rate.
+ *   So, now have to store DEP information.
+ *
+ * It means several new methods, and two new data members:
+ * 1) unsigned short DEPdata
+ * 2) float nMIP_DEP
+ * So, now the size of one StMuEpdHit is 16 bytes
  ************************************************/
 class StEpdHit;
 
@@ -44,10 +55,12 @@ class StMuEpdHit : public StObject
   /// \param TAC          TAC reported by QT board (if there is one) [0,4095]
   /// \param TDC          TDC reported by QT board [0,32]
   /// \param hasTAC       true/fals if this channel has a TAC
-  /// \param nMIP         gain-calibrated signal; energy loss in terms of MPV of Landau for a MIP
+  /// \param nMIP_QT      gain-calibrated signal; energy loss in terms of MPV of Landau for a MIP - based on QT data
   /// \param statusIsGood good status, according to database
   /// \param truthId      id of particle most responsible for energy loss (simulation)
-  StMuEpdHit(Int_t position, Int_t tile, Short_t EW, Int_t ADC, Int_t TAC, Int_t TDC, bool hasTAC, Float_t nMIP, bool statusIsGood, Int_t truthId);
+  /// \param DEPdata      raw data from DEP - March 2023
+  /// \param nMIP_DEP     gain-calibrated signal; energy loss in terms of MPV of Landau for a MIP - based on DEP data - March 2023
+  StMuEpdHit(Int_t position, Int_t tile, Short_t EW, Int_t ADC, Int_t TAC, Int_t TDC, bool hasTAC, Float_t nMIP_QT, bool statusIsGood, Int_t truthId, UShort_t DEPdata, Float_t nMIP_DEP);
 
   /// constructor based on StEpdHit
   /// this is what will be used in constructing the StMuDst from the StEvent
@@ -77,8 +90,6 @@ class StMuEpdHit : public StObject
   ///                    bit 29=0/1 for has/does not have TAC;
   ///                    bit 30=0/1 if tile is marked bad/good in database
   Int_t qtData() {return mQTdata;}
-  /// gain calibrated energy loss in tile, in units of Landau MPV for one MIP
-  Float_t nMIP() {return mnMIP;}
   /// false if tile is bad or missing, according to (time-dependent) database
   bool isGood() const;
 
@@ -92,15 +103,30 @@ class StMuEpdHit : public StObject
   /// It is expected that this will not be invoked, but rather the constructor used
   /// \param id = sign*(100*position+tile) where sign=+/- for West/East wheel
   void setId(Short_t id){mId = id;}
-  /// \param gain calibrated energy loss in tile, in units of Landau MPV for one MIP
-  void SetnMIP(Float_t nMIP){mnMIP = nMIP;}
-
+  /// \param gain calibrated energy loss in tile, in units of Landau MPV for one MIP - based on QT data - March 2023
+  void setnMIP_QT(Float_t nMIP_QT){mnMIP_QT = nMIP_QT;}
   /// set the id of particle most responsible for energy loss in tile (monte carlo)
   void setIdTruth(Int_t id){mTruthId = id;}
-
   /// returns the particle number for the particle most responsible for energy loss (monte carlo)
   Int_t idTruth(){return mTruthId;}
 
+  // Now a bunch of methods for DEP - March 2023
+  /// store the raw DEP data
+  void setDEPdata(unsigned short DEPdata){mDEPdata=DEPdata;}
+  /// store the gain-calibrated energy loss based on DEP data
+  void setnMIP_DEP(float nMipDep){mnMIP_DEP=nMipDep;}
+  /// get the raw DEP data
+  UShort_t depData() const {return mDEPdata;}
+  /// get the gain-calibrated energy loss based on DEP data
+  Float_t nMIP_DEP() const {return mnMIP_DEP;}
+  /// true if there is QT information available for this (will be false for sure at high rates on west side)
+  bool qtDataAvailable() const;
+  /// gain calibrated energy loss in tile, in units of Landau MPV for one MIP - based on QT data
+  Float_t nMIP_QT() const {return mnMIP_QT;}
+  /// gain calibrated energy loss in tile, in units of Landau MPV for one MIP - based on QT data if there is QT data.  Otherwise from DEP
+  Float_t nMIP() const {return (this->qtDataAvailable())?mnMIP_QT:mnMIP_DEP;}
+
+
 protected:
 
   /// Packed channel Id:
@@ -113,13 +139,19 @@ class StMuEpdHit : public StObject
   ///                      bit 30 is the good/bad (1/0) status flag
   Int_t mQTdata;
 
-  /// gain calibrated energy loss in tile, in units of Landau MPV for one MIP
-  Float_t mnMIP;
+  /// gain calibrated energy loss in tile, in units of Landau MPV for one MIP - based on QT
+  Float_t mnMIP_QT;
+
+  /// raw DEP data - March 2023
+  UShort_t mDEPdata;
+
+  /// gain-calibrated energy loss in tile, in units of Landau MPV for one MIP - based on DEP - March 2023
+  Float_t mnMIP_DEP;
 
   /// greatest contributer to energy deposition (MC)
   Int_t mTruthId;
 
-  ClassDef(StMuEpdHit, 1)
+  ClassDef(StMuEpdHit, 2)
 };
 
 inline Short_t StMuEpdHit::side() const { return mId < 0 ? -1 : +1;}
@@ -133,4 +165,6 @@ inline Int_t   StMuEpdHit::tac() const { return (mQTdata >> 12) & 0x0FFF; }
 inline Int_t   StMuEpdHit::tdc() const { return (mQTdata >> 24) & 0x001F; }
 inline bool    StMuEpdHit::hasTac() const { return (mQTdata >> 29) & 0x1; }
 inline bool    StMuEpdHit::isGood() const { return (mQTdata >> 30) & 0x1; }
+inline bool    StMuEpdHit::qtDataAvailable() const {return (this->adc()!=0);}
+
 #endif