Updating ZDC Reconstruction for Run3 Era

matt2275 · matt2275 · commit 0dee34675aa5 · 2024-08-23T21:52:44.000+02:00
diff --git a/Configuration/StandardSequences/python/Reconstruction_cff.py b/Configuration/StandardSequences/python/Reconstruction_cff.py
@@ -304,6 +304,7 @@
 modulesToRemove.append(horeco)
 modulesToRemove.append(hcalnoise)
 modulesToRemove.append(zdcreco)
+modulesToRemove.append(zdcrecoRun3)
 modulesToRemove.append(castorreco)
 ##it's OK according to Ronny modulesToRemove.append(CSCHaloData)#needs digis
 reconstruction_fromRECO = reconstruction.copyAndExclude(modulesToRemove+noTrackingAndDependent)
diff --git a/DataFormats/HcalRecHit/interface/ZDCRecHit.h b/DataFormats/HcalRecHit/interface/ZDCRecHit.h
@@ -19,8 +19,25 @@ class ZDCRecHit : public CaloRecHit {
   // follow EcalRecHit method of adding variable flagBits_ to CaloRecHit
   float lowGainEnergy() const { return lowGainEnergy_; };
 
+  constexpr inline void setEnergySOIp1(const float en) { energySOIp1_ = en; };
+  constexpr inline float energySOIp1() const { return energySOIp1_; };  // energy of Slice of Interest plus 1
+  constexpr inline void setRatioSOIp1(const float ratio) { ratioSOIp1_ = ratio; };
+  constexpr inline float ratioSOIp1() const {
+    return ratioSOIp1_;
+  };  // ratio of Energy of (Slice of Interest)/ (Slice of Interest plus 1)
+  constexpr inline void setTDCtime(const float time) { TDCtime_ = time; };
+  constexpr inline float TDCtime() const { return TDCtime_; };
+  constexpr inline void setChargeWeightedTime(const float time) {
+    chargeWeightedTime_ = time;
+  };  // time of activity determined by charged weighted average
+  constexpr inline float chargeWeightedTime() const { return chargeWeightedTime_; };
+
 private:
   float lowGainEnergy_;
+  float energySOIp1_;
+  float ratioSOIp1_;
+  float TDCtime_;
+  float chargeWeightedTime_;
 };
 
 std::ostream& operator<<(std::ostream& s, const ZDCRecHit& hit);
diff --git a/DataFormats/HcalRecHit/src/ZDCRecHit.cc b/DataFormats/HcalRecHit/src/ZDCRecHit.cc
@@ -1,9 +1,15 @@
 #include "DataFormats/HcalRecHit/interface/ZDCRecHit.h"
 
-ZDCRecHit::ZDCRecHit() : CaloRecHit(), lowGainEnergy_() {}
+ZDCRecHit::ZDCRecHit()
+    : CaloRecHit(), lowGainEnergy_(), energySOIp1_(-99), ratioSOIp1_(-99), TDCtime_(-99), chargeWeightedTime_(-99) {}
 
 ZDCRecHit::ZDCRecHit(const HcalZDCDetId& id, float energy, float time, float lowGainEnergy)
-    : CaloRecHit(id, energy, time), lowGainEnergy_(lowGainEnergy) {}
+    : CaloRecHit(id, energy, time),
+      lowGainEnergy_(lowGainEnergy),
+      energySOIp1_(-99),
+      ratioSOIp1_(-99),
+      TDCtime_(-99),
+      chargeWeightedTime_(-99) {}
 
 std::ostream& operator<<(std::ostream& s, const ZDCRecHit& hit) {
   return s << hit.id() << ": " << hit.energy() << " GeV, " << hit.time() << " ns";
diff --git a/DataFormats/HcalRecHit/src/classes_def.xml b/DataFormats/HcalRecHit/src/classes_def.xml
@@ -35,7 +35,8 @@
     <version ClassVersion="12" checksum="1242817974"/>
     <version ClassVersion="10" checksum="1310006561"/>
    </class>
-   <class name="ZDCRecHit" ClassVersion="12">
+   <class name="ZDCRecHit" ClassVersion="13">
+    <version ClassVersion="13" checksum="1625066895"/>
     <version ClassVersion="12" checksum="4082648564"/>
     <version ClassVersion="11" checksum="2452340764"/>
    </class>
diff --git a/RecoHI/HiCentralityAlgos/python/HiCentrality_cfi.py b/RecoHI/HiCentralityAlgos/python/HiCentrality_cfi.py
@@ -46,10 +46,14 @@
                                       srcTracks = "generalTracks",
                                       srcVertex = "offlinePrimaryVertices"
 )
