refactor: Remove SurfaceSortingAlgorithm from Examples

[andiwand]

In #3944 we found out that this algorithm is not needed anymore

Summary by CodeRabbit

• New Features

  • Enhanced configurability for machine learning-based seed filtering with the addition of an ONNX model parameter.
  • Streamlined seeding and track fitting algorithms for improved modularity.

• Bug Fixes

  • Removed unnecessary complexity by eliminating the directNavigation parameter from multiple functions.

• Documentation

  • Updated test suite to improve clarity and maintainability.

• Chores

  • Removed obsolete files and references related to the SurfaceSortingAlgorithm class to streamline the codebase.

[coderabbitai]

Walkthrough

Removed, the SurfaceSortingAlgorithm class and its files from the ActsExamplesTrackFitting library, we have. The header and source files defining the class, deleted they are. From various Python scripts and test files, its references removed, they are. Simplified function signatures in the Python code, modifications made to enhance configurability for seeding algorithms and track finding processes, yes.

Changes

File Path	Change Summary
Examples/Algorithms/TrackFitting/CMakeLists.txt	Removed src/SurfaceSortingAlgorithm.cpp from build configuration.
Examples/Algorithms/TrackFitting/include/ActsExamples/TrackFitting/SurfaceSortingAlgorithm.hpp	Removed SurfaceSortingAlgorithm class, Config struct, and associated methods.
Examples/Algorithms/TrackFitting/src/SurfaceSortingAlgorithm.cpp	Removed implementation of SurfaceSortingAlgorithm class and its methods.
Examples/Python/python/acts/examples/reconstruction.py	Updated addKalmanTracks by removing directNavigation; added onnxModelFile to several methods.
Examples/Python/src/TrackFitting.cpp	Removed includes for SurfaceSortingAlgorithm.hpp and its declaration from addTrackFitting.
Examples/Python/tests/root_file_hashes.txt	Simplified naming convention for truth tracking entries; added and removed several entries.
Examples/Python/tests/test_algorithms.py	Removed SurfaceSortingAlgorithm from imports and parameterization.
Examples/Python/tests/test_examples.py	Simplified test_truth_tracking_kalman by removing directNavigation from parameters.
Examples/Scripts/Python/truth_tracking_kalman.py	Removed directNavigation parameter from runTruthTrackingKalman function.

Possibly related PRs

• refactor: Move MLAmbiguitySolver to Core #3272: The main PR modifies the CMakeLists.txt to remove a source file related to the SurfaceSortingAlgorithm, which is also referenced in the retrieved PR that discusses moving the MLAmbiguitySolver, indicating a potential connection in terms of project structure changes.
• feat: Logger passed to Gbts and Orthogonal seeders #3807: This PR enhances logging in the GBTS and Orthogonal seeders, which may relate to the overall improvements in the tracking and fitting processes, including the removal of the SurfaceSortingAlgorithm.
• feat: adding G4 stepping #3812: The changes in this PR focus on adding Geant4 stepping, which may indirectly relate to the overall track fitting and measurement processes affected by the removal of the SurfaceSortingAlgorithm.
• refactor: Reworked HitSelector in Examples #3836: The refactor of the HitSelector may relate to the changes in how hits are processed in the main PR, as both involve modifications to selection criteria in tracking algorithms.
• refactor(gx2f): put parts into separate compile units #3946: The introduction of new methods for handling measurements in the GlobalChiSquareFitter may connect with the changes in the main PR regarding how measurements are managed in the fitting process.
• fix: Distinguish between hits and measurements in ParticleSelector in Examples #3947: The distinction between hits and measurements in the ParticleSelector aligns with the changes in the main PR, which also involves modifications to how measurements are handled in the context of track fitting.
• feat: move spline to helper in Visualization #3950: The relocation of spline functionality to a helper in visualization may connect with the overall improvements in measurement handling and fitting processes discussed in the main PR.

Suggested labels

Component - Core

Suggested reviewers

• AJPfleger

In the realm of tracks, a shift we see,
The SurfaceSortingAlgorithm now set free.
With functions refined, and parameters few,
A clearer path forward, for algorithms anew.
In the code's embrace, simplicity reigns,
As we journey together, through data's vast plains.
🌌✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4dca81b and 1af5fef.

📒 Files selected for processing (4)

• Examples/Python/python/acts/examples/reconstruction.py (0 hunks)
• Examples/Python/tests/root_file_hashes.txt (1 hunks)
• Examples/Python/tests/test_examples.py (1 hunks)
• Examples/Scripts/Python/truth_tracking_kalman.py (0 hunks)

💤 Files with no reviewable changes (2)

• Examples/Scripts/Python/truth_tracking_kalman.py
• Examples/Python/python/acts/examples/reconstruction.py

🚧 Files skipped from review as they are similar to previous changes (2)

• Examples/Python/tests/test_examples.py
• Examples/Python/tests/root_file_hashes.txt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

📊: Physics performance monitoring for 1af5fef

Full contents

physmon summary

• ✅ Particles fatras
• ✅ Particles geant4
• ✅ Particles ttbar
• ✅ Vertices ttbar
• ✅ Truth tracking (KF)
• ✅ Truth tracking (GSF)
• ✅ Truth tracking (GX2F)
• ✅ Truth tracking (KF refit)
• ✅ Truth tracking (GSF refit)
• ✅ CKF finding performance | trackfinding | single muon | truth smeared seeding
• ✅ CKF fitting performance | trackfinding | single muon | truth smeared seeding
• ✅ CKF track summary | trackfinding | single muon | truth smeared seeding
• ✅ Seeding trackfinding | single muon | truth estimated seeding
• ✅ CKF finding performance | trackfinding | single muon | truth estimated seeding
• ✅ CKF fitting performance | trackfinding | single muon | truth estimated seeding
• ✅ CKF track summary | trackfinding | single muon | truth estimated seeding
• ✅ Seeding trackfinding | single muon | default seeding
• ✅ CKF finding performance | trackfinding | single muon | default seeding
• ✅ CKF fitting performance | trackfinding | single muon | default seeding
• ✅ CKF track summary | trackfinding | single muon | default seeding
• ✅ Seeding trackfinding | single muon | orthogonal seeding
• ✅ CKF finding performance | trackfinding | single muon | orthogonal seeding
• ✅ CKF fitting performance | trackfinding | single muon | orthogonal seeding
• ✅ CKF track summary | trackfinding | single muon | orthogonal seeding
• ✅ Seeding trackfinding | 4 muon x 50 vertices | default seeding
• ✅ CKF finding performance | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ CKF fitting performance | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ CKF track summary | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ Ambisolver finding performance | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ IVF notime | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ AMVF gauss notime | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ AMVF grid time | trackfinding | 4 muon x 50 vertices | default seeding
• ✅ Seeding trackfinding | ttbar with 200 pileup | default seeding
• ✅ CKF finding performance | trackfinding | ttbar with 200 pileup | default seeding
• ✅ CKF fitting performance | trackfinding | ttbar with 200 pileup | default seeding
• ✅ CKF track summary | trackfinding | ttbar with 200 pileup | default seeding
• ✅ Ambisolver finding performance | trackfinding | ttbar with 200 pileup | default seeding
• ✅ ML Ambisolver | trackfinding | ttbar with 200 pileup | default seeding
• ✅ AMVF gauss notime | trackfinding | ttbar with 200 pileup | default seeding
• ✅ AMVF grid time | trackfinding | ttbar with 200 pileup | default seeding

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 04190ae and b5bfdc4.

📒 Files selected for processing (9)

• Examples/Algorithms/TrackFitting/CMakeLists.txt (0 hunks)
• Examples/Algorithms/TrackFitting/include/ActsExamples/TrackFitting/SurfaceSortingAlgorithm.hpp (0 hunks)
• Examples/Algorithms/TrackFitting/src/SurfaceSortingAlgorithm.cpp (0 hunks)
• Examples/Python/python/acts/examples/reconstruction.py (0 hunks)
• Examples/Python/src/TrackFitting.cpp (0 hunks)
• Examples/Python/tests/root_file_hashes.txt (1 hunks)
• Examples/Python/tests/test_algorithms.py (0 hunks)
• Examples/Python/tests/test_examples.py (1 hunks)
• Examples/Scripts/Python/truth_tracking_kalman.py (0 hunks)

💤 Files with no reviewable changes (7)

• Examples/Algorithms/TrackFitting/CMakeLists.txt
• Examples/Python/tests/test_algorithms.py
• Examples/Scripts/Python/truth_tracking_kalman.py
• Examples/Algorithms/TrackFitting/include/ActsExamples/TrackFitting/SurfaceSortingAlgorithm.hpp
• Examples/Python/src/TrackFitting.cpp
• Examples/Algorithms/TrackFitting/src/SurfaceSortingAlgorithm.cpp
• Examples/Python/python/acts/examples/reconstruction.py

🔇 Additional comments (1)

Examples/Python/tests/test_examples.py (1)

583-583: Hmmmm, simplified the function signature is, approve this change I do!

Removed the directNavigation parameter has been, yet maintains its purpose the function does. Clean and focused the test remains, young padawan.

[benjaminhuth]

Looks good to me!

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[acts-project-service]

✅ Athena integration test results [5e8efd6]

✅ All tests successful

status	job	report
🟢	report_pull_request
🟡	run_workflow_tests_run4_mc
🟢	run_workflow_tests_run2_mc
🟢	run_workflow_tests_run2_data
🟢	run_workflow_tests_run3_mc
🟢	run_workflow_tests_run3_data
🟢	test_ActsDumpGeometryIdentifiers
🟢	test_ActsCheckObjectCountsWorkflowHgtd
🟢	test_ActsCheckObjectCountsCachedWorkflow
🟢	test_ActsCheckObjectCountsWorkflow
🟢	test_ActsEFTrackFit
🟢	test_ActsPersistifySeeds
🟢	test_ActsBenchmarkWithSpot
🟢	test_ActsAnalogueClustering
🟢	test_ActsWorkflowHeavyIons
🟢	test_ActsWorkflowFastTracking
🟢	test_ActsWorkflowCached
🟢	test_ActsWorkflow
🟢	test_ActsValidateAmbiguityResolution
🟢	test_ActsValidateResolvedTracks
🟢	test_ActsValidateTracks
🟢	test_ActsValidateActsCoreSpacePoints
🟢	test_ActsValidateActsSpacePoints
🟢	test_ActsValidateSeeds
🟢	test_ActsValidateOrthogonalSeeds
🟢	test_ActsValidateClusters
🟢	test_ActsPersistifyEDM
🟢	test_ActsGx2fRefitting
🟢	test_ActsGSFRefitting
🟢	test_ActsKfRefitting
🟢	test_ActsExtrapolationAlgTest
🟢	test_ActsITkTest