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

chore: Adjust target limit after reset in Core CKF #3985

Merged
merged 3 commits into from
Dec 16, 2024

Conversation

andiwand
Copy link
Contributor

@andiwand andiwand commented Dec 14, 2024

After a reset in the CKF we need to adjust the target limit again to make sure the next step picks it up. I don't think we hit this case yet but it is good to have it anyways.

pulled out of #3449

Summary by CodeRabbit

  • New Features

    • Enhanced functionality for managing path limits and target surfaces in the filtering process.
    • Improved error handling and state management during track finding.
  • Bug Fixes

    • Refined logic for processing new track states and handling outlier states.
  • Documentation

    • Minor adjustments to comments and logging for improved clarity.

@andiwand andiwand added this to the next milestone Dec 14, 2024
Copy link

coderabbitai bot commented Dec 14, 2024

Walkthrough

In the realm of track finding, modifications to the CombinatorialKalmanFilter have emerged. The changes primarily focus on enhancing the Actor class methods, specifically reset and filter, by making them const and refining their internal logic. The updates aim to improve path limit handling, surface interactions, and state management during the track propagation process, ensuring more robust error handling and control flow.

Changes

File Change Summary
Core/include/Acts/.../CombinatorialKalmanFilter.hpp - reset() method made const
- filter() method made const
- Enhanced path limit and surface interaction logic

Poem

Tracks weave through space, a Jedi's dance, 🚀
Kalman's wisdom, in code's expanse 🧘‍♂️
Const methods guard the filtering way
Path limits bend, but never stray 🌈
The Force of algorithms, strong they be! 💫

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a2b74d and 1d91992.

📒 Files selected for processing (1)
  • Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp (1 hunks)
🧰 Additional context used
📓 Learnings (2)
📓 Common learnings
Learnt from: goetzgaycken
PR: acts-project/acts#3825
File: Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp:933-938
Timestamp: 2024-12-02T14:13:24.820Z
Learning: In `Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp`, the overloading of `findTracks` functions is intentional for convenience and not considered code duplication.
Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp (1)
Learnt from: goetzgaycken
PR: acts-project/acts#3825
File: Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp:933-938
Timestamp: 2024-12-02T14:13:24.820Z
Learning: In `Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp`, the overloading of `findTracks` functions is intentional for convenience and not considered code duplication.
🔇 Additional comments (2)
Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp (2)

692-695: Wise it is, to reset loop protection after resetting the state.

Ensures correct behavior, this addition does.


696-697: Prudent you are, adjusting target limit after reset.

Ensures subsequent steps recognize the target surface, this does.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

github-actions bot commented Dec 14, 2024

📊: Physics performance monitoring for bb98a62

Full contents

physmon summary

@andiwand andiwand marked this pull request as ready for review December 14, 2024 12:32
@kodiakhq kodiakhq bot merged commit 2bb167c into acts-project:main Dec 16, 2024
45 checks passed
@andiwand andiwand deleted the ckf-targetlimit-after-reset branch December 16, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Track Finding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants