andiwand commented 1 week ago

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.

coderabbitai[bot] commented 1 week ago

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

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

andiwand commented 1 week ago

cc @pbutti @paulgessinger

github-actions[bot] commented 1 week ago

📊: Physics performance monitoring for 1b2ee9e59bee90defb849af22d1e98983672936d

Full contents

physmon summary

paulgessinger commented 4 days ago

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

andiwand commented 4 days ago

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 commented 3 days ago

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