DataFormatsGlobalTracking: rename CosmicTrack to TrackCosmicsExtended

The per-cosmic output of the cluster collector contains the matcher's
TrackCosmics plus the raw hits of its legs; the new name makes that
relation explicit (review comment). Header CosmicTrack.h is now
TrackCosmicsExtended.h; content and branch names are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: matthias-kleiner

DataFormats/Detectors/GlobalTracking/CMakeLists.txt

@@ -45,5 +45,5 @@ o2_target_root_dictionary(
   DataFormatsGlobalTracking
   HEADERS include/DataFormatsGlobalTracking/FilteredRecoTF.h
           include/DataFormatsGlobalTracking/TrackTuneParams.h
-          include/DataFormatsGlobalTracking/CosmicTrack.h
+          include/DataFormatsGlobalTracking/TrackCosmicsExtended.h
 )

…/DataFormatsGlobalTracking/CosmicTrack.h …atsGlobalTracking/TrackCosmicsExtended.hDataFormats/Detectors/GlobalTracking/include/DataFormatsGlobalTracking/CosmicTrack.h renamed to DataFormats/Detectors/GlobalTracking/include/DataFormatsGlobalTracking/TrackCosmicsExtended.h DataFormats/Detectors/GlobalTracking/include/DataFormatsGlobalTracking/CosmicTrack.h renamed to DataFormats/Detectors/GlobalTracking/include/DataFormatsGlobalTracking/TrackCosmicsExtended.h

@@ -9,11 +9,11 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file CosmicTrack.h
+/// \file TrackCosmicsExtended.h
 /// \brief Matched cosmic track with the raw clusters of its legs and of the road around them, for offline refits
 
-#ifndef ALICEO2_COSMIC_TRACK_H
-#define ALICEO2_COSMIC_TRACK_H
+#ifndef ALICEO2_TRACK_COSMICS_EXTENDED_H
+#define ALICEO2_TRACK_COSMICS_EXTENDED_H
 
 #include <vector>
 #include <cstdint>
@@ -32,8 +32,8 @@ struct CosmicTPCCluster {
     Attached = 0x1, ///< attached to the TPC track of this leg
     Corridor = 0x2, ///< found in the road around the leg
     Used = 0x4,     ///< attached to some TPC track (for corridor clusters: another track, e.g. a split piece of the leg)
-    AbsTime = 0x8   ///< found on the other TPC side with the absolute time of the cosmic instead of the time0 of the leg: CosmicTrack::timeTOFMUS
-                    ///< if >= 0, else the time of CosmicTrack::cosmic
+    AbsTime = 0x8   ///< found on the other TPC side with the absolute time of the cosmic instead of the time0 of the leg: TrackCosmicsExtended::timeTOFMUS
+                    ///< if >= 0, else the time of TrackCosmicsExtended::cosmic
   };
   o2::tpc::ClusterNative cl{}; ///< raw cluster: time, pad, widths, charges, flags
   uint8_t sector = 0;
@@ -60,7 +60,7 @@ struct CosmicITSCluster {
   uint16_t row = 0;
   uint16_t col = 0;
   uint16_t pattID = 0;
-  int32_t pattEntry = -1; ///< start of the pattern bytes in CosmicTrack::itsPatterns (pattern not in the dictionary or group pattern), -1: none
+  int32_t pattEntry = -1; ///< start of the pattern bytes in TrackCosmicsExtended::itsPatterns (pattern not in the dictionary or group pattern), -1: none
   int32_t rofBC = 0;      ///< start of the cluster's ROF in BCs since the start of the TF
   uint8_t leg = 0;        ///< 0 bottom, 1 top
   uint8_t flags = 0;      ///< CosmicHitFlags
@@ -88,7 +88,7 @@ struct CosmicTRDTracklet {
 };
 
 /// matched cosmic with everything needed for an offline refit
-struct CosmicTrack {
+struct TrackCosmicsExtended {
   o2::dataformats::TrackCosmics cosmic{};      ///< matcher output (time in mus; the leg references are only valid within the TF)
   o2::tpc::TrackTPC tpcBottom{};               ///< TPC part of the bottom leg (default if none); z refers to its time0; its cluster
                                                ///< references are only valid within the TF: the clusters are in clTPCBottom
@@ -112,7 +112,7 @@ struct CosmicTrack {
   o2::MCCompLabel label{};                     ///< MC label of the cosmic (MC only)
 
   bool hasTOFTime() const { return scoreTOFPair >= 0.f; } ///< a HitTOFFlight pair gave the cosmic its time timeTOFMUS
-  ClassDefNV(CosmicTrack, 1);
+  ClassDefNV(TrackCosmicsExtended, 1);
 };
 
 /// per-TF quantities of the TPC transformation used in the reconstruction

DataFormats/Detectors/GlobalTracking/src/DataFormatsGlobalTrackingLinkDef.h

@@ -30,8 +30,8 @@
 #pragma link C++ class std::vector < o2::dataformats::CosmicTOFCluster> + ;
 #pragma link C++ class o2::dataformats::CosmicTRDTracklet + ;
 #pragma link C++ class std::vector < o2::dataformats::CosmicTRDTracklet> + ;
-#pragma link C++ class o2::dataformats::CosmicTrack + ;
-#pragma link C++ class std::vector < o2::dataformats::CosmicTrack> + ;
+#pragma link C++ class o2::dataformats::TrackCosmicsExtended + ;
+#pragma link C++ class std::vector < o2::dataformats::TrackCosmicsExtended> + ;
 #pragma link C++ class o2::dataformats::CosmicsTFInfo + ;
 
 #endif

Detectors/GlobalTrackingWorkflow/src/CosmicsClusterCollectorSpec.cxx

@@ -64,7 +64,7 @@
 #include "Framework/DeviceSpec.h"
 #include "GlobalTrackingWorkflow/CosmicsClusterCollectorSpec.h"
 #include "DataFormatsGlobalTracking/RecoContainer.h"
-#include "DataFormatsGlobalTracking/CosmicTrack.h"
+#include "DataFormatsGlobalTracking/TrackCosmicsExtended.h"
 #include "ReconstructionDataFormats/TrackCosmics.h"
 #include "DataFormatsTPC/TrackTPC.h"
 #include "DataFormatsTPC/ClusterNative.h"
@@ -186,19 +186,19 @@ class CosmicsClusterCollectorSpec : public Task
     int index;   ///< index of the cluster in the TF
   };
   void addITS(const RecoContainer& data, GTrackID gid, uint8_t leg, std::vector<o2::dataformats::CosmicITSCluster>& out, int icosm, std::vector<ITSPattRequest>& requests, std::unordered_set<int>& matched) const;
-  void fillITSPatterns(const RecoContainer& data, std::vector<ITSPattRequest>& requests, std::vector<o2::dataformats::CosmicTrack>& cosmics) const;
+  void fillITSPatterns(const RecoContainer& data, std::vector<ITSPattRequest>& requests, std::vector<o2::dataformats::TrackCosmicsExtended>& cosmics) const;
   void addTOF(const RecoContainer& data, GTrackID gid, uint8_t leg, std::vector<o2::dataformats::CosmicTOFCluster>& out, std::unordered_set<int>& matched) const;
   void addTRD(const RecoContainer& data, GTrackID gid, uint8_t leg, std::vector<o2::dataformats::CosmicTRDTracklet>& out, std::unordered_set<int>& matched) const;
   std::pair<float, float> timeWindowMUS(const CosmicTime& cosmicTime) const;
   bool predictOutward(const o2::tpc::TrackTPC& leg, const CosmicTime& cosmicTime, int sector, float x, float& y, float& z) const;
   void roadTOF(const RecoContainer& data, const o2::tpc::TrackTPC* const* legs, const CosmicTime& cosmicTime, int icosm, std::vector<o2::dataformats::CosmicTOFCluster>& out, const std::unordered_set<int>& matched, float& timeTOFMUS, float& scoreTOFPair, float& scoreTOFReversed) const;
-  void polish(const o2::tpc::TrackTPC* const* legs, float timeMUS, o2::gpu::GPUO2InterfaceRefit& refitter, o2::dataformats::CosmicTrack& out) const;
+  void polish(const o2::tpc::TrackTPC* const* legs, float timeMUS, o2::gpu::GPUO2InterfaceRefit& refitter, o2::dataformats::TrackCosmicsExtended& out) const;
   void roadTRD(const RecoContainer& data, const o2::tpc::TrackTPC* const* legs, const CosmicTime& cosmicTime, int icosm, std::vector<o2::dataformats::CosmicTRDTracklet>& out, const std::unordered_set<int>& matched) const;
   void roadITS(const RecoContainer& data, const o2::dataformats::TrackCosmics& cosm, const CosmicTime& cosmicTime, int legsSide, int icosm, std::vector<o2::dataformats::CosmicITSCluster>& out, std::vector<ITSPattRequest>& requests,
                const std::unordered_set<int>& matched) const;
   void cacheITSChipCentres();
-  void writeDebug(const o2::dataformats::CosmicTrack& cosm, int icosm) const;
-  void flagDuplicates(std::vector<o2::dataformats::CosmicTrack>& cosmics) const;
+  void writeDebug(const o2::dataformats::TrackCosmicsExtended& cosm, int icosm) const;
+  void flagDuplicates(std::vector<o2::dataformats::TrackCosmicsExtended>& cosmics) const;
   void writeDebugTOF(const o2::tof::Cluster& c, int icosm, int leg, uint8_t flags) const;
 
   std::shared_ptr<DataRequest> mDataRequest;
@@ -303,7 +303,7 @@ void CosmicsClusterCollectorSpec::run(ProcessingContext& pc)
   tfInfo.vDrift = mCorrMap->getVDrift();
   tfInfo.t0 = mCorrMap->getT0();
 
-  std::vector<o2::dataformats::CosmicTrack> cosmicsOut;
+  std::vector<o2::dataformats::TrackCosmicsExtended> cosmicsOut;
   const auto cosmics = recoData.getCosmicTracks();
   const size_t nCosmics = std::min(cosmics.size(), mMaxCosmicsPerTF);
   if (nCosmics < cosmics.size()) {
@@ -1062,7 +1062,7 @@ void CosmicsClusterCollectorSpec::roadTOF(const RecoContainer& data, const o2::t
   }
 }
 
-void CosmicsClusterCollectorSpec::polish(const o2::tpc::TrackTPC* const* legs, float timeMUS, o2::gpu::GPUO2InterfaceRefit& refitter, o2::dataformats::CosmicTrack& out) const
+void CosmicsClusterCollectorSpec::polish(const o2::tpc::TrackTPC* const* legs, float timeMUS, o2::gpu::GPUO2InterfaceRefit& refitter, o2::dataformats::TrackCosmicsExtended& out) const
 {
   // refit of a cosmic with TPC-only legs at its TOF time, as MatchCosmics::refitWinners: the bottom leg inward, then to the closest approach
   // to the beam line; the top leg inward, then to the same point; the two halves combined. Muon mass, energy loss along the muon's flight
@@ -1324,7 +1324,7 @@ void CosmicsClusterCollectorSpec::roadITS(const RecoContainer& data, const o2::d
   }
 }
 
-void CosmicsClusterCollectorSpec::fillITSPatterns(const RecoContainer& data, std::vector<ITSPattRequest>& requests, std::vector<o2::dataformats::CosmicTrack>& cosmics) const
+void CosmicsClusterCollectorSpec::fillITSPatterns(const RecoContainer& data, std::vector<ITSPattRequest>& requests, std::vector<o2::dataformats::TrackCosmicsExtended>& cosmics) const
 {
   // the TF's pattern stream holds, in cluster order, the patterns of the clusters with an invalid or a group pattern ID
   if (!mITSDict) {
@@ -1376,7 +1376,7 @@ void CosmicsClusterCollectorSpec::addTRD(const RecoContainer& data, GTrackID gid
   }
 }
 
-void CosmicsClusterCollectorSpec::flagDuplicates(std::vector<o2::dataformats::CosmicTrack>& cosmics) const
+void CosmicsClusterCollectorSpec::flagDuplicates(std::vector<o2::dataformats::TrackCosmicsExtended>& cosmics) const
 {
   // the same muon can be matched twice, e.g. when a leg is split into two TPC tracks: the roads then collect largely the same clusters
   // (PbPb 567939: 10 of 47 cosmic pairs in a TF share 56-99 % of the clusters of the smaller one, all others none). The best one (TOF time,
@@ -1421,7 +1421,7 @@ void CosmicsClusterCollectorSpec::flagDuplicates(std::vector<o2::dataformats::Co
   }
 }
 
-void CosmicsClusterCollectorSpec::writeDebug(const o2::dataformats::CosmicTrack& cosm, int icosm) const
+void CosmicsClusterCollectorSpec::writeDebug(const o2::dataformats::TrackCosmicsExtended& cosm, int icosm) const
 {
   constexpr int NSectorsA = TPCGeo::getNumberOfSectorsA();
   // the time the other-side corridor used (and the common frame zCos): the TOF time if the TOF road found one, else the TPC time

Detectors/GlobalTrackingWorkflow/src/TrackCosmicsWriterSpec.cxx

@@ -16,7 +16,7 @@
 #include "DPLUtils/MakeRootTreeWriterSpec.h"
 #include "ReconstructionDataFormats/TrackCosmics.h"
 #include "SimulationDataFormat/MCCompLabel.h"
-#include "DataFormatsGlobalTracking/CosmicTrack.h"
+#include "DataFormatsGlobalTracking/TrackCosmicsExtended.h"
 #include "CommonDataFormat/TFIDInfo.h"
 
 using namespace o2::framework;
@@ -55,15 +55,15 @@ DataProcessorSpec getTrackCosmicsWriterSpec(bool useMC)
 
 DataProcessorSpec getCosmicsFullWriterSpec()
 {
-  auto logger = [](std::vector<o2::dataformats::CosmicTrack> const& cosmics) {
+  auto logger = [](std::vector<o2::dataformats::TrackCosmicsExtended> const& cosmics) {
     LOG(info) << "Writing " << cosmics.size() << " cosmics with clusters";
   };
   return MakeRootTreeWriterSpec("cosmics-full-writer",
                                 "o2_cosmics_full.root",
                                 "cosmicsFull",
                                 -1,  // do not limit number of events to store
                                 100, // periodically autosave
-                                BranchDefinition<std::vector<o2::dataformats::CosmicTrack>>{InputSpec{"cosmics", "GLO", "COSMFULL", 0}, "cosmics", 1, logger},
+                                BranchDefinition<std::vector<o2::dataformats::TrackCosmicsExtended>>{InputSpec{"cosmics", "GLO", "COSMFULL", 0}, "cosmics", 1, logger},
                                 BranchDefinition<o2::dataformats::CosmicsTFInfo>{InputSpec{"tfinfo", "GLO", "COSMFULLTF", 0}, "tfInfo", 1},
                                 BranchDefinition<o2::dataformats::TFIDInfo>{InputSpec{"tfid", "GLO", "COSMFULLTFID", 0}, "tfID", 1})();
 }