feat: introduction obj simhit writer
This PR adds a wavefront .obj sim hit writer to the Examples.
Added (optional) spline fit based on Eigen::Spline
📊: Physics performance monitoring for 8ded30c7ff25a2aa50d4ec4807c07ee0e5c9dc80
physmon summary
- ✅ Particles fatras
- ✅ Particles geant4
- ✅ Particles ttbar
- ✅ Vertices ttbar
- ✅ Truth tracking (KF)
- ✅ Truth tracking (GSF)
- ✅ Truth tracking (GX2F)
- ✅ Truth tracking (KF refit)
- ✅ Truth tracking (GSF refit)
- ✅ CKF finding performance | trackfinding | single muon | truth smeared seeding
- ✅ CKF fitting performance | trackfinding | single muon | truth smeared seeding
- ✅ CKF track summary | trackfinding | single muon | truth smeared seeding
- ✅ Seeding trackfinding | single muon | truth estimated seeding
- ✅ CKF finding performance | trackfinding | single muon | truth estimated seeding
- ✅ CKF fitting performance | trackfinding | single muon | truth estimated seeding
- ✅ CKF track summary | trackfinding | single muon | truth estimated seeding
- ✅ Seeding trackfinding | single muon | default seeding
- ✅ CKF finding performance | trackfinding | single muon | default seeding
- ✅ CKF fitting performance | trackfinding | single muon | default seeding
- ✅ CKF track summary | trackfinding | single muon | default seeding
- ✅ Seeding trackfinding | single muon | orthogonal seeding
- ✅ CKF finding performance | trackfinding | single muon | orthogonal seeding
- ✅ CKF fitting performance | trackfinding | single muon | orthogonal seeding
- ✅ CKF track summary | trackfinding | single muon | orthogonal seeding
- ✅ Seeding trackfinding | 4 muon x 50 vertices | default seeding
- ✅ CKF finding performance | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ CKF fitting performance | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ CKF track summary | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ Ambisolver finding performance | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ IVF notime | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ AMVF gauss notime | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ AMVF grid time | trackfinding | 4 muon x 50 vertices | default seeding
- ✅ Seeding trackfinding | ttbar with 200 pileup | default seeding
- ✅ CKF finding performance | trackfinding | ttbar with 200 pileup | default seeding
- ✅ CKF fitting performance | trackfinding | ttbar with 200 pileup | default seeding
- ✅ CKF track summary | trackfinding | ttbar with 200 pileup | default seeding
- ✅ Ambisolver finding performance | trackfinding | ttbar with 200 pileup | default seeding
- ✅ AMVF gauss notime | trackfinding | ttbar with 200 pileup | default seeding
- ✅ AMVF grid time | trackfinding | ttbar with 200 pileup | default seeding
Walkthrough
A new source file, ObjSimHitWriter.cpp, has been added to the ActsExamplesIoObj library, along with its corresponding header file ObjSimHitWriter.hpp. This new class, ObjSimHitWriter, is designed for writing simulation hit data to OBJ files. Additionally, several functions in simulation.py were updated to include a new optional parameter for specifying output directories for object files. The Output.cpp file has been modified to include the new writer in Python bindings, while the full_chain_odd.py script has been enhanced with new command-line arguments for improved configurability. The file sim_digi_odd.py has been deleted.
Changes
| File | Change Summary |
|---|---|
Examples/Io/Obj/CMakeLists.txt |
Added src/ObjSimHitWriter.cpp to the ActsExamplesIoObj library. |
Examples/Io/Obj/include/ActsExamples/Io/Obj/ObjSimHitWriter.hpp |
Introduced ObjSimHitWriter class and Config struct with methods for writing simulation hits. |
Examples/Io/Obj/src/ObjSimHitWriter.cpp |
Implemented ObjSimHitWriter class methods for writing OBJ files and managing simulation hits. |
Examples/Io/Obj/src/ObjTrackingGeometryWriter.cpp |
Updated include path for ObjTrackingGeometryWriter.hpp. |
Examples/Python/python/acts/examples/simulation.py |
Updated functions to include outputDirObj parameter for object file output. |
Examples/Python/src/Output.cpp |
Added includes for new writers and updated Python bindings for ObjSimHitWriter. |
Examples/Scripts/Python/full_chain_odd.py |
Enhanced argument parser with new options for particle gun configuration and output management. |
Examples/Scripts/Python/sim_digi_odd.py |
Deleted the file responsible for simulating and digitizing particle interactions. |
Possibly related PRs
- #3836: Changes in the
HitSelectorclass involve modifications to configuration parameters and functionality related to hit selection, which may intersect with theObjSimHitWriterclass's role in processing simulation hits.
Suggested labels
automerge
Suggested reviewers
- benjaminhuth
In the realm of code, new paths we weave,
WithObjSimHitWriter, data to achieve.
Functions enhanced, and options galore,
In the galaxy of scripts, we open new doors.
So let us rejoice, with a cheer and a grin,
For the magic of coding, together we win! 🌌✨
[!WARNING]
Rate limit exceeded
@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 54 seconds before requesting another review.
⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the
@coderabbitai reviewcommand as a PR comment. Alternatively, push new commits to this PR.We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.
📥 Commits
Reviewing files that changed from the base of the PR and between 0b8e768046d494624d0e191eea8183988e4c9ab7 and eccba9f62a2665adcadff13c9f48a1186204e2df.
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Looks good. Would it be possible to do the move from
PluginstoIoin a separate PR?
Possible, but the IO code is so contained and almost not exposed that it would probably be an overkill. I would prefer to do it once as the PR is not very big.
Quality Gate passed
Issues
2 New issues
0 Accepted issues
Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code