Add SimPulse data type for storing simulated pulses pre-digitization#106
Merged
Add SimPulse data type for storing simulated pulses pre-digitization#106
SimPulse data type for storing simulated pulses pre-digitization#106Conversation
…dd relation to SimCalorimeterPulse
veprbl
reviewed
Apr 9, 2025
Co-authored-by: Dmitry Kalinkin <dmitry.kalinkin@gmail.com>
…ric pulse access in algorithms in the future
Co-authored-by: Derek M Anderson <derek.murphy.anderson@protonmail.com>
veprbl
reviewed
Apr 10, 2025
veprbl
reviewed
Apr 14, 2025
veprbl
reviewed
Apr 14, 2025
SimCalorimeterPulse data type for storing simulated calorimeter pulses pre-digitizationSimPulse data type for storing simulated pulses pre-digitization
simonge
reviewed
Apr 14, 2025
Co-authored-by: Simon Gardner <simon.gardner@glasgow.ac.uk>
veprbl
reviewed
Apr 14, 2025
Member
veprbl
left a comment
There was a problem hiding this comment.
Could you also update version in CMakeLists.txt, please?
simonge
reviewed
Apr 14, 2025
Co-authored-by: Simon Gardner <simon.gardner@glasgow.ac.uk>
Co-authored-by: Dmitry Kalinkin <dmitry.kalinkin@gmail.com>
veprbl
approved these changes
Apr 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Briefly, what does this PR introduce?
This PR adds a new data type,
edm4eic::SimPulse, to represent simulated pulses before digitization.The new structure is modeled consistently with the edmhep simulated hit types and aligns with existing waveform structures such as
edm4hep::RawTimeSeries(generic digitization output) andedm4hep::TimeSeries(generic measured time series).SimPulsedefines four one-to-many relations relations:SimCalorimeterHit: Pulses can be constructed from contributions of one or more simulated calorimeter hits.SimTrackerHit: Pulses can be constructed from one or more simulated tracker hits.SimPulse: Pulses can be constructed out of other pulses.MCParticle: Each pulse can be attributed to a single MCParticle (primary pulse), multiple MCParticles (overlayed pulses), or zero MCParticles (noise pulse).Storing pulses at the simulation level ensures conceptual clarity and consistency within our data model. The simulated pulse data to be stored in this structure have no equivalent in real detector output, and are therefore not digitization output.
By using a Simulation structure, we gain direct
Relationsupport with other simulation entities, enabling efficient backward navigation through the simulation chain. While Associations are used to link digitization and reconstruction structures to simulation, Relations are preferred for internal connections within the same domain (e.g. within Simulation or within Reconstruction). This design avoids introducing redundant Association types and keeps the data model consistent, clean and efficient.What kind of change does this PR introduce?
Please check if this PR fulfills the following:
Does this PR introduce breaking changes? What changes might users need to make to their code?
No
Does this PR change default behavior?
No