summer chain demonstrator (cms-sw#111)

* track builder channel upgraded to assign stubs to channel. * renamed TrackBuilderChannel to ChannelAssignment now also containing DTC to IR mapping * ProducerIRin and ProducerTBout added, Demonstrator configured by default to use them. * rebase with tschuh_TrackBuilder and code format * StreamsStub added as EDProduct of L1FPGATrackProducer * code format. * convert only finally accepted Tracklets to StreamsStub. * undo last commit, adding trackword ed product and adding gaps to stubs and tracks to get clock accurate emulation. * swap bugfix. * rebased and name change of TrackBuilderChannel adopted. * fixing rebase errors. * fixing more rebase errors. * fixing even more rebase errors. * first comments from Ian. * code format * second comments from Ian. * code format * Ians third comments. * Ians 4th comments. * small merge error fix * Added comment * Refine comment * miniscule comment change Co-authored-by: Ian Tomalin <[email protected]>
sarafiorendi · Jun 10, 2022 · f1e8693 · f1e8693
1 parent 81c984e
commit f1e8693
Show file tree

Hide file tree

Showing 26 changed files with 517 additions and 49 deletions.
diff --git a/DataFormats/L1TrackTrigger/interface/TTTypes.h b/DataFormats/L1TrackTrigger/interface/TTTypes.h
@@ -62,8 +62,10 @@ namespace tt {
   typedef std::pair<TTTrackRef, Frame> FrameTrack;
   typedef std::vector<FrameStub> StreamStub;
   typedef std::vector<FrameTrack> StreamTrack;
+  typedef std::vector<Frame> Stream;
   typedef std::vector<StreamStub> StreamsStub;
   typedef std::vector<StreamTrack> StreamsTrack;
+  typedef std::vector<Stream> Streams;
   typedef std::map<TTTrackRef, TTTrackRef> TTTrackRefMap;
   typedef std::vector<TTTrack<Ref_Phase2TrackerDigi_>> TTTracks;
 }  // namespace tt

diff --git a/DataFormats/L1TrackTrigger/src/classes_def.xml b/DataFormats/L1TrackTrigger/src/classes_def.xml
@@ -38,8 +38,10 @@
   <class name="edm::Ptr<TTTrack<edm::Ref<edm::DetSetVector<Phase2TrackerDigi>,Phase2TrackerDigi,edm::refhelper::FindForDetSetVector<Phase2TrackerDigi> > > >" />
   <class name="tt::StreamsStub"/>
   <class name="tt::StreamsTrack"/>
+  <class name="tt::Streams"/>
   <class name="edm::Wrapper<tt::StreamsStub>"/>
   <class name="edm::Wrapper<tt::StreamsTrack>"/>
+  <class name="edm::Wrapper<tt::Streams>"/>
   <class name="tt::TTTracks"/>
   <class name="edm::Wrapper<tt::TTTracks>"/>
   <class name="std::pair<const TTTrackRef, TTTrackRef>"/>

diff --git a/L1Trigger/TrackFindingTracklet/interface/ChannelAssignment.h b/L1Trigger/TrackFindingTracklet/interface/ChannelAssignment.h
@@ -26,8 +26,10 @@ namespace trklet {
     bool channelId(const TTTrackRef& ttTrackRef, int& channelId);
     // number of used channels
     int numChannels() const { return numChannels_; }
-    // sets layerId (0-7 in sequence the seed type projects to) of given TTStubRef and TTTrackRef, returns false if seeed stub
-    bool layerId(const TTTrackRef& ttTrackRef, const TTStubRef& ttStubRef, int& layerId);
+    // sets layerId (0-7 in sequence the seed type projects to) of given TTStubRef and seedType, returns false if seeed stub
+    bool layerId(int seedType, const TTStubRef& ttStubRef, int& layerId) const;
+    // return tracklet layerId (barrel: [0-5], endcap: [6-10]) for given TTStubRef
+    int trackletLayerId(const TTStubRef& ttStubRef) const { return setup_->trackletLayerId(ttStubRef); };
     // max number layers a sedd type may project to
     int maxNumProjectionLayers() const { return maxNumProjectionLayers_; }
     // map of used DTC tfp channels in InputRouter

diff --git a/L1Trigger/TrackFindingTracklet/interface/FitTrack.h b/L1Trigger/TrackFindingTracklet/interface/FitTrack.h
@@ -5,8 +5,10 @@
 #include "L1Trigger/TrackFindingTracklet/interface/TrackletParametersMemory.h"
 #include "L1Trigger/TrackFindingTracklet/interface/FullMatchMemory.h"
 #include "L1Trigger/TrackFindingTracklet/interface/TrackFitMemory.h"
+#include "L1Trigger/TrackFindingTracklet/interface/ChannelAssignment.h"
 
 #include <vector>
+#include <deque>
 
 namespace trklet {
 
@@ -38,7 +40,10 @@ namespace trklet {
 
     std::vector<Tracklet*> orderedMatches(std::vector<FullMatchMemory*>& fullmatch);
 
-    void execute(unsigned int iSector);
+    void execute(const ChannelAssignment* channelAssignment,
+                 std::deque<tt::Frame>& streamTrack,
+                 std::vector<std::deque<tt::FrameStub>>& streamsStub,
+                 unsigned int iSector);
 
   private:
     std::vector<TrackletParametersMemory*> seedtracklet_;

diff --git a/L1Trigger/TrackFindingTracklet/interface/L1TStub.h b/L1Trigger/TrackFindingTracklet/interface/L1TStub.h
@@ -2,6 +2,7 @@
 #define L1Trigger_TrackFindingTracklet_interface_L1TStub_h
 
 #include "L1Trigger/TrackFindingTracklet/interface/Settings.h"
+#include "DataFormats/L1TrackTrigger/interface/TTTypes.h"
 
 #include <iostream>
 #include <fstream>
@@ -26,7 +27,8 @@ namespace trklet {
             double z,
             double bend,
             double strip,
-            std::vector<int> tps);
+            std::vector<int> tps,
+            const TTStubRef& ttStubRef);
 
     ~L1TStub() = default;
 
@@ -107,6 +109,8 @@ namespace trklet {
 
     const std::string& stubword() const { return stubword_; }
 
+    TTStubRef ttStubRef() const { return ttStubRef_; }
+
   private:
     int layerdisk_;
     std::string DTClink_;
@@ -131,6 +135,7 @@ namespace trklet {
 
     unsigned int isPSmodule_;
     unsigned int isFlipped_;
+    TTStubRef ttStubRef_;
   };
 };  // namespace trklet
 #endif
diff --git a/L1Trigger/TrackFindingTracklet/interface/SLHCEvent.h b/L1Trigger/TrackFindingTracklet/interface/SLHCEvent.h
@@ -39,7 +39,8 @@ namespace trklet {
                  double z,
                  double bend,
                  double strip,
-                 std::vector<int> tps);
+                 std::vector<int> tpstt,
+                 const TTStubRef& ttStubRef);
 
     const L1TStub& lastStub() const { return stubs_.back(); }
 

diff --git a/L1Trigger/TrackFindingTracklet/interface/Sector.h b/L1Trigger/TrackFindingTracklet/interface/Sector.h
@@ -4,6 +4,7 @@
 
 #include "L1Trigger/TrackFindingTracklet/interface/L1TStub.h"
 #include "L1Trigger/TrackFindingTracklet/interface/SLHCEvent.h"
+#include "L1Trigger/TrackFindingTracklet/interface/ChannelAssignment.h"
 
 #include <string>
 #include <map>
@@ -114,7 +115,7 @@ namespace trklet {
     void executeME();
     void executeMC();
     void executeMP();
-    void executeFT();
+    void executeFT(const ChannelAssignment* channelAssignment, tt::Streams& streamsTrack, tt::StreamsStub& streamsStub);
     void executePD(std::vector<Track>& tracks);
 
     std::vector<Tracklet*> getAllTracklets() const;

diff --git a/L1Trigger/TrackFindingTracklet/interface/Settings.h b/L1Trigger/TrackFindingTracklet/interface/Settings.h
@@ -241,6 +241,10 @@ namespace trklet {
     bool doMultipleMatches() const { return doMultipleMatches_; }
     bool fakefit() const { return fakefit_; }
     void setFakefit(bool fakefit) { fakefit_ = fakefit; }
+    bool storeTrackBuilderOutput() const { return storeTrackBuilderOutput_; }
+    void setStoreTrackBuilderOutput(bool storeTrackBuilderOutput) {
+      storeTrackBuilderOutput_ = storeTrackBuilderOutput_;
+    }
 
     // configurable
     unsigned int nHelixPar() const { return nHelixPar_; }
@@ -769,7 +773,7 @@ namespace trklet {
     //IR should be set to 108 to match the FW for the summer chain, but ultimately should be at 156
     std::unordered_map<std::string, unsigned int> maxstep_{{"IR", 156},  //IR will run at a higher clock speed to handle
                                                                          //input links running at 25 Gbits/s
-                                                                         //Set to 108 to match firmware project 240 MHz clock
+                                                           //Set to 108 to match firmware project 240 MHz clock
 
                                                            {"VMR", 107},
                                                            {"TE", 107},
@@ -905,6 +909,8 @@ namespace trklet {
 
     // if true, run a dummy fit, producing TTracks directly from output of tracklet pattern reco stage
     bool fakefit_{false};
+    // if true EDProducer fills additionaly bit and clock accurate TrackBuilder EDProduct
+    bool storeTrackBuilderOutput_{false};
 
     unsigned int nHelixPar_{4};  // 4 or 5 param helix fit
     bool extended_{false};       // turn on displaced tracking

diff --git a/L1Trigger/TrackFindingTracklet/interface/TrackletEventProcessor.h b/L1Trigger/TrackFindingTracklet/interface/TrackletEventProcessor.h
@@ -3,10 +3,12 @@
 #define L1Trigger_TrackFindingTracklet_interface_TrackletEventProcessor_h
 
 #include "L1Trigger/TrackFindingTracklet/interface/Timer.h"
+#include "L1Trigger/TrackFindingTracklet/interface/ChannelAssignment.h"
 
 #include <map>
 #include <memory>
 #include <vector>
+#include <deque>
 #include <string>
 
 namespace trklet {
@@ -24,18 +26,21 @@ namespace trklet {
 
     ~TrackletEventProcessor();
 
-    void init(Settings const& theSettings);
+    void init(Settings const& theSettings, const ChannelAssignment* channelAssignment);
 
     void event(SLHCEvent& ev);
 
     void printSummary();
 
     const std::vector<Track>& tracks() const { return tracks_; }
 
+    void produce(tt::Streams& streamsTrack, tt::StreamsStub& streamsStub);
+
   private:
     void configure(std::istream& inwire, std::istream& inmem, std::istream& inproc);
 
     const Settings* settings_{nullptr};
+    const ChannelAssignment* channelAssignment_{nullptr};
 
     std::unique_ptr<Globals> globals_;
 
@@ -63,6 +68,8 @@ namespace trklet {
     Timer PDTimer_;
 
     std::vector<Track> tracks_;
+    tt::Streams streamsTrack_;
+    tt::StreamsStub streamsStub_;
   };
 
 };  // namespace trklet

diff --git a/L1Trigger/TrackFindingTracklet/plugins/L1FPGATrackProducer.cc b/L1Trigger/TrackFindingTracklet/plugins/L1FPGATrackProducer.cc
@@ -83,6 +83,10 @@
 #include "L1Trigger/TrackFindingTracklet/interface/Sector.h"
 #include "L1Trigger/TrackFindingTracklet/interface/Track.h"
 #include "L1Trigger/TrackFindingTracklet/interface/TrackletEventProcessor.h"
+#include "L1Trigger/TrackFindingTracklet/interface/ChannelAssignment.h"
+#include "L1Trigger/TrackFindingTracklet/interface/Tracklet.h"
+#include "L1Trigger/TrackFindingTracklet/interface/Residual.h"
+#include "L1Trigger/TrackFindingTracklet/interface/Stub.h"
 
 ////////////////
 // PHYSICS TOOLS
@@ -106,6 +110,8 @@
 // NAMESPACES
 using namespace edm;
 using namespace std;
+using namespace tt;
+using namespace trklet;
 
 //////////////////////////////
 //                          //
@@ -159,9 +165,6 @@ class L1FPGATrackProducer : public edm::one::EDProducer<edm::one::WatchRuns> {
   // settings containing various constants for the tracklet processing
   trklet::Settings settings;
 
-  // event processor for the tracklet track finding
-  trklet::TrackletEventProcessor eventProcessor;
-
   unsigned int nHelixPar_;
   bool extended_;
   bool reduced_;
@@ -181,6 +184,15 @@ class L1FPGATrackProducer : public edm::one::EDProducer<edm::one::WatchRuns> {
   edm::EDGetTokenT<std::vector<TrackingParticle>> TrackingParticleToken_;
   edm::EDGetTokenT<TTDTC> tokenDTC_;
 
+  // ED output token for clock and bit accurate tracks
+  EDPutTokenT<Streams> edPutTokenTracks_;
+  // ED output token for clock and bit accurate stubs
+  EDPutTokenT<StreamsStub> edPutTokenStubs_;
+  // ChannelAssignment token
+  ESGetToken<ChannelAssignment, ChannelAssignmentRcd> esGetTokenChannelAssignment_;
+  // helper class to assign tracks to channel
+  const ChannelAssignment* channelAssignment_;
+
   // helper class to store DTC configuration
   tt::Setup setup_;
 
@@ -222,6 +234,10 @@ L1FPGATrackProducer::L1FPGATrackProducer(edm::ParameterSet const& iConfig)
   }
 
   produces<std::vector<TTTrack<Ref_Phase2TrackerDigi_>>>("Level1TTTracks").setBranchAlias("Level1TTTracks");
+  // book ED output token for clock and bit accurate TrackBuilder tracks
+  edPutTokenTracks_ = produces<Streams>("Level1TTTracks");
+  // book ED output token for clock and bit accurate TrackBuilder stubs
+  edPutTokenStubs_ = produces<StreamsStub>("Level1TTTracks");
 
   asciiEventOutName_ = iConfig.getUntrackedParameter<string>("asciiFileName", "");
 
@@ -239,8 +255,12 @@ L1FPGATrackProducer::L1FPGATrackProducer(edm::ParameterSet const& iConfig)
     tableTREFile = iConfig.getParameter<edm::FileInPath>("tableTREFile");
   }
 
-  // book ES product
+  // book ES product to assign tracks and stubs to InputRouter input channel and TrackBuilder output channel
+  esGetTokenChannelAssignment_ = esConsumes<ChannelAssignment, ChannelAssignmentRcd, Transition::BeginRun>();
+  // book ES product for track trigger cinfiguration
   esGetToken_ = esConsumes<tt::Setup, tt::SetupRcd, edm::Transition::BeginRun>();
+  // initial ES products
+  channelAssignment_ = nullptr;
 
   // --------------------------------------------------------------------------------
   // set options in Settings based on inputs from configuration files
@@ -256,6 +276,7 @@ L1FPGATrackProducer::L1FPGATrackProducer(edm::ParameterSet const& iConfig)
   settings.setWiresFile(wiresFile.fullPath());
 
   settings.setFakefit(iConfig.getParameter<bool>("Fakefit"));
+  settings.setStoreTrackBuilderOutput(iConfig.getParameter<bool>("StoreTrackBuilderOutput"));
 
   if (extended_) {
     settings.setTableTEDFile(tableTEDFile.fullPath());
@@ -287,6 +308,15 @@ L1FPGATrackProducer::L1FPGATrackProducer(edm::ParameterSet const& iConfig)
   if (trackQuality_) {
     trackQualityModel_ = std::make_unique<L1TrackQuality>(iConfig.getParameter<edm::ParameterSet>("TrackQualityPSet"));
   }
+  if (settings.storeTrackBuilderOutput() && (settings.doMultipleMatches() || settings.removalType() != "")) {
+    cms::Exception exception("ConfigurationNotSupported.");
+    exception.addContext("L1FPGATrackProducer::produce");
+    if (settings.doMultipleMatches())
+      exception << "Stroing of TrackBuilder output does not support doMultipleMatches.";
+    if (settings.removalType() != "")
+      exception << "Stroing of TrackBuilder output does not support duplicate removal.";
+    throw exception;
+  }
 }
 
 /////////////
@@ -311,14 +341,16 @@ void L1FPGATrackProducer::beginRun(const edm::Run& run, const edm::EventSetup& i
   settings.setBfield(mMagneticFieldStrength);
 
   setup_ = iSetup.getData(esGetToken_);
-
-  // initialize the tracklet event processing (this sets all the processing & memory modules, wiring, etc)
-  eventProcessor.init(settings);
+  channelAssignment_ = &iSetup.getData(esGetTokenChannelAssignment_);
 }
 
 //////////
 // PRODUCE
 void L1FPGATrackProducer::produce(edm::Event& iEvent, const edm::EventSetup& iSetup) {
+  // event processor for the tracklet track finding
+  trklet::TrackletEventProcessor eventProcessor;
+  // initialize the tracklet event processing (this sets all the processing & memory modules, wiring, etc)
+  eventProcessor.init(settings, channelAssignment_);
   typedef std::map<trklet::L1TStub,
                    edm::Ref<edmNew::DetSetVector<TTStub<Ref_Phase2TrackerDigi_>>, TTStub<Ref_Phase2TrackerDigi_>>,
                    L1TStubCompare>
@@ -543,7 +575,8 @@ void L1FPGATrackProducer::produce(edm::Event& iEvent, const edm::EventSetup& iSe
                    ttPos.z(),
                    stubbend,
                    stub.first->innerClusterPosition(),
-                   assocTPs);
+                   assocTPs,
+                   stub.first);
 
         const trklet::L1TStub& lastStub = ev.lastStub();
         stubMap[lastStub] = stub.first;
@@ -638,6 +671,17 @@ void L1FPGATrackProducer::produce(edm::Event& iEvent, const edm::EventSetup& iSe
 
   iEvent.put(std::move(L1TkTracksForOutput), "Level1TTTracks");
 
+  // produce clock and bit output tracks and stubs
+  // number of track channel
+  const int numStreamsTrack = N_SECTOR * channelAssignment_->numChannels();
+  // number of stub channel
+  const int numStreamsStub = numStreamsTrack * channelAssignment_->maxNumProjectionLayers();
+  Streams streamsTrack(numStreamsTrack);
+  StreamsStub streamsStub(numStreamsStub);
+  eventProcessor.produce(streamsTrack, streamsStub);
+  iEvent.emplace(edPutTokenTracks_, move(streamsTrack));
+  iEvent.emplace(edPutTokenStubs_, move(streamsStub));
+
 }  /// End of produce()
 
 // ///////////////////////////

diff --git a/L1Trigger/TrackFindingTracklet/python/ProducerKF_cff.py b/L1Trigger/TrackFindingTracklet/python/ProducerKF_cff.py
@@ -8,6 +8,8 @@
 from L1Trigger.TrackFindingTracklet.ChannelAssignment_cff import ChannelAssignment
 from L1Trigger.TrackFindingTracklet.ProducerKF_cfi import TrackFindingTrackletProducerKF_params
 
+TrackFindingTrackletProducerIRin = cms.EDProducer( 'trklet::ProducerIRin', TrackFindingTrackletProducerKF_params )
+TrackFindingTrackletProducerTBout = cms.EDProducer( 'trklet::ProducerTBout', TrackFindingTrackletProducerKF_params )
 TrackFindingTrackletProducerKFin = cms.EDProducer( 'trklet::ProducerKFin', TrackFindingTrackletProducerKF_params )
 TrackFindingTrackletProducerKF = cms.EDProducer( 'trackerTFP::ProducerKF', TrackFindingTrackletProducerKF_params )
 TrackFindingTrackletProducerTT = cms.EDProducer( 'trklet::ProducerTT', TrackFindingTrackletProducerKF_params )

diff --git a/L1Trigger/TrackFindingTracklet/python/ProducerKF_cfi.py b/L1Trigger/TrackFindingTracklet/python/ProducerKF_cfi.py
@@ -2,7 +2,7 @@
 
 TrackFindingTrackletProducerKF_params = cms.PSet (
 
-  InputTag             = cms.InputTag( "TrackletTracksFromTrackletEmulation", "Level1TTTracks"), #
+  InputTag             = cms.InputTag( "TTTracksFromTrackletEmulation", "Level1TTTracks"), #
   InputTagDTC          = cms.InputTag( "TrackerDTCProducer", "StubAccepted"),                    #
   LabelKFin            = cms.string  ( "TrackFindingTrackletProducerKFin"  ),                    #
   LabelKF              = cms.string  ( "TrackFindingTrackletProducerKF"    ),                    #

diff --git a/L1Trigger/TrackFindingTracklet/python/Tracklet_cfi.py b/L1Trigger/TrackFindingTracklet/python/Tracklet_cfi.py
@@ -1,5 +1,6 @@
 import FWCore.ParameterSet.Config as cms
 from L1Trigger.TrackTrigger.TrackQualityParams_cfi import *
+from L1Trigger.TrackFindingTracklet.ChannelAssignment_cff import ChannelAssignment
 
 TTTracksFromTrackletEmulation = cms.EDProducer("L1FPGATrackProducer",
                                                TTStubSource = cms.InputTag("TTStubsFromPhase2TrackerDigis","StubAccepted"),
@@ -21,7 +22,8 @@
                                                # Quality Flag and Quality params
                                                TrackQuality = cms.bool(True),
                                                TrackQualityPSet = cms.PSet(TrackQualityParams),
-                                               Fakefit = cms.bool(False)
+                                               Fakefit = cms.bool(False), # True causes Tracklet reco to output TTTracks before DR & KF
+                                               StoreTrackBuilderOutput = cms.bool(False) # if True EDProducts for TrackBuilder tracks and stubs will be filled
     )
 
 TTTracksFromExtendedTrackletEmulation = TTTracksFromTrackletEmulation.clone(