Warning, /EDM4eic/edm4eic.yaml is written in an unsupported language. File is not indexed.
0001 # SPDX-License-Identifier: LGPL-3.0-or-later
0002 # Copyright (C) 2023 Sylvester Joosten, Whitney Armstrong, Wouter Deconinck, Christopher Dilks
0003 # Some datatypes based on EDM4hep. EDM4hep license applies to those sections.
0004 ---
0005 ## Schema versioning
0006 ## This is required to be an integer, and defined as 100*major+minor.
0007 ## Patch level changes are required to be schema invariant.
0008 ##
0009 ## If there are schema version changes that can be evolved, see the podio documentation
0010 ## for an example: https://github.com/AIDASoft/podio/tree/master/tests/schema_evolution
0011 ##
0012 schema_version: 820
0013
0014 options :
0015 # should getters / setters be prefixed with get / set?
0016 getSyntax: True
0017 # should POD members be exposed with getters/setters in classes that have them as members?
0018 exposePODMembers: False
0019 includeSubfolder: True
0020
0021 ## Some guidance:
0022 ## - Ensure data products usable without library dependencies (favor PODness where
0023 ## possible).
0024 ## - Move towards EDM4hep compatibility (to allow a transition to mainly use EDM4hep).
0025 ## - migrate away from custom indices in favor of podio relations
0026 ## - Use float most of the time except for 4-vectors where ppm precision is important.
0027 ## - Data alignment:
0028 ## - data should be aligned with a 64-bit structure where possible.
0029 ## - when using 32 bit values, use them in pairs (or after all 64-bit variables are defined).
0030 ## - same goes for 16-bit values (keep them aligned with the largest following component)
0031 ## - Explicitly specify the integer length (use the typedefs from <cstdint>,
0032 ## such as int32_t etc)
0033
0034 components:
0035
0036 edm4eic::CovDiag3f:
0037 Members:
0038 - float xx
0039 - float yy
0040 - float zz
0041 ExtraCode:
0042 declaration: "
0043 CovDiag3f() : xx{0}, yy{0}, zz{0} {}\n
0044 CovDiag3f(double x, double y, double z)\n
0045 : xx{static_cast<float>(x)}, yy{static_cast<float>(y)}, zz{static_cast<float>(z)} {}\n
0046 float operator()(unsigned i, unsigned j) const {return (i == j) ? *(&xx + i) : 0.;}\n
0047 "
0048
0049 edm4eic::Cov2f:
0050 Members:
0051 - float xx
0052 - float yy
0053 - float xy
0054 ExtraCode:
0055 declaration: "
0056 Cov2f() : xx{0}, yy{0}, xy{0} {}\n
0057 Cov2f(double vx, double vy, double vxy = 0)\n
0058 : xx{static_cast<float>(vx)}, yy{static_cast<float>(vy)}, xy{static_cast<float>(vxy)} {}\n
0059 float operator()(unsigned i, unsigned j) const {\n
0060 // diagonal\n
0061 if (i == j) {\n
0062 return *(&xx + i);\n
0063 }\n
0064 // off-diagonal\n
0065 // we have as options (0, 1), and (1, 0)\n
0066 // note that, starting from xy, we find the correct element at (i+j+1)/2)\n
0067 return *(&xy + (i + j + 1) / 2);\n
0068 }\n
0069 "
0070
0071 edm4eic::Cov3f:
0072 Members:
0073 - float xx
0074 - float yy
0075 - float zz
0076 - float xy
0077 - float xz
0078 - float yz
0079 ExtraCode:
0080 declaration: "
0081 Cov3f() : xx{0}, yy{0}, zz{0}, xy{0}, xz{0}, yz{0} {}\n
0082 Cov3f(double vx, double vy, double vz, double vxy = 0, double vxz = 0, double vyz = 0)\n
0083 : xx{static_cast<float>(vx)}, yy{static_cast<float>(vy)}, zz{static_cast<float>(vz)},\n
0084 xy{static_cast<float>(vxy)}, xz{static_cast<float>(vxz)}, yz{static_cast<float>(vyz)} {}\n
0085 float operator()(unsigned i, unsigned j) const {\n
0086 // diagonal\n
0087 if (i == j) {\n
0088 return *(&xx + i);\n
0089 }\n
0090 // off-diagonal\n
0091 // we have as options (0, 1), (0, 2) and (1, 2) (and mirrored)\n
0092 // note that, starting from xy, we find the correct element at (i+j-1)\n
0093 return *(&xy + i + j - 1);\n
0094 }\n
0095 "
0096
0097 edm4eic::Cov4f:
0098 Members:
0099 - float xx
0100 - float yy
0101 - float zz
0102 - float tt
0103 - float xy
0104 - float xz
0105 - float xt
0106 - float yz
0107 - float yt
0108 - float zt
0109 ExtraCode:
0110 declaration: "
0111 Cov4f() : xx{0}, yy{0}, zz{0}, tt{0}, xy{0}, xz{0}, xt{0}, yz{0}, yt{0}, zt{0} {}\n
0112 Cov4f(double vx, double vy, double vz, double vt,\n
0113 double vxy = 0, double vxz = 0, double vxt = 0,\n
0114 double vyz = 0, double vyt = 0, double vzt = 0)\n
0115 : xx{static_cast<float>(vx)}, yy{static_cast<float>(vy)}, zz{static_cast<float>(vz)}, tt{static_cast<float>(vt)},\n
0116 xy{static_cast<float>(vxy)}, xz{static_cast<float>(vxz)}, xt{static_cast<float>(vxt)},\n
0117 yz{static_cast<float>(vyz)}, yt{static_cast<float>(vyt)}, zt{static_cast<float>(vzt)} {}\n
0118 float operator()(unsigned i, unsigned j) const {\n
0119 // diagonal\n
0120 if (i == j) {\n
0121 return *(&xx + i);\n
0122 // off-diagonal, can probably be done with less if statements \n
0123 } else {\n
0124 if (i > j) { \n
0125 std::swap(i,j); \n
0126 } \n
0127 if (i == 0) { \n
0128 return *(&xy + j - 1); \n
0129 } else if (i == 1) { \n
0130 return *(&yz + j - 2); \n
0131 } else { \n
0132 return zt; \n
0133 } \n
0134 } \n
0135 }\n
0136 "
0137
0138 edm4eic::Cov6f:
0139 Members:
0140 - std::array<float, 21> covariance // 6d triangular packed covariance matrix
0141 ExtraCode:
0142 declaration: "
0143 Cov6f() : covariance{} {}\n
0144 Cov6f(std::array<float, 21> vcov) : covariance{vcov}{}\n
0145 float operator()(unsigned i, unsigned j) const {\n
0146 if(i > j) {\n
0147 std::swap(i, j);\n
0148 }\n
0149 return covariance[i + 1 + (j + 1) * (j) / 2 - 1];\n
0150 }\n
0151 float& operator()(unsigned i, unsigned j) {\n
0152 if(i > j) {\n
0153 std::swap(i, j);\n
0154 }\n
0155 return covariance[i + 1 + (j + 1) * (j) / 2 - 1];\n
0156 }\n
0157 "
0158
0159 ## A point along a track
0160 edm4eic::TrackPoint:
0161 Members:
0162 - uint64_t surface // Surface track was propagated to (possibly multiple per detector)
0163 - uint32_t system // Detector system track was propagated to
0164 - edm4hep::Vector3f position // Position of the trajectory point [mm]
0165 - edm4eic::Cov3f positionError // Error on the position
0166 - edm4hep::Vector3f momentum // 3-momentum at the point [GeV]
0167 - edm4eic::Cov3f momentumError // Error on the 3-momentum
0168 - float time // Time at this point [ns]
0169 - float timeError // Error on the time at this point
0170 - float theta // polar direction of the track at the surface [rad]
0171 - float phi // azimuthal direction of the track at the surface [rad]
0172 - edm4eic::Cov2f directionError // Error on the polar and azimuthal angles
0173 - float pathlength // Pathlength from the origin to this point
0174 - float pathlengthError // Error on the pathlength
0175
0176 ## PID hypothesis from Cherenkov detectors
0177 edm4eic::CherenkovParticleIDHypothesis:
0178 Members:
0179 - int32_t PDG // PDG code
0180 - float npe // Overall photoelectron count
0181 - float weight // Weight of this hypothesis, such as likelihood, moment, etc.
0182
0183 ## Representation of surfaces, including dynamic perigee surfaces (identical to ActsPodioEdm::Surface)
0184 edm4eic::Surface:
0185 Members:
0186 - int surfaceType // Cone = 0, Cylinder = 1, Disc = 2, Perigee = 3, Plane = 4, Straw = 5, Curvilinear = 6, Other = 7
0187 - int boundsType // eCone = 0, eCylinder = 1, eDiamond = 2, eDisc = 3, eEllipse = 4, eLine = 5, eRectangle = 6, eTrapezoid = 7, eTriangle = 8, eDiscTrapezoid = 9, eConvexPolygon = 10, eAnnulus = 11, eBoundless = 12, eOther = 13
0188 - uint64_t geometryId // bit pattern volume:8,boundary:8,layer:12,approach:8,sensitive:20,extra:8
0189 - uint64_t identifier // identifier of associated detector element, if available
0190 - std::array<double,10> boundValues // bound values, e.g. for RectangleBounds, BoundValues are eMinX = 0, eMinY = 1, eMaxX = 2, eMaxY = 3, eSize = 4
0191 - uint32_t boundValuesSize // size of bound values
0192 - std::array<double,16> transform // row-wise 4x4 affine transform [R T; 0 1] with 3x3 rotation matrix R and translation column 3-vector T
0193
0194 datatypes:
0195
0196 edm4eic::Tensor:
0197 Description: "Tensor type for use in training in inference of ML models"
0198 Author: "D. Kalinkin"
0199 Members:
0200 - int32_t elementType // Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
0201 VectorMembers:
0202 - int64_t shape // Vector of tensor lengths along its axes
0203 - float floatData // Iff elementType==1, values are stored here
0204 - int64_t int64Data // Iff elementType==7, values are stored here
0205
0206 ## ==========================================================================
0207 ## Simulation info
0208 ## ==========================================================================
0209
0210 edm4eic::SimPulse:
0211 Description: "Simulated pulse prior to digitization."
0212 Author: "D. Anderson, S. Gardner, S. Joosten., D. Kalinkin"
0213 Members:
0214 - uint64_t cellID // ID of the readout cell for this pulse.
0215 - float integral // Total pulse integral in relevant units.
0216 - edm4hep::Vector3f position // Position the pulse is evaluated in world coordinates [mm].
0217 - float time // Start time for the pulse in [ns].
0218 - float interval // Time interval between amplitude values [ns].
0219 VectorMembers:
0220 - float amplitude // Pulse amplitude in relevant units, sum of amplitude values equals integral
0221 OneToManyRelations:
0222 - edm4hep::SimCalorimeterHit calorimeterHits // SimCalorimeterHits used to create this pulse
0223 - edm4hep::SimTrackerHit trackerHits // SimTrackerHits used to create this pulse
0224 - edm4eic::SimPulse pulses // SimPulses used to create this pulse
0225 - edm4hep::MCParticle particles // MCParticle that caused the pulse
0226
0227 ## ==========================================================================
0228 ## Particle info
0229 ## ==========================================================================
0230
0231 edm4eic::ReconstructedParticle:
0232 Description: "EIC Reconstructed Particle"
0233 Author: "W. Armstrong, S. Joosten, F. Gaede"
0234 Members:
0235 - int32_t type // type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
0236 - float energy // [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
0237 - edm4hep::Vector3f momentum // [GeV] particle momentum. Four momentum state is not kept consistent internally.
0238 - edm4hep::Vector3f referencePoint // [mm] reference, i.e. where the particle has been measured
0239 - float charge // charge of the reconstructed particle.
0240 - float mass // [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
0241 - float goodnessOfPID // overall goodness of the PID on a scale of [0;1]
0242 - edm4eic::Cov4f covMatrix // covariance matrix of the reconstructed particle 4vector (10 parameters).
0243 ##@TODO: deviation from EDM4hep: store explicit PDG ID here. Needs to be discussed how we
0244 ## move forward as this could easiliy become unwieldy without this information here.
0245 ## The only acceptable alternative would be to store reconstructed identified
0246 ## particles in separate collections for the different particle types (which would
0247 ## require some algorithmic changes but might work. Doing both might even make
0248 ## sense. Needs some discussion, note that PID is more emphasized in NP than
0249 ## HEP).
0250 - int32_t PDG // PDG code for this particle
0251 ## @TODO: Do we need timing info? Or do we rely on the start vertex time?
0252 OneToOneRelations:
0253 - edm4eic::Vertex startVertex // Start vertex associated to this particle
0254 - edm4hep::ParticleID particleIDUsed // particle ID used for the kinematics of this particle
0255 OneToManyRelations:
0256 - edm4eic::Cluster clusters // Clusters used for this particle
0257 - edm4eic::Track tracks // Tracks used for this particle
0258 - edm4eic::ReconstructedParticle particles // Reconstructed particles that have been combined to this particle
0259 - edm4hep::ParticleID particleIDs // All associated particle IDs for this particle (not sorted by likelihood)
0260 ExtraCode:
0261 declaration: "
0262 bool isCompound() const {return particles_size() > 0;}\n
0263 "
0264
0265 ## ==========================================================================
0266 ## Calorimetry
0267 ## ==========================================================================
0268 edm4eic::CalorimeterHit:
0269 Description: "Calorimeter hit"
0270 Author: "W. Armstrong, S. Joosten"
0271 Members:
0272 - uint64_t cellID // The detector specific (geometrical) cell id.
0273 - float energy // The energy for this hit in [GeV].
0274 - float energyError // Error on energy [GeV].
0275 - float time // The time of the hit in [ns].
0276 - float timeError // Error on the time
0277 - edm4hep::Vector3f position // The global position of the hit in world coordinates [mm].
0278 - edm4hep::Vector3f dimension // The dimension information of the cell [mm].
0279 - int32_t sector // Sector that this hit occurred in
0280 - int32_t layer // Layer that the hit occurred in
0281 - edm4hep::Vector3f local // The local coordinates of the hit in the detector segment [mm].
0282 OneToOneRelations:
0283 - edm4hep::RawCalorimeterHit rawHit // Related raw calorimeter hit
0284
0285 ## ==========================================================================
0286 ## Clustering
0287 ## ==========================================================================
0288
0289 edm4eic::ProtoCluster:
0290 Description: "Collection of hits identified by the clustering algorithm to belong together"
0291 Author: "S. Joosten"
0292 OneToManyRelations:
0293 - edm4eic::CalorimeterHit hits // Hits associated with this cluster
0294 VectorMembers:
0295 - float weights // Weight for each of the hits, mirrors hits array
0296
0297 edm4eic::Cluster:
0298 Description: "EIC hit cluster, reworked to more closely resemble EDM4hep"
0299 Author: "W. Armstrong, S. Joosten, C.Peng"
0300 Members:
0301 # main variables
0302 - int32_t type // Flag-word that defines the type of the cluster
0303 - float energy // Reconstructed energy of the cluster [GeV].
0304 - float energyError // Error on the cluster energy [GeV]
0305 - float time // [ns]
0306 - float timeError // Error on the cluster time
0307 - uint32_t nhits // Number of hits in the cluster.
0308 - edm4hep::Vector3f position // Global position of the cluster [mm].
0309 - edm4eic::Cov3f positionError // Covariance matrix of the position (6 Parameters).
0310 - float intrinsicTheta // Intrinsic cluster propagation direction polar angle [rad]
0311 - float intrinsicPhi // Intrinsic cluster propagation direction azimuthal angle [rad]
0312 - edm4eic::Cov2f intrinsicDirectionError // Error on the intrinsic cluster propagation direction
0313 VectorMembers:
0314 - float shapeParameters // Should be set in metadata, for now it's a list of -- radius [mm], dispersion [mm], 2 entries for theta-phi widths [rad], 3 entries for x-y-z widths [mm].
0315 - float hitContributions // Energy contributions of the hits. Runs parallel to ::hits()
0316 - float subdetectorEnergies // Energies observed in each subdetector used for this cluster.
0317 OneToManyRelations:
0318 - edm4eic::Cluster clusters // Clusters that have been combined to form this cluster
0319 - edm4eic::CalorimeterHit hits // Hits that have been combined to form this cluster
0320 - edm4hep::ParticleID particleIDs // Particle IDs sorted by likelihood
0321
0322 ## ==========================================================================
0323 ## RICH/Cherenkov and PID
0324 ## ==========================================================================
0325
0326 edm4eic::PMTHit:
0327 Description: "EIC PMT hit"
0328 Author: "S. Joosten, C. Peng"
0329 Members:
0330 - uint64_t cellID // The detector specific (geometrical) cell id.
0331 - float npe // Estimated number of photo-electrons [#]
0332 # @TODO do we need an uncertainty on NPE?
0333 - float time // Time [ns]
0334 - float timeError // Error on the time [ns]
0335 - edm4hep::Vector3f position // PMT hit position [mm]
0336 - edm4hep::Vector3f dimension // The dimension information of the pixel [mm].
0337 - int32_t sector // The sector this hit occurred in
0338 - edm4hep::Vector3f local // The local position of the hit in detector coordinates (relative to the sector) [mm]
0339
0340 edm4eic::CherenkovParticleID:
0341 Description: "Cherenkov detector PID"
0342 Author: "A. Kiselev, C. Chatterjee, C. Dilks"
0343 Members:
0344 - float npe // Overall photoelectron count
0345 - float refractiveIndex // Average refractive index at the Cherenkov photons' vertices
0346 - float photonEnergy // Average energy for these Cherenkov photons [GeV]
0347 VectorMembers:
0348 - edm4eic::CherenkovParticleIDHypothesis hypotheses // Evaluated PDG hypotheses
0349 - edm4hep::Vector2f thetaPhiPhotons // estimated (theta,phi) for each Cherenkov photon
0350 OneToOneRelations:
0351 - edm4eic::TrackSegment chargedParticle // reconstructed charged particle
0352 OneToManyRelations:
0353 - edm4eic::MCRecoTrackerHitAssociation rawHitAssociations // raw sensor hits, associated with MC hits
0354
0355 edm4eic::RingImage:
0356 ##@TODO: Juggler support; not used in EICrecon
0357 Description: "EIC Ring Image Cluster"
0358 Author: "S. Joosten, C. Peng"
0359 Members:
0360 - float npe // Number of photo-electrons [#]
0361 - edm4hep::Vector3f position // Global position of the cluster [mm]
0362 - edm4hep::Vector3f positionError // Error on the position
0363 - float theta // Opening angle of the ring [rad, 0->pi]
0364 - float thetaError // Error on the opening angle
0365 - float radius // Radius of the best fit ring [mm]
0366 - float radiusError // Estimated error from the fit [mm]
0367
0368 ## ==========================================================================
0369 ## Tracking
0370 ## ==========================================================================
0371
0372 edm4eic::RawTrackerHit:
0373 Description: "Raw (digitized) tracker hit"
0374 Author: "W. Armstrong, S. Joosten"
0375 Members:
0376 - uint64_t cellID // The detector specific (geometrical) cell id.
0377 - int32_t charge // ADC value
0378 ## @TODO: is charge appropriate here? Needs revisiting.
0379 - int32_t timeStamp // TDC value.
0380
0381 edm4eic::TrackerHit:
0382 Description: "Tracker hit (reconstructed from Raw)"
0383 Author: "W. Armstrong, S. Joosten"
0384 Members:
0385 - uint64_t cellID // The detector specific (geometrical) cell id.
0386 - edm4hep::Vector3f position // Hit (cell) position [mm]
0387 - edm4eic::CovDiag3f positionError // Covariance Matrix
0388 - float time // Hit time [ns]
0389 - float timeError // Error on the time
0390 - float edep // Energy deposit in this hit [GeV]
0391 - float edepError // Error on the energy deposit [GeV]
0392 OneToOneRelations:
0393 - edm4eic::RawTrackerHit rawHit // Related raw tracker hit
0394
0395 edm4eic::Measurement2D:
0396 Description: "2D measurement (on an arbitrary surface)"
0397 Author: "W. Deconinck"
0398 Members:
0399 - uint64_t surface // Surface for bound coordinates (geometryID)
0400 - edm4hep::Vector2f loc // 2D location on surface
0401 - float time // Measurement time
0402 - edm4eic::Cov3f covariance // Covariance on location and time
0403 VectorMembers:
0404 - float weights // Weight for each of the hits, mirrors hits array
0405 OneToManyRelations:
0406 - edm4eic::TrackerHit hits // Hits in this measurement (single or clustered)
0407
0408 edm4eic::TrackSeed:
0409 Description: "Seed info from the realistic seed finder"
0410 Author: "S. Li, B. Schmookler, J. Osborn"
0411 Members:
0412 - edm4hep::Vector3f perigee // Vector for the perigee (line surface)
0413 OneToManyRelations:
0414 - edm4eic::TrackerHit hits // Tracker hits triplet for seeding
0415 OneToOneRelations:
0416 - edm4eic::TrackParameters params // Initial track parameters
0417
0418 edm4eic::Trajectory:
0419 Description: "Raw trajectory from the tracking algorithm. What is called hit here is 2d measurement indeed."
0420 Author: "S. Joosten, S. Li"
0421 Members:
0422 - uint32_t type // 0 (does not have good track fit), 1 (has good track fit)
0423 - uint32_t nStates // Number of tracking steps
0424 - uint32_t nMeasurements // Number of hits used
0425 - uint32_t nOutliers // Number of hits not considered
0426 - uint32_t nHoles // Number of missing hits
0427 - uint32_t nSharedHits // Number of shared hits with other trajectories
0428 VectorMembers:
0429 - float measurementChi2 // Chi2 for each of the measurements
0430 - float outlierChi2 // Chi2 for each of the outliers
0431 OneToManyRelations:
0432 - edm4eic::TrackParameters trackParameters // Associated track parameters, if any
0433 - edm4eic::Measurement2D measurements_deprecated // Measurements that were used for this track. Will move this to the edm4eic::Track
0434 - edm4eic::Measurement2D outliers_deprecated // Measurements that were not used for this track. Will move this to the edm4eic::Track
0435 OneToOneRelations:
0436 - edm4eic::TrackSeed seed // Corresponding track seed
0437
0438 edm4eic::TrackParameters:
0439 Description: "ACTS Bound Track parameters"
0440 Author: "W. Armstrong, S. Joosten, J. Osborn"
0441 Members:
0442 - int32_t type // Type of track parameters (-1/seed, 0/head, ...)
0443 - uint64_t surface // Surface for bound parameters (geometryID)
0444 - edm4hep::Vector2f loc // 2D location on surface
0445 - float theta // Track polar angle [rad]
0446 - float phi // Track azimuthal angle [rad]
0447 - float qOverP // [e/GeV]
0448 - float time // Track time [ns]
0449 - int32_t pdg // pdg pid for these parameters
0450 - edm4eic::Cov6f covariance // Full covariance in basis [l0,l1,theta,phi,q/p,t]
0451
0452
0453 edm4eic::Track:
0454 Description: "Track information at the vertex"
0455 Author: "S. Joosten, J. Osborn"
0456 Members:
0457 - int32_t type // Flag that defines the type of track
0458 - edm4hep::Vector3f position // Track 3-position at the vertex
0459 - edm4hep::Vector3f momentum // Track 3-momentum at the vertex [GeV]
0460 - edm4eic::Cov6f positionMomentumCovariance // Covariance matrix in basis [x,y,z,px,py,pz]
0461 - float time // Track time at the vertex [ns]
0462 - float timeError // Error on the track vertex time
0463 - float charge // Particle charge
0464 - float chi2 // Total chi2
0465 - uint32_t ndf // Number of degrees of freedom
0466 - int32_t pdg // PDG particle ID hypothesis
0467 OneToOneRelations:
0468 - edm4eic::Trajectory trajectory // Trajectory of this track
0469 OneToManyRelations:
0470 - edm4eic::Measurement2D measurements // Measurements that were used for this track
0471 - edm4eic::Track tracks // Tracks (segments) that have been combined to create this track
0472
0473 edm4eic::TrackSegment:
0474 Description: "A track segment defined by one or more points along a track."
0475 Author: "S. Joosten"
0476 Members:
0477 - float length // Pathlength from the first to the last point
0478 - float lengthError // Error on the segment length
0479 OneToOneRelations:
0480 - edm4eic::Track track // Track used for this projection
0481 VectorMembers:
0482 - edm4eic::TrackPoint points // Points where the track parameters were evaluated
0483
0484 ## ==========================================================================
0485 ## Vertexing
0486 ## ==========================================================================
0487
0488 edm4eic::Vertex:
0489 Description: "EIC vertex"
0490 Author: "J. Osborn"
0491 Members:
0492 - int32_t type // Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
0493 - float chi2 // Chi-squared of the vertex fit
0494 - int ndf // NDF of the vertex fit
0495 - edm4hep::Vector4f position // position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector
0496 ## this is named "covMatrix" in EDM4hep, renamed for consistency with the rest of edm4eic
0497 - edm4eic::Cov4f positionError // Covariance matrix of the position+time. Time is 4th component, similarly to 4vector
0498 OneToManyRelations:
0499 - edm4eic::ReconstructedParticle associatedParticles // particles associated to this vertex.
0500
0501 ## ==========================================================================
0502 ## Kinematic reconstruction
0503 ## ==========================================================================
0504
0505 edm4eic::InclusiveKinematics:
0506 Description: "Kinematic variables for DIS events"
0507 Author: "S. Joosten, W. Deconinck"
0508 Members:
0509 - float x // Bjorken x (Q2/2P.q)
0510 - float Q2 // Four-momentum transfer squared [GeV^2]
0511 - float W // Invariant mass of final state [GeV]
0512 - float y // Inelasticity (P.q/P.k)
0513 - float nu // Energy transfer P.q/M [GeV]
0514 OneToOneRelations:
0515 - edm4eic::ReconstructedParticle scat // Associated scattered electron (if identified)
0516 ## @TODO: Spin state?
0517 ## - phi_S?
0518
0519 edm4eic::HadronicFinalState:
0520 Description: "Summed quantities of the hadronic final state"
0521 Author: "T. Kutz"
0522 Members:
0523 - float sigma // Longitudinal energy-momentum balance (aka E - pz)
0524 - float pT // Transverse momentum
0525 - float gamma // Hadronic angle
0526 OneToManyRelations:
0527 - edm4eic::ReconstructedParticle hadrons // Reconstructed hadrons used in calculation
0528
0529 ## ==========================================================================
0530 ## Data-Montecarlo relations
0531 ## ==========================================================================
0532
0533 edm4eic::MCRecoParticleAssociation:
0534 Description: "Used to keep track of the correspondence between MC and reconstructed particles"
0535 Author: "S. Joosten"
0536 Members:
0537 - uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
0538 - uint32_t recID // Index of corresponding ReconstructedParticle (position in ReconstructedParticles array)
0539 - float weight // weight of this association
0540 OneToOneRelations :
0541 - edm4eic::ReconstructedParticle rec // reference to the reconstructed particle
0542 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0543
0544 edm4eic::MCRecoClusterParticleAssociation:
0545 Description: "Association between a Cluster and a MCParticle"
0546 Author : "S. Joosten"
0547 Members:
0548 - uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
0549 - uint32_t recID // Index of corresponding Cluster (position in Clusters array)
0550 - float weight // weight of this association
0551 OneToOneRelations:
0552 - edm4eic::Cluster rec // reference to the cluster
0553 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0554
0555 edm4eic::MCRecoTrackParticleAssociation:
0556 Description: "Association between a Track and a MCParticle"
0557 Author : "S. Joosten"
0558 Members:
0559 - uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
0560 - uint32_t recID // Index of corresponding Track (position in Tracks array)
0561 - float weight // weight of this association
0562 OneToOneRelations:
0563 - edm4eic::Track rec // reference to the track
0564 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0565
0566 edm4eic::MCRecoVertexParticleAssociation:
0567 Description: "Association between a Vertex and a MCParticle"
0568 Author : "S. Joosten"
0569 Members:
0570 - uint32_t simID // Index of corresponding MCParticle (position in MCParticles array)
0571 - uint32_t recID // Index of corresponding Vertex (position in Vertices array)
0572 - float weight // weight of this association
0573 OneToOneRelations:
0574 - edm4eic::Vertex rec // reference to the vertex
0575 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0576
0577 edm4eic::MCRecoTrackerHitAssociation:
0578 Description: "Association between a RawTrackerHit and a SimTrackerHit"
0579 Author: "C. Dilks, W. Deconinck"
0580 Members:
0581 - float weight // weight of this association
0582 OneToOneRelations:
0583 - edm4eic::RawTrackerHit rawHit // reference to the digitized hit
0584 - edm4hep::SimTrackerHit simHit // reference to the simulated hit
0585
0586 edm4eic::MCRecoCalorimeterHitAssociation:
0587 Description: "Association between a RawCalorimeterHit and a SimCalorimeterHit"
0588 Author: "S. Rahman"
0589 Members:
0590 - float weight // weight of this association
0591 OneToOneRelations:
0592 - edm4hep::RawCalorimeterHit rawHit // reference to the digitized calorimeter hit
0593 - edm4hep::SimCalorimeterHit simHit // reference to the simulated calorimeter hit
0594
0595 edm4eic::TrackClusterMatch:
0596 Description: "Match between a Cluster and a Track"
0597 Author: "D. Anderson, D. Brandenburg, D. Kalinkin, S. Joosten"
0598 Members:
0599 - float weight // weight of this association
0600 OneToOneRelations:
0601 - edm4eic::Cluster cluster // reference to the cluster
0602 - edm4eic::Track track // reference to the track
0603
0604 links:
0605 edm4eic::TrackProtoClusterLink:
0606 Description: "Link between a ProtoCluster and a Track"
0607 Author: "D. Anderson, D. Kalinkin"
0608 From: edm4eic::Track
0609 To: edm4eic::ProtoCluster
