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+10*minor+patch.
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: 890
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 ## An individual sample output by a CALOROC1A chip
0195 edm4eic::CALOROC1ASample:
0196 Members:
0197 - uint16_t ADC // [ADC Counts], amplitude of signal during sample, valid IFF TOTInProgress is false
0198 - uint16_t timeOfArrival // Time of arrival (TOA) [TDC counts], nonzero IFF ADC crossed threshold upwards during sample
0199 - uint16_t timeOverThreshold // Time over threshold (TOT) [TDC counts], nonzero IFF ADC crossed threshold downwards during sample AND if TOA fired in a previous sample
0200
0201 ## An individual sample output by a CALOROC1B chip
0202 edm4eic::CALOROC1BSample:
0203 Members:
0204 - uint16_t lowGainADC // [ADC Counts], amplitude of signal during sample in the low gain mode
0205 - uint16_t highGainADC // [ADC Counts], amplitude of signal during sample in the high gain mode
0206 - uint16_t timeOfArrival // Time of arrival (TOA) [TDC counts]
0207
0208 ## Event-level truthiness information
0209 edm4eic::TruthinessContribution:
0210 Members:
0211 - float pid // Contribution of PID matching to truthiness
0212 - float energy // Contribution of energy matching to truthiness
0213 - float momentum // Contribution of momentum matching to truthiness
0214
0215 datatypes:
0216
0217 edm4eic::Tensor:
0218 Description: "Tensor type for use in training in inference of ML models"
0219 Author: "D. Kalinkin"
0220 Members:
0221 - int32_t elementType // Data type in the same encoding as "ONNXTensorElementDataType", 1 - float, 7 - int64
0222 VectorMembers:
0223 - int64_t shape // Vector of tensor lengths along its axes
0224 - float floatData // Iff elementType==1, values are stored here
0225 - int64_t int64Data // Iff elementType==7, values are stored here
0226
0227 ## ==========================================================================
0228 ## Simulation info
0229 ## ==========================================================================
0230
0231 edm4eic::SimPulse:
0232 Description: "Simulated pulse prior to digitization."
0233 Author: "D. Anderson, S. Gardner, S. Joosten., D. Kalinkin"
0234 Members:
0235 - uint64_t cellID // ID of the readout cell for this pulse.
0236 - float integral // Total pulse integral in relevant units.
0237 - edm4hep::Vector3f position // Position the pulse is evaluated in world coordinates [mm].
0238 - float time // Start time for the pulse in [ns].
0239 - float interval // Time interval between amplitude values [ns].
0240 VectorMembers:
0241 - float amplitude // Pulse amplitude in relevant units, sum of amplitude values equals integral
0242 OneToManyRelations:
0243 - edm4hep::SimCalorimeterHit calorimeterHits // SimCalorimeterHits used to create this pulse
0244 - edm4hep::SimTrackerHit trackerHits // SimTrackerHits used to create this pulse
0245 - edm4eic::SimPulse pulses // SimPulses used to create this pulse
0246 - edm4hep::MCParticle particles // MCParticle that caused the pulse
0247
0248 ## ==========================================================================
0249 ## Particle info
0250 ## ==========================================================================
0251
0252 edm4eic::ReconstructedParticle:
0253 Description: "EIC Reconstructed Particle"
0254 Author: "W. Armstrong, S. Joosten, F. Gaede"
0255 Members:
0256 - int32_t type // type of reconstructed particle. Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.
0257 - float energy // [GeV] energy of the reconstructed particle. Four momentum state is not kept consistent internally.
0258 - edm4hep::Vector3f momentum // [GeV] particle momentum. Four momentum state is not kept consistent internally.
0259 - edm4hep::Vector3f referencePoint // [mm] reference, i.e. where the particle has been measured
0260 - float charge // charge of the reconstructed particle.
0261 - float mass // [GeV] mass of the reconstructed particle, set independently from four vector. Four momentum state is not kept consistent internally.
0262 - float goodnessOfPID // overall goodness of the PID on a scale of [0;1]
0263 - edm4eic::Cov4f covMatrix // covariance matrix of the reconstructed particle 4vector (10 parameters).
0264 - int32_t PDG // PDG code for this particle
0265 ## @TODO: Do we need timing info? Or do we rely on the start vertex time?
0266 OneToOneRelations:
0267 - edm4eic::Vertex startVertex // Start vertex associated to this particle
0268 - edm4hep::ParticleID particleIDUsed // particle ID used for the kinematics of this particle
0269 OneToManyRelations:
0270 - edm4eic::Cluster clusters // Clusters used for this particle
0271 - edm4eic::Track tracks // Tracks used for this particle
0272 - edm4eic::ReconstructedParticle particles // Reconstructed particles that have been combined to this particle
0273 - edm4hep::ParticleID particleIDs // All associated particle IDs for this particle (not sorted by likelihood)
0274 ExtraCode:
0275 declaration: "
0276 bool isCompound() const {return particles_size() > 0;}\n
0277 "
0278
0279 ## ==========================================================================
0280 ## Calorimetry
0281 ## ==========================================================================
0282
0283 edm4eic::RawCALOROCHit:
0284 Description: "Raw hit from a CALOROC1A/B chip"
0285 Author: "D. Anderson, S. Joosten, T. Protzman, N. Novitzky, D. Kalinkin, M. Zurek, M. H. Kim"
0286 Members:
0287 - uint64_t cellID // Detector specific (geometrical) cell id
0288 - int32_t samplePhase // Phase of samples in [# samples], for synchronizing across chips
0289 - int32_t timeStamp // [TDC counts]
0290 VectorMembers:
0291 - edm4eic::CALOROC1ASample aSamples // ADC, Time of Arrival (TOA), and Time over Threshold (TOT) values for each sample read out
0292 - edm4eic::CALOROC1BSample bSamples // Low- and high-gain ADC and Time of Arrival (TOA) values for each sample read out
0293
0294 edm4eic::CalorimeterHit:
0295 Description: "Calorimeter hit"
0296 Author: "W. Armstrong, S. Joosten"
0297 Members:
0298 - uint64_t cellID // The detector specific (geometrical) cell id.
0299 - float energy // The energy for this hit in [GeV].
0300 - float energyError // Error on energy [GeV].
0301 - float time // The time of the hit in [ns].
0302 - float timeError // Error on the time
0303 - edm4hep::Vector3f position // The global position of the hit in world coordinates [mm].
0304 - edm4hep::Vector3f dimension // The dimension information of the cell [mm].
0305 - int32_t sector // Sector that this hit occurred in
0306 - int32_t layer // Layer that the hit occurred in
0307 - edm4hep::Vector3f local // The local coordinates of the hit in the detector segment [mm].
0308 OneToOneRelations:
0309 - edm4hep::RawCalorimeterHit rawHit // Related raw calorimeter hit
0310
0311 ## ==========================================================================
0312 ## Clustering
0313 ## ==========================================================================
0314
0315 edm4eic::ProtoCluster:
0316 Description: "Collection of hits identified by the clustering algorithm to belong together"
0317 Author: "S. Joosten"
0318 OneToManyRelations:
0319 - edm4eic::CalorimeterHit hits // Hits associated with this cluster
0320 VectorMembers:
0321 - float weights // Weight for each of the hits, mirrors hits array
0322
0323 edm4eic::Cluster:
0324 Description: "EIC hit cluster, reworked to more closely resemble EDM4hep"
0325 Author: "W. Armstrong, S. Joosten, C.Peng"
0326 Members:
0327 # main variables
0328 - int32_t type // Flag-word that defines the type of the cluster
0329 - float energy // Reconstructed energy of the cluster [GeV].
0330 - float energyError // Error on the cluster energy [GeV]
0331 - float time // [ns]
0332 - float timeError // Error on the cluster time
0333 - uint32_t nhits // Number of hits in the cluster.
0334 - edm4hep::Vector3f position // Global position of the cluster [mm].
0335 - edm4eic::Cov3f positionError // Covariance matrix of the position (6 Parameters).
0336 - float intrinsicTheta // Intrinsic cluster propagation direction polar angle [rad]
0337 - float intrinsicPhi // Intrinsic cluster propagation direction azimuthal angle [rad]
0338 - edm4eic::Cov2f intrinsicDirectionError // Error on the intrinsic cluster propagation direction
0339 VectorMembers:
0340 - 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].
0341 - float hitContributions // Energy contributions of the hits. Runs parallel to ::hits()
0342 - float subdetectorEnergies // Energies observed in each subdetector used for this cluster.
0343 OneToManyRelations:
0344 - edm4eic::Cluster clusters // Clusters that have been combined to form this cluster
0345 - edm4eic::CalorimeterHit hits // Hits that have been combined to form this cluster
0346 - edm4hep::ParticleID particleIDs // Particle IDs sorted by likelihood
0347
0348 ## ==========================================================================
0349 ## RICH/Cherenkov and PID
0350 ## ==========================================================================
0351
0352 edm4eic::PMTHit:
0353 Description: "EIC PMT hit"
0354 Author: "S. Joosten, C. Peng"
0355 Members:
0356 - uint64_t cellID // The detector specific (geometrical) cell id.
0357 - float npe // Estimated number of photo-electrons [#]
0358 # @TODO do we need an uncertainty on NPE?
0359 - float time // Time [ns]
0360 - float timeError // Error on the time [ns]
0361 - edm4hep::Vector3f position // PMT hit position [mm]
0362 - edm4hep::Vector3f dimension // The dimension information of the pixel [mm].
0363 - int32_t sector // The sector this hit occurred in
0364 - edm4hep::Vector3f local // The local position of the hit in detector coordinates (relative to the sector) [mm]
0365
0366 edm4eic::CherenkovParticleID:
0367 Description: "Cherenkov detector PID"
0368 Author: "A. Kiselev, C. Chatterjee, C. Dilks"
0369 Members:
0370 - float npe // Overall photoelectron count
0371 - float refractiveIndex // Average refractive index at the Cherenkov photons' vertices
0372 - float photonEnergy // Average energy for these Cherenkov photons [GeV]
0373 VectorMembers:
0374 - edm4eic::CherenkovParticleIDHypothesis hypotheses // Evaluated PDG hypotheses
0375 - edm4hep::Vector2f thetaPhiPhotons // estimated (theta,phi) for each Cherenkov photon
0376 OneToOneRelations:
0377 - edm4eic::TrackSegment chargedParticle // reconstructed charged particle
0378 OneToManyRelations:
0379 - edm4eic::MCRecoTrackerHitAssociation rawHitAssociations // raw sensor hits, associated with MC hits
0380
0381 edm4eic::IrtRadiatorInfo:
0382 Description: "IRT 2.1 output (radiator level)"
0383 Author: "A. Kiselev"
0384 Members:
0385 - uint16_t npe // Detected photoelectron count
0386 - uint16_t nhits // Hit count associated with this radiator by IRT engine
0387 - float angle // Reconstructed Cherenkov angle
0388
0389 edm4eic::IrtParticle:
0390 Description: "IRT 2.1 output (track level)"
0391 Author: "A. Kiselev"
0392 Members:
0393 - int32_t PDG // Reconstructed most probable PDG code
0394 - uint16_t npe // Detected photoelectron count
0395 - uint16_t nhits // Hit count associated with this particle by IRT engine
0396 OneToOneRelations:
0397 - edm4eic::Track track // charged particle track
0398 OneToManyRelations:
0399 - edm4eic::IrtRadiatorInfo radiators // radiator-related information
0400
0401 edm4eic::RingImage:
0402 ##@TODO: Juggler support; not used in EICrecon
0403 Description: "EIC Ring Image Cluster"
0404 Author: "S. Joosten, C. Peng"
0405 Members:
0406 - float npe // Number of photo-electrons [#]
0407 - edm4hep::Vector3f position // Global position of the cluster [mm]
0408 - edm4hep::Vector3f positionError // Error on the position
0409 - float theta // Opening angle of the ring [rad, 0->pi]
0410 - float thetaError // Error on the opening angle
0411 - float radius // Radius of the best fit ring [mm]
0412 - float radiusError // Estimated error from the fit [mm]
0413
0414 ## ==========================================================================
0415 ## Tracking
0416 ## ==========================================================================
0417
0418 edm4eic::RawTrackerHit:
0419 Description: "Raw (digitized) tracker hit"
0420 Author: "W. Armstrong, S. Joosten"
0421 Members:
0422 - uint64_t cellID // The detector specific (geometrical) cell id.
0423 - int32_t charge // ADC value
0424 ## @TODO: is charge appropriate here? Needs revisiting.
0425 - int32_t timeStamp // TDC value.
0426
0427 edm4eic::TrackerHit:
0428 Description: "Tracker hit (reconstructed from Raw)"
0429 Author: "W. Armstrong, S. Joosten"
0430 Members:
0431 - uint64_t cellID // The detector specific (geometrical) cell id.
0432 - edm4hep::Vector3f position // Hit (cell) position [mm]
0433 - edm4eic::CovDiag3f positionError // Covariance Matrix
0434 - float time // Hit time [ns]
0435 - float timeError // Error on the time
0436 - float edep // Energy deposit in this hit [GeV]
0437 - float edepError // Error on the energy deposit [GeV]
0438 OneToOneRelations:
0439 - edm4eic::RawTrackerHit rawHit // Related raw tracker hit
0440
0441 edm4eic::Measurement2D:
0442 Description: "2D measurement (on an arbitrary surface)"
0443 Author: "W. Deconinck"
0444 Members:
0445 - uint64_t surface // Surface for bound coordinates (geometryID)
0446 - edm4hep::Vector2f loc // 2D location on surface
0447 - float time // Measurement time
0448 - edm4eic::Cov3f covariance // Covariance on location and time
0449 VectorMembers:
0450 - float weights // Weight for each of the hits, mirrors hits array
0451 OneToManyRelations:
0452 - edm4eic::TrackerHit hits // Hits in this measurement (single or clustered)
0453
0454 edm4eic::TrackSeed:
0455 Description: "Seed info from the realistic seed finder"
0456 Author: "S. Li, B. Schmookler, J. Osborn"
0457 Members:
0458 - edm4hep::Vector3f perigee // Vector for the perigee (line surface)
0459 - float quality // Seed quality reported by finder
0460 OneToManyRelations:
0461 - edm4eic::TrackerHit hits // Tracker hits triplet for seeding
0462 OneToOneRelations:
0463 - edm4eic::TrackParameters params // Initial track parameters
0464
0465 edm4eic::Trajectory:
0466 Description: "Raw trajectory from the tracking algorithm. What is called hit here is 2d measurement indeed."
0467 Author: "S. Joosten, S. Li"
0468 Members:
0469 - uint32_t type // 0 (does not have good track fit), 1 (has good track fit)
0470 - uint32_t nStates // Number of tracking steps
0471 - uint32_t nMeasurements // Number of hits used
0472 - uint32_t nOutliers // Number of hits not considered
0473 - uint32_t nHoles // Number of missing hits
0474 - uint32_t nSharedHits // Number of shared hits with other trajectories
0475 VectorMembers:
0476 - float measurementChi2 // Chi2 for each of the measurements
0477 - float outlierChi2 // Chi2 for each of the outliers
0478 OneToManyRelations:
0479 - edm4eic::TrackParameters trackParameters // Associated track parameters, if any
0480 - edm4eic::Measurement2D measurements_deprecated // Measurements that were used for this track. Will move this to the edm4eic::Track
0481 - edm4eic::Measurement2D outliers_deprecated // Measurements that were not used for this track. Will move this to the edm4eic::Track
0482 OneToOneRelations:
0483 - edm4eic::TrackSeed seed // Corresponding track seed
0484
0485 edm4eic::TrackParameters:
0486 Description: "ACTS Bound Track parameters"
0487 Author: "W. Armstrong, S. Joosten, J. Osborn"
0488 Members:
0489 - int32_t type // Type of track parameters (-1/seed, 0/head, ...)
0490 - uint64_t surface // Surface for bound parameters (geometryID)
0491 - edm4hep::Vector2f loc // 2D location on surface
0492 - float theta // Track polar angle [rad]
0493 - float phi // Track azimuthal angle [rad]
0494 - float qOverP // [e/GeV]
0495 - float time // Track time [ns]
0496 - int32_t pdg // pdg pid for these parameters
0497 - edm4eic::Cov6f covariance // Full covariance in basis [l0,l1,theta,phi,q/p,t]
0498
0499
0500 edm4eic::Track:
0501 Description: "Track information at the vertex"
0502 Author: "S. Joosten, J. Osborn"
0503 Members:
0504 - int32_t type // Flag that defines the type of track
0505 - edm4hep::Vector3f position // Track 3-position at the vertex
0506 - edm4hep::Vector3f momentum // Track 3-momentum at the vertex [GeV]
0507 - edm4eic::Cov6f positionMomentumCovariance // Covariance matrix in basis [x,y,z,px,py,pz]
0508 - float time // Track time at the vertex [ns]
0509 - float timeError // Error on the track vertex time
0510 - float charge // Particle charge
0511 - float chi2 // Total chi2
0512 - uint32_t ndf // Number of degrees of freedom
0513 - int32_t pdg // PDG particle ID hypothesis
0514 OneToOneRelations:
0515 - edm4eic::Trajectory trajectory // Trajectory of this track
0516 OneToManyRelations:
0517 - edm4eic::Measurement2D measurements // Measurements that were used for this track
0518 - edm4eic::Track tracks // Tracks (segments) that have been combined to create this track
0519
0520 edm4eic::TrackSegment:
0521 Description: "A track segment defined by one or more points along a track."
0522 Author: "S. Joosten"
0523 Members:
0524 - float length // Pathlength from the first to the last point
0525 - float lengthError // Error on the segment length
0526 OneToOneRelations:
0527 - edm4eic::Track track // Track used for this projection
0528 VectorMembers:
0529 - edm4eic::TrackPoint points // Points where the track parameters were evaluated
0530
0531 ## ==========================================================================
0532 ## Vertexing
0533 ## ==========================================================================
0534
0535 edm4eic::Vertex:
0536 Description: "EIC vertex"
0537 Author: "J. Osborn"
0538 Members:
0539 - int32_t type // Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
0540 - float chi2 // Chi-squared of the vertex fit
0541 - int ndf // NDF of the vertex fit
0542 - edm4hep::Vector4f position // position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector
0543 ## this is named "covMatrix" in EDM4hep, renamed for consistency with the rest of edm4eic
0544 - edm4eic::Cov4f positionError // Covariance matrix of the position+time. Time is 4th component, similarly to 4vector
0545 OneToManyRelations:
0546 - edm4eic::ReconstructedParticle associatedParticles // particles associated to this vertex.
0547
0548 ## ==========================================================================
0549 ## Kinematic reconstruction
0550 ## ==========================================================================
0551
0552 edm4eic::InclusiveKinematics:
0553 Description: "Kinematic variables for DIS events"
0554 Author: "S. Joosten, W. Deconinck"
0555 Members:
0556 - float x // Bjorken x (Q2/2P.q)
0557 - float Q2 // Four-momentum transfer squared [GeV^2]
0558 - float W // Invariant mass of final state [GeV]
0559 - float y // Inelasticity (P.q/P.k)
0560 - float nu // Energy transfer P.q/M [GeV]
0561 OneToOneRelations:
0562 - edm4eic::ReconstructedParticle scat // Associated scattered electron (if identified)
0563 ## @TODO: Spin state?
0564 ## - phi_S?
0565
0566 edm4eic::HadronicFinalState:
0567 Description: "Summed quantities of the hadronic final state"
0568 Author: "T. Kutz"
0569 Members:
0570 - float sigma // Longitudinal energy-momentum balance (aka E - pz)
0571 - float pT // Transverse momentum
0572 - float gamma // Hadronic angle
0573 OneToManyRelations:
0574 - edm4eic::ReconstructedParticle hadrons // Reconstructed hadrons used in calculation
0575
0576 edm4eic::Jet:
0577 Description: "A reconstructed jet, inspired by the FastJet PseudoJet"
0578 Author: "D. Anderson"
0579 Members:
0580 - uint32_t type // Jet type as enumerated in fastjet::JetAlgorithm
0581 - float area // Jet area
0582 - float energy // Jet energy [GeV]
0583 - float backgroundEnergyDensity // Background energy density [GeV/area]
0584 - edm4hep::Vector3f momentum // Jet 3-momentum [GeV]
0585 OneToManyRelations:
0586 - edm4eic::ReconstructedParticle constituents // Constituents of this jet
0587 ExtraCode:
0588 declaration: "
0589 /// Compute the background energy in [GeV]\n
0590 float getBackgroundEnergy() const { return getArea() * getBackgroundEnergyDensity(); }\n
0591 "
0592
0593 ## ==========================================================================
0594 ## Data-Monte Carlo relations
0595 ## ==========================================================================
0596
0597 edm4eic::MCRecoParticleAssociation:
0598 Description: "Used to keep track of the correspondence between MC and reconstructed particles"
0599 Author: "S. Joosten"
0600 Members:
0601 - float weight // weight of this association
0602 OneToOneRelations :
0603 - edm4eic::ReconstructedParticle rec // reference to the reconstructed particle
0604 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0605 ExtraCode:
0606 includes: "
0607 #include <edm4eic/ReconstructedParticle.h>\n
0608 #include <edm4hep/MCParticle.h>\n
0609 "
0610 declaration: "
0611 [[deprecated(\"use getSim().getObjectID().index instead\")]]
0612 int getSimID() const { return getSim().getObjectID().index; }\n
0613 [[deprecated(\"use getRec().getObjectID().index instead\")]]
0614 int getRecID() const { return getRec().getObjectID().index; }\n
0615 "
0616 MutableExtraCode:
0617 includes: "
0618 #include <edm4eic/ReconstructedParticle.h>\n
0619 #include <edm4hep/MCParticle.h>\n
0620 "
0621 declaration: "
0622 [[deprecated(\"use setSim() instead; this function does nothing\")]]
0623 void setSimID(int) { }\n
0624 [[deprecated(\"use setRec() instead; this function does nothing\")]]
0625 void setRecID(int) { }\n
0626 "
0627
0628 edm4eic::MCRecoClusterParticleAssociation:
0629 Description: "Association between a Cluster and a MCParticle"
0630 Author : "S. Joosten"
0631 Members:
0632 - float weight // weight of this association
0633 OneToOneRelations:
0634 - edm4eic::Cluster rec // reference to the cluster
0635 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0636 ExtraCode:
0637 includes: "
0638 #include <edm4eic/Cluster.h>\n
0639 #include <edm4hep/MCParticle.h>\n
0640 "
0641 declaration: "
0642 [[deprecated(\"use getSim().getObjectID().index instead\")]]
0643 int getSimID() const { return getSim().getObjectID().index; }\n
0644 [[deprecated(\"use getRec().getObjectID().index instead\")]]
0645 int getRecID() const { return getRec().getObjectID().index; }\n
0646 "
0647 MutableExtraCode:
0648 includes: "
0649 #include <edm4eic/Cluster.h>\n
0650 #include <edm4hep/MCParticle.h>\n
0651 "
0652 declaration: "
0653 [[deprecated(\"use setSim() instead; this function does nothing\")]]
0654 void setSimID(int) { }\n
0655 [[deprecated(\"use setRec() instead; this function does nothing\")]]
0656 void setRecID(int) { }\n
0657 "
0658
0659 edm4eic::MCRecoTrackParticleAssociation:
0660 Description: "Association between a Track and a MCParticle"
0661 Author : "S. Joosten"
0662 Members:
0663 - float weight // weight of this association
0664 OneToOneRelations:
0665 - edm4eic::Track rec // reference to the track
0666 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0667 ExtraCode:
0668 includes: "
0669 #include <edm4eic/Track.h>\n
0670 #include <edm4hep/MCParticle.h>\n
0671 "
0672 declaration: "
0673 [[deprecated(\"use getSim().getObjectID().index instead\")]]
0674 int getSimID() const { return getSim().getObjectID().index; }\n
0675 [[deprecated(\"use getRec().getObjectID().index instead\")]]
0676 int getRecID() const { return getRec().getObjectID().index; }\n
0677 "
0678 MutableExtraCode:
0679 includes: "
0680 #include <edm4eic/Track.h>\n
0681 #include <edm4hep/MCParticle.h>\n
0682 "
0683 declaration: "
0684 [[deprecated(\"use setSim() instead; this function does nothing\")]]
0685 void setSimID(int) { }\n
0686 [[deprecated(\"use setRec() instead; this function does nothing\")]]
0687 void setRecID(int) { }\n
0688 "
0689
0690 edm4eic::MCRecoVertexParticleAssociation:
0691 Description: "Association between a Vertex and a MCParticle"
0692 Author : "S. Joosten"
0693 Members:
0694 - float weight // weight of this association
0695 OneToOneRelations:
0696 - edm4eic::Vertex rec // reference to the vertex
0697 - edm4hep::MCParticle sim // reference to the Monte-Carlo particle
0698 ExtraCode:
0699 includes: "
0700 #include <edm4eic/Vertex.h>\n
0701 #include <edm4hep/MCParticle.h>\n
0702 "
0703 declaration: "
0704 [[deprecated(\"use getSim().getObjectID().index instead\")]]
0705 int getSimID() const { return getSim().getObjectID().index; }\n
0706 [[deprecated(\"use getRec().getObjectID().index instead\")]]
0707 int getRecID() const { return getRec().getObjectID().index; }\n
0708 "
0709 MutableExtraCode:
0710 includes: "
0711 #include <edm4eic/Vertex.h>\n
0712 #include <edm4hep/MCParticle.h>\n
0713 "
0714 declaration: "
0715 [[deprecated(\"use setSim() instead; this function does nothing\")]]
0716 void setSimID(int) { }\n
0717 [[deprecated(\"use setRec() instead; this function does nothing\")]]
0718 void setRecID(int) { }\n
0719 "
0720
0721 edm4eic::MCRecoTrackerHitAssociation:
0722 Description: "Association between a RawTrackerHit and a SimTrackerHit"
0723 Author: "C. Dilks, W. Deconinck"
0724 Members:
0725 - float weight // weight of this association
0726 OneToOneRelations:
0727 - edm4eic::RawTrackerHit rawHit // reference to the digitized hit
0728 - edm4hep::SimTrackerHit simHit // reference to the simulated hit
0729
0730 edm4eic::MCRecoCalorimeterHitAssociation:
0731 Description: "Association between a RawCalorimeterHit and a SimCalorimeterHit"
0732 Author: "S. Rahman"
0733 Members:
0734 - float weight // weight of this association
0735 OneToOneRelations:
0736 - edm4hep::RawCalorimeterHit rawHit // reference to the digitized calorimeter hit
0737 - edm4hep::SimCalorimeterHit simHit // reference to the simulated calorimeter hit
0738
0739 edm4eic::TrackClusterMatch:
0740 Description: "Match between a Cluster and a Track"
0741 Author: "D. Anderson, D. Brandenburg, D. Kalinkin, S. Joosten"
0742 Members:
0743 - float weight // weight of this association
0744 OneToOneRelations:
0745 - edm4eic::Cluster cluster // reference to the cluster
0746 - edm4eic::Track track // reference to the track
0747
0748 edm4eic::TrackProtoClusterMatch:
0749 Description: "Match between a ProtoCluster and a Track"
0750 Author: "D. Anderson, D. Kalinkin"
0751 Members:
0752 - float weight // weight of this association
0753 OneToOneRelations:
0754 - edm4eic::Track from // reference to the track
0755 - edm4eic::ProtoCluster to // reference to the protocluster
0756
0757 ## ==========================================================================
0758 ## Data-Monte Carlo comparisons
0759 ## ==========================================================================
0760
0761 edm4eic::Truthiness:
0762 Description: "Positive-definite convex norm of how confidently wrong the reconstruction is,
0763 with non-negative contributions from various aspects of the reconstruction,
0764 where a zero value indicates a perfect reconstruction."
0765 Author: "W. Deconinck, S. Colbert"
0766 Members:
0767 - float truthiness // Overall truthiness of the entire event
0768 - edm4eic::TruthinessContribution associationContribution // Contribution from all associated particles
0769 - float unassociatedMCParticlesContribution // Contribution from unassociated MC particles
0770 - float unassociatedRecoParticlesContribution // Contribution from unassociated reconstructed particles
0771 VectorMembers:
0772 - edm4eic::TruthinessContribution associationContributions // Contribution from associated particles
0773 OneToManyRelations:
0774 - edm4eic::MCRecoParticleAssociation associations // Reference to the associated particles
0775 - edm4hep::MCParticle unassociatedMCParticles // Reference to the unassociated MC particles
0776 - edm4eic::ReconstructedParticle unassociatedRecoParticles // Reference to the unassociated reconstructed particles
0777
0778 links:
0779
0780 edm4eic::MCRecoParticleLink:
0781 Description: "Used to keep track of the correspondence between MC and reconstructed particles"
0782 Author: "S. Joosten"
0783 From: edm4eic::ReconstructedParticle
0784 To: edm4hep::MCParticle
0785
0786 edm4eic::MCRecoClusterParticleLink:
0787 Description: "Association between a Cluster and a MCParticle"
0788 Author : "S. Joosten"
0789 From: edm4eic::Cluster
0790 To: edm4hep::MCParticle
0791
0792 edm4eic::MCRecoTrackParticleLink:
0793 Description: "Association between a Track and a MCParticle"
0794 Author : "S. Joosten"
0795 From: edm4eic::Track
0796 To: edm4hep::MCParticle
0797
0798 edm4eic::MCRecoVertexParticleLink:
0799 Description: "Association between a Vertex and a MCParticle"
0800 Author : "S. Joosten"
0801 From: edm4eic::Vertex
0802 To: edm4hep::MCParticle
0803
0804 edm4eic::MCRecoTrackerHitLink:
0805 Description: "Association between a RawTrackerHit and a SimTrackerHit"
0806 Author: "C. Dilks, W. Deconinck"
0807 From: edm4eic::RawTrackerHit
0808 To: edm4hep::SimTrackerHit
0809
0810 edm4eic::MCRecoCalorimeterHitLink:
0811 Description: "Association between a RawCalorimeterHit and a SimCalorimeterHit"
0812 Author: "S. Rahman"
0813 From: edm4hep::RawCalorimeterHit
0814 To: edm4hep::SimCalorimeterHit
0815
0816 edm4eic::TrackClusterLink:
0817 Description: "Match between a Cluster and a Track"
0818 Author: "D. Anderson, D. Brandenburg, D. Kalinkin, S. Joosten"
0819 From: edm4eic::Cluster
0820 To: edm4eic::Track
0821
0822 edm4eic::TrackProtoClusterLink:
0823 Description: "Link between a ProtoCluster and a Track"
0824 Author: "D. Anderson, D. Kalinkin"
0825 From: edm4eic::Track
0826 To: edm4eic::ProtoCluster
