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: Update athena dump reader #4011

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

benjaminhuth
Copy link
Member

@benjaminhuth benjaminhuth commented Jan 9, 2025

Some changes I did to the Athena dump reader lately. Includes:

  • Reader takes now a list of root files (allows to process bigger datasets)
  • Reader allows to read only reco information, to speed up the reading
  • Reader also exposes the particles-measurements-map
  • Don't read branches of for track information - not needed currently

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced RootAthenaDumpReader to support multiple input files.
    • Added configuration option to skip truth data.
    • Introduced new mapping for particle measurements.
  • Improvements

    • More flexible input file handling with updated error reporting.
    • Improved configuration options for data processing based on truth information.
    • Enhanced control over data initialization and output components.

@benjaminhuth benjaminhuth added this to the next milestone Jan 9, 2025
Copy link

coderabbitai bot commented Jan 9, 2025

Walkthrough

Changes to the RootAthenaDumpReader, there are! Support for multiple input files now exists, enhancing configuration capabilities. A new boolean, noTruth, introduced it is, allowing the skipping of truth data. Adjustments made to particle measurement mapping, enabling more flexible data processing. Overall, improvements to input handling and initialization based on settings, these modifications bring.

Changes

File Change Summary
Examples/Io/Root/include/ActsExamples/Io/Root/RootAthenaDumpReader.hpp - inputfileinputfiles (vector of strings)
- Added outputParticleMeasurementsMap
- Added noTruth boolean
- Added m_outputParticleMeasMap data handle
Examples/Io/Root/src/RootAthenaDumpReader.cpp - Multiple input file handling
- Conditional initialization based on noTruth
- Updated error and debug messages
Examples/Python/src/Input.cpp - Updated ACTS_PYTHON_DECLARE_READER macro
- Added inputfiles, outputParticleMeasurementsMap
- Introduced onlySpacepoints and noTruth parameters

Possibly related PRs

Suggested labels

automerge

Suggested reviewers

  • andiwand

Poem

In the forest of code, branches spread wide,
Multiple files now, in harmony, they bide.
With noTruth to skip, the truth data flies,
A reader's new magic, under digital skies! 🌌✨
Configuration's wisdom, a path to explore,
In the realm of data, adventures galore!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@github-actions github-actions bot added the Component - Examples Affects the Examples module label Jan 9, 2025
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

🧹 Nitpick comments (2)
Examples/Io/Root/src/RootAthenaDumpReader.cpp (2)

219-221: Commented code, preserved for future wisdom it is.

Track-related code, commented out it is. Documentation of intent, clear it is. Yet, consider extracting to separate file or creating TODO issue, we should.

Would you like me to create a GitHub issue to track the potential future implementation of track-related functionality?

Also applies to: 257-257


259-262: Multiple input files support, implemented well it is!

Clear logging of each added file, helpful for debugging it is. Consider adding total file count to debug message for better oversight.

 for (const auto& file : m_cfg.inputfiles) {
   m_inputchain->Add(file.c_str());
-  ACTS_DEBUG("Adding file '" << file << "' to tree " << m_cfg.treename);
+  ACTS_DEBUG("Adding file '" << file << "' to tree " << m_cfg.treename 
+            << " (" << &file - &m_cfg.inputfiles[0] + 1 << "/"
+            << m_cfg.inputfiles.size() << ")");
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5405865 and 12cd786.

📒 Files selected for processing (1)
  • Examples/Io/Root/src/RootAthenaDumpReader.cpp (9 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: merge-sentinel
  • GitHub Check: macos
🔇 Additional comments (6)
Examples/Io/Root/src/RootAthenaDumpReader.cpp (6)

67-68: Input validation improved, it has been!

Changed from single file to list of files, the validation has. More robust, this approach is!


81-86: Conditional initialization of truth components, wise it is!

Performance optimization achieved by conditionally initializing truth-related components. Memory and processing resources, saved they are!


471-486: Particle-measurement mapping, guarded well it is!

Conditional truth data processing, performance benefits it brings. Error handling for missing particles, robust it is.


501-502: Message severity adjusted wisely, it has been!

Changed from warning to debug level for zero time-over-threshold clusters. Less noise in logs, this change brings.


640-641: Space point conversion warning, clearer it now is!

Improved warning message by accounting for skipped space points in the comparison. More accurate debugging information, this provides!


724-744: Truth data processing, optional it has become!

Conditional processing of particle truth data, well structured it is. Memory efficiency improved, it has been. Clear separation of concerns, achieved it is!

Copy link

📊: Physics performance monitoring for cee908b

Full contents

physmon summary

@github-actions github-actions bot added the Stale label Feb 15, 2025
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

🧹 Nitpick comments (1)
Examples/Io/Root/include/ActsExamples/Io/Root/RootAthenaDumpReader.hpp (1)

279-312: Commented code about tracks, notice I do!

Hmm, commented code in header files, a path to technical debt it is. Remove if unused, we should.

-  // Those fields are not used currently
-  // Keep the code though, since it is annoying to write
-  /*
-  // Tracks
-  Int_t nTRK = 0;
-  Int_t TRKindex[maxTRK] = {};                //[nTRK]
-  // ... (other track-related fields)
-  */

Version control system, remember the code it will. Need commented code in headers, we do not.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 12cd786 and cee908b.

📒 Files selected for processing (2)
  • Examples/Io/Root/include/ActsExamples/Io/Root/RootAthenaDumpReader.hpp (5 hunks)
  • Examples/Io/Root/src/RootAthenaDumpReader.cpp (9 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Examples/Io/Root/src/RootAthenaDumpReader.cpp
🔇 Additional comments (4)
Examples/Io/Root/include/ActsExamples/Io/Root/RootAthenaDumpReader.hpp (4)

48-48: Support for multiple input files, added it is!

A wise change this is, from single string to vector of strings. Handle larger datasets, it now can.


61-64: Bidirectional mapping between measurements and particles, established it is!

Clear and descriptive comments for both maps, you have made. Wise decision to maintain symmetry in naming convention, it was.


173-174: New WriteDataHandle for particle measurements map, added it is!

Consistent with the Config changes, this implementation is. Proper naming convention, it follows.


71-72:

❓ Verification inconclusive

Skip truth data, one can now!

Performance optimization potential, this brings. But verify impact on downstream consumers, we must.


🏁 Script executed:

#!/bin/bash
# Search for code that depends on truth data
ast-grep --pattern 'if (!$noTruth) {
  $$$
}'

# Search for direct usage of truth-related fields
rg -l "Part_|TTC" --type cpp

Length of output: 195


Downstream usage verification, you must!

Optimized skipping of truth data this change appears to enable, promising performance benefits it does. Yet, evidence shows that truth-related code persists in both the header and source files. Verify downstream consumers—especially within Examples/Io/Root/src/RootAthenaDumpReader.cpp and the header—ensure no unintended impact on truth-data handling, you must.

@github-actions github-actions bot removed the Stale label Feb 15, 2025
Comment on lines +132 to +141
if (!m_cfg.noTruth) {
m_inputchain->SetBranchAddress("CLparticleLink_eventIndex",
&CLparticleLink_eventIndex);
m_inputchain->SetBranchAddress("CLparticleLink_barcode",
&CLparticleLink_barcode);
m_inputchain->SetBranchAddress("CLbarcodesLinked", &CLbarcodesLinked);
m_inputchain->SetBranchAddress("CLparticle_charge", &CLparticle_charge);
}

if (!m_cfg.noTruth) {
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a reason to separate these ifs?

Comment on lines +231 to +232
m_inputchain->Add(file.c_str());
ACTS_DEBUG("Adding file '" << file << "' to tree " << m_cfg.treename);
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick: in case of an error this might be better

Suggested change
m_inputchain->Add(file.c_str());
ACTS_DEBUG("Adding file '" << file << "' to tree " << m_cfg.treename);
ACTS_DEBUG("Adding file '" << file << "' to tree " << m_cfg.treename);
m_inputchain->Add(file.c_str());

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.

2 participants