From 49ba4abab8621f6ffe5f435d3497762042a04b6b Mon Sep 17 00:00:00 2001 From: Oleksii Lubynets Date: Mon, 5 Aug 2024 12:13:54 +0200 Subject: [PATCH] rename field titles --- core/BranchConfig.cpp | 70 +++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/core/BranchConfig.cpp b/core/BranchConfig.cpp index 178e1304..c3e7f318 100644 --- a/core/BranchConfig.cpp +++ b/core/BranchConfig.cpp @@ -18,46 +18,46 @@ BranchConfig::BranchConfig(std::string name, DetType type, std::string title) : GenerateId(); if (type_ == DetType::kTrack) { - VectorConfig::AddField("px", TrackFields::kPx, "GeV/c"); - VectorConfig::AddField("py", TrackFields::kPy, "GeV/c"); - VectorConfig::AddField("pz", TrackFields::kPz, "GeV/c"); - VectorConfig::AddField("pT", TrackFields::kPt, "GeV/c"); - VectorConfig::AddField("phi", TrackFields::kPhi, "azimuthal angle"); - VectorConfig::AddField("eta", TrackFields::kEta, "pseudorapidity"); - VectorConfig::AddField("p", TrackFields::kP, "GeV/c"); + VectorConfig::AddField("px", TrackFields::kPx, "X-projection of the momentum of the track, GeV/c"); + VectorConfig::AddField("py", TrackFields::kPy, "Y-projection of the momentum of the track, GeV/c"); + VectorConfig::AddField("pz", TrackFields::kPz, "Z-projection of the momentum of the track, GeV/c"); + VectorConfig::AddField("pT", TrackFields::kPt, "Transverse momentum of the track, GeV/c"); + VectorConfig::AddField("phi", TrackFields::kPhi, "Azimuthal angle of the track, rad"); + VectorConfig::AddField("eta", TrackFields::kEta, "Pseudorapidity of the track"); + VectorConfig::AddField("p", TrackFields::kP, "Full momentum of the track, GeV/c"); VectorConfig::AddField("q", TrackFields::kQ, "Charge of the track (or its sign when absolute value unknown)"); - VectorConfig::AddField("id", TrackFields::kId, "unique id"); + VectorConfig::AddField("id", TrackFields::kId, "Unique id of the track within current event; assigned automatically (not by user)"); } else if (type_ == DetType::kParticle) { - VectorConfig::AddField("px", ParticleFields::kPx, "GeV/c"); - VectorConfig::AddField("py", ParticleFields::kPy, "GeV/c"); - VectorConfig::AddField("pz", ParticleFields::kPz, "GeV/c"); - VectorConfig::AddField("pT", ParticleFields::kPt, "GeV/c"); - VectorConfig::AddField("phi", ParticleFields::kPhi, "azimuthal angle"); - VectorConfig::AddField("eta", ParticleFields::kEta, "pseudorapidity"); - VectorConfig::AddField("mass", ParticleFields::kMass, "GeV/c^2"); - VectorConfig::AddField("p", ParticleFields::kP, "GeV/c"); - VectorConfig::AddField("E", ParticleFields::kEnergy, "full energy, GeV"); - VectorConfig::AddField("T", ParticleFields::kKineticEnergy, "kinetic energy, GeV"); - VectorConfig::AddField("rapidity", ParticleFields::kRapidity, "in Lab. frame"); - VectorConfig::AddField("q", ParticleFields::kQ, "Charge of the particle"); - VectorConfig::AddField("pid", ParticleFields::kPid, "PDG code"); - VectorConfig::AddField("id", ParticleFields::kId, "unique id"); + VectorConfig::AddField("px", ParticleFields::kPx, "X-projection of the momentum of the particle, GeV/c"); + VectorConfig::AddField("py", ParticleFields::kPy, "Y-projection of the momentum of the particle, GeV/c"); + VectorConfig::AddField("pz", ParticleFields::kPz, "Z-projection of the momentum of the particle, GeV/c"); + VectorConfig::AddField("pT", ParticleFields::kPt, "Transverse momentum of the particle, GeV/c"); + VectorConfig::AddField("phi", ParticleFields::kPhi, "Azimuthal angle of the particle, rad"); + VectorConfig::AddField("eta", ParticleFields::kEta, "Pseudorapidity of the particle"); + VectorConfig::AddField("mass", ParticleFields::kMass, "Mass of the particle, GeV/c^2 (true mass of certain particle species; deprecated to use for invariant mass, mass from TOF etc.)"); + VectorConfig::AddField("p", ParticleFields::kP, "Full momentum of the particle, GeV/c"); + VectorConfig::AddField("E", ParticleFields::kEnergy, "Full energy of the particle, GeV"); + VectorConfig::AddField("T", ParticleFields::kKineticEnergy, "Kinetic energy of the particle, GeV"); + VectorConfig::AddField("rapidity", ParticleFields::kRapidity, "Rapidity of the particle"); + VectorConfig::AddField("q", ParticleFields::kQ, "Charge of the particle (true charge of certain particle species)"); + VectorConfig::AddField("pid", ParticleFields::kPid, "PDG code of the particle (e.g. by simulation for MC-particles or the most probable one for reconstructed particles with performed PID etc.)"); + VectorConfig::AddField("id", ParticleFields::kId, "Unique id of the particle within current event; assigned automatically (not by user)"); } else if (type_ == DetType::kHit) { - VectorConfig::AddField("x", HitFields::kX, "cm"); - VectorConfig::AddField("y", HitFields::kY, "cm"); - VectorConfig::AddField("z", HitFields::kZ, "cm"); - VectorConfig::AddField("phi", HitFields::kPhi, "azimuthal angle"); - VectorConfig::AddField("signal", HitFields::kSignal, ""); - VectorConfig::AddField("id", HitFields::kId, "unique id"); + VectorConfig::AddField("x", HitFields::kX, "X coordinate of the hit, cm"); + VectorConfig::AddField("y", HitFields::kY, "Y coordinate of the hit, cm"); + VectorConfig::AddField("z", HitFields::kZ, "Z coordinate of the hit, cm"); + VectorConfig::AddField("phi", HitFields::kPhi, "Azimuthal angle of the hit, rad"); + VectorConfig::AddField("signal", HitFields::kSignal, "Energy deposit collected in the hit"); + VectorConfig::AddField("id", HitFields::kId, "Unique id of the hit within current event; assigned automatically (not by user)"); } else if (type_ == DetType::kModule) { - VectorConfig::AddField("number", ModuleFields::kNumber, "module number"); - VectorConfig::AddField("signal", ModuleFields::kSignal, ""); - VectorConfig::AddField("id", ModuleFields::kId, "unique id"); + VectorConfig::AddField("number", ModuleFields::kNumber, "Module number"); + VectorConfig::AddField("signal", ModuleFields::kSignal, "Energy deposit collected in the module"); + VectorConfig::AddField("id", ModuleFields::kId, "Unique id of the hit within current event; assigned automatically (not by user)"); } else if (type_ == DetType::kEventHeader) { - VectorConfig::AddField("vtx_x", EventHeaderFields::kVertexX, "cm"); - VectorConfig::AddField("vtx_y", EventHeaderFields::kVertexY, "cm"); - VectorConfig::AddField("vtx_z", EventHeaderFields::kVertexZ, "cm"); - VectorConfig::AddField("id", EventHeaderFields::kId, "unique id"); + VectorConfig::AddField("vtx_x", EventHeaderFields::kVertexX, "X coordinate of the vertex, cm"); + VectorConfig::AddField("vtx_y", EventHeaderFields::kVertexY, "Y coordinate of the vertex, cm"); + VectorConfig::AddField("vtx_z", EventHeaderFields::kVertexZ, "Z coordinate of the vertex, cm"); + VectorConfig::AddField("id", EventHeaderFields::kId, "Always 0, this field is not used for EventHeader and is needed for compatibility with other Container types"); } }