+
+from Configuration.Eras.Modifier_run3_common_cff import run3_common
+run3_common.toModify(hiCentrality, srcZDChits = "zdcrecoRun3",lowGainZDC = False)
+
 from Configuration.ProcessModifiers.phase2_pp_on_AA_cff import phase2_pp_on_AA
 phase2_pp_on_AA.toModify(hiCentrality,
     isPhase2 = True,
     producePixelTracks = False,
     srcTracks = "generalTracks",
     srcVertex = "offlinePrimaryVertices"
-)
+)
diff --git a/RecoHI/HiCentralityAlgos/python/pACentrality_cfi.py b/RecoHI/HiCentralityAlgos/python/pACentrality_cfi.py
@@ -36,4 +36,6 @@
 
                             )
 
+from Configuration.Eras.Modifier_run3_common_cff import run3_common
+run3_common.toModify(pACentrality, srcZDChits = "zdcrecoRun3",lowGainZDC =False)
 
diff --git a/RecoHI/HiEvtPlaneAlgos/python/RecoHiEvtPlane_EventContent_cff.py b/RecoHI/HiEvtPlaneAlgos/python/RecoHiEvtPlane_EventContent_cff.py
@@ -5,6 +5,7 @@
     outputCommands = cms.untracked.vstring(
 	'keep recoEvtPlanes_hiEvtPlane_*_*',
         'keep ZDCRecHitsSorted_zdcreco_*_*',
+        'keep ZDCRecHitsSorted_zdcrecoRun3_*_*',
         'keep ZDCDataFramesSorted_hcalDigis_*_*',
         'keep HFRecHitsSorted_hfreco_*_*')
 )
diff --git a/RecoLocalCalo/Configuration/python/RecoLocalCalo_Cosmics_cff.py b/RecoLocalCalo/Configuration/python/RecoLocalCalo_Cosmics_cff.py
@@ -107,3 +107,11 @@
 from RecoLocalCalo.Configuration.hcalLocalRecoNZS_cff import *
 calolocalrecoTaskCosmicsNZS = cms.Task(ecalLocalRecoTaskCosmics,hcalLocalRecoTask,hcalLocalRecoTaskNZS) 
 calolocalrecoCosmicsNZS = cms.Sequence(calolocalrecoTaskCosmicsNZS) 
+
+#--- for Run 3 and later
+_run3_hcalLocalRecoTask = _phase1_hcalLocalRecoTask.copy()
+from RecoLocalCalo.HcalRecProducers.zdcrecoRun3_cfi import zdcrecoRun3
+_run3_hcalLocalRecoTask.remove(zdcreco)
+_run3_hcalLocalRecoTask.add(zdcrecoRun3)
+from Configuration.Eras.Modifier_run3_common_cff import run3_common
+run3_common.toReplaceWith(hcalLocalRecoTask, _run3_hcalLocalRecoTask)
diff --git a/RecoLocalCalo/Configuration/python/RecoLocalCalo_EventContentCosmics_cff.py b/RecoLocalCalo/Configuration/python/RecoLocalCalo_EventContentCosmics_cff.py
@@ -24,6 +24,7 @@
 	'keep ZDCDataFramesSorted_castorDigis_*_*',
 	'keep ZDCDataFramesSorted_simHcalUnsuppressedDigis_*_*',
 	'keep ZDCRecHitsSorted_zdcreco_*_*',
+	'keep ZDCRecHitsSorted_zdcrecoRun3_*_*',
 	'keep HcalUnpackerReport_castorDigis_*_*',
 	'keep HcalUnpackerReport_hcalDigis_*_*')
 )
diff --git a/RecoLocalCalo/Configuration/python/RecoLocalCalo_EventContent_cff.py b/RecoLocalCalo/Configuration/python/RecoLocalCalo_EventContent_cff.py
@@ -59,7 +59,8 @@
                                            'keep ZDCDataFramesSorted_hcalDigis_*_*',
                                            'keep ZDCDataFramesSorted_castorDigis_*_*',
                                            'keep QIE10DataFrameHcalDataFrameContainer_hcalDigis_ZDC_*',
-                                           'keep ZDCRecHitsSorted_zdcreco_*_*')
+                                           'keep ZDCRecHitsSorted_zdcreco_*_*',
+                                           'keep ZDCRecHitsSorted_zdcrecoRun3_*_*')
 )
 RecoLocalCaloRECO.outputCommands.extend(RecoLocalCaloAOD.outputCommands)
 RecoLocalCaloRECO.outputCommands.extend(ecalLocalRecoRECO.outputCommands)
diff --git a/RecoLocalCalo/Configuration/python/hcalLocalReco_cff.py b/RecoLocalCalo/Configuration/python/hcalLocalReco_cff.py
@@ -60,8 +60,12 @@
 #--- for Run 3 and later
 _run3_hcalLocalRecoTask = _phase1_hcalLocalRecoTask.copy()
 _run3_hcalLocalRecoTask.remove(hbheprereco)
-from Configuration.Eras.Modifier_run3_HB_cff import run3_HB
-run3_HB.toReplaceWith(hcalLocalRecoTask, _run3_hcalLocalRecoTask)
+
+from RecoLocalCalo.HcalRecProducers.zdcrecoRun3_cfi import zdcrecoRun3
+_run3_hcalLocalRecoTask.remove(zdcreco)
+_run3_hcalLocalRecoTask.add(zdcrecoRun3)
+from Configuration.Eras.Modifier_run3_common_cff import run3_common
+run3_common.toReplaceWith(hcalLocalRecoTask, _run3_hcalLocalRecoTask)
 
 #--- for Run 3 on GPU
 from Configuration.ProcessModifiers.gpu_cff import gpu
@@ -79,9 +83,10 @@
 alpaka.toReplaceWith(hcalLocalRecoTask, _run3_hcalLocalRecoPortableTask)
 
 #--- HCAL-only workflow
-hcalOnlyLocalRecoTask = hcalLocalRecoTask.copyAndExclude([zdcreco])
+hcalOnlyLocalRecoTask = hcalLocalRecoTask.copyAndExclude([zdcreco,zdcrecoRun3])
 
 #--- HCAL-only workflow for Run 2 on GPU
+from Configuration.Eras.Modifier_run3_HB_cff import run3_HB
 from RecoLocalCalo.HcalRecProducers.hcalCPURecHitsProducer_cfi import hcalCPURecHitsProducer as _hbheprerecoFromCUDA
 (gpu & ~run3_HB).toModify(hbheprereco,
     cuda = _hbheprerecoFromCUDA.clone(
@@ -95,6 +100,6 @@
 )
 
 #--- for FastSim
-_fastSim_hcalLocalRecoTask = hcalLocalRecoTask.copyAndExclude([zdcreco])
+_fastSim_hcalLocalRecoTask = hcalLocalRecoTask.copyAndExclude([zdcreco,zdcrecoRun3])
 from Configuration.Eras.Modifier_fastSim_cff import fastSim
 fastSim.toReplaceWith( hcalLocalRecoTask, _fastSim_hcalLocalRecoTask )
diff --git a/RecoLocalCalo/HcalRecAlgos/interface/ZdcSimpleRecAlgo_Run3.h b/RecoLocalCalo/HcalRecAlgos/interface/ZdcSimpleRecAlgo_Run3.h
@@ -0,0 +1,74 @@
+#ifndef ZDCSIMPLERECALGO_RUN3_H
+#define ZDCSIMPLERECALGO_RUN3_H 1
+
+#include "DataFormats/HcalDigi/interface/HBHEDataFrame.h"
+#include "DataFormats/HcalDigi/interface/HFDataFrame.h"
+#include "DataFormats/HcalDigi/interface/HODataFrame.h"
+#include "DataFormats/HcalDigi/interface/ZDCDataFrame.h"
+#include "DataFormats/HcalDigi/interface/HcalCalibDataFrame.h"
+#include "DataFormats/HcalRecHit/interface/HBHERecHit.h"
+#include "DataFormats/HcalRecHit/interface/HFRecHit.h"
+#include "DataFormats/HcalRecHit/interface/HORecHit.h"
+#include "DataFormats/HcalRecHit/interface/ZDCRecHit.h"
+#include "DataFormats/HcalRecHit/interface/HcalCalibRecHit.h"
+#include "CalibFormats/HcalObjects/interface/HcalCoder.h"
+#include "CalibFormats/HcalObjects/interface/HcalCalibrations.h"
+#include "CalibFormats/HcalObjects/interface/HcalCalibrationWidths.h"
+#include "CondFormats/HcalObjects/interface/HcalPedestal.h"
+#include "CalibCalorimetry/HcalAlgos/interface/HcalPulseContainmentCorrection.h"
+#include <memory>
+
+#include "DataFormats/HcalDigi/interface/QIE10DataFrame.h"
+
+/** \class ZdcSimpleRecAlgo_Run3
+
+   This class reconstructs RecHits from Digis for ZDC  by addition
+   of selected time samples, pedestal subtraction, and gain application. The
+   time of the hit is reconstructed using a weighted peak bin calculation
+   supplemented by precise time lookup table. A consumer of this class also
+   has the option of correcting the reconstructed time for energy-dependent
+   time slew associated with the QIE.
+
+   A sencon method based on a based on a event by event substraction is also
+   implelented. signal = (S4 + S5 - 2*(S1+S2+S3 + S7+S8+S9+S10))*(ft-Gev constant)
+   where SN is the signal in the nth time slice
+    
+   \author E. Garcia CSU &  J. Gomez UMD
+*/
+
+class ZdcSimpleRecAlgo_Run3 {
+public:
+  /** Simple constructor for PMT-based detectors */
+  ZdcSimpleRecAlgo_Run3(int recoMethod);
+  void initCorrectionMethod(const int method, const int ZdcSection);
+  void initTemplateFit(const std::vector<unsigned int>& bxTs,
+                       const std::vector<double>& chargeRatios,
+                       const int nTs,
+                       const int ZdcSection);
+  void initRatioSubtraction(const float ratio, const float frac, const int ZdcSection);
+
+  ZDCRecHit reco0(const QIE10DataFrame& digi,
+                  const HcalCoder& coder,
+                  const HcalCalibrations& calibs,
+                  const HcalPedestal& effPeds,
+                  const std::vector<unsigned int>& myNoiseTS,
+                  const std::vector<unsigned int>& mySignalTS) const;
+  // reco method currently used to match L1 Trigger LUT energy formula
+  ZDCRecHit reconstruct(const QIE10DataFrame& digi,
+                        const std::vector<unsigned int>& myNoiseTS,
+                        const std::vector<unsigned int>& mySignalTS,
+                        const HcalCoder& coder,
+                        const HcalCalibrations& calibs,
+                        const HcalPedestal& effPeds) const;
+
+private:
+  int recoMethod_;
+  int nTs_;
+  std::map<int, std::vector<double>> templateFitValues_;  // Values[ZdcSection][Ts]
+  std::map<int, bool> templateFitValid_;                  // Values[ZdcSection]
+  std::map<int, float> ootpuRatio_;                       // Values[ZdcSection]
+  std::map<int, float> ootpuFrac_;                        // Values[ZdcSection]
+  std::map<int, int> correctionMethod_;                   // Values[ZdcSection]
+};
+
+#endif
diff --git a/RecoLocalCalo/HcalRecAlgos/src/ZdcSimpleRecAlgo_Run3.cc b/RecoLocalCalo/HcalRecAlgos/src/ZdcSimpleRecAlgo_Run3.cc
diff --git a/RecoLocalCalo/HcalRecProducers/plugins/BuildFile.xml b/RecoLocalCalo/HcalRecProducers/plugins/BuildFile.xml
diff --git a/RecoLocalCalo/HcalRecProducers/plugins/ZdcHitReconstructor_Run3.cc b/RecoLocalCalo/HcalRecProducers/plugins/ZdcHitReconstructor_Run3.cc
diff --git a/RecoLocalCalo/HcalRecProducers/plugins/ZdcHitReconstructor_Run3.h b/RecoLocalCalo/HcalRecProducers/plugins/ZdcHitReconstructor_Run3.h

Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,6 @@`
`36`	`36`
`37`	`37`	`)`
`38`	`38`
	`39`	`+from Configuration.Eras.Modifier_run3_common_cff import run3_common`
	`40`	`+run3_common.toModify(pACentrality, srcZDChits = "zdcrecoRun3",lowGainZDC =False)`
`39`	`41`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`outputCommands = cms.untracked.vstring(`
`6`	`6`	`'keep recoEvtPlanes_hiEvtPlane__',`
`7`	`7`	`'keep ZDCRecHitsSorted_zdcreco__',`
	`8`	`+ 'keep ZDCRecHitsSorted_zdcrecoRun3__',`
`8`	`9`	`'keep ZDCDataFramesSorted_hcalDigis__',`
`9`	`10`	`'keep HFRecHitsSorted_hfreco__')`
`10`	`11`	`)`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`'keep ZDCDataFramesSorted_castorDigis__',`
`25`	`25`	`'keep ZDCDataFramesSorted_simHcalUnsuppressedDigis__',`
`26`	`26`	`'keep ZDCRecHitsSorted_zdcreco__',`
	`27`	`+ 'keep ZDCRecHitsSorted_zdcrecoRun3__',`
`27`	`28`	`'keep HcalUnpackerReport_castorDigis__',`
`28`	`29`	`'keep HcalUnpackerReport_hcalDigis__')`
`29`	`30`	`)`