Homogenize authors and cleanup docstrings #276
Merged
Conversation
This file contains 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
tmadlener
reviewed
Feb 22, 2024
edm4hep.yaml
Outdated
| VectorMembers: | ||
| - float shapeParameters //shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters. | ||
| - float subdetectorEnergies //energy observed in a particular subdetector. Check/set collection parameter ClusterSubdetectorNames for decoding the indices of the array. | ||
| - float shapeParameters // shape parameters. This should be accompanied by a descriptive list of names in the shapeParameterNames collection level metadata, as a vector of strings with the same ordering. |
There was a problem hiding this comment.
We could even add a constant into edm4hep/Constants.h that is just the name of this, so that there are no typos. Basically the same as we did for the weights vector member in EventHeader.
edm4hep.yaml
Outdated
| - edm4hep::Vector3d position //hit position in [mm]. | ||
| - std::array<float,6> covMatrix //covariance of the position (x,y,z), stored as lower triangle matrix. i.e. cov(x,x) , cov(y,x) , cov(y,y) , cov(z,x) , cov(z,y) , cov(z,z) | ||
| - uint64_t cellID // ID of the sensor that created this hit. | ||
| - int32_t type // type of raw data hit, either one of edm4hep::RawTimeSeries, edm4hep::SIMTRACKERHIT. |
There was a problem hiding this comment.
Suggested change
| - int32_t type // type of raw data hit, either one of edm4hep::RawTimeSeries, edm4hep::SIMTRACKERHIT. | |
| - int32_t type // type of raw data hit. |
I don't think we define anything like that at the moment.
edm4hep.yaml
Outdated
| - edm4hep::Vector3d position //hit position in [mm]. | ||
| - std::array<float,6> covMatrix //covariance of the position (x,y,z), stored as lower triangle matrix. i.e. cov(x,x) , cov(y,x) , cov(y,y) , cov(z,x) , cov(z,y) , cov(z,z) | ||
| - uint64_t cellID // ID of the sensor that created this hit. | ||
| - int32_t type // type of raw data hit, either one of edm4hep::RawTimeSeries, edm4hep::SIMTRACKERHIT. |
There was a problem hiding this comment.
Suggested change
| - int32_t type // type of raw data hit, either one of edm4hep::RawTimeSeries, edm4hep::SIMTRACKERHIT. | |
| - int32_t type // type of raw data hit. |
We don't define anything like that yet, so I think it's best to just remove it completely.
edm4hep.yaml
Outdated
| - int32_t subdetectorHitNumbers //number of hits in particular subdetectors.Check/set collection variable TrackSubdetectorNames for decoding the indices | ||
| - edm4hep::TrackState trackStates //track states | ||
| - edm4hep::Quantity dxQuantities // different measurements of dx quantities | ||
| - int32_t subdetectorHitNumbers // number of hits in particular subdetectors.Check/set collection variable TrackSubdetectorNames for decoding the indices. |
There was a problem hiding this comment.
Suggested change
| - int32_t subdetectorHitNumbers // number of hits in particular subdetectors.Check/set collection variable TrackSubdetectorNames for decoding the indices. | |
| - int32_t subdetectorHitNumbers // number of hits in particular subdetectors. |
edm4hep.yaml
Outdated
| Members: | ||
| - int32_t type //type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues. | ||
| - int32_t type // type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues. |
There was a problem hiding this comment.
Suggested change
| - int32_t type // type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues. | |
| - int32_t type // type of reconstructed particle. |
Although we will redefine this as PDG in any case, I think.
|
Can you also run |
jmcarcell
force-pushed
the
cosmeticsRebased
branch
from
5577523 to
ade2e5c
Compare
jmcarcell
approved these changes
Feb 22, 2024
jmcarcell
force-pushed
the
cosmeticsRebased
branch
from
ade2e5c to
87fcde7
Compare
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.
BEGINRELEASENOTES
Authorfield for all data types. Fixes Homogenize the authors of the datatypes? #255ENDRELEASENOTES
Let me know if you want me to remove the two commits homogenizing comments.