search

FairRootGroup / FairRoot

C++ simulation, reconstruction and analysis framework for particle physics experiments
http://fairroot.gsi.de
Other
57 stars 96 forks source link

New way to color tracks. #1579

Open DanielWielanek opened 3 months ago

DanielWielanek commented 3 months ago

Currently the tracks coloring depens on node MCTrack colors, and the color scheme is configured by FairEventManager. In this commit I propose the following changes:

  1. FairEventManager only provide the pointer to XML node with configuration
  2. In examples there are different nodes for coloring of Geo and MC tracks (thank to the new policy)
  3. Old coloring shame is marked as depreacted
  4. The XML config for Event Display was updated (at some point the names of the last layers of examples was changed - the configuration was not working for last 4 stations of detector)

Checklist:

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The recent changes improve the event display framework's color management system by implementing a modular, XML-based approach for track and detector color assignments. Significant enhancements include the introduction of new classes for color handling, improved memory management practices, and a more flexible assignment mechanism that allows for dynamic configuration. This results in a more maintainable and user-friendly system for visualizing particle tracks and detector components. ## Changes | Files | Change Summary | |---------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | `.../FairEveMCTracks.cxx`
`.../FairEveMCTracks.h` | Updated track color handling to utilize `FairXMLPdgColor`, enhancing configurability through XML. Added member variable `fPdgColor`. | | `.../FairEventManager.cxx`
`.../FairEventManager.h` | Introduced methods for XML configuration (`SetXMLConfig`, `GetXMLConfigNode`), deprecated the old color method, and improved memory management with smart pointers. | | `.../FairEveGeoTracks.cxx`
`.../FairEveGeoTracks.h` | Added `fPdgColor` for track color coding, integrated XML for color retrieval from configuration. | | `.../FairXMLDetectorColor.cxx`
`.../FairXMLDetectorColor.h` | Implemented `FairXMLDetectorColor` class for applying color to detector nodes based on XML configurations, including methods for recursive color application. | | `.../CMakeLists.txt` | Included `FairXMLDetectorColor.cxx` in the build configuration. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant FairEventManager participant FairXMLPdgColor participant FairEveMCTracks User->>FairEventManager: SetXMLConfig("config.xml") FairEventManager->>FairXMLPdgColor: Load configuration FairEventManager->>FairEveMCTracks: Initialize FairEveMCTracks->>FairXMLPdgColor: GetColor(pdgCode) FairEveMCTracks->>User: DrawTrack(color) ```
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 8a1980e90bac4183b88d92509978b5e7c8c2d8da and 65ae2457a86adcf2afa756c8254465d0d27d2de2.
Files selected for processing (2) * fairroot/eventdisplay/xml/FairXMLDetectorColor.cxx (1 hunks) * fairroot/eventdisplay/xml/FairXMLDetectorColor.h (1 hunks)
Files skipped from review as they are similar to previous changes (2) * fairroot/eventdisplay/xml/FairXMLDetectorColor.cxx * fairroot/eventdisplay/xml/FairXMLDetectorColor.h
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.