Moved creating SiPixelTemplateStore from DB to an ESProducer

All DB construction was switched to using EventSetup. Cases using
reading from files were kept local to module.
The new ESProducer was added as a Task to all needed Sequences.

CalibTracker/SiPixelLorentzAngle/src/SiPixelLorentzAnglePCLWorker.cc

@@ -128,7 +128,7 @@ class SiPixelLorentzAnglePCLWorker : public DQMEDAnalyzer {
   // template stuff
   edm::ESWatcher<SiPixelTemplateDBObjectESProducerRcd> watchSiPixelTemplateRcd_;
   const SiPixelTemplateDBObject* templateDBobject_;
-  std::vector<SiPixelTemplateStore> thePixelTemp_;
+  const std::vector<SiPixelTemplateStore>* thePixelTemp_ = nullptr;
 
   LorentzAngleAnalysisTypeEnum analysisType_;
   std::string folder_;
@@ -195,6 +195,7 @@ class SiPixelLorentzAnglePCLWorker : public DQMEDAnalyzer {
   edm::ESGetToken<TrackerGeometry, TrackerDigiGeometryRecord> geomEsToken_;
   edm::ESGetToken<TrackerTopology, TrackerTopologyRcd> topoEsToken_;
   edm::ESGetToken<SiPixelTemplateDBObject, SiPixelTemplateDBObjectESProducerRcd> siPixelTemplateEsToken_;
+  edm::ESGetToken<std::vector<SiPixelTemplateStore>, SiPixelTemplateDBObjectESProducerRcd> siPixelTemplateStoreEsToken_;
   edm::ESGetToken<TrackerTopology, TrackerTopologyRcd> topoPerEventEsToken_;
   edm::ESGetToken<TrackerGeometry, TrackerDigiGeometryRecord> geomPerEventEsToken_;
   edm::ESGetToken<MagneticField, IdealMagneticFieldRecord> magneticFieldToken_;
@@ -223,6 +224,7 @@ SiPixelLorentzAnglePCLWorker::SiPixelLorentzAnglePCLWorker(const edm::ParameterS
       geomEsToken_(esConsumes<edm::Transition::BeginRun>()),
       topoEsToken_(esConsumes<edm::Transition::BeginRun>()),
       siPixelTemplateEsToken_(esConsumes<edm::Transition::BeginRun>()),
+      siPixelTemplateStoreEsToken_(esConsumes<edm::Transition::BeginRun>()),
       topoPerEventEsToken_(esConsumes()),
       geomPerEventEsToken_(esConsumes()),
       magneticFieldToken_(esConsumes()) {
@@ -467,7 +469,7 @@ void SiPixelLorentzAnglePCLWorker::analyze(edm::Event const& iEvent, edm::EventS
 
           if (notInPCL_) {
             // fill the template from the store (from dqmBeginRun)
-            SiPixelTemplate theTemplate(thePixelTemp_);
+            SiPixelTemplate theTemplate(*thePixelTemp_);
 
             float locBx = (cotbeta < 0.) ? -1 : 1.;
             float locBz = (cotalpha < 0.) ? -locBx : locBx;
@@ -639,7 +641,7 @@ void SiPixelLorentzAnglePCLWorker::analyze(edm::Event const& iEvent, edm::EventS
 
           if (notInPCL_) {
             // fill the template from the store (from dqmBeginRun)
-            SiPixelTemplate theTemplate(thePixelTemp_);
+            SiPixelTemplate theTemplate(*thePixelTemp_);
 
             float locBx = (cotbeta < 0.) ? -1 : 1.;
             float locBz = (cotalpha < 0.) ? -locBx : locBx;
@@ -730,11 +732,7 @@ void SiPixelLorentzAnglePCLWorker::dqmBeginRun(edm::Run const& run, edm::EventSe
     // Initialize 1D templates
     if (watchSiPixelTemplateRcd_.check(iSetup)) {
       templateDBobject_ = &iSetup.getData(siPixelTemplateEsToken_);
-      if (!SiPixelTemplate::pushfile(*templateDBobject_, thePixelTemp_)) {
-        edm::LogError("SiPixelLorentzAnglePCLWorker")
-            << "Templates not filled correctly. Check the sqlite file. Using SiPixelTemplateDBObject version "
-            << (*templateDBobject_).version();
-      }
+      thePixelTemp_ = &iSetup.getData(siPixelTemplateStoreEsToken_);
     }
   }
 

Calibration/TkAlCaRecoProducers/python/ALCARECOPromptCalibProdSiPixelLorentzAngleMCS_cff.py

@@ -26,6 +26,7 @@
 from RecoTracker.Configuration.RecoTrackerP5_cff import *
 from RecoTracker.TrackProducer.TrackRefitter_cfi import *
 from TrackingTools.TransientTrack.TransientTrackBuilder_cfi import *
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
 
 ALCARECOPixelLACalibrationTracksRefitMCS = TrackRefitter.clone(src = "ALCARECOPixelLACalibrationTracksMCS",
                                                                TrajectoryInEvent = True,
@@ -65,5 +66,6 @@
     ALCARECOCalCosmicsFilterForSiPixelLorentzAngleMCS *
     ALCARECOPixelLATrackFilterRefitMCS *
     ALCARECOSiPixelLACalibMCS *
-    MEtoEDMConvertSiPixelLorentzAngleMCS 
+    MEtoEDMConvertSiPixelLorentzAngleMCS,
+    cms.Task(SiPixelTemplateStoreESProducer)
    )

Calibration/TkAlCaRecoProducers/python/ALCARECOPromptCalibProdSiPixelLorentzAngle_cff.py

@@ -62,9 +62,11 @@
                                                    )
 
 # The actual sequence
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
 seqALCARECOPromptCalibProdSiPixelLorentzAngle = cms.Sequence(
     ALCARECOCalSignleMuonFilterForSiPixelLorentzAngle *
     ALCARECOPixelLATrackFilterRefit *
     ALCARECOSiPixelLACalib *
-    MEtoEDMConvertSiPixelLorentzAngle                                             
+    MEtoEDMConvertSiPixelLorentzAngle,
+    cms.Task(SiPixelTemplateStoreESProducer)
    )

CondFormats/SiPixelTransient/BuildFile.xml

@@ -1,5 +1,6 @@
 <use name="FWCore/MessageLogger"/>
 <use name="FWCore/Utilities"/>
+<use name="FWCore/Framework"/>
 <use name="boost"/>
 <export>
   <lib name="1"/>

CondFormats/SiPixelTransient/src/T_EventSetup_SiPixelTemplateStore.cc

@@ -0,0 +1,19 @@
+// -*- C++ -*-
+//
+// Package:     CondFormats/SiPixelTransient
+// Class  :     T_EventSetup_SiPixelTemplateStore
+//
+// Implementation:
+//     [Notes on implementation]
+//
+// Original Author:  Christopher Jones
+//         Created:  Tue, 08 Aug 2023 15:33:48 GMT
+//
+
+// system include files
+
+// user include files
+#include "CondFormats/SiPixelTransient/interface/SiPixelTemplate.h"
+#include "FWCore/Framework/interface/eventsetuprecord_registration_macro.h"
+
+TYPELOOKUP_DATA_REG(std::vector<SiPixelTemplateStore>);

DQM/SiPixelPhase1Config/python/SiPixelPhase1OfflineDQM_source_cff.py

@@ -14,6 +14,7 @@
 from DQM.SiPixelPhase1Track.SiPixelPhase1ResidualsExtra_cfi import *
 # Clusters ontrack/offtrack (also general tracks)
 from DQM.SiPixelPhase1Track.SiPixelPhase1TrackClusters_cfi import *
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
 # Hit Efficiencies
 from DQM.SiPixelPhase1Track.SiPixelPhase1TrackEfficiency_cfi import *
 # FED/RAW Data
@@ -24,7 +25,6 @@
 from DQM.SiPixelPhase1Summary.SiPixelBarycenter_cfi import *
 
 
-
 from RecoTracker.PixelLowPtUtilities.ClusterShapeHitFilterESProducer_cfi import *
 from RecoLocalTracker.SiStripClusterizer.SiStripClusterChargeCut_cfi import *
 from DQM.SiPixelPhase1Track.SiPixelPhase1EfficiencyExtras_cfi import *
@@ -39,7 +39,8 @@
                                             + SiPixelPhase1RecHitsAnalyzer
                                             + SiPixelPhase1TrackResidualsAnalyzer
                                             + SiPixelPhase1TrackClustersAnalyzer
-                                            + SiPixelPhase1TrackEfficiencyAnalyzer
+                                            + SiPixelPhase1TrackEfficiencyAnalyzer,
+                                            cms.Task(SiPixelTemplateStoreESProducer)  
                                             )
 
 

DQM/SiPixelPhase1Config/python/SiPixelPhase1OnlineDQM_Timing_cff.py

@@ -97,12 +97,12 @@
 
 # Cluster (track-independent) monitoring
 from DQM.SiPixelPhase1Common.SiPixelPhase1Clusters_cfi import *
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
 
 # Track cluster 
 from DQM.SiPixelPhase1Track.SiPixelPhase1TrackClusters_cfi import *
 from DQM.SiPixelPhase1Track.SiPixelPhase1TrackResiduals_cfi import *
 
-
 # Raw data errors
 from DQM.SiPixelPhase1Common.SiPixelPhase1RawData_cfi import *
 
@@ -115,7 +115,8 @@
  + SiPixelPhase1ClustersAnalyzer
  + SiPixelPhase1RawDataAnalyzer
  + SiPixelPhase1TrackClustersAnalyzer
- + SiPixelPhase1TrackResidualsAnalyzer
+ + SiPixelPhase1TrackResidualsAnalyzer,
+ cms.Task(SiPixelTemplateStoreESProducer)   
 )
 
 siPixelPhase1OnlineDQM_harvesting = cms.Sequence(
@@ -149,7 +150,8 @@
  + SiPixelPhase1ClustersAnalyzer
  + SiPixelPhase1RawDataAnalyzer
  + SiPixelPhase1TrackClustersAnalyzer_cosmics
- + SiPixelPhase1TrackResidualsAnalyzer_cosmics
+ + SiPixelPhase1TrackResidualsAnalyzer_cosmics,
+ cms.Task(SiPixelTemplateStoreESProducer)
 )
 
 ## Additional settings for pp_run (Phase 0 test)
@@ -177,6 +179,7 @@
  + SiPixelPhase1RawDataAnalyzer
  + SiPixelPhase1TrackClustersAnalyzer_pprun
  + SiPixelPhase1TrackResidualsAnalyzer_pprun
- + SiPixelPhase1TrackEfficiencyAnalyzer_pprun
+ + SiPixelPhase1TrackEfficiencyAnalyzer_pprun,
+ cms.Task(SiPixelTemplateStoreESProducer)
 )
 

DQM/SiPixelPhase1Config/python/SiPixelPhase1OnlineDQM_cff.py

@@ -70,6 +70,8 @@
 
 # Track cluster                                                                                                                                                                            
 from DQM.SiPixelPhase1Track.SiPixelPhase1TrackClusters_cfi import *
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
+
 SiPixelPhase1TrackClustersOnTrackCorrCharge.enabled=cms.bool(False)
 SiPixelPhase1TrackTemplateCorr.enabled=cms.bool(False)
 SiPixelPhase1TrackClustersOnTrackCorrChargeOuter.enabled=cms.bool(False)
@@ -86,6 +88,7 @@
  + SiPixelPhase1TrackClustersAnalyzer
  + SiPixelPhase1TrackResidualsAnalyzer
 # + SiPixelPhase1GeometryDebugAnalyzer
+ , cms.Task(SiPixelTemplateStoreESProducer)
 )
 
 siPixelPhase1OnlineDQM_harvesting = cms.Sequence(
@@ -119,7 +122,8 @@
  + SiPixelPhase1ClustersAnalyzer
  + SiPixelPhase1RawDataAnalyzer
  + SiPixelPhase1TrackClustersAnalyzer_cosmics
- + SiPixelPhase1TrackResidualsAnalyzer_cosmics
+ + SiPixelPhase1TrackResidualsAnalyzer_cosmics,
+ cms.Task(SiPixelTemplateStoreESProducer)
 )
 
 ## Additional settings for pp_run                                                                                                                                         
@@ -142,7 +146,8 @@
  + SiPixelPhase1ClustersAnalyzer
  + SiPixelPhase1RawDataAnalyzer
  + SiPixelPhase1TrackClustersAnalyzer_pprun
- + SiPixelPhase1TrackResidualsAnalyzer_pprun
+ + SiPixelPhase1TrackResidualsAnalyzer_pprun,
+ cms.Task(SiPixelTemplateStoreESProducer)
 )
 
 siPixelPhase1OnlineDQM_timing_harvesting = siPixelPhase1OnlineDQM_harvesting.copyAndExclude([

DQM/SiPixelPhase1Track/plugins/SiPixelPhase1TrackClusters.cc

@@ -88,8 +88,8 @@ namespace {
 
   private:
     const bool applyVertexCut_;
-    const SiPixelTemplateDBObject* templateDBobject_;
-    std::vector<SiPixelTemplateStore> thePixelTemp_;
+    const SiPixelTemplateDBObject* templateDBobject_ = nullptr;
+    const std::vector<SiPixelTemplateStore>* thePixelTemp_ = nullptr;
     const TrackerTopology* tkTpl = nullptr;
 
     edm::EDGetTokenT<reco::TrackCollection> tracksToken_;
@@ -101,6 +101,7 @@ namespace {
     edm::ESGetToken<ClusterShapeHitFilter, CkfComponentsRecord> clusterShapeHitFilterToken_;
 
     edm::ESGetToken<SiPixelTemplateDBObject, SiPixelTemplateDBObjectESProducerRcd> templateDBobjectToken_;
+    edm::ESGetToken<std::vector<SiPixelTemplateStore>, SiPixelTemplateDBObjectESProducerRcd> templateStoreToken_;
   };
 
   SiPixelPhase1TrackClusters::SiPixelPhase1TrackClusters(const edm::ParameterSet& iConfig)
@@ -118,6 +119,7 @@ namespace {
     trackerGeomToken_ = esConsumes<edm::Transition::BeginRun>();
     clusterShapeHitFilterToken_ =
         esConsumes<ClusterShapeHitFilter, CkfComponentsRecord>(edm::ESInputTag("", "ClusterShapeHitFilter"));
+    templateStoreToken_ = esConsumes<edm::Transition::BeginRun>();
     templateDBobjectToken_ = esConsumes<edm::Transition::BeginRun>();
   }
 
@@ -127,10 +129,7 @@ namespace {
 
     // Initialize 1D templates
     templateDBobject_ = &iSetup.getData(templateDBobjectToken_);
-    if (!SiPixelTemplate::pushfile(*templateDBobject_, thePixelTemp_))
-      edm::LogError("SiPixelPhase1TrackClusters")
-          << "Templates not filled correctly. Check the sqlite file. Using SiPixelTemplateDBObject version "
-          << (*templateDBobject_).version() << std::endl;
+    thePixelTemp_ = &iSetup.getData(templateStoreToken_);
   }
 
   void SiPixelPhase1TrackClusters::analyze(const edm::Event& iEvent, const edm::EventSetup& iSetup) {
@@ -162,7 +161,7 @@ namespace {
       return;
     }
 
-    SiPixelTemplate templ(thePixelTemp_);
+    SiPixelTemplate templ(*thePixelTemp_);
 
     edm::Handle<SiPixelClusterShapeCache> pixelClusterShapeCacheH;
     iEvent.getByToken(pixelClusterShapeCacheToken_, pixelClusterShapeCacheH);

DQMOffline/Trigger/python/SiPixel_OfflineMonitoring_cff.py

@@ -4,6 +4,7 @@
 from DQMOffline.Trigger.SiPixel_OfflineMonitoring_TrackCluster_cff import *
 from RecoTracker.PixelLowPtUtilities.siPixelClusterShapeCache_cfi import *
 from DQM.SiPixelMonitorTrack.RefitterForPixelDQM import *
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
 
 hltSiPixelClusterShapeCache = siPixelClusterShapeCache.clone(src = 'hltSiPixelClusters')
 hltrefittedForPixelDQM = refittedForPixelDQM.clone(src ='hltMergedTracks',
@@ -12,5 +13,6 @@
     hltSiPixelClusterShapeCache
     + hltSiPixelPhase1ClustersAnalyzer
     + hltrefittedForPixelDQM
-    + hltSiPixelPhase1TrackClustersAnalyzer
+    + hltSiPixelPhase1TrackClustersAnalyzer,
+    cms.Task(SiPixelTemplateStoreESProducer)
 )    

DQMOffline/Trigger/python/SiStrip_OfflineMonitoring_cff.py

@@ -7,6 +7,7 @@
 #HLTsiStripClusters.SiStripRefGetter  = cms.InputTag("hltSiStripClusters")
 
 # SiStripCluster monitoring
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import SiPixelTemplateStoreESProducer as hltSiPixelTemplateStoreESProducer
 import DQM.SiStripMonitorCluster.SiStripMonitorCluster_cfi
 HLTSiStripMonitorCluster = DQM.SiStripMonitorCluster.SiStripMonitorCluster_cfi.SiStripMonitorCluster.clone(
     ClusterProducerStrip = "hltSiStripRawToClustersFacility",

FastSimulation/Configuration/python/Reconstruction_BefMix_cff.py

@@ -41,12 +41,14 @@
 
 from FastSimulation.Tracking.iterativeTk_cff import *
 from TrackingTools.TrackFitters.TrackFitters_cff import *
+from RecoLocalTracker.SiPixelRecHits.SiPixelTemplateStoreESProducer_cfi import *
 
 reconstruction_befmix = cms.Sequence(
     offlineBeamSpot
     * fastTrackerRecHits
     * fastMatchedTrackerRecHits
     * fastMatchedTrackerRecHitCombinations
     * MeasurementTrackerEvent
-    * iterTracking
+    * iterTracking,
+    cms.Task(SiPixelTemplateStoreESProducer)
     )

FastSimulation/TrackingRecHitProducer/interface/PixelTemplateSmearerBase.h

@@ -49,9 +49,9 @@ class PixelTemplateSmearerBase : public TrackingRecHitAlgorithm {
   bool mergeHitsOn = false;  // if true then see if neighboring hits might merge
 
   //--- Template DB Object(s)
-  const SiPixelTemplateDBObject* pixelTemplateDBObject_ = nullptr;     // needed for template<-->DetId map.
-  std::vector<SiPixelTemplateStore> thePixelTemp_;                     // our own template storage
-  std::vector<SiPixelTemplateStore>& thePixelTempRef = thePixelTemp_;  // points to the one we will use.
+  const SiPixelTemplateDBObject* pixelTemplateDBObject_ = nullptr;            // needed for template<-->DetId map.
+  std::vector<SiPixelTemplateStore> thePixelTemp_;                            // our own template storage
+  const std::vector<SiPixelTemplateStore>* thePixelTempRef = &thePixelTemp_;  // points to the one we will use.
   int templateId = -1;
 
   //--- Flag to tell us whether we are in barrel or in forward.
@@ -92,7 +92,7 @@ class PixelTemplateSmearerBase : public TrackingRecHitAlgorithm {
   void beginRun(edm::Run const& run,
                 const edm::EventSetup& eventSetup,
                 const SiPixelTemplateDBObject* pixelTemplateDBObjectPtr,
-                std::vector<SiPixelTemplateStore>& tempStoreRef) override;
+                const std::vector<SiPixelTemplateStore>& tempStoreRef) override;
   // void endEvent(edm::Event& event, const edm::EventSetup& eventSetup) override;
 
   //--- Process all unmerged hits. Calls smearHit() for each.

FastSimulation/TrackingRecHitProducer/interface/TrackingRecHitAlgorithm.h

@@ -51,7 +51,7 @@ class TrackingRecHitAlgorithm {
   virtual void beginRun(edm::Run const& run,
                         const edm::EventSetup& eventSetup,
                         const SiPixelTemplateDBObject* pixelTemplateDBObjectPtr,
-                        std::vector<SiPixelTemplateStore>& tempStoreRef);
+                        const std::vector<SiPixelTemplateStore>& tempStoreRef);
 
   //this function will only be called once per event
   virtual void beginEvent(edm::Event& event, const edm::EventSetup& eventSetup);

FastSimulation/TrackingRecHitProducer/plugins/TrackingRecHitProducer.cc

@@ -48,8 +48,9 @@ class TrackingRecHitProducer : public edm::stream::EDProducer<> {
   unsigned long long _trackerTopologyCacheID = 0;
   std::map<unsigned int, TrackingRecHitPipe> _detIdPipes;
   void setupDetIdPipes(const edm::EventSetup& eventSetup);
-  std::vector<SiPixelTemplateStore> _pixelTempStore;  // pixel template storage
   const edm::ESGetToken<SiPixelTemplateDBObject, SiPixelTemplateDBObjectESProducerRcd> siPixelTemplateDBObjectESToken_;
+  const edm::ESGetToken<std::vector<SiPixelTemplateStore>, SiPixelTemplateDBObjectESProducerRcd>
+      siPixelTemplateStoreESToken_;
   const edm::ESGetToken<TrackerGeometry, TrackerDigiGeometryRecord> trackerGeometryESToken_;
   const edm::ESGetToken<TrackerTopology, TrackerTopologyRcd> trackerTopologyESToken_;
 
@@ -115,17 +116,10 @@ void TrackingRecHitProducer::beginRun(edm::Run const& run, const edm::EventSetup
   //    to a no-op.
 
   const SiPixelTemplateDBObject& pixelTemplateDBObject = eventSetup.getData(siPixelTemplateDBObjectESToken_);
-
-  //--- Now that we have the DB object, load the correct templates from the DB.
-  //    (They are needed for data and full sim MC, so in a production FastSim
-  //    run, everything should already be in the DB.)
-  if (!SiPixelTemplate::pushfile(pixelTemplateDBObject, _pixelTempStore)) {
-    throw cms::Exception("TrackingRecHitProducer:")
-        << "SiPixel Templates not loaded correctly from the DB object!" << std::endl;
-  }
+  const auto& pixelTemplateStore = eventSetup.getData(siPixelTemplateStoreESToken_);
 
   for (auto& algo : _recHitAlgorithms) {
-    algo->beginRun(run, eventSetup, &pixelTemplateDBObject, _pixelTempStore);
+    algo->beginRun(run, eventSetup, &pixelTemplateDBObject, pixelTemplateStore);
   }
 }