TrackingChain.h

Go to the documentation of this file.

/* Copyright (C) 2023-2025 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergei Zharko [committer] */
 
 
#pragma once
 
#include "CaDataManager.h"
#include "CaFramework.h"
#include "CaQa.h"
#include "CaTrack.h"
#include "CaTrackingMonitor.h"
#include "CaVector.h"
#include "PartitionedSpan.h"
#include "RecoResults.h"
#include "SubChain.h"
#include "TrackingChainConfig.h"
#include "TrackingDefs.h"
#include "TrackingSetup.h"
#include "sts/Hit.h"
#include "tof/Hit.h"
 
#include <memory>
#include <vector>
 
namespace cbm::algo::qa
{
  class Manager;
}
 
namespace cbm::algo
{
  class TrackingChain : public SubChain {
   public:
    TrackingChain(ECbmRecoMode recoMode, const std::unique_ptr<cbm::algo::qa::Manager>& qaManager = nullptr,
                  std::string_view name = "");
 
    struct Input_t {
      PartitionedSpan<sts::Hit> stsHits;
      PartitionedSpan<tof::Hit> tofHits;
      PartitionedSpan<trd::Hit> trdHits;
    };
 
    struct Output_t {
      ca::Vector<ca::Track> tracks;
 
      ca::Vector<std::vector<std::pair<uint32_t, uint32_t>>> stsHitIndices;
 
      ca::Vector<std::vector<std::pair<uint32_t, uint32_t>>> tofHitIndices;
 
      ca::Vector<std::vector<std::pair<uint32_t, uint32_t>>> trdHitIndices;
 
      ca::TrackingMonitorData monitorData;
    };
 
    const ca::TrackingMonitor& GetCaMonitor() const { return fCaMonitor; }
 
    void Init();
 
    void RegisterSetup(std::shared_ptr<TrackingSetup> pSetup) { fpSetup = pSetup; }
 
    Output_t Run(Input_t recoResults);
 
    void Finalize();
 
 
   private:
    // *********************
    // **  Utility functions
 
    void PrepareInput(Input_t recoResults);
 
    Output_t PrepareOutput();
 
    template<ca::EDetectorID DetID>
    void ReadHits(PartitionedSpan<const ca::HitTypes_t::at<DetID>> hits);
 
    // *************************
    // **  Framework variables
 
    ca::TrackingMonitor fCaMonitor{};              
    ca::TrackingMonitorData fCaMonitorData{};      
    ca::Framework fCaFramework{};                  
    ca::DataManager fCaDataManager{};              
    ca::Qa fQa;                                    
 
    std::shared_ptr<TrackingSetup> fpSetup = nullptr;  
 
    ca::DetIdArray_t<bool> fbDetUsed;  
 
    // ************************
    // **  Auxilary variables
 
    TrackingChainConfig fConfig;        
    ca::HitKeyIndex_t fNofHitKeys = 0;  
 
    ca::Vector<std::tuple<ca::EDetectorID, uint32_t, uint32_t>> faHitExternalIndices{"faHitExternalIndices"};
 
    ECbmRecoMode fRecoMode{ECbmRecoMode::Undefined};  
 
    static constexpr bool kDEBUG = false;  
  };
 
 
}  // namespace cbm::algo