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

fix: Track selector printouts to be in line with actual cuts #3815

Merged
merged 9 commits into from
Nov 12, 2024

Conversation

pbutti
Copy link
Contributor

@pbutti pbutti commented Nov 5, 2024

Minor fix to the printouts in the track selector to show the right limits applied to the counters.

Summary by CodeRabbit

  • New Features

    • Enhanced output clarity with new printing functions for cut values in track selection.
    • Added validation checks for etaMax parameter and improved error handling for bin indexing.
  • Bug Fixes

    • Updated logic for evaluating track validity to ensure accurate results.

Copy link

coderabbitai bot commented Nov 5, 2024

Walkthrough

Enhancements to the TrackSelector class and its structures in TrackSelector.hpp, these changes are. Improved the operator<< function for Config and EtaBinnedConfig, yes. New helper functions for printing cut values introduced, they have. Validation checks for etaMax in addCuts methods added, ensuring positivity and order, hmm. Exception handling in binIndex method for out-of-bounds eta, also included. Refined functionality and robustness of track selection process, these modifications do.

Changes

File Path Change Summary
Core/include/Acts/TrackFinding/TrackSelector.hpp Enhanced operator<< for Config and EtaBinnedConfig with new printing logic; updated addCuts for etaMax validation; modified binIndex for exception handling; refined isValidTrack logic.

Poem

In the code where tracks do flow,
New prints and checks, like rivers, grow.
With Yoda's wisdom, clarity shines,
Validations strong, in structured lines.
A journey of tracks, robust and bright,
In the galaxy of code, all feels right! 🌌✨


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.

@github-actions github-actions bot added Component - Core Affects the Core module Track Finding labels Nov 5, 2024
@pbutti pbutti changed the title Fix Track selector printouts to be in line with actual cuts fix: Track selector printouts to be in line with actual cuts Nov 5, 2024
Copy link

github-actions bot commented Nov 5, 2024

📊: Physics performance monitoring for be0e473

Full contents

physmon summary

Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

A couple of nitpicks

I suspect that there is an overload to print which made this compile at the end. I think we should avoid such a function name.

Core/include/Acts/TrackFinding/TrackSelector.hpp Outdated Show resolved Hide resolved
Core/include/Acts/TrackFinding/TrackSelector.hpp Outdated Show resolved Hide resolved
Core/include/Acts/TrackFinding/TrackSelector.hpp Outdated Show resolved Hide resolved
Core/include/Acts/TrackFinding/TrackSelector.hpp Outdated Show resolved Hide resolved
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: 0

🧹 Outside diff range and nitpick comments (2)
Core/include/Acts/TrackFinding/TrackSelector.hpp (2)

307-318: Hmmmm, well structured these lambda functions are!

Clear separation of printing patterns, you have achieved. Improved readability, this brings to our codebase.

A small suggestion, I have. Add comments to explain when each lambda should be used:

-  // for printing cuts set up with `within`
+  // For printing bounded cuts with both minimum and maximum values (e.g., "min <= value < max")
-  // for printing cuts set up with `checkMin`
+  // For printing lower-bounded cuts (e.g., "min <= value")
-  // for printing cuts set up with `checkMax`
+  // For printing upper-bounded cuts (e.g., "value <= max")

320-332: Wise choice of printing functions for each cut type, this is!

Match the actual cut checks in isValidTrack, these printouts now do. But a small suggestion for improvement, I have.

Group the printouts to match the order in isValidTrack method, we should. Apply this change:

  printMinMax("loc0", cuts.loc0Min, cuts.loc0Max);
  printMinMax("loc1", cuts.loc1Min, cuts.loc1Max);
-  printMinMax("time", cuts.timeMin, cuts.timeMax);
  printMinMax("phi", cuts.phiMin, cuts.phiMax);
  printMinMax("eta", cuts.etaMin, cuts.etaMax);
  printMinMax("absEta", cuts.absEtaMin, cuts.absEtaMax);
  printMinMax("pt", cuts.ptMin, cuts.ptMax);
+  printMinMax("time", cuts.timeMin, cuts.timeMax);
  printMax("nHoles", cuts.maxHoles);
  printMax("nOutliers", cuts.maxOutliers);
  printMax("nHoles + nOutliers", cuts.maxHolesAndOutliers);
  printMax("nSharedHits", cuts.maxSharedHits);
  printMax("chi2", cuts.maxChi2);
  printMin("nMeasurements", cuts.minMeasurements);

This order, it matches the validation sequence in isValidTrack method, hmm yes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a18fcd0 and 6d21c0a.

📒 Files selected for processing (1)
  • Core/include/Acts/TrackFinding/TrackSelector.hpp (1 hunks)

@paulgessinger paulgessinger added this to the next milestone Nov 6, 2024
Copy link

sonarcloud bot commented Nov 12, 2024

@kodiakhq kodiakhq bot merged commit 5fc391b into acts-project:main Nov 12, 2024
44 checks passed
Rosie-Hasan pushed a commit to Rosie-Hasan/acts that referenced this pull request Nov 13, 2024
…oject#3815)

Minor fix to the printouts in the track selector to show the right limits applied to the counters. 
 





<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **New Features**
	- Enhanced output clarity with new printing functions for cut values in track selection.
	- Added validation checks for `etaMax` parameter and improved error handling for bin indexing.

- **Bug Fixes**
	- Updated logic for evaluating track validity to ensure accurate results.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants