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: Add back DD4hep field access #4073

Merged
merged 4 commits into from
Feb 7, 2025

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Feb 6, 2025

This was removed in #3498, but we do need it.

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

  • New Features
    • Enhanced detector functionality by providing direct access to field-related information through a new method.
    • Extended Python integration with a new read-only field property for streamlined access.
    • Introduced a new class for configuration options, allowing improved setup and customization of the detector.

This was removed in acts-project#3498, but
we do need it.
@paulgessinger paulgessinger added this to the next milestone Feb 6, 2025
Copy link

coderabbitai bot commented Feb 6, 2025

Walkthrough

A new public method, field(), to the DD4hepDetector class, introduced it is. A shared pointer to Acts::DD4hepFieldAdapter returned it shall. In Python bindings, a read-only field property and a new DD4hepDetectorOptions class added they are. The attachDD4hepGeoIdMapper function updated, enhancing access to the field, yes. The structure of the detector remains intact, it does.

Changes

File(s) Change Summary
Examples/Detectors/DD4hepDetector//DD4hepDetector.hpp
Examples/Detectors/DD4hepDetector//DD4hepDetector.cpp
Added field() method to DD4hepDetector, returning a shared pointer to DD4hepFieldAdapter.
Examples/Python/src//DD4hepComponent.cpp Added read-only field property; introduced DD4hepDetectorOptions class; updated attachDD4hepGeoIdMapper method.

Suggested labels

Track Fitting

Suggested reviewers

  • andiwand

Poem

A method new, in code we find,
A field to share, with ease combined.
Python and C++, together they play,
Options and properties, brighten the way.
In the realm of detectors, harmony sings,
With every change, new joy it brings!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 b564b5e and e8ed5bc.

📒 Files selected for processing (2)
  • Examples/Detectors/DD4hepDetector/include/ActsExamples/DD4hepDetector/DD4hepDetector.hpp (2 hunks)
  • Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp
  • Examples/Detectors/DD4hepDetector/include/ActsExamples/DD4hepDetector/DD4hepDetector.hpp

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 Feb 6, 2025
andiwand
andiwand previously approved these changes Feb 6, 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: 1

🧹 Nitpick comments (1)
Examples/Detectors/DD4hepDetector/include/ActsExamples/DD4hepDetector/DD4hepDetector.hpp (1)

91-93: Documentation enhancement, beneficial it would be.

While documentation exists, more details about return value ownership and potential exceptions, helpful they would be.

 /// @brief Access to the DD4hep field
+/// @return A shared pointer to the DD4hep field adapter, ownership shared it is
+/// @throws std::runtime_error if field access fails
 std::shared_ptr<Acts::DD4hepFieldAdapter> field() const;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b94ecd1 and b564b5e.

📒 Files selected for processing (3)
  • Examples/Detectors/DD4hepDetector/include/ActsExamples/DD4hepDetector/DD4hepDetector.hpp (2 hunks)
  • Examples/Detectors/DD4hepDetector/src/DD4hepDetector.cpp (1 hunks)
  • Examples/Python/src/DD4hepComponent.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: merge-sentinel
  • GitHub Check: unused_files
  • GitHub Check: missing_includes
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, clang++)
  • GitHub Check: macos
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, g++)
  • GitHub Check: build_debug
  • GitHub Check: docs
  • GitHub Check: linux_ubuntu
🔇 Additional comments (3)
Examples/Detectors/DD4hepDetector/include/ActsExamples/DD4hepDetector/DD4hepDetector.hpp (1)

31-33: Forward declaration, well placed it is.

Clean and proper forward declaration of DD4hepFieldAdapter class in Acts namespace, I see.

Examples/Python/src/DD4hepComponent.cpp (2)

40-41: Python bindings, well structured they are.

Clean addition of read-only field property to Python bindings, I observe. Proper exposure of DD4hep field functionality to Python users, this provides.


63-66: Field adapter binding, complete it appears.

Proper exposure of DD4hepFieldAdapter to Python, maintaining inheritance from MagneticFieldProvider, I see.

@paulgessinger
Copy link
Member Author

@andiwand forward declaration doesn't seem to be working, can you go again?

Copy link

github-actions bot commented Feb 6, 2025

📊: Physics performance monitoring for 569b9da

Full contents

physmon summary

Copy link

sonarqubecloud bot commented Feb 7, 2025

@kodiakhq kodiakhq bot merged commit 1df6258 into acts-project:main Feb 7, 2025
43 checks passed
@github-actions github-actions bot removed the automerge label Feb 7, 2025
@paulgessinger paulgessinger modified the milestones: next, v39.1.0 Feb 14, 2025
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.

3 participants