Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Helpers to calculate residuals, chi2 and unbiased states #3877

Conversation

andiwand
Copy link
Contributor

@andiwand andiwand commented Nov 20, 2024

This came up a couple of times and it really should be in core so I added helpers to

  • calculate residuals and their covariance for predicted, filtered and smoothed states
  • calculate chi2 for these
  • calculate unbiased parameters and covariance

For now I added them to TrackHelpers.hpp but potentially this could also live in the TrackStateProxy.

Summary by CodeRabbit

  • New Features

    • Introduced new helper functions for track state calculations, including methods for computing predicted, filtered, and smoothed residuals and chi-squared values.
    • Added functionality to calculate unbiased track parameters and their covariance.
  • Bug Fixes

    • Simplified the logic for calculating unbiased track parameters, improving maintainability and reducing complexity.
  • Documentation

    • Updated method signatures and descriptions to reflect changes in functionality.

@andiwand andiwand added this to the next milestone Nov 20, 2024
Copy link

coderabbitai bot commented Nov 20, 2024

Walkthrough

Changes made to the TrackHelpers.hpp file introduce new helper functions for track state calculations and enhance dependencies with additional includes. The RootTrackStatesWriter.cpp file undergoes modifications that simplify the logic for calculating unbiased track parameters, replacing complex calculations with a call to the new helper function. Include directives are adjusted, ensuring the necessary dependencies are maintained while streamlining the code.

Changes

File Path Change Summary
Core/include/Acts/Utilities/TrackHelpers.hpp Added includes for TrackParametrization, MeasurementHelpers, and TrackStateProxyConcept. Implemented new methods for calculating predicted, filtered, and smoothed residuals and chi-squared values, along with unbiased parameters covariance.
Examples/Io/Root/src/RootTrackStatesWriter.cpp Removed several include statements and added TrackHelpers.hpp. Simplified unbiased track parameters calculation in getTrackParams lambda function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TrackHelpers
    participant RootTrackStatesWriter

    User->>RootTrackStatesWriter: Request track parameters
    RootTrackStatesWriter->>TrackHelpers: calculateUnbiasedParametersCovariance(state)
    TrackHelpers-->>RootTrackStatesWriter: Return unbiased parameters
    RootTrackStatesWriter-->>User: Provide track parameters
Loading

In the realm of tracks, new functions arise,
Calculating residuals, oh how they surprise!
With Yoda's wisdom, we simplify the way,
Unbiased parameters, now here to stay.
Code flows smoother, like the Force's embrace,
In the galaxy of coding, we've found our place! 🌌✨


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
🪧 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.

@andiwand
Copy link
Contributor Author

cc @pbutti @paulgessinger

@github-actions github-actions bot added Component - Core Affects the Core module Component - Examples Affects the Examples module labels Nov 20, 2024
Copy link

github-actions bot commented Nov 20, 2024

📊: Physics performance monitoring for 1b2ee9e

Full contents

physmon summary

Copy link
Member

@paulgessinger paulgessinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. The new public functions would need at least doxygen comments.

Core/include/Acts/Utilities/TrackHelpers.hpp Outdated Show resolved Hide resolved
Core/include/Acts/Utilities/TrackHelpers.hpp Outdated Show resolved Hide resolved
Core/include/Acts/Utilities/TrackHelpers.hpp Outdated Show resolved Hide resolved
pbutti
pbutti previously approved these changes Nov 21, 2024
@andiwand andiwand marked this pull request as ready for review November 25, 2024 18:53
@paulgessinger
Copy link
Member

Sonar has a couple of valid points on the usage of auto parameters in lambdas where the parameter is then actually used.

@andiwand
Copy link
Contributor Author

Sonar has a couple of valid points on the usage of auto parameters in lambdas where the parameter is then actually used.

@paulgessinger I think this is the code I copied from other places to do the visit_measurement unroll magic. Do you think we should change this coherently in all places to use template instead of auto?

@paulgessinger
Copy link
Member

@andiwand This only complains about cases where the template parameter is subsequently accessed. Indeed, this only became possible in C++20 with explicit template parameters to lambdas.

Ultimately, we should migrate to it, but I personally think updating this incrementally is fine.

@acts-policybot acts-policybot bot dismissed pbutti’s stale review November 26, 2024 14:07

Invalidated by push of 5e86218

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
Core/include/Acts/Utilities/TrackHelpers.hpp (1)

508-534: Refactor common code, you can

The functions calculatePredictedResidual, calculateFilteredResidual, and calculateSmoothedResidual much code they share. Improve maintainability, to refactor common logic into a single helper function, consider you should.

Also applies to: 544-570, 580-606

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4656a8d and 5e86218.

📒 Files selected for processing (2)
  • Core/include/Acts/Utilities/TrackHelpers.hpp (2 hunks)
  • Examples/Io/Root/src/RootTrackStatesWriter.cpp (2 hunks)
🔇 Additional comments (3)
Core/include/Acts/Utilities/TrackHelpers.hpp (1)

621-629: Template parameters in lambdas, ensure compatibility you must

In your use of visit_measurement, auto parameters in lambdas you use. Compatibility issues this may cause with C++ standards before C++20. Explicit template parameters, prefer you might to ensure broader compatibility.

Also applies to: 644-652, 667-675

Examples/Io/Root/src/RootTrackStatesWriter.cpp (2)

19-19: Include necessary header, you have.

Adding "Acts/Utilities/TrackHelpers.hpp" ensures access to required helper functions.


484-486: Simplify code with helper function, you do.

Replacing complex calculations with Acts::calculateUnbiasedParametersCovariance(state) enhances readability and maintainability.

Core/include/Acts/Utilities/TrackHelpers.hpp Show resolved Hide resolved
Core/include/Acts/Utilities/TrackHelpers.hpp Show resolved Hide resolved
Copy link

sonarcloud bot commented Nov 26, 2024

@kodiakhq kodiakhq bot merged commit 93d8781 into acts-project:main Nov 26, 2024
44 checks passed
@acts-project-service
Copy link
Collaborator

acts-project-service commented Nov 27, 2024

🔴 Athena integration test results [93d8781]

Build job with this PR failed!

Please investigate the build job for the pipeline!

@acts-project-service acts-project-service added the Breaks Athena build This PR breaks the Athena build label Nov 27, 2024
@andiwand andiwand deleted the feat-residual-chi2-unbiased-track-state-helpers branch November 27, 2024 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaks Athena build This PR breaks the Athena build Component - Core Affects the Core module Component - Examples Affects the Examples module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants