ATLAS Offline Software
Loading...
Searching...
No Matches
TrackFindingBaseAlg.cxx
Go to the documentation of this file.
1/*
2 Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
3*/
4
6
7// ActsTrk
14#include "Acts/Surfaces/PerigeeSurface.hpp"
15
17
18namespace ActsTrk {
20
23
24 TrackFindingBaseAlg::TrackFindingBaseAlg(const std::string &name, ISvcLocator *pSvcLocator) : AthReentrantAlgorithm(name, pSvcLocator) {}
25
27
29 ATH_MSG_DEBUG("Properties Summary:");
41 ATH_MSG_DEBUG(" " << m_phiMin);
42 ATH_MSG_DEBUG(" " << m_phiMax);
43 ATH_MSG_DEBUG(" " << m_etaMin);
47 ATH_MSG_DEBUG(" " << m_ptMin);
48 ATH_MSG_DEBUG(" " << m_ptMax);
49 ATH_MSG_DEBUG(" " << m_d0Min);
50 ATH_MSG_DEBUG(" " << m_d0Max);
51 ATH_MSG_DEBUG(" " << m_z0Min);
52 ATH_MSG_DEBUG(" " << m_z0Max);
70
71 m_logger = makeActsAthenaLogger(this, "Acts");
72
73 // Read and Write handles
74 ATH_CHECK(m_trackContainerKey.initialize());
76
77 ATH_CHECK(m_monTool.retrieve(EnableTool{not m_monTool.empty()}));
79 ATH_CHECK(m_ctxProvider.initialize());
80 ATH_CHECK(m_trackStatePrinter.retrieve(EnableTool{not m_trackStatePrinter.empty()}));
81 ATH_CHECK(m_pixelCalibTool.retrieve(EnableTool{not m_pixelCalibTool.empty()}));
82 ATH_CHECK(m_stripCalibTool.retrieve(EnableTool{not m_stripCalibTool.empty()}));
83 ATH_CHECK(m_hgtdCalibTool.retrieve(EnableTool{not m_hgtdCalibTool.empty()}));
84
85 auto magneticField = std::make_unique<ATLASMagneticFieldWrapper>();
86 auto trackingGeometry = m_trackingGeometrySvc->trackingGeometry();
87
88 detail::Stepper stepper(std::move(magneticField));
89 detail::Navigator::Config config{std::move(trackingGeometry)};
90 config.resolvePassive = false;
91 config.resolveMaterial = true;
92 config.resolveSensitive = true;
93 detail::Navigator navigator(std::move(config), logger().cloneWithSuffix("Navigator"));
94 detail::Propagator propagator(std::move(stepper), std::move(navigator), logger().cloneWithSuffix("Prop"));
95
96 // Using the CKF propagator as extrapolator
97 detail::Extrapolator extrapolator = propagator;
98
99 // m_etaBins (from flags.Tracking.ActiveConfig.etaBins) includes a dummy first and last bin, which we ignore
100 std::vector<double> absEtaEdges;
101 if (m_etaBins.size() <= 2)
102 {
103 absEtaEdges.reserve(2ul);
104 absEtaEdges.push_back(0.0);
105 absEtaEdges.push_back(std::numeric_limits<double>::infinity());
106 }
107 else
108 {
109 absEtaEdges.reserve(m_etaBins.size());
110 absEtaEdges.push_back(m_absEtaMin);
111 absEtaEdges.insert(absEtaEdges.end(), m_etaBins.begin() + 1, m_etaBins.end() - 1);
112 absEtaEdges.push_back(m_absEtaMax);
113 }
114
115 auto setCut = [](auto &cfgVal, const auto &cuts, size_t ind) -> void
116 {
117 if (cuts.empty())
118 return;
119 cfgVal = (ind < cuts.size()) ? cuts[ind] : cuts[cuts.size() - 1];
120 };
121
122 Acts::TrackSelector::EtaBinnedConfig trackSelectorCfg{std::move(absEtaEdges)};
123 if (m_etaBins.size() <= 2)
124 {
125 assert(trackSelectorCfg.cutSets.size() == 1);
126 trackSelectorCfg.cutSets[0].absEtaMin = m_absEtaMin;
127 trackSelectorCfg.cutSets[0].absEtaMax = m_absEtaMax;
128 }
129 size_t cutIndex = 0;
130 for (auto &cfg : trackSelectorCfg.cutSets)
131 {
132 setCut(cfg.phiMin, m_phiMin, cutIndex);
133 setCut(cfg.phiMax, m_phiMax, cutIndex);
134 setCut(cfg.etaMin, m_etaMin, cutIndex);
135 setCut(cfg.etaMax, m_etaMax, cutIndex);
136 setCut(cfg.ptMin, m_ptMin, cutIndex);
137 setCut(cfg.ptMax, m_ptMax, cutIndex);
138 setCut(cfg.loc0Min, m_d0Min, cutIndex);
139 setCut(cfg.loc0Max, m_d0Max, cutIndex);
140 setCut(cfg.loc1Min, m_z0Min, cutIndex);
141 setCut(cfg.loc1Max, m_z0Max, cutIndex);
142 setCut(cfg.minMeasurements, m_minMeasurements, cutIndex);
143 setCut(cfg.maxHoles, m_maxHoles, cutIndex);
144 setCut(cfg.maxOutliers, m_maxOutliers, cutIndex);
145 setCut(cfg.maxSharedHits, m_maxSharedHits, cutIndex);
146 setCut(cfg.maxChi2, m_maxChi2, cutIndex);
147 ++cutIndex;
148 }
149
150 ATH_MSG_DEBUG(trackSelectorCfg);
151
152 // initializer measurement selector and connect it to the delegates of the track finder optins
154
155 detail::CKF_config ckfConfig{
156 std::move(extrapolator),
157 detail::CKF{std::move(propagator), logger().cloneWithSuffix("CKF")},
158 {},
159 Acts::TrackSelector{trackSelectorCfg}};
160
161 m_trackFinder = std::make_unique<CKF_pimpl>(std::move(ckfConfig));
162
164
166
167 return StatusCode::SUCCESS;
168 }
169
170 StatusCode TrackFindingBaseAlg::execute(const EventContext &) const {
171 ATH_MSG_FATAL("execute() method from the base class was called! Implement proper execute() method in the derived class!");
172
173 return StatusCode::FAILURE;
174 }
175
178
179 return StatusCode::SUCCESS;
180 }
181
182 std::unique_ptr<ActsTrk::IMeasurementSelector> TrackFindingBaseAlg::setMeasurementSelector(
183 const EventContext &ctx,
184 const detail::TrackFindingMeasurements &measurements,
185 TrackFinderOptions &options) const {
186
187 std::unique_ptr<ActsTrk::IMeasurementSelector> measurementSelector = ActsTrk::detail::getMeasurementSelector(
188 ctx,
189 m_pixelCalibTool.isEnabled() ? &(*m_pixelCalibTool) : nullptr,
190 m_stripCalibTool.isEnabled() ? &(*m_stripCalibTool) : nullptr,
191 m_hgtdCalibTool.isEnabled() ? &(*m_hgtdCalibTool) : nullptr,
192 measurements.measurementRanges(),
194 m_measurementSelectorConfig.m_chi2CutOffOutlier,
196 m_edgeHoleBorderWidth.value());
197
198 measurementSelector->connect(&options.extensions.createTrackStates);
199
200 return measurementSelector;
201 }
202
204 const EventContext &ctx,
205 const DetectorContextHolder &detContext,
206 const detail::TrackFindingMeasurements &measurements,
207 const Acts::PerigeeSurface* pSurface) const {
208 Acts::PropagatorPlainOptions plainOptions{detContext.geometry, detContext.magField};
209 plainOptions.maxSteps = m_maxPropagationStep;
210 plainOptions.direction = Acts::Direction::Forward();
211 plainOptions.endOfWorldVolumeIds = m_endOfWorldVolumeIds;
212
213 // Set the CombinatorialKalmanFilter options
214 TrackFinderOptions options(detContext.geometry, detContext.magField, detContext.calib,
215 trackFinder().ckfExtensions, plainOptions, pSurface);
216 options.recordMaterialStates = m_recordMaterialStates;
217
218 std::unique_ptr<ActsTrk::IMeasurementSelector> measurementSelector = setMeasurementSelector(ctx, measurements, options);
219
220 Acts::PropagatorPlainOptions plainSecondOptions{detContext.geometry, detContext.magField};
221 plainSecondOptions.maxSteps = m_maxPropagationStep;
222 plainSecondOptions.direction = plainOptions.direction.invert();
223
224 TrackFinderOptions secondOptions(detContext.geometry, detContext.magField, detContext.calib,
225 options.extensions, plainSecondOptions, pSurface);
226 secondOptions.targetSurface = pSurface;
227 secondOptions.skipPrePropagationUpdate = true;
228 secondOptions.recordMaterialStates = m_recordMaterialStates;
229
230 return {std::move(options), std::move(secondOptions), std::move(measurementSelector)};
231 };
232
233 const Acts::TrackSelector::Config& TrackFindingBaseAlg::getCuts (double eta) const {
234 const auto &trackSelectorCfg = trackFinder().trackSelector.config();
235 // return the last bin for |eta|>=4 or nan
236 return (!(std::abs(eta) < trackSelectorCfg.absEtaEdges.back())) ? trackSelectorCfg.cutSets.back()
237 : (std::abs(eta) < trackSelectorCfg.absEtaEdges.front()) ? trackSelectorCfg.cutSets.front()
238 : trackSelectorCfg.getCuts(eta);
239 };
240
241 std::vector<typename detail::RecoTrackContainer::TrackProxy>
243 const TrkProxy &trackProxy,
244 detail::RecoTrackContainer &tracksContainerTemp,
245 const TrackFinderOptions &options) const {
246 if (not m_doTwoWay) return {};
247
248 // Create initial parameters for the propagation
249 Acts::BoundTrackParameters secondInitialParameters = trackProxy.createParametersFromState(detail::RecoConstTrackStateContainerProxy{firstMeasurement});
250 if (!secondInitialParameters.referenceSurface().insideBounds(secondInitialParameters.localPosition())) { // #3751
251 return {};
252 }
253
254 // First, inflate the covariance matrix if configured
256 ATH_MSG_DEBUG("Inflating covariance matrix for second track finding with factor = " << m_twoWayinflateCovarianceFactor.value());
257 ATH_MSG_VERBOSE("Original parameters before inflation: \n" << secondInitialParameters);
258
259 auto inflatedCovariance = secondInitialParameters.covariance().value();
260 inflatedCovariance *= m_twoWayinflateCovarianceFactor;
261
262 const auto& origSurface = secondInitialParameters.referenceSurface();
263 auto surfacePtr = const_cast<Acts::Surface&>(origSurface).shared_from_this();
264
265 Acts::BoundTrackParameters newParams(
266 std::static_pointer_cast<const Acts::Surface>(std::move(surfacePtr)),
267 secondInitialParameters.parameters(),
268 std::make_optional(inflatedCovariance),
269 secondInitialParameters.particleHypothesis());
270 secondInitialParameters = std::move(newParams);
271
272 ATH_MSG_VERBOSE("Inflated covariance matrix : \n" << secondInitialParameters.covariance().value());
273 }
274
275 auto rootBranch = tracksContainerTemp.makeTrack();
276 rootBranch.copyFromWithoutStates(trackProxy); // #3534
277
278 // perform track finding
279 auto secondResult =
280 trackFinder().ckf.findTracks(secondInitialParameters, options, tracksContainerTemp, rootBranch);
281 if (not secondResult.ok()) {
282 return {};
283 }
284 return secondResult.value();
285 }
286
287 xAOD::UncalibMeasType TrackFindingBaseAlg::measurementType (const detail::RecoTrackContainer::TrackStateProxy &trackState) {
288 if (trackState.hasReferenceSurface()) {
289 if (const auto *actsDetElem = dynamic_cast<const ISurfacePlacement*>(trackState.referenceSurface().surfacePlacement())) {
290 switch (actsDetElem->detectorType()) {
297 default:
298 break;
299 }
300 }
301 }
303 }
304
306 const detail::RecoTrackContainer::TrackProxy &track,
307 const detail::RecoTrackContainer::TrackStateProxy &trackState,
308 const Acts::TrackSelector::EtaBinnedConfig &trackSelectorCfg,
309 const Acts::GeometryContext &tgContext,
310 const detail::MeasurementIndex &measurementIndex,
311 const std::size_t typeIndex,
312 EventStats::value_type &event_stat_category_i) const {
313 if (m_addCounts) {
314 updateCounts(track, trackState.typeFlags(),
315 measurementType(trackState));
316 if (m_checkCounts) {
317 checkCounts(track);
318 }
319 }
320
321 if (m_trackStatePrinter.isSet()) {
322 m_trackStatePrinter->printTrackState(tgContext, trackState,
323 measurementIndex, true);
324 }
325
326 if (!m_doBranchStopper) {
327 return BranchStopperResult::Continue;
328 }
329
330 const auto &parameters = trackState.hasFiltered() ? trackState.filtered()
331 : trackState.predicted();
332 double eta = -std::log(std::tan(0.5 * parameters[Acts::eBoundTheta]));
333 const auto &cutSet = getCuts(eta);
334
335 if (typeIndex < m_ptMinMeasurements.size() &&
336 !(track.nMeasurements() < m_ptMinMeasurements[typeIndex])) {
337 double pT = std::sin(parameters[Acts::eBoundTheta]) /
338 parameters[Acts::eBoundQOverP];
339 if (std::abs(pT) < cutSet.ptMin * m_branchStopperPtMinFactor) {
340 ++event_stat_category_i[kNStoppedTracksMinPt];
341 ATH_MSG_DEBUG("CkfBranchStopper: drop branch with q*pT="
342 << pT << " after " << track.nMeasurements()
343 << " measurements");
344 return BranchStopperResult::StopAndDrop;
345 }
346 }
347
348 if (typeIndex < m_absEtaMaxMeasurements.size() &&
349 !(track.nMeasurements() < m_absEtaMaxMeasurements[typeIndex]) &&
350 !(std::abs(eta) < trackSelectorCfg.absEtaEdges.back() +
352 ++event_stat_category_i[kNStoppedTracksMaxEta];
353 ATH_MSG_DEBUG("CkfBranchStopper: drop branch with eta="
354 << eta << " after " << track.nMeasurements()
355 << " measurements");
356 return BranchStopperResult::StopAndDrop;
357 }
358
359
360 // In the pixel endcap regions relax the requirement for minMeasurements before cutting the branch off
361 auto minMeasurementsBranchStop = std::abs(eta) > m_branchStopperAbsEtaMeasCut ? cutSet.minMeasurements - m_branchStopperMeasCutReduce : cutSet.minMeasurements;
362 bool enoughMeasurements = (track.nMeasurements() >= minMeasurementsBranchStop);
363 bool tooManyHoles = (track.nHoles() > cutSet.maxHoles);
364 bool tooManyOutliers = (track.nOutliers() > cutSet.maxOutliers);
365
366 if (m_addCounts) {
367 auto [enoughMeasurementsPS, tooManyHolesPS, tooManyOutliersPS] =
368 selectCounts(track, eta);
369 enoughMeasurements = enoughMeasurements && enoughMeasurementsPS;
370 tooManyHoles = tooManyHoles || tooManyHolesPS;
371 tooManyOutliers = tooManyOutliers || tooManyOutliersPS;
372 }
373
374 if (!(tooManyHoles || tooManyOutliers)) {
375 return BranchStopperResult::Continue;
376 }
377
378 if (!enoughMeasurements) {
379 ++event_stat_category_i[kNStoppedTracksMaxHoles];
380 }
381
382 if (m_addCounts) {
383 ATH_MSG_DEBUG("CkfBranchStopper: stop and "
384 << (enoughMeasurements ? "keep" : "drop")
385 << " branch with nHoles=" << track.nHoles() << " ("
386 << s_branchState.nPixelHoles(track) << " pixel+"
387 << s_branchState.nStripHoles(track) << " strip+"
388 << s_branchState.nHgtdHoles(track)
389 << " hgtd), nOutliers=" << track.nOutliers() << " ("
390 << s_branchState.nPixelOutliers(track) << "+"
391 << s_branchState.nStripOutliers(track) << "+"
392 << s_branchState.nHgtdOutliers(track)
393 << "), nMeasurements=" << track.nMeasurements() << " ("
394 << s_branchState.nPixelHits(track) << "+"
395 << s_branchState.nStripHits(track) << "+"
396 << s_branchState.nHgtdHits(track) << ")");
397 } else {
398 ATH_MSG_DEBUG("CkfBranchStopper: stop and "
399 << (enoughMeasurements ? "keep" : "drop")
400 << " branch with nHoles=" << track.nHoles()
401 << ", nOutliers=" << track.nOutliers()
402 << ", nMeasurements=" << track.nMeasurements());
403 }
404
405 return enoughMeasurements ? BranchStopperResult::StopAndKeep
406 : BranchStopperResult::StopAndDrop;
407 }
408
409
411 {
412 if (addCounts) {
413 tracksContainer.addColumn<unsigned int>("nPixelHits");
414 tracksContainer.addColumn<unsigned int>("nStripHits");
415 tracksContainer.addColumn<unsigned int>("nHgtdHits");
416 tracksContainer.addColumn<unsigned int>("nPixelHoles");
417 tracksContainer.addColumn<unsigned int>("nStripHoles");
418 tracksContainer.addColumn<unsigned int>("nHgtdHoles");
419 tracksContainer.addColumn<unsigned int>("nPixelOutliers");
420 tracksContainer.addColumn<unsigned int>("nStripOutliers");
421 tracksContainer.addColumn<unsigned int>("nHgtdOutliers");
422 }
424 }
425
426 void TrackFindingBaseAlg::initCounts(const detail::RecoTrackContainer::TrackProxy &track)
427 {
428 s_branchState.nPixelHits(track) = 0;
429 s_branchState.nStripHits(track) = 0;
430 s_branchState.nHgtdHits(track) = 0;
431 s_branchState.nPixelHoles(track) = 0;
432 s_branchState.nStripHoles(track) = 0;
433 s_branchState.nHgtdHoles(track) = 0;
434 s_branchState.nPixelOutliers(track) = 0;
435 s_branchState.nStripOutliers(track) = 0;
436 s_branchState.nHgtdOutliers(track) = 0;
437 }
438
440 const detail::RecoTrackContainer::TrackProxy &track,
441 Acts::ConstTrackStateTypeMap typeFlags, xAOD::UncalibMeasType detType) {
443 if (typeFlags.isHole()) {
444 s_branchState.nPixelHoles(track)++;
445 } else if (typeFlags.isOutlier()) {
446 s_branchState.nPixelOutliers(track)++;
447 } else if (typeFlags.isMeasurement()) {
448 s_branchState.nPixelHits(track)++;
449 }
450 } else if (detType == xAOD::UncalibMeasType::StripClusterType) {
451 if (typeFlags.isHole()) {
452 s_branchState.nStripHoles(track)++;
453 } else if (typeFlags.isOutlier()) {
454 s_branchState.nStripOutliers(track)++;
455 } else if (typeFlags.isMeasurement()) {
456 s_branchState.nStripHits(track)++;
457 }
458 } else if (detType == xAOD::UncalibMeasType::HGTDClusterType) {
459 if (typeFlags.isHole()) {
460 s_branchState.nHgtdHoles(track)++;
461 } else if (typeFlags.isOutlier()) {
462 s_branchState.nHgtdOutliers(track)++;
463 } else if (typeFlags.isMeasurement()) {
464 s_branchState.nHgtdHits(track)++;
465 }
466 }
467 }
468
469 void TrackFindingBaseAlg::checkCounts(const detail::RecoTrackContainer::TrackProxy &track) const {
470 // This check will fail if there are other types (HGTD, MS?) of hits, holes, or outliers.
471 // The check can be removed when it is no longer appropriate.
472 if (track.nMeasurements() != s_branchState.nPixelHits(track) + s_branchState.nStripHits(track) + s_branchState.nHgtdHits(track))
473 ATH_MSG_WARNING("mismatched hit count: total (" << track.nMeasurements()
474 << ") != pixel (" << s_branchState.nPixelHits(track)
475 << ") + strip (" << s_branchState.nStripHits(track)
476 << ") + hgtd (" << s_branchState.nHgtdHits(track)
477 << ")");
478 if (track.nHoles() != s_branchState.nPixelHoles(track) + s_branchState.nStripHoles(track) + s_branchState.nHgtdHoles(track))
479 ATH_MSG_WARNING("mismatched hole count: total (" << track.nHoles()
480 << ") < pixel (" << s_branchState.nPixelHoles(track)
481 << ") + strip (" << s_branchState.nStripHoles(track)
482 << ") + hgtd (" << s_branchState.nHgtdHoles(track)
483 << ")");
484 if (track.nOutliers() != s_branchState.nPixelOutliers(track) + s_branchState.nStripOutliers(track) + s_branchState.nHgtdOutliers(track))
485 ATH_MSG_WARNING("mismatched outlier count: total (" << track.nOutliers()
486 << ") != pixel (" << s_branchState.nPixelOutliers(track)
487 << ") + strip (" << s_branchState.nStripOutliers(track)
488 << ") + hgtd (" << s_branchState.nHgtdOutliers(track)
489 << ")");
490 };
491
492 std::array<bool, 3> TrackFindingBaseAlg::selectCounts(const detail::RecoTrackContainer::TrackProxy &track, double eta) const {
493 bool enoughMeasurements = true, tooManyHoles = false, tooManyOutliers = false;
494 const auto &trackSelectorCfg = trackFinder().trackSelector.config();
495 std::size_t etaBin = (std::abs(eta) < trackSelectorCfg.absEtaEdges.front()) ? 0
496 : (std::abs(eta) >= trackSelectorCfg.absEtaEdges.back()) ? trackSelectorCfg.absEtaEdges.size() - 1
497 : trackSelectorCfg.binIndex(eta);
498 auto cutMin = [etaBin](std::size_t val, const std::vector<std::size_t> &cutSet) {
499 return !cutSet.empty() && (val < (etaBin < cutSet.size() ? cutSet[etaBin] : cutSet.back()));
500 };
501 auto cutMax = [etaBin](std::size_t val, const std::vector<std::size_t> &cutSet) {
502 return !cutSet.empty() && (val > (etaBin < cutSet.size() ? cutSet[etaBin] : cutSet.back()));
503 };
504
505 enoughMeasurements = enoughMeasurements && !cutMin(s_branchState.nPixelHits(track), m_minPixelHits);
506 enoughMeasurements = enoughMeasurements && !cutMin(s_branchState.nStripHits(track), m_minStripHits);
507 enoughMeasurements = enoughMeasurements && !cutMin(s_branchState.nHgtdHits(track), m_minHgtdHits);
508 tooManyHoles = tooManyHoles || cutMax(s_branchState.nPixelHoles(track), m_maxPixelHoles);
509 tooManyHoles = tooManyHoles || cutMax(s_branchState.nStripHoles(track), m_maxStripHoles);
510 tooManyHoles = tooManyHoles || cutMax(s_branchState.nHgtdHoles(track), m_maxHgtdHoles);
511 tooManyOutliers = tooManyOutliers || cutMax(s_branchState.nPixelOutliers(track), m_maxPixelOutliers);
512 tooManyOutliers = tooManyOutliers || cutMax(s_branchState.nStripOutliers(track), m_maxStripOutliers);
513 tooManyOutliers = tooManyOutliers || cutMax(s_branchState.nHgtdOutliers(track), m_maxHgtdOutliers);
514
515 return {enoughMeasurements, tooManyHoles, tooManyOutliers};
516 }
517
519 std::vector<std::pair<float, float> > &chi2CutOffOutlier = m_measurementSelectorConfig.m_chi2CutOffOutlier;
520 chi2CutOffOutlier .reserve( m_chi2CutOff.size() );
521 if (!m_chi2OutlierCutOff.empty()) {
522 if (m_chi2CutOff.size() != m_chi2OutlierCutOff.size()) {
523 ATH_MSG_ERROR("Outlier chi2 cut off provided but number of elements does not agree with"
524 " chi2 cut off for measurements which however is required: "
525 << m_chi2CutOff.size() << " != " << m_chi2OutlierCutOff.size());
526 return StatusCode::FAILURE;
527 }
528 }
529 unsigned int idx=0;
530 for (const auto &elm : m_chi2CutOff) {
531 chi2CutOffOutlier.push_back( std::make_pair(static_cast<float>(elm),
532 idx < m_chi2OutlierCutOff.size()
533 ? static_cast<float>(m_chi2OutlierCutOff[idx])
534 : std::numeric_limits<float>::max()) );
535 ++idx;
536 }
537 if (m_etaBins.size() > 2) {
538 std::vector<float> &etaBinsf = m_measurementSelectorConfig.m_etaBins;
539 etaBinsf.assign(m_etaBins.begin() + 1, m_etaBins.end() - 1);
540 }
541
542 return /*m_measurementSelector ?*/ StatusCode::SUCCESS /*: StatusCode::FAILURE*/;
543 }
544
545 // === Statistics printout =================================================
546
548 if (!m_statEtaBins.empty())
549 {
551 float last_eta = m_statEtaBins[0];
552 for (float eta : m_statEtaBins)
553 {
554 if (eta < last_eta)
555 {
556 ATH_MSG_FATAL("Eta bins for statistics counter not in ascending order.");
557 }
558 last_eta = eta;
559 }
560 }
561 m_stat.resize(nSeedCollections() * seedCollectionStride());
562 }
563
564 // copy statistics
565 void TrackFindingBaseAlg::copyStats(const EventStats &event_stat) const {
566 std::lock_guard<std::mutex> lock(m_mutex);
567 std::size_t category_i = 0;
568 for (const std::array<unsigned int, kNStat> &src_stat : event_stat)
569 {
570 std::array<std::size_t, kNStat> &dest_stat = m_stat[category_i++];
571 for (std::size_t i = 0; i < src_stat.size(); ++i)
572 {
573 assert(i < dest_stat.size());
574 dest_stat[i] += src_stat[i];
575 }
576 }
577 }
578
579 // print statistics
581 if (msgLvl(MSG::INFO))
582 {
583 std::vector<std::string> stat_labels =
585 {
586 std::make_pair(kNTotalSeeds, "Input seeds"),
587 std::make_pair(kNoTrackParam, "No track parameters"),
588 std::make_pair(kNUsedSeeds, "Used seeds"),
589 std::make_pair(kNoTrack, "Cannot find track"),
590 std::make_pair(kNDuplicateSeeds, "Duplicate seeds"),
591 std::make_pair(kNNoEstimatedParams, "Initial param estimation failed"),
592 std::make_pair(kNRejectedRefinedSeeds, "Rejected refined parameters"),
593 std::make_pair(kNSeedRefitFailure, "Seed refit Kalman fit failure"),
594 std::make_pair(kNOutputTracks, "CKF tracks"),
595 std::make_pair(kNSelectedTracks, "selected tracks"),
596 std::make_pair(kNResolvedTracks, "resolved tracks"),
597 std::make_pair(kNStoppedTracksMaxHoles, "Stopped tracks reaching max holes"),
598 std::make_pair(kMultipleBranches, "Seeds with more than one branch"),
599 std::make_pair(kNoSecond, "Tracks failing second CKF"),
600 std::make_pair(kNStoppedTracksMinPt, "Stopped tracks below pT cut"),
601 std::make_pair(kNStoppedTracksMaxEta, "Stopped tracks above max eta"),
602 std::make_pair(kNTotalSharedHits, "Total shared hits"),
603 std::make_pair(kNForcedSeedMeasurements, "Total forced measurements")
604 });
605 assert(stat_labels.size() == kNStat);
606 std::vector<std::string> categories;
607 categories.reserve(m_seedLabels.size() + 1);
608 categories.insert(categories.end(), m_seedLabels.begin(), m_seedLabels.end());
609 categories.push_back("ALL");
610
611 std::vector<std::string> eta_labels;
612 eta_labels.reserve(m_statEtaBins.size() + 2);
613 for (std::size_t eta_bin_i = 0; eta_bin_i < m_statEtaBins.size() + 2; ++eta_bin_i)
614 {
615 eta_labels.push_back(TableUtils::makeEtaBinLabel(m_statEtaBins, eta_bin_i, m_useAbsEtaForStat));
616 }
617
618 // vector used as 3D array stat[ eta_bin ][ stat_i ][ seed_type]
619 // stat_i = [0, kNStat)
620 // eta_bin = [0, m_statEtaBins.size()+2 ); eta_bin == m_statEtaBinsSize()+1 means sum of all etaBins
621 // seed_type = [0, nSeedCollections()+1) seed_type == nSeedCollections() means sum of all seed collections
622 std::vector<std::size_t> stat =
624 m_statEtaBins.size() + 1,
625 m_stat);
626
627 // the extra columns and rows for the projections are addeded internally:
628 std::size_t stat_stride =
630 m_statEtaBins.size() + 1,
631 kNStat);
632 std::size_t eta_stride =
634 m_statEtaBins.size() + 1,
635 kNStat);
636 std::stringstream table_out;
637
638 if (m_dumpAllStatEtaBins.value())
639 {
640 // dump for each counter a table with one row per eta bin
641 std::size_t max_label_width = TableUtils::maxLabelWidth(stat_labels) + TableUtils::maxLabelWidth(eta_labels);
642 for (std::size_t stat_i = 0; stat_i < kNStat; ++stat_i)
643 {
644 std::size_t dest_idx_offset = stat_i * stat_stride;
645 table_out << makeTable(stat, dest_idx_offset, eta_stride,
646 eta_labels,
647 categories)
648 .columnWidth(10)
649 // only dump the footer for the last eta bin i.e. total
650 .dumpHeader(stat_i == 0)
651 .dumpFooter(stat_i + 1 == kNStat)
652 .separateLastRow(true) // separate the sum of all eta bins
653 .minLabelWidth(max_label_width)
654 .labelPrefix(stat_labels.at(stat_i));
655 }
656 }
657 else
658 {
659 // dump one table with one row per counter showing the total eta range
660 for (std::size_t eta_bin_i = (m_dumpAllStatEtaBins.value() ? 0 : m_statEtaBins.size() + 1);
661 eta_bin_i < m_statEtaBins.size() + 2;
662 ++eta_bin_i)
663 {
664 std::size_t dest_idx_offset = eta_bin_i * eta_stride;
665 table_out << makeTable(stat, dest_idx_offset, stat_stride,
666 stat_labels,
667 categories,
668 eta_labels.at(eta_bin_i))
669 .columnWidth(10)
670 // only dump the footer for the last eta bin i.e. total
671 .dumpFooter(!m_dumpAllStatEtaBins.value() || eta_bin_i == m_statEtaBins.size() + 1);
672 }
673 }
674 ATH_MSG_INFO("statistics:\n"
675 << table_out.str());
676 table_out.str("");
677
678 // define retios first element numerator, second element denominator
679 // each element contains a vector of counter and a multiplier e.g. +- 1
680 // ratios are computed as (sum_i stat[stat_i] * multiplier_i ) / (sum_j stat[stat_j] * multiplier_j )
681 auto [ratio_labels, ratio_def] =
683 std::vector<TableUtils::SummandDefinition>{
687 // no track counted as used but want to include it as failed
689 }, // failed seeds i.e. seeds which are not duplicates but did not produce a track
690 std::vector<TableUtils::SummandDefinition>{TableUtils::defineSummand(kNTotalSeeds, 1)}),
692 TableUtils::defineSimpleRatio("Rejected refined params / seeds", kNRejectedRefinedSeeds, kNTotalSeeds),
694 TableUtils::defineSimpleRatio("selected tracks / used seeds", kNSelectedTracks, kNUsedSeeds),
696 TableUtils::defineSimpleRatio("resolved tracks / used seeds", kNResolvedTracks, kNUsedSeeds),
697 TableUtils::defineSimpleRatio("branched tracks / used seeds", kMultipleBranches, kNUsedSeeds),
698 TableUtils::defineSimpleRatio("no 2nd CKF / CKF tracks", kNoSecond, kNOutputTracks),
700 TableUtils::defineSimpleRatio("forced measurements / used seeds", kNForcedSeedMeasurements, kNUsedSeeds)});
701
702 std::vector<float> ratio = TableUtils::computeRatios(ratio_def,
703 nSeedCollections() + 1,
704 m_statEtaBins.size() + 2,
705 stat);
706
707 // the extra columns and rows for the projections are _not_ added internally
708 std::size_t ratio_stride = TableUtils::ratioStride(nSeedCollections() + 1,
709 m_statEtaBins.size() + 2,
710 ratio_def);
711 std::size_t ratio_eta_stride = TableUtils::subCategoryStride(nSeedCollections() + 1,
712 m_statEtaBins.size() + 2,
713 ratio_def);
714
715 std::size_t max_label_width = TableUtils::maxLabelWidth(ratio_labels) + TableUtils::maxLabelWidth(eta_labels);
716 if (m_dumpAllStatEtaBins.value())
717 {
718 // show for each ratio a table with one row per eta bin
719 for (std::size_t ratio_i = 0; ratio_i < ratio_labels.size(); ++ratio_i)
720 {
721 table_out << makeTable(ratio,
722 ratio_i * ratio_stride,
723 ratio_eta_stride,
724 eta_labels,
725 categories)
726 .columnWidth(10)
727 // only dump the footer for the last eta bin i.e. total
728 .dumpHeader(ratio_i == 0)
729 .dumpFooter(ratio_i + 1 == ratio_labels.size())
730 .separateLastRow(true) // separate the sum of las
731 .minLabelWidth(max_label_width)
732 .labelPrefix(ratio_labels.at(ratio_i));
733 }
734 }
735 else
736 {
737 // dump one table with one row per ratio showing the total eta range
738 table_out << makeTable(ratio,
739 (m_statEtaBins.size() + 1) * ratio_eta_stride + 0 * ratio_stride,
740 ratio_stride,
741 ratio_labels,
742 categories)
743 .columnWidth(10)
744 // only dump the footer for the last eta bin i.e. total
745 .minLabelWidth(max_label_width)
746 .dumpFooter(false);
747
748 // also dump a table for final tracks over used seeds (ratio_i==6 or 4) showing one row per eta bin
749 eta_labels.erase(eta_labels.end() - 1); // drop last line of table which shows again all eta bins summed.
750 std::size_t ratio_i = m_showResolvedStats ? 6 : 4;
751 table_out << makeTable(ratio,
752 ratio_i * ratio_stride,
753 ratio_eta_stride,
754 eta_labels,
755 categories)
756 .columnWidth(10)
757 .dumpHeader(false)
758 // only dump the footer for the last eta bin i.e. total
759 .dumpFooter(!m_dumpAllStatEtaBins.value() || ratio_i + 1 == ratio_labels.size())
760 .separateLastRow(false)
761 .minLabelWidth(max_label_width)
762 .labelPrefix(ratio_labels.at(ratio_i));
763 }
764
765 ATH_MSG_INFO("Ratios:\n"
766 << table_out.str());
767 }
768 }
769
770 std::size_t TrackFindingBaseAlg::getStatCategory(std::size_t seed_collection, float eta) const {
771 std::vector<float>::const_iterator bin_iter = std::upper_bound(m_statEtaBins.begin(),
772 m_statEtaBins.end(),
773 m_useAbsEtaForStat ? std::abs(eta) : eta);
774 std::size_t category_i = seed_collection * seedCollectionStride() + static_cast<std::size_t>(bin_iter - m_statEtaBins.begin());
775 assert(category_i < m_stat.size());
776 return category_i;
777 }
778
779 std::size_t TrackFindingBaseAlg::computeStatSum(std::size_t seed_collection, EStat counter_i, const EventStats &stat) const {
780 std::size_t out = 0u;
781 for (std::size_t category_i = seed_collection * seedCollectionStride();
782 category_i < (seed_collection + 1) * seedCollectionStride();
783 ++category_i)
784 {
785 assert(category_i < stat.size());
786 out += stat[category_i][counter_i];
787 }
788 return out;
789 }
790
791 bool TrackFindingBaseAlg::selectCountsFinal(const detail::RecoTrackContainer::TrackProxy &track) const {
792 if (not m_addCounts) return true;
793 double eta = -std::log(std::tan(0.5 * track.theta()));
794 auto [enoughMeasurementsPS, tooManyHolesPS, tooManyOutliersPS] = selectCounts(track, eta);
795 return enoughMeasurementsPS && !tooManyHolesPS && !tooManyOutliersPS;
796 }
797
798} // namespace ActsTrk
Scalar eta() const
pseudorapidity method
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_ERROR(x)
#define ATH_MSG_FATAL(x)
#define ATH_MSG_INFO(x)
#define ATH_MSG_VERBOSE(x)
#define ATH_MSG_WARNING(x)
#define ATH_MSG_DEBUG(x)
virtual void lock()=0
Interface to allow an object to lock itself when made const in SG.
TableUtils::StatTable< T > makeTable(const std::array< T, N > &counter, const std::array< std::string, N > &label)
Definition TableUtils.h:544
std::unique_ptr< const Acts::Logger > makeActsAthenaLogger(IMessageSvc *svc, const std::string &name, int level, std::optional< std::string > parent_name)
Definition Logger.cxx:64
Extension of the interface of the Acts::SurfacePlacementBase for ATLAS.
Gaudi::Property< std::vector< std::size_t > > m_maxStripHoles
Gaudi::Property< double > m_branchStopperAbsEtaMeasCut
Gaudi::Property< std::vector< float > > m_statEtaBins
Gaudi::Property< double > m_branchStopperPtMinFactor
Gaudi::Property< std::vector< std::size_t > > m_maxOutliers
Gaudi::Property< std::vector< std::size_t > > m_maxHgtdHoles
std::unique_ptr< const Acts::Logger > m_logger
logging instance
Gaudi::Property< std::vector< double > > m_etaBins
Gaudi::Property< bool > m_doTwoWay
Gaudi::Property< bool > m_dumpAllStatEtaBins
Gaudi::Property< std::vector< size_t > > m_numMeasurementsCutOff
Gaudi::Property< std::vector< std::size_t > > m_maxSharedHits
Gaudi::Property< unsigned int > m_maxPropagationStep
static xAOD::UncalibMeasType measurementType(const detail::RecoTrackContainer::TrackStateProxy &trackState)
ToolHandle< ActsTrk::TrackStatePrinterTool > m_trackStatePrinter
Gaudi::Property< double > m_edgeHoleBorderWidth
Gaudi::Property< std::vector< double > > m_etaMax
Gaudi::Property< std::vector< double > > m_ptMin
Gaudi::Property< std::vector< std::size_t > > m_minPixelHits
Gaudi::Property< std::vector< std::size_t > > m_maxStripOutliers
SG::WriteHandleKey< ActsTrk::TrackContainer > m_trackContainerKey
Gaudi::Property< std::vector< double > > m_ptMax
Gaudi::Property< std::vector< double > > m_chi2CutOff
Gaudi::Property< double > m_seedRefitPtMinFactor
detail::RecoTrackContainer::TrackProxy TrkProxy
Gaudi::Property< std::vector< std::size_t > > m_maxPixelHoles
static constexpr BranchState s_branchState
void copyStats(const EventStats &event_stat) const
Gaudi::Property< std::vector< double > > m_phiMin
Gaudi::Property< double > m_branchStopperMeasCutReduce
ToolHandle< ActsTrk::IPixelOnTrackCalibratorTool< detail::RecoTrackStateContainer > > m_pixelCalibTool
Gaudi::Property< std::vector< std::uint32_t > > m_endOfWorldVolumeIds
Gaudi::Property< std::vector< std::size_t > > m_minStripHits
ActsTrk::MutableTrackContainerHandlesHelper m_tracksBackendHandlesHelper
std::size_t getStatCategory(std::size_t seed_collection, float eta) const
std::size_t seedCollectionStride() const
Gaudi::Property< double > m_branchStopperAbsEtaMaxExtra
ToolHandle< GenericMonitoringTool > m_monTool
std::vector< typename detail::RecoTrackContainer::TrackProxy > doTwoWayTrackFinding(const detail::RecoTrackStateContainerProxy &firstMeasurement, const TrkProxy &trackProxy, detail::RecoTrackContainer &tracksContainerTemp, const TrackFinderOptions &options) const
Perform two-way track finding.
Gaudi::Property< std::vector< std::size_t > > m_absEtaMaxMeasurements
TrackFindingBaseAlg(const std::string &name, ISvcLocator *pSvcLocator)
Gaudi::Property< std::vector< double > > m_etaMin
Gaudi::Property< bool > m_recordMaterialStates
Gaudi::Property< std::vector< double > > m_d0Min
virtual StatusCode execute(const EventContext &ctx) const override
Gaudi::Property< std::vector< std::size_t > > m_maxHgtdOutliers
Gaudi::Property< std::vector< double > > m_z0Max
Gaudi::Property< double > m_absEtaMax
std::size_t computeStatSum(std::size_t seed_collection, EStat counter_i, const EventStats &stat) const
virtual StatusCode initialize() override
Gaudi::Property< std::vector< double > > m_z0Min
void checkCounts(const detail::RecoTrackContainer::TrackProxy &track) const
Gaudi::Property< bool > m_doBranchStopper
static void addCountsAndProperties(detail::RecoTrackContainer &tracksContainer, bool add_counts)
Gaudi::Property< std::vector< std::size_t > > m_minMeasurements
Gaudi::Property< std::vector< double > > m_maxChi2
const Acts::Logger & logger() const
Private access to the logger.
Gaudi::Property< double > m_absEtaMin
BranchStopperResult stopBranch(const detail::RecoTrackContainer::TrackProxy &track, const detail::RecoTrackContainer::TrackStateProxy &trackState, const Acts::TrackSelector::EtaBinnedConfig &trackSelectorCfg, const Acts::GeometryContext &tgContext, const detail::MeasurementIndex &measurementIndex, const std::size_t typeIndex, EventStats::value_type &event_stat_category_i) const
Branch stopper.
static void initCounts(const detail::RecoTrackContainer::TrackProxy &track)
Gaudi::Property< std::vector< std::size_t > > m_maxPixelOutliers
const Acts::TrackSelector::Config & getCuts(double eta) const
Retrieves track selector configuration for given eta value.
Gaudi::Property< bool > m_checkCounts
Gaudi::Property< std::vector< std::size_t > > m_maxHoles
ToolHandle< ActsTrk::IStripOnTrackCalibratorTool< detail::RecoTrackStateContainer > > m_stripCalibTool
std::array< bool, 3 > selectCounts(const detail::RecoTrackContainer::TrackProxy &track, double eta) const
std::unique_ptr< CKF_pimpl > m_trackFinder
ServiceHandle< ActsTrk::ITrackingGeometrySvc > m_trackingGeometrySvc
TrackFindingDefaultOptions getDefaultOptions(const EventContext &ctx, const DetectorContextHolder &detContext, const detail::TrackFindingMeasurements &measurements, const Acts::PerigeeSurface *pSurface) const
Get CKF options for first and second pass + pointer to MeasurementSelector.
Acts::CombinatorialKalmanFilterOptions< detail::RecoTrackContainer > TrackFinderOptions
virtual StatusCode finalize() override
ContextUtility m_ctxProvider
Utility to fetch the geometry, magnetic field and calibration context in the event.
std::vector< std::array< unsigned int, kNStat > > EventStats
ToolHandle< ActsTrk::IHGTDOnTrackCalibratorTool< detail::RecoTrackStateContainer > > m_hgtdCalibTool
Gaudi::Property< double > m_twoWayinflateCovarianceFactor
static void updateCounts(const detail::RecoTrackContainer::TrackProxy &track, Acts::ConstTrackStateTypeMap typeFlags, xAOD::UncalibMeasType detType)
Gaudi::Property< bool > m_addCounts
Gaudi::Property< std::vector< std::size_t > > m_minHgtdHits
struct ActsTrk::TrackFindingBaseAlg::MeasurementSelectorConfig m_measurementSelectorConfig
Gaudi::Property< std::vector< double > > m_phiMax
Gaudi::Property< std::vector< std::size_t > > m_ptMinMeasurements
Gaudi::Property< std::vector< double > > m_d0Max
Gaudi::Property< bool > m_inflateCovarianceTwoWay
Gaudi::Property< std::vector< double > > m_chi2OutlierCutOff
Acts::CombinatorialKalmanFilterBranchStopperResult BranchStopperResult
std::unique_ptr< ActsTrk::IMeasurementSelector > setMeasurementSelector(const EventContext &ctx, const detail::TrackFindingMeasurements &measurements, TrackFinderOptions &options) const
Setup and attach measurement selector to KF options.
bool selectCountsFinal(const detail::RecoTrackContainer::TrackProxy &track) const
Gaudi::Property< std::vector< std::string > > m_seedLabels
const MeasurementRangeList & measurementRanges() const
bool msgLvl(const MSG::Level lvl) const
An algorithm that can be simultaneously executed in multiple threads.
Acts::Result< void > gainMatrixUpdate(const Acts::GeometryContext &gctx, typename trajectory_t::TrackStateProxy trackState, const Acts::Logger &logger)
Acts::SympyStepper Stepper
Adapted from Acts Examples/Algorithms/TrackFinding/src/TrackFindingAlgorithmFunction....
RecoTrackStateContainer::TrackStateProxy RecoTrackStateContainerProxy
std::unique_ptr< ActsTrk::IMeasurementSelector > getMeasurementSelector(const EventContext &ctx, const ActsTrk::IPixelOnTrackCalibratorTool< detail::RecoTrackStateContainer > *pixelOnTrackCalibratorTool, const ActsTrk::IStripOnTrackCalibratorTool< detail::RecoTrackStateContainer > *stripOnTrackCalibratorTool, const ActsTrk::IHGTDOnTrackCalibratorTool< detail::RecoTrackStateContainer > *hgtdOnTrackCalibratorTool, const ActsTrk::detail::MeasurementRangeList &measurementRanges, const std::vector< float > &etaBinsf, const std::vector< std::pair< float, float > > &chi2CutOffOutlier, const std::vector< size_t > &numMeasurementsCutOff, double edge_hole_border_width)
Acts::TrackContainer< Acts::VectorTrackContainer, Acts::VectorMultiTrajectory > RecoTrackContainer
RecoTrackStateContainer::ConstTrackStateProxy RecoConstTrackStateContainerProxy
Acts::CombinatorialKalmanFilter< Propagator, RecoTrackContainer > CKF
The AlignStoreProviderAlg loads the rigid alignment corrections and pipes them through the readout ge...
std::string prefixFromTrackContainerName(const std::string &tracks)
Parse TrackContainer name to get the prefix for backends The name has to contain XYZTracks,...
@ Pixel
Inner detector legacy.
std::tuple< std::vector< std::string >, std::vector< RatioDefinition > > splitRatioDefinitionsAndLabels(std::initializer_list< std::tuple< std::string, RatioDefinition > > a_ratio_list)
Definition TableUtils.h:469
SummandDefinition defineSummand(T counter_idx, int multiplier)
Definition TableUtils.h:423
std::size_t maxLabelWidth(const T_Collection &col)
Definition TableUtils.h:311
RatioDefinition defineSimpleRatio(T numerator, T denominator)
Definition TableUtils.h:405
std::vector< std::string > makeLabelVector(T_index n_entries, std::initializer_list< std::pair< T_index, T_string > > a_list)
Definition TableUtils.h:296
constexpr std::size_t subCategoryStride(const std::size_t categories, const std::size_t sub_categories, const std::size_t n_counter)
Definition TableUtils.h:325
constexpr std::size_t counterStride(const std::size_t categories, const std::size_t sub_categories, const std::size_t n_counter)
Definition TableUtils.h:330
std::string makeEtaBinLabel(const std::vector< float > &eta_bins, std::size_t eta_bin_i, bool abs_eta=false)
Definition TableUtils.h:535
std::tuple< std::string, RatioDefinition > makeRatioDefinition(std::string &&name, std::vector< SummandDefinition > &&numerator, std::vector< SummandDefinition > &&denominator)
Definition TableUtils.h:459
std::vector< float > computeRatios(const std::vector< RatioDefinition > &ratio_def, const std::size_t categories, const std::size_t sub_categories, const std::vector< std::size_t > &counter)
constexpr std::size_t ratioStride(const std::size_t categories, const std::size_t sub_categories, const std::vector< RatioDefinition > &ratio_def)
Definition TableUtils.h:494
std::vector< T_Output > createCounterArrayWithProjections(const std::size_t categories, const std::size_t sub_categories, const std::vector< std::array< T_Input, N > > &input_counts)
Definition TableUtils.h:343
UncalibMeasType
Define the type of the uncalibrated measurement.
static void addFitterTypeProperty(track_container_t &tracksContainer)
add fitter column to the track container
Acts::CombinatorialKalmanFilterExtensions< RecoTrackContainer > ckfExtensions