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.

Sign up for GitHub

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

feat: deprecate simID and recID accessors #100

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

feat: deprecate simID and recID accessors #100

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a311943
feat: deprecate simID and recID accessors
wdconinc Jan 20, 2025
8dff4ff
feat: also provide deprecated setters (which don't set anything)
wdconinc Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 88 additions & 8 deletions edm4eic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,45 +513,125 @@ datatypes:
Description: "Used to keep track of the correspondence between MC and reconstructed particles"
Author: "S. Joosten"
Members:
- uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
- uint32_t recID // Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
- float weight // weight of this association
OneToOneRelations :
- edm4eic::ReconstructedParticle rec // reference to the reconstructed particle
- edm4hep::MCParticle sim // reference to the Monte-Carlo particle
ExtraCode:
includes: "
#include <edm4eic/ReconstructedParticle.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use getSim().getObjectID().index instead\")]]
int getSimID() const { return getSim().getObjectID().index; }\n
[[deprecated(\"use getRec().getObjectID().index instead\")]]
int getRecID() const { return getRec().getObjectID().index; }\n
"
MutableExtraCode:
includes: "
#include <edm4eic/ReconstructedParticle.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use setSim() instead; this function does nothing\")]]
void setSimID(int) { }\n
[[deprecated(\"use setRec() instead; this function does nothing\")]]
void setRecID(int) { }\n
"

edm4eic::MCRecoClusterParticleAssociation:
Description: "Association between a Cluster and a MCParticle"
Author : "S. Joosten"
Members:
- uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
- uint32_t recID // Index of corresponding Cluster (position in Clusters array)
- float weight // weight of this association
OneToOneRelations:
- edm4eic::Cluster rec // reference to the cluster
- edm4hep::MCParticle sim // reference to the Monte-Carlo particle
ExtraCode:
includes: "
#include <edm4eic/Cluster.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use getSim().getObjectID().index instead\")]]
int getSimID() const { return getSim().getObjectID().index; }\n
[[deprecated(\"use getRec().getObjectID().index instead\")]]
int getRecID() const { return getRec().getObjectID().index; }\n
"
MutableExtraCode:
includes: "
#include <edm4eic/Cluster.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use setSim() instead; this function does nothing\")]]
void setSimID(int) { }\n
[[deprecated(\"use setRec() instead; this function does nothing\")]]
void setRecID(int) { }\n
"

edm4eic::MCRecoTrackParticleAssociation:
Description: "Association between a Track and a MCParticle"
Author : "S. Joosten"
Members:
- uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
- uint32_t recID // Index of corresponding Track (position in Tracks array)
- float weight // weight of this association
OneToOneRelations:
- edm4eic::Track rec // reference to the track
- edm4hep::MCParticle sim // reference to the Monte-Carlo particle
ExtraCode:
includes: "
#include <edm4eic/Track.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use getSim().getObjectID().index instead\")]]
int getSimID() const { return getSim().getObjectID().index; }\n
[[deprecated(\"use getRec().getObjectID().index instead\")]]
int getRecID() const { return getRec().getObjectID().index; }\n
"
MutableExtraCode:
includes: "
#include <edm4eic/Track.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use setSim() instead; this function does nothing\")]]
void setSimID(int) { }\n
[[deprecated(\"use setRec() instead; this function does nothing\")]]
void setRecID(int) { }\n
"

edm4eic::MCRecoVertexParticleAssociation:
Description: "Association between a Vertex and a MCParticle"
Author : "S. Joosten"
Members:
- uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
- uint32_t recID // Index of corresponding Vertex (position in Vertices array)
- float weight // weight of this association
OneToOneRelations:
- edm4eic::Vertex rec // reference to the vertex
- edm4hep::MCParticle sim // reference to the Monte-Carlo particle
ExtraCode:
includes: "
#include <edm4eic/Vertex.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use getSim().getObjectID().index instead\")]]
int getSimID() const { return getSim().getObjectID().index; }\n
[[deprecated(\"use getRec().getObjectID().index instead\")]]
int getRecID() const { return getRec().getObjectID().index; }\n
"
MutableExtraCode:
includes: "
#include <edm4eic/Vertex.h>\n
#include <edm4hep/MCParticle.h>\n
"
declaration: "
[[deprecated(\"use setSim() instead; this function does nothing\")]]
void setSimID(int) { }\n
[[deprecated(\"use setRec() instead; this function does nothing\")]]
void setRecID(int) { }\n
"

edm4eic::MCRecoTrackerHitAssociation:
Description: "Association between a RawTrackerHit and a SimTrackerHit"
Expand Down
Loading