Rework the definition of the Patatrack pixel workflows

Drop the obsolete pixelNtupleFit modifier, and replace the
customizePixelTracksSoAonCPU function with the pixelNtupletFit modifier.

Make the "gpu" workflows autodetect if a GPU is a present, and fall back
to running only on CPU otherwise.

Update the name of the modules for better consistency.

CalibTracker/Configuration/python/Reconstruction_cff.py

@@ -1,24 +1,24 @@
 import FWCore.ParameterSet.Config as cms
 
-#local reconstruction
+# local reconstruction
 from EventFilter.SiPixelRawToDigi.SiPixelRawToDigi_cfi import *
 from EventFilter.SiStripRawToDigi.SiStripDigis_cfi import *
 from RecoLocalTracker.SiPixelClusterizer.SiPixelClusterizerPreSplitting_cfi import *
 from RecoLocalTracker.SiStripZeroSuppression.SiStripZeroSuppression_cfi import *
 from RecoLocalTracker.SiStripClusterizer.SiStripClusterizer_cfi import *
-recolocal = cms.Sequence( siPixelDigis*siPixelClustersPreSplitting*siStripDigis*siStripZeroSuppression*siStripClusters)
-siPixelDigis.InputLabel = 'rawDataCollector'
+recolocal = cms.Sequence(siPixelDigis + siPixelClustersPreSplitting + siStripDigis + siStripZeroSuppression + siStripClusters)
+siPixelDigis.cpu.InputLabel = 'rawDataCollector'
 
-#tracking
+# tracking
 from RecoVertex.BeamSpotProducer.BeamSpot_cff import *
 from RecoLocalTracker.SiPixelRecHits.SiPixelRecHits_cfi import *
 from RecoLocalTracker.SiStripRecHitConverter.SiStripRecHitConverter_cfi import *
 from RecoTracker.Configuration.RecoTracker_cff import *
 from RecoTracker.Configuration.RecoTrackerP5_cff import *
 from RecoPixelVertexing.Configuration.RecoPixelVertexing_cff import *
-recotrack = cms.Sequence( offlineBeamSpot + siPixelRecHitsPreSplitting*siStripMatchedRecHits*recopixelvertexing*ckftracks)
-recotrackP5 = cms.Sequence( offlineBeamSpot + siPixelRecHitsPreSplitting*siStripMatchedRecHits*recopixelvertexing*ctftracksP5)
+recotrack = cms.Sequence(offlineBeamSpot + siPixelRecHitsPreSplitting + siStripMatchedRecHits + recopixelvertexing + ckftracks)
+recotrackP5 = cms.Sequence(offlineBeamSpot + siPixelRecHitsPreSplitting + siStripMatchedRecHits + recopixelvertexing + ctftracksP5)
 
-#Schedule
-reconstruction_step = cms.Path( recolocal + recotrack )
-reconstructionP5_step = cms.Path( recolocal + recotrackP5 )
+# Schedule
+reconstruction_step = cms.Path(recolocal + recotrack)
+reconstructionP5_step = cms.Path(recolocal + recotrackP5)

Configuration/ProcessModifiers/python/pixelNtupletFit_cff.py

@@ -0,0 +1,7 @@
+import FWCore.ParameterSet.Config as cms
+
+# This modifier is for replacing the legacy pixel tracks with the "Patatrack" pixel ntuplets,
+# fishbone cleaning, and either the Broken Line fit (by default) or the Riemann fit.
+# It also replaces the "gap" pixel vertices with a density-based vertex reconstruction algorithm.
+
+pixelNtupletFit =  cms.Modifier()

Configuration/PyReleaseValidation/python/relval_steps.py

@@ -2187,10 +2187,13 @@ def gen2021HiMix(fragment,howMuch):
                   }
 
 step3_pixel_ntuplet_cpu = {
-    '--customise': 'RecoPixelVertexing/Configuration/customizePixelTracksSoAonCPU.customizePixelTracksSoAonCPU'
+    '--procModifiers': 'pixelNtupletFit'
+}
+step3_pixel_ntuplet_gpu = {
+    '--procModifiers': 'pixelNtupletFit,gpu'
 }
 step3_pixel_triplets = {
-    '--customise': 'RecoPixelVertexing/Configuration/customizePixelTracksSoAonCPU.customizePixelTracksForTriplets'
+    '--customise': 'RecoPixelVertexing/Configuration/customizePixelTracksForTriplets.customizePixelTracksForTriplets'
 }
 step3_gpu = {
     '--procModifiers': 'gpu',
@@ -2324,9 +2327,9 @@ def gen2021HiMix(fragment,howMuch):
 steps['RECODR2_2018reHLT_ZBPrompt']=merge([{'--conditions':'auto:run2_data','-s':'RAW2DIGI,L1Reco,RECO,EI,PAT,ALCA:SiStripCalZeroBias+SiStripCalMinBias+TkAlMinBias+EcalESAlign,DQM:@rerecoZeroBias+@ExtraHLT+@miniAODDQM'},steps['RECODR2_2018reHLT']])
 steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']=merge([{'-s': 'RAW2DIGI:RawToDigi_pixelOnly,RECO:reconstruction_pixelTrackingOnly,DQM:@pixelTrackingOnlyDQM'},steps['RECODR2_2018reHLT_Prompt']])
 steps['RECODR2_2018reHLT_Patatrack_PixelOnlyCPU']=merge([step3_pixel_ntuplet_cpu, steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']])
-steps['RECODR2_2018reHLT_Patatrack_PixelOnlyGPU']=merge([step3_gpu, steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']])
+steps['RECODR2_2018reHLT_Patatrack_PixelOnlyGPU']=merge([step3_pixel_ntuplet_gpu, steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']])
 steps['RECODR2_2018reHLT_Patatrack_PixelOnlyTripletsCPU']=merge([step3_pixel_ntuplet_cpu, step3_pixel_triplets, steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']])
-steps['RECODR2_2018reHLT_Patatrack_PixelOnlyTripletsGPU']=merge([step3_gpu, step3_pixel_triplets, steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']])
+steps['RECODR2_2018reHLT_Patatrack_PixelOnlyTripletsGPU']=merge([step3_pixel_ntuplet_gpu, step3_pixel_triplets, steps['RECODR2_2018reHLT_Prompt_pixelTrackingOnly']])
 
 steps['RECODR2_2018reHLT_ECALOnlyCPU']=merge([{'-s': 'RAW2DIGI:RawToDigi_ecalOnly,RECO:reconstruction_ecalOnly,DQM:@ecalOnly'},steps['RECODR2_2018reHLT_Prompt']])
 steps['RECODR2_2018reHLT_ECALOnlyGPU']=merge([step3_gpu, steps['RECODR2_2018reHLT_ECALOnlyCPU']])

Configuration/PyReleaseValidation/python/upgradeWorkflowComponents.py

@@ -444,7 +444,7 @@ def setup_(self, step, stepName, stepDict, k, properties):
 upgradeWFs['PatatrackPixelOnlyCPU'] = PatatrackWorkflow(
     reco = {
         '-s': 'RAW2DIGI:RawToDigi_pixelOnly,RECO:reconstruction_pixelTrackingOnly,VALIDATION:@pixelTrackingOnlyValidation,DQM:@pixelTrackingOnlyDQM',
-        '--customise' : 'RecoPixelVertexing/Configuration/customizePixelTracksSoAonCPU.customizePixelTracksSoAonCPU'
+        '--procModifiers': 'pixelNtupletFit'
     },
     harvest = {
         '-s': 'HARVESTING:@trackingOnlyValidation+@pixelTrackingOnlyDQM'
@@ -456,7 +456,7 @@ def setup_(self, step, stepName, stepDict, k, properties):
 upgradeWFs['PatatrackPixelOnlyGPU'] = PatatrackWorkflow(
     reco = {
         '-s': 'RAW2DIGI:RawToDigi_pixelOnly,RECO:reconstruction_pixelTrackingOnly,VALIDATION:@pixelTrackingOnlyValidation,DQM:@pixelTrackingOnlyDQM',
-        '--procModifiers': 'gpu'
+        '--procModifiers': 'pixelNtupletFit,gpu'
     },
     harvest = {
         '-s': 'HARVESTING:@trackingOnlyValidation+@pixelTrackingOnlyDQM'
@@ -468,7 +468,8 @@ def setup_(self, step, stepName, stepDict, k, properties):
 upgradeWFs['PatatrackPixelOnlyTripletsCPU'] = PatatrackWorkflow(
     reco = {
         '-s': 'RAW2DIGI:RawToDigi_pixelOnly,RECO:reconstruction_pixelTrackingOnly,VALIDATION:@pixelTrackingOnlyValidation,DQM:@pixelTrackingOnlyDQM',
-        '--customise' : 'RecoPixelVertexing/Configuration/customizePixelTracksSoAonCPU.customizePixelTracksSoAonCPU,RecoPixelVertexing/Configuration/customizePixelTracksSoAonCPU.customizePixelTracksForTriplets'
+        '--procModifiers': 'pixelNtupletFit',
+        '--customise' : 'RecoPixelVertexing/Configuration/customizePixelTracksForTriplets.customizePixelTracksForTriplets'
     },
     harvest = {
         '-s': 'HARVESTING:@trackingOnlyValidation+@pixelTrackingOnlyDQM'
@@ -480,8 +481,8 @@ def setup_(self, step, stepName, stepDict, k, properties):
 upgradeWFs['PatatrackPixelOnlyTripletsGPU'] = PatatrackWorkflow(
     reco = {
         '-s': 'RAW2DIGI:RawToDigi_pixelOnly,RECO:reconstruction_pixelTrackingOnly,VALIDATION:@pixelTrackingOnlyValidation,DQM:@pixelTrackingOnlyDQM',
-        '--procModifiers': 'gpu',
-        '--customise': 'RecoPixelVertexing/Configuration/customizePixelTracksSoAonCPU.customizePixelTracksForTriplets'
+        '--procModifiers': 'pixelNtupletFit,gpu',
+        '--customise': 'RecoPixelVertexing/Configuration/customizePixelTracksForTriplets.customizePixelTracksForTriplets'
     },
     harvest = {
         '-s': 'HARVESTING:@trackingOnlyValidation+@pixelTrackingOnlyDQM'

Configuration/StandardSequences/python/RawToDigi_cff.py

@@ -87,7 +87,7 @@
 run3_common.toReplaceWith(RawToDigiTask, RawToDigiTask.copyAndExclude([castorDigis]))
 
 from Configuration.Eras.Modifier_phase2_tracker_cff import phase2_tracker
-# Remove siPixelDigis until we have phase1 pixel digis
+# Remove siPixelDigis until we have Phase 2 pixel digis
 phase2_tracker.toReplaceWith(RawToDigiTask, RawToDigiTask.copyAndExclude([siPixelDigis])) # FIXME
 
 

Configuration/StandardSequences/python/Services_cff.py

@@ -8,12 +8,13 @@
 # DQM store service
 from DQMServices.Core.DQMStore_cfi import *
 
-# load CUDA services when the "gpu" modifier is enabled
+# load CUDA services when the "gpu" or "pixelNtupletFit" modifiers are enabled
 def _addCUDAServices(process):
      process.load("HeterogeneousCore.CUDAServices.CUDAService_cfi")
 
 from Configuration.ProcessModifiers.gpu_cff import gpu
-modifyConfigurationStandardSequencesServicesAddCUDAServices_ = gpu.makeProcessModifier(_addCUDAServices)
+from Configuration.ProcessModifiers.pixelNtupletFit_cff import pixelNtupletFit
+modifyConfigurationStandardSequencesServicesAddCUDAServices_ = (gpu | pixelNtupletFit).makeProcessModifier(_addCUDAServices)
 
 # load TritonService when SONIC workflow is enabled
 def _addTritonService(process):

EventFilter/SiPixelRawToDigi/python/SiPixelRawToDigiRegional_cfi.py

@@ -3,7 +3,7 @@
 from EventFilter.SiPixelRawToDigi.SiPixelRawToDigi_cfi import *
 
 ## regional seeded unpacking for specialized HLT paths
-siPixelDigisRegional = siPixelDigis.clone()
+siPixelDigisRegional = siPixelDigis.cpu.clone()
 siPixelDigisRegional.Regions = cms.PSet(
     inputs = cms.VInputTag( "hltL2EtCutDoublePFIsoTau45Trk5" ),
     deltaPhi = cms.vdouble( 0.5 ),

EventFilter/SiPixelRawToDigi/python/SiPixelRawToDigi_cfi.py

@@ -1,15 +1,20 @@
 import FWCore.ParameterSet.Config as cms
-from EventFilter.SiPixelRawToDigi.siPixelRawToDigi_cfi import siPixelRawToDigi as _siPixelRawToDigi
-
 from HeterogeneousCore.CUDACore.SwitchProducerCUDA import SwitchProducerCUDA
+from Configuration.ProcessModifiers.gpu_cff import gpu
+
+# legacy pixel unpacker
+from EventFilter.SiPixelRawToDigi.siPixelRawToDigi_cfi import siPixelRawToDigi as _siPixelRawToDigi
 siPixelDigis = SwitchProducerCUDA(
     cpu = _siPixelRawToDigi.clone()
 )
 
+# use the Phase 1 settings
 from Configuration.Eras.Modifier_phase1Pixel_cff import phase1Pixel
-phase1Pixel.toModify(siPixelDigis.cpu, UsePhase1=True)
+phase1Pixel.toModify(siPixelDigis.cpu,
+    UsePhase1 = True
+)
 
-from Configuration.ProcessModifiers.gpu_cff import gpu
+# SwitchProducer wrapping the legacy pixel digis producer or an alias combining the pixel digis information converted from SoA
 gpu.toModify(siPixelDigis,
     cuda = cms.EDAlias(
         siPixelDigiErrors = cms.VPSet(

EventFilter/SiPixelRawToDigi/python/siPixelDigis_cff.py

@@ -1,30 +1,43 @@
 import FWCore.ParameterSet.Config as cms
 
 from EventFilter.SiPixelRawToDigi.SiPixelRawToDigi_cfi import siPixelDigis
-from EventFilter.SiPixelRawToDigi.siPixelDigisSoAFromCUDA_cfi import siPixelDigisSoAFromCUDA as _siPixelDigisSoAFromCUDA
-from EventFilter.SiPixelRawToDigi.siPixelDigiErrorsSoAFromCUDA_cfi import siPixelDigiErrorsSoAFromCUDA as _siPixelDigiErrorsSoAFromCUDA
-from EventFilter.SiPixelRawToDigi.siPixelDigiErrorsFromSoA_cfi import siPixelDigiErrorsFromSoA as _siPixelDigiErrorsFromSoA
 
-siPixelDigisTask = cms.Task(siPixelDigis)
+siPixelDigisTask = cms.Task(
+    # SwitchProducer wrapping the legacy pixel digis producer or an alias combining the pixel digis information converted from SoA
+    siPixelDigis
+)
 
+# copy the pixel digis (except errors) and clusters to the host
+from EventFilter.SiPixelRawToDigi.siPixelDigisSoAFromCUDA_cfi import siPixelDigisSoAFromCUDA as _siPixelDigisSoAFromCUDA
 siPixelDigisSoA = _siPixelDigisSoAFromCUDA.clone(
     src = "siPixelClustersPreSplittingCUDA"
 )
+
+# copy the pixel digis errors to the host
+from EventFilter.SiPixelRawToDigi.siPixelDigiErrorsSoAFromCUDA_cfi import siPixelDigiErrorsSoAFromCUDA as _siPixelDigiErrorsSoAFromCUDA
 siPixelDigiErrorsSoA = _siPixelDigiErrorsSoAFromCUDA.clone(
     src = "siPixelClustersPreSplittingCUDA"
 )
+
+# convert the pixel digis errors to the legacy format
+from EventFilter.SiPixelRawToDigi.siPixelDigiErrorsFromSoA_cfi import siPixelDigiErrorsFromSoA as _siPixelDigiErrorsFromSoA
 siPixelDigiErrors = _siPixelDigiErrorsFromSoA.clone()
 
+# use the Phase 1 settings
 from Configuration.Eras.Modifier_phase1Pixel_cff import phase1Pixel
-phase1Pixel.toModify(siPixelDigiErrors, UsePhase1=True)
-
-siPixelDigisTaskCUDA = cms.Task(
-    siPixelDigisSoA,
-    siPixelDigiErrorsSoA,
-    siPixelDigiErrors
+phase1Pixel.toModify(siPixelDigiErrors,
+    UsePhase1 = True
 )
 
+
 from Configuration.ProcessModifiers.gpu_cff import gpu
-_siPixelDigisTask_gpu = siPixelDigisTask.copy()
-_siPixelDigisTask_gpu.add(siPixelDigisTaskCUDA)
-gpu.toReplaceWith(siPixelDigisTask, _siPixelDigisTask_gpu)
+gpu.toReplaceWith(siPixelDigisTask, cms.Task(
+    # copy the pixel digis (except errors) and clusters to the host
+    siPixelDigisSoA,
+    # copy the pixel digis errors to the host
+    siPixelDigiErrorsSoA,
+    # convert the pixel digis errors to the legacy format
+    siPixelDigiErrors,
+    # SwitchProducer wrapping the legacy pixel digis producer or an alias combining the pixel digis information converted from SoA
+    siPixelDigisTask.copy()
+))

RecoLocalTracker/Configuration/python/RecoLocalTracker_cff.py

@@ -1,9 +1,7 @@
 import FWCore.ParameterSet.Config as cms
 
-#
 # Tracker Local Reco
-# Initialize magnetic field
-#
+
 from RecoLocalTracker.SiStripRecHitConverter.SiStripRecHitConverter_cfi import *
 from RecoLocalTracker.SiStripRecHitConverter.SiStripRecHitMatcher_cfi import *
 from RecoLocalTracker.SiStripRecHitConverter.StripCPEfromTrackAngle_cfi import *
@@ -13,9 +11,19 @@
 from RecoLocalTracker.SiPixelRecHits.SiPixelRecHits_cfi import *
 from RecoLocalTracker.SubCollectionProducers.clustersummaryproducer_cfi import *
 
-pixeltrackerlocalrecoTask = cms.Task(siPixelClustersPreSplittingTask,siPixelRecHitsPreSplittingTask)
-striptrackerlocalrecoTask = cms.Task(siStripZeroSuppression,siStripClusters,siStripMatchedRecHits)
-trackerlocalrecoTask = cms.Task(pixeltrackerlocalrecoTask,striptrackerlocalrecoTask,clusterSummaryProducer)
+pixeltrackerlocalrecoTask = cms.Task(
+    siPixelClustersPreSplittingTask,
+    siPixelRecHitsPreSplittingTask)
+
+striptrackerlocalrecoTask = cms.Task(
+    siStripZeroSuppression,
+    siStripClusters,
+    siStripMatchedRecHits)
+
+trackerlocalrecoTask = cms.Task(
+    pixeltrackerlocalrecoTask,
+    striptrackerlocalrecoTask,
+    clusterSummaryProducer)
 
 pixeltrackerlocalreco = cms.Sequence(pixeltrackerlocalrecoTask)
 striptrackerlocalreco = cms.Sequence(striptrackerlocalrecoTask)

RecoLocalTracker/SiPixelClusterizer/python/SiPixelClusterizerPreSplitting_cfi.py

@@ -1,14 +1,22 @@
 import FWCore.ParameterSet.Config as cms
+from HeterogeneousCore.CUDACore.SwitchProducerCUDA import SwitchProducerCUDA
 
+# SiPixelGainCalibrationServiceParameters
 from CondTools.SiPixel.SiPixelGainCalibrationService_cfi import *
+
+# legacy pixel cluster producer
 from RecoLocalTracker.SiPixelClusterizer.SiPixelClusterizer_cfi import siPixelClusters as _siPixelClusters
-from HeterogeneousCore.CUDACore.SwitchProducerCUDA import SwitchProducerCUDA
 siPixelClustersPreSplitting = SwitchProducerCUDA(
     cpu = _siPixelClusters.clone()
 )
 
 from Configuration.ProcessModifiers.gpu_cff import gpu
+# SwitchProducer wrapping the legacy pixel cluster producer or an alias for the pixel clusters information converted from SoA
 gpu.toModify(siPixelClustersPreSplitting,
+    # ensure the same results when running on GPU (which supports only the 'HLT' payload) and CPU
+    cpu = dict(
+        payloadType = 'HLT'
+    ),
     cuda = cms.EDAlias(
         siPixelDigisClustersPreSplitting = cms.VPSet(
             cms.PSet(type = cms.string("SiPixelClusteredmNewDetSetVector"))

RecoLocalTracker/SiPixelClusterizer/python/siPixelClustersPreSplitting_cff.py

@@ -1,26 +1,40 @@
 import FWCore.ParameterSet.Config as cms
+from Configuration.Eras.Modifier_run3_common_cff import run3_common
+from Configuration.ProcessModifiers.gpu_cff import gpu
 
+# conditions used *only* by the modules running on GPU
+from CalibTracker.SiPixelESProducers.siPixelROCsStatusAndMappingWrapperESProducer_cfi import siPixelROCsStatusAndMappingWrapperESProducer
+from CalibTracker.SiPixelESProducers.siPixelGainCalibrationForHLTGPU_cfi import siPixelGainCalibrationForHLTGPU
+
+# SwitchProducer wrapping the legacy pixel cluster producer or an alias for the pixel clusters information converted from SoA
 from RecoLocalTracker.SiPixelClusterizer.SiPixelClusterizerPreSplitting_cfi import siPixelClustersPreSplitting
-from RecoLocalTracker.SiPixelClusterizer.siPixelRawToClusterCUDA_cfi import siPixelRawToClusterCUDA as _siPixelRawToClusterCUDA
-from RecoLocalTracker.SiPixelClusterizer.siPixelDigisClustersFromSoA_cfi import siPixelDigisClustersFromSoA as _siPixelDigisClustersFromSoA
-from CalibTracker.SiPixelESProducers.siPixelROCsStatusAndMappingWrapperESProducer_cfi import *
-from CalibTracker.SiPixelESProducers.siPixelGainCalibrationForHLTGPU_cfi import *
 
-siPixelClustersPreSplittingTask = cms.Task(siPixelClustersPreSplitting)
+siPixelClustersPreSplittingTask = cms.Task(
+    # SwitchProducer wrapping the legacy pixel cluster producer or an alias for the pixel clusters information converted from SoA
+    siPixelClustersPreSplitting
+)
 
+# reconstruct the pixel digis and clusters on the gpu
+from RecoLocalTracker.SiPixelClusterizer.siPixelRawToClusterCUDA_cfi import siPixelRawToClusterCUDA as _siPixelRawToClusterCUDA
 siPixelClustersPreSplittingCUDA = _siPixelRawToClusterCUDA.clone()
-from Configuration.Eras.Modifier_run3_common_cff import run3_common
+
 run3_common.toModify(siPixelClustersPreSplittingCUDA,
-  isRun2=False
+    # use the pixel channel calibrations scheme for Run 3
+    isRun2 = False
 )
 
+# convert the pixel digis (except errors) and clusters to the legacy format
+from RecoLocalTracker.SiPixelClusterizer.siPixelDigisClustersFromSoA_cfi import siPixelDigisClustersFromSoA as _siPixelDigisClustersFromSoA
 siPixelDigisClustersPreSplitting = _siPixelDigisClustersFromSoA.clone()
-siPixelClustersPreSplittingTaskCUDA = cms.Task(
+
+gpu.toReplaceWith(siPixelClustersPreSplittingTask, cms.Task(
+    # conditions used *only* by the modules running on GPU
+    siPixelROCsStatusAndMappingWrapperESProducer,
+    siPixelGainCalibrationForHLTGPU,
+    # reconstruct the pixel digis and clusters on the gpu
     siPixelClustersPreSplittingCUDA,
+    # convert the pixel digis (except errors) and clusters to the legacy format
     siPixelDigisClustersPreSplitting,
-)
-
-from Configuration.ProcessModifiers.gpu_cff import gpu
-_siPixelClustersPreSplittingTask_gpu = siPixelClustersPreSplittingTask.copy()
-_siPixelClustersPreSplittingTask_gpu.add(siPixelClustersPreSplittingTaskCUDA)
-gpu.toReplaceWith(siPixelClustersPreSplittingTask, _siPixelClustersPreSplittingTask_gpu)
+    # SwitchProducer wrapping the legacy pixel cluster producer or an alias for the pixel clusters information converted from SoA
+    siPixelClustersPreSplittingTask.copy()
+))