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

refactor: make whiteboard alias for tracks configurable #3917

Closed
wants to merge 1 commit into from

Conversation

AJPfleger
Copy link
Contributor

@AJPfleger AJPfleger commented Nov 28, 2024

This is helps to administrate multiple tracks, when using multiple fitters on the whiteboard.

Summary by CodeRabbit

  • New Features
    • Enhanced configurability of track naming with the introduction of a customizable whiteboardAliasTracks parameter across multiple functions.
  • Bug Fixes
    • Improved flexibility in track management by replacing hardcoded track names with the new parameter in relevant functions.

@AJPfleger AJPfleger added this to the next milestone Nov 28, 2024
Copy link

coderabbitai bot commented Nov 28, 2024

Walkthrough

Enhancements to the reconstruction.py file, yes. Parameters added, function signatures modified, they are. The whiteboardAliasTracks parameter introduced, it allows customizable naming for output tracks. Functions addKalmanTracks, addCKFTracks, addGx2fTracks, and addSeedFilterML, updated they were, to include this new parameter. Hardcoded names replaced, flexibility improved, it is. The structure of the code, intact it remains, focusing on usability, yes.

Changes

File Path Change Summary
Examples/Python/python/acts/examples/reconstruction.py Function signatures of addKalmanTracks, addCKFTracks, addGx2fTracks, and addSeedFilterML updated to include whiteboardAliasTracks parameter. Hardcoded track names replaced with this new parameter.

Poem

In the code where tracks align,
New names emerge, oh so fine!
Flexibility now takes the stage,
With parameters to engage.
A whiteboard's charm, we now embrace,
In reconstruction's wondrous space! ✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e10cd54 and a7afcdc.

📒 Files selected for processing (1)
  • Examples/Python/python/acts/examples/reconstruction.py (6 hunks)
🔇 Additional comments (4)
Examples/Python/python/acts/examples/reconstruction.py (4)

1286-1286: LGTM! Flexible track naming in Kalman filter, it provides.

The addition of whiteboardAliasTracks parameter with default value "tracks", wise it is. Proper whiteboard alias configuration at line 1323, it enables.

Also applies to: 1323-1323


1422-1422: LGTM! Track naming flexibility in CKF algorithm, achieved it is.

The whiteboardAliasTracks parameter addition, consistent with Kalman implementation it remains. Default value maintains backward compatibility, while flexibility it provides.

Also applies to: 1525-1525


1573-1573: LGTM! Track naming control in Global Chi-Square fitter, granted it is.

The whiteboardAliasTracks parameter, harmoniously added it was. With other track fitters, consistency it maintains. Default behavior preserved, it is.

Also applies to: 1600-1600


Line range hint 1286-1600: Verify the impact on existing track consumers, we must.

Though changes look good, verify we must that existing code consuming tracks from whiteboard handles the aliasing properly.

Run this script to find track consumers:

✅ Verification successful

Hmm, safe the aliasing is, young padawan.

Through the Force, I sense that all track consumers properly handle the whiteboard aliasing. The search reveals that:

  • All track consumers consistently use the "tracks" key as input
  • Each tracking algorithm (Kalman, GSF, GX2F, CKF) properly sets up the whiteboard alias using s.addWhiteboardAlias(whiteboardAliasTracks, ...)
  • The whiteboard alias parameter is consistently defaulted to "tracks" across all functions
  • No direct access to algorithm-specific track names (like "ckf_tracks", "gsf_tracks") is found in consumers

Maintain this pattern, we do, where consumers read from the generic "tracks" alias while algorithms handle the proper aliasing of their specific output tracks.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find code that reads from the whiteboard's "tracks" key
# This helps verify that the new aliasing won't break existing consumers

# Search for whiteboard track access patterns
rg -A 2 'inputTracks.*=.*"tracks"'

# Search for direct track references
rg '"tracks"'

Length of output: 11805


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.

Copy link

📊: Physics performance monitoring for a7afcdc

Full contents

physmon summary

Copy link
Member

@benjaminhuth benjaminhuth left a comment

Choose a reason for hiding this comment

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

Looks good in general. I'm a bit concerned that this python code we add around our bindings gets more and more convoluted, but for this specific purpose I also don't see a way around this currently.

@benjaminhuth benjaminhuth changed the title refactor: add whiteboard alias option add<Fitter>Tracks() refactor: make whiteboard alias for tracks configurable Dec 2, 2024
@@ -1283,6 +1283,7 @@ def addKalmanTracks(
clusters: str = None,
calibrator: acts.examples.MeasurementCalibrator = acts.examples.makePassThroughCalibrator(),
logLevel: Optional[acts.logging.Level] = None,
whiteboardAliasTracks: str = "tracks",
Copy link
Contributor

Choose a reason for hiding this comment

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

why do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

hm I don't see why this is necessary for #3889 - the alias is something that should not need dynamic names. It is the thing that replaces dynamic names.

Looking at #3889 I think you can just do KF first and have "tracks" point to KF tracks and then do GX2F and have "tracks" point to this. Or you explicitly point to the "kf_tracks"

and GX2F respectively

Copy link
Member

@benjaminhuth benjaminhuth Dec 2, 2024

Choose a reason for hiding this comment

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

Ah right, I didn't had in mind that we can reassign alieses, so it should be possible to first run+write the first fitter, and then run+write the second fitter.
Can you try that @AJPfleger? If this works, this change is not needed I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, I am waiting for the physmon results. it worked locally :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@andiwand thanks for the suggestion. I didn't think, we could skip the aliasing. This is now a lot cleaner :)

@AJPfleger AJPfleger closed this Dec 2, 2024
@paulgessinger paulgessinger modified the milestones: next, v38.1.0 Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants