Better TrajectorySeed interface to recHits #29971

guitargeek · 2020-05-24T23:25:48Z

PR description:

The current interface of the TrajectorySeed class to its recHits bothered me for quite some time, especially since the ElectronSeed inherits it. I'm speaking about this member function [1]:

std::pair<const_iterator, const_iterator> recHits() const { return std::make_pair(hits_.begin(), hits_.end()); }

~~which I think should better just return a const reference to the edm::OwnVector<TrackingRecHit> of seeds (proposed in this PR):~~ original idea that got discarded in review
which should better return a edm::Range<RecHitContainer::const_iterator> that implements begin() and end() such that recHits() can be used in range-based loops:

edm::Range<RecHitContainer::const_iterator> recHits() const { return {hits_.begin(), hits_.end()}; }

this also avoids the very misleading expression recHits().second: one might think that it points to the second rechit, but actually it is the hits_.end() iterator. This caused possible bugs here [2] and here [3], I think. No attempt is made in this PR to fix these potential bugs, it only adapts the code to the newly proposed range-loop friendly interface without changing any functionality (hopefully).

[1] https://github.com/cms-sw/cmssw/blob/master/DataFormats/TrajectorySeed/interface/TrajectorySeed.h#L52
[2] https://github.com/cms-sw/cmssw/blob/master/RecoTracker/MeasurementDet/src/StartingLayerFinder.cc#L79
[3] https://github.com/cms-sw/cmssw/blob/master/Validation/RecoMuon/src/MuonSeedTrack.cc#L208

PR validation:

CMSSW compiles and local matrix tests pass.

if this PR is a backport please specify the original PR and why you need to backport that PR:

No backport intended.

cmsbuild · 2020-05-24T23:26:13Z

The code-checks are being triggered in jenkins.

cmsbuild · 2020-05-24T23:33:40Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-29971/15634

This PR adds an extra 356KB to repository
There are other open Pull requests which might conflict with changes you have proposed:
- File DPGAnalysis/SiStripTools/plugins/SeedMultiplicityAnalyzer.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-use-emplace #29937, [RFC] Test clang-tidy --checks modernize-use-auto #29936
- File DataFormats/MuonSeed/src/L2MuonTrajectorySeed.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933
- File FastSimulation/Muons/plugins/FastTSGFromIOHit.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-use-auto #29936
- File FastSimulation/Muons/plugins/FastTSGFromL2Muon.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-use-auto #29936
- File FastSimulation/Tracking/plugins/PixelTracksProducer.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-use-auto #29936
- File FastSimulation/Tracking/plugins/TrackCandidateProducer.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File Fireworks/Tracks/plugins/FWTrajectorySeedProxyBuilder.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-use-auto #29936
- File RecoEgamma/EgammaElectronAlgos/src/ElectronSeedGenerator.cc modified in PR(s): Continue work on electron seeding convergence #29815, [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoEgamma/EgammaElectronAlgos/src/PixelHitMatcher.cc modified in PR(s): Continue work on electron seeding convergence #29815
- File RecoEgamma/EgammaElectronAlgos/src/TrajSeedMatcher.cc modified in PR(s): Continue work on electron seeding convergence #29815, [RFC] Test clang-tidy --checks modernize-use-emplace #29937
- File RecoEgamma/Examples/plugins/ElectronSeedAnalyzer.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoMuon/MuonSeedGenerator/src/MuonSeedCleaner.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoMuon/MuonSeedGenerator/src/RPCSeedOverlapper.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933
- File RecoMuon/TrackerSeedGenerator/plugins/TSGForOI.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoMuon/TrackerSeedGenerator/plugins/TSGForOIFromL2.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-use-emplace #29937
- File RecoMuon/TrackerSeedGenerator/plugins/TSGForRoadSearch.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-use-emplace #29937
- File RecoMuon/TrackerSeedGenerator/src/RedundantSeedCleaner.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoParticleFlow/PFSimProducer/plugins/ConvBremSeedProducer.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-use-emplace #29937
- File RecoParticleFlow/PFTracking/plugins/PFElecTkProducer.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-make-unique #29934
- File RecoTracker/CkfPattern/plugins/GroupedCkfTrajectoryBuilder.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoTracker/CkfPattern/src/CkfTrackCandidateMakerBase.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoTracker/FinalTrackSelectors/plugins/TrackListMerger.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoTracker/SingleTrackPattern/src/CRackTrajectoryBuilder.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935, [RFC] Test clang-tidy --checks modernize-use-emplace #29937
- File RecoTracker/SingleTrackPattern/src/CosmicTrajectoryBuilder.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoTracker/TkSeedGenerator/plugins/SeedCombiner.cc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoTracker/TrackProducer/interface/TrackProducerAlgorithm.icc modified in PR(s): [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File RecoTracker/TrackProducer/src/DAFTrackProducerAlgorithm.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-loop-convert #29935
- File SimTracker/TrackAssociatorProducers/plugins/QuickTrackAssociatorByHitsImpl.cc modified in PR(s): [RFC] Test clang-tidy --checks performance-unnecessary-value-param #29933, [RFC] Test clang-tidy --checks modernize-use-emplace #29937

cmsbuild · 2020-05-24T23:34:12Z

A new Pull Request was created by @guitargeek (Jonas Rembser) for master.

It involves the following packages:

DPGAnalysis/SiStripTools
DQM/TrackingMonitor
DataFormats/EgammaReco
DataFormats/MuonSeed
DataFormats/ParticleFlowReco
DataFormats/TrajectorySeed
FastSimulation/Muons
FastSimulation/Tracking
Fireworks/Tracks
HLTrigger/Muon
RecoEgamma/EgammaElectronAlgos
RecoEgamma/Examples
RecoLocalTracker/SubCollectionProducers
RecoMuon/L2MuonSeedGenerator
RecoMuon/L3MuonProducer
RecoMuon/MuonSeedGenerator
RecoMuon/StandAloneTrackFinder
RecoMuon/TrackerSeedGenerator
RecoParticleFlow/PFSimProducer
RecoParticleFlow/PFTracking
RecoTracker/CkfPattern
RecoTracker/ConversionSeedGenerators
RecoTracker/FinalTrackSelectors
RecoTracker/MeasurementDet
RecoTracker/MkFit
RecoTracker/SingleTrackPattern
RecoTracker/TkSeedGenerator
RecoTracker/TrackProducer
SimMuon/MCTruth
SimTracker/TrackAssociatorProducers
TrackingTools/TrackRefitter
Validation/RecoMuon
Validation/RecoTrack

@perrotta, @Martin-Grunewald, @ssekmen, @Dr15Jones, @lveldere, @alja, @makortel, @civanch, @sbein, @schneiml, @andrius-k, @mdhildreth, @cmsbuild, @kmaeshima, @jfernan2, @fioriNTU, @slava77, @fwyzard, @santocch can you please review it and eventually sign? Thanks.
@wmtford, @echabert, @makortel, @felicepantaleo, @jainshilpi, @jandrea, @robervalwalsh, @echapon, @mschrode, @fioriNTU, @lgray, @abbiendi, @mmusich, @slomeo, @venturia, @mmarionncern, @hdelanno, @calderona, @pieterdavid, @threus, @jhgoh, @varuns23, @HuguesBrun, @seemasharmafnal, @yduhm, @rociovilar, @Sam-Harper, @cbernet, @GiacomoSguazzoni, @rovere, @VinInn, @bellan, @hatakeyamak, @alesaggio, @idebruyn, @ebrondol, @mtosi, @dgulhan, @Martin-Grunewald, @trocino, @battibass, @gbenelli, @Fedespring, @alja, @sobhatta, @lecriste, @afiqaize, @gpetruc, @matt-komm, @cericeci, @folguera this is something you requested to watch as well.
@silviodonato, @dpiparo you are the release manager for this.

cms-bot commands are listed here

fwyzard · 2020-05-24T23:55:31Z

Does the current code already guarantee that the rechits are always stored in a vector ?

guitargeek · 2020-05-25T00:07:42Z

Pardon, I should have said that they are stored in an edm::OwnVector<TrackingRecHit> not a normal vector. I clarified that above. The OwnVectors interface fortunately comes with it's own iterator class and implements begin(), end() and empty(), which is why the range-based loop can be used:
https://github.com/cms-sw/cmssw/blob/master/DataFormats/Common/interface/OwnVector.h#L153
Unfortunately I'm not that familiar with the edm::OwnVector class, so if you have any further concerns I might not be able to comment them immediately.

slava77 · 2020-05-25T01:51:50Z

@cmsbuild please test

cmsbuild · 2020-05-25T01:52:18Z

The tests are being triggered in jenkins.
https://cmssdt.cern.ch/jenkins/job/ib-run-pr-tests/6556/console Started: 2020/05/25 03:53

cmsbuild · 2020-05-25T04:19:30Z

+1
Tested at: c6f9576
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-ad7c88/6556/summary.html
CMSSW: CMSSW_11_2_X_2020-05-24-0000
SCRAM_ARCH: slc7_amd64_gcc820

cmsbuild · 2020-05-25T04:19:33Z

Comparison job queued.

cmsbuild · 2020-05-25T05:53:38Z

Comparison is ready
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-ad7c88/6556/summary.html

Comparison Summary:

No significant changes to the logs found
Reco comparison results: 0 differences found in the comparisons
DQMHistoTests: Total files compared: 36
DQMHistoTests: Total histograms compared: 2780792
DQMHistoTests: Total failures: 4027
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 2776715
DQMHistoTests: Total skipped: 50
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 35 files compared)
Checked 152 log files, 16 edm output root files, 36 DQM output files

jfernan2 · 2020-05-28T08:54:49Z

+1

Martin-Grunewald · 2020-05-29T13:45:38Z

+1

silviodonato · 2020-06-02T14:41:05Z

Any objections?
analysis: @santocch
visualization: @Dr15Jones @alja @makortel
fastsim: @civanch @lveldere @mdhildreth @sbein @ssekmen
simulation: @civanch @mdhildreth

santocch · 2020-06-03T04:14:45Z

+1

alja · 2020-06-03T21:29:29Z

+1

civanch · 2020-06-05T07:53:26Z

+1

cmsbuild · 2020-06-05T07:53:55Z

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @silviodonato, @dpiparo (and backports should be raised in the release meeting by the corresponding L2)

silviodonato · 2020-06-05T13:29:51Z

+1

cmsbuild added this to the CMSSW_11_2_X milestone May 24, 2020

cmsbuild added analysis-pending code-checks-pending comparison-pending dqm-pending fastsim-pending hlt-pending orp-pending pending-signatures reconstruction-pending simulation-pending tests-pending visualization-pending labels May 24, 2020

cmsbuild added code-checks-approved and removed code-checks-pending labels May 24, 2020

cmsbuild added tests-started and removed tests-pending labels May 25, 2020

cmsbuild added tests-approved and removed tests-started labels May 25, 2020

cmsbuild removed the comparison-pending label May 25, 2020

cmsbuild added reconstruction-approved and removed reconstruction-pending labels May 28, 2020

cmsbuild added dqm-approved and removed dqm-pending labels May 28, 2020

cmsbuild added hlt-approved and removed hlt-pending labels May 29, 2020

cmsbuild added analysis-approved and removed analysis-pending labels Jun 3, 2020

cmsbuild added visualization-approved and removed visualization-pending labels Jun 3, 2020

cmsbuild removed fastsim-pending pending-signatures simulation-pending labels Jun 5, 2020

cmsbuild added fastsim-approved fully-signed simulation-approved labels Jun 5, 2020

cmsbuild added orp-approved and removed orp-pending labels Jun 5, 2020

cmsbuild merged commit 8008927 into cms-sw:master Jun 5, 2020

guitargeek deleted the TrajectorySeed_recHits branch June 5, 2020 13:43

guitargeek mentioned this pull request Jun 7, 2020

Remove invalid usage of TrajectorySeed::recHits() #30133

Merged

guitargeek mentioned this pull request Jun 24, 2020

edm::Range interface to TrackCandidate recHits #30361

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better TrajectorySeed interface to recHits #29971

Better TrajectorySeed interface to recHits #29971

guitargeek commented May 24, 2020 •

edited

Loading

cmsbuild commented May 24, 2020

cmsbuild commented May 24, 2020

cmsbuild commented May 24, 2020

fwyzard commented May 24, 2020

guitargeek commented May 25, 2020 •

edited

Loading

slava77 commented May 25, 2020

cmsbuild commented May 25, 2020 •

edited

Loading

cmsbuild commented May 25, 2020

cmsbuild commented May 25, 2020

cmsbuild commented May 25, 2020

jfernan2 commented May 28, 2020

Martin-Grunewald commented May 29, 2020

silviodonato commented Jun 2, 2020

santocch commented Jun 3, 2020

alja commented Jun 3, 2020

civanch commented Jun 5, 2020

cmsbuild commented Jun 5, 2020

silviodonato commented Jun 5, 2020

Better TrajectorySeed interface to recHits #29971

Better TrajectorySeed interface to recHits #29971

Conversation

guitargeek commented May 24, 2020 • edited Loading

PR description:

PR validation:

if this PR is a backport please specify the original PR and why you need to backport that PR:

cmsbuild commented May 24, 2020

cmsbuild commented May 24, 2020

cmsbuild commented May 24, 2020

fwyzard commented May 24, 2020

guitargeek commented May 25, 2020 • edited Loading

slava77 commented May 25, 2020

cmsbuild commented May 25, 2020 • edited Loading

cmsbuild commented May 25, 2020

cmsbuild commented May 25, 2020

cmsbuild commented May 25, 2020

jfernan2 commented May 28, 2020

Martin-Grunewald commented May 29, 2020

silviodonato commented Jun 2, 2020

santocch commented Jun 3, 2020

alja commented Jun 3, 2020

civanch commented Jun 5, 2020

cmsbuild commented Jun 5, 2020

silviodonato commented Jun 5, 2020

guitargeek commented May 24, 2020 •

edited

Loading

guitargeek commented May 25, 2020 •

edited

Loading

cmsbuild commented May 25, 2020 •

edited

Loading