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

Draft: Start to migrate the R4-MS segment fit #4108

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

junggjo9
Copy link
Contributor

@junggjo9 junggjo9 commented Feb 24, 2025

PLEASE DESCRIBE YOUR CHANGES.
THIS MESSAGE ENDS UP AS THE COMMIT MESSAGE.
DO NOT USE @-MENTIONS HERE!

--- END COMMIT MESSAGE ---

@goblirsc , @dimitra97

Summary by CodeRabbit

  • New Features
    • Introduced new measurement handling abstractions to support composite detectors and muon measurements.
    • Enhanced data operations with advanced sorting and refined attribute access (e.g., positions, sensor directions, timings).
    • Expanded output capabilities to capture more detailed measurement properties for improved data reporting.

Copy link

coderabbitai bot commented Feb 24, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

New headers and include directives, added they have been. In StationSpacePoint.hpp, a concept and a template sorter are defined; in MuonSpacePoint.hpp, a class for muon measurements now exists. Additional include directives enable access to the new muon space point definitions in existing modules, and a CSV structure for muon space point data is introduced. Changes, all related to muon measurement handling in composite detectors, they are.

Changes

File(s) Change Summary
Core/.../StationSpacePoint.hpp New header added, defining the StationSpacePoint concept and the MeasurementSorter class template.
Examples/Algorithms/.../MuonHoughSeeder.cpp
Examples/Framework/.../MuonSimHit.hpp
Added include directive for "ActsExamples/EventData/MuonSpacePoint.hpp".
Examples/Framework/.../MuonSpacePoint.hpp New header added, implementing the MuonSpacePoint class with methods for measurement properties.
Examples/Io/Csv/src/CsvOutputData.hpp New structure MuonSpacePointData added, holding muon measurement attributes.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Sorter as MeasurementSorter
    participant SSP as StationSpacePoint
    Client->>Sorter: Create sorter instance with muon point
    Sorter->>SSP: Call localPosition()
    Sorter->>SSP: Call sensorDirection()
    Sorter->>SSP: Call stripPlaneNormal()
    Sorter->>SSP: Call driftRadius()
    Sorter->>SSP: Call time()
    Client->>Sorter: Retrieve sorted measurements
Loading

Poem

In code’s vast galaxy, new stars shine bright,
A concept and sorter, guiding with light.
Muon points align in harmony true,
Headers and data, joined anew we do.
Hmmm, may the Force of clean code forever ignite!


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 Component - Core Affects the Core module Component - Examples Affects the Examples module Event Data Model Track Finding labels Feb 24, 2025
@github-actions github-actions bot added this to the next milestone Feb 24, 2025
@junggjo9 junggjo9 marked this pull request as draft February 24, 2025 21:33
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 (2)
Core/include/Acts/EventData/StationSpacePoint.hpp (1)

21-22: Complete the documentation, you must.

Incomplete, this documentation is. The sentence "To describe the" hangs without purpose, like a lightsaber without its crystal.

Examples/Io/Csv/src/CsvOutputData.hpp (1)

125-128: Redundant, these covariance entries are. Symmetric matrix properties, you must respect.

In a covariance matrix, covXY equals covYX it does. Unnecessary duplication of data, this creates.

Simplify the structure, you should:

   float covX{0.f};
   float covXY{0.f};
-  float covYX{0.f};
   float covY{0.f};

And update the DFE_NAMEDTUPLE macro accordingly:

   DFE_NAMEDTUPLE(MuonSpacePointData, sectorId, bucketId, 
                 localPositionX ,localPositionY ,localPositionZ,
                 locSensorDirX, locSensorDirY, locSensorDirZ, 
                 locPlaneNormX, locPlaneNormY, locPlaneNormZ, 
-                covX, covXY, covYX, covY, driftR,
+                covX, covXY, covY, driftR,
                 technology, gasGap, primaryCh, secondaryCh);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d15f9a3 and 56378e1.

📒 Files selected for processing (5)
  • Core/include/Acts/EventData/StationSpacePoint.hpp (1 hunks)
  • Examples/Algorithms/TrackFinding/src/MuonHoughSeeder.cpp (1 hunks)
  • Examples/Framework/include/ActsExamples/EventData/MuonSimHit.hpp (1 hunks)
  • Examples/Framework/include/ActsExamples/EventData/MuonSpacePoint.hpp (1 hunks)
  • Examples/Io/Csv/src/CsvOutputData.hpp (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • Examples/Framework/include/ActsExamples/EventData/MuonSimHit.hpp
  • Examples/Algorithms/TrackFinding/src/MuonHoughSeeder.cpp
⏰ Context from checks skipped due to timeout of 90000ms (21)
  • GitHub Check: CI Bridge / lcg_107: [alma9, clang19]
  • GitHub Check: CI Bridge / lcg_107: [alma9, gcc14]
  • GitHub Check: CI Bridge / lcg_107: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, clang16]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc14]
  • GitHub Check: CI Bridge / lcg_105: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_105: [alma9, clang16]
  • GitHub Check: CI Bridge / linux_ubuntu_2204_clang
  • GitHub Check: CI Bridge / linux_ubuntu_2204
  • GitHub Check: CI Bridge / build_linux_ubuntu
  • GitHub Check: CI Bridge / build_exatrkx_cpu
  • GitHub Check: CI Bridge / build_exatrkx
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: unused_files
  • GitHub Check: macos
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, clang++)
  • GitHub Check: missing_includes
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, g++)
  • GitHub Check: linux_ubuntu
  • GitHub Check: build_debug
🔇 Additional comments (3)
Core/include/Acts/EventData/StationSpacePoint.hpp (1)

23-37: Well-defined concept requirements, I sense.

Strong with the Force, this concept definition is. Clear requirements for space point measurements in composite detectors, it provides. Approve this implementation, I do.

Examples/Framework/include/ActsExamples/EventData/MuonSpacePoint.hpp (1)

32-36: Wise use of move semantics, I observe.

The Force flows strong through these setter methods. Move semantics, they use wisely. Memory efficiency, they bring.

Also applies to: 38-40, 42-44, 46-48

Examples/Io/Csv/src/CsvOutputData.hpp (1)

106-147: Well-structured data representation, this is.

Clear documentation and comprehensive fields for muon measurements, this structure provides. Strong foundation for CSV output handling, it creates.

Comment on lines 18 to 20
const Acts::Vector3& stripPlaneNormal() const {
return m_pos;
}
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

A disturbance in the Force, I sense. Wrong member variable returned, it is.

Return m_pos instead of m_norm, this function does. A critical error this is, young padawan.

Fix this, you must:

-                    return m_pos;
+                    return m_norm;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const Acts::Vector3& stripPlaneNormal() const {
return m_pos;
}
const Acts::Vector3& stripPlaneNormal() const {
return m_norm;
}

Copy link

github-actions bot commented Feb 24, 2025

📊: Physics performance monitoring for 9ed5ba9

Full contents

physmon summary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Component - Examples Affects the Examples module Event Data Model Track Finding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant