fix: Test and fix broken TrackHelpers for chi2 and unbiased track state

[andiwand]

New helper functions for chi2 and unbiased track states slipped in untested with #3877. Somehow I forgot to do this and the code ended up being broken in the latest release.

Here I add some quick unit tests and fix the code so it can actually be compiled.

Summary by CodeRabbit

• New Features

  • Enhanced track state calculations for improved precision in subspace projections and measurement handling.
  • Introduced a new template function for creating test track states, facilitating better testing of track-related functionalities.

• Bug Fixes

  • Improved type safety and clarity in chi-squared calculations.

• Tests

  • Added new test cases for calculating predicted, filtered, and smoothed chi-squared values, as well as unbiased parameters covariance.

[coderabbitai]

Walkthrough

Changes made to TrackHelpers.hpp and TrackHelpersTests.cpp enhance the handling of track state parameters and their calculations within the ACTS project. The fixedBoundSubspaceHelper method is replaced by projectorSubspaceHelper, affecting several functions related to residual calculations. Method signatures are updated to include measurement dimensions, improving specificity. Additionally, new test cases are introduced to validate these calculations, while some unused includes are removed and a new helper function for creating test track states is added.

Changes

File Path	Change Summary
Core/include/Acts/Utilities/TrackHelpers.hpp	Updated method signatures for residual and chi-squared calculations; replaced fixedBoundSubspaceHelper with projectorSubspaceHelper.
Tests/UnitTests/Core/Utilities/TrackHelpersTests.cpp	Added createTestTrackState function; introduced four new test cases for chi-squared and covariance calculations; removed unused includes.

Possibly related PRs

• feat: Helpers to calculate residuals, chi2 and unbiased states #3877: The changes in this PR directly relate to the modifications made in TrackHelpers.hpp, specifically the addition of the same functions (calculatePredictedResidual, calculateFilteredResidual, calculateSmoothedResidual, calculatePredictedChi2, calculateFilteredChi2, calculateSmoothedChi2, and calculateUnbiasedParametersCovariance) that are also updated in the main PR.

Suggested labels

Track Finding

Suggested reviewers

• paulgessinger

In the realm of tracks, changes unfold,
New helpers and tests, a story retold.
Chi-squared calculations, precise and clear,
With each line of code, we bring forth cheer!
In the dance of the data, we find our way,
Enhancing our tools, come what may! ✨

---

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 3581d3a

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
• ✅ AMVF gauss notime | trackfinding | ttbar with 200 pileup | default seeding
• ✅ AMVF grid time | trackfinding | ttbar with 200 pileup | default seeding

[coderabbitai]

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 797c3c3 and 468743a.

📒 Files selected for processing (2)

• Core/include/Acts/Utilities/TrackHelpers.hpp (6 hunks)
• Tests/UnitTests/Core/Utilities/TrackHelpersTests.cpp (3 hunks)

🔇 Additional comments (7)

Core/include/Acts/Utilities/TrackHelpers.hpp (1)

520-520: Replaced fixedBoundSubspaceHelper with projectorSubspaceHelper, correctly you have.

Smoothly, the code integration proceeds. Approve this change, I do.

Also applies to: 522-524

Tests/UnitTests/Core/Utilities/TrackHelpersTests.cpp (6)

11-11: Include necessary headers, you have.

Appropriate additions, these are.

Also applies to: 16-16

---

37-63: Well-structured createTestTrackState function, this is.

Facilitates creation of test track states, it does. Good practice, this is.

---

135-141: Test case CalculatePredictedChi2, correctly added you have.

Validates functionality, it does. Approve, I do.

---

143-149: Test case CalculateFilteredChi2, correctly implemented.

Ensures correctness, this test does. Approve, I do.

---

151-157: Test case CalculateSmoothedChi2, well added it is.

Valid and useful, this test is. Approve, I do.

---

159-175: Test case CalculateUnbiasedParametersCovariance, thorough it is.

Checks correctness of covariance calculations. Valuable addition, this is.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

[acts-project-service]

🔴 Athena integration test results [1663c02]

Build job with this PR failed!

Please investigate the build job for the pipeline!