trd/RecoSetupUnit.h

Go to the documentation of this file.

/* Copyright (C) 2025 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergei Zharko [committer] */

 
#ifndef ALGO_TRD_RecoSetupUnit_h
#define ALGO_TRD_RecoSetupUnit_h 1
 
#include "CbmDefs.h"
#include "CbmTrdAddress.h"
#include "algo/setup/TrackingSetupIfs.h"
 
#include <boost/serialization/access.hpp>
#include <boost/serialization/array.hpp>
#include <boost/serialization/export.hpp>
#include <boost/serialization/utility.hpp>
 
#include <array>
#include <utility>
#include <vector>
 
namespace cbm::algo::trd
{
  class RecoSetupUnit : public TrackingSetupIfs<RecoSetupUnit> {
    friend class TrackingSetupIfs<RecoSetupUnit>;
 
   public:
    // TODO: move this structure in the HitfindSetupIfs
    struct ModuleInfo {
      int32_t orientation;  
      int32_t type;         

      ModuleInfo() = default;

      ModuleInfo(int32_t orientation_, int32_t type_) : orientation(orientation_), type(type_) {}
 
     private:
      friend class boost::serialization::access;
      template<typename Archive>
      void serialize(Archive& ar, const unsigned int /*version*/)
      {
        ar& orientation;
        ar& type;
      }
    };

    using ModuleInfoMap_t = std::pair<std::vector<ModuleInfo>, uint32_t>;

    RecoSetupUnit() = default;

    RecoSetupUnit(std::pair<std::vector<GeoVolume>, std::vector<GeoVolume>>&& stationVolumes,
                  ModuleInfoMap_t&& moduleTypeMap);

    static constexpr std::string_view GetDetectorName() { return "TRD"; }

    static constexpr ECbmModuleId GetModuleId() { return ECbmModuleId::kTrd; }
 
   private:
    ModuleInfo GetModuleInfo(uint32_t address) const;

    template<class HitType>
    HitRange ImplGetHitRange(const HitType& hit) const;

    int ImplGetTrackingStationId(uint32_t address) const;

    bool ImplIsTimeInfoProvided(int /*stationId*/) const { return true; }

    bool IsInitialized() const;
 
    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive& ar, const unsigned int /*version*/)
    {
      ar& boost::serialization::base_object<TrackingSetupIfs<RecoSetupUnit>>(*this);
      ar& fvModuleInfoMap;
    }
 
    ModuleInfoMap_t fvModuleInfoMap{};  
  };
 
  //* Inline method implementations
 
  // -------------------------------------------------------------------------------------------------------------------
  //
  inline RecoSetupUnit::ModuleInfo RecoSetupUnit::GetModuleInfo(uint32_t address) const
  {
    // NOTE: an assumption, that the layer is the tracking station for TRD!
    auto iLayer  = CbmTrdAddress::GetLayerId(address);
    auto iModule = CbmTrdAddress::GetModuleId(address);
    return fvModuleInfoMap.first[fvModuleInfoMap.second * iLayer + iModule];
  }
 
  // -------------------------------------------------------------------------------------------------------------------
  //
  template<class HitType>
  inline HitRange RecoSetupUnit::ImplGetHitRange(const HitType& hit) const
  {
    HitRange res          = TrackingSetupIfs<RecoSetupUnit>::ImplGetHitRange(hit);  // default hit ranges
    const auto moduleInfo = GetModuleInfo(hit.GetAddress());
    // NOTE: for now take the information on the TRD Pad type from the hit, but it should be retrieved from the
    //       moduleInfo as soon, as the digitization parameters of TRD are brought to the next version.
    if (hit.GetClassType() == 0) {
      if (!hit.IsRowCross()) {
        if (1 == moduleInfo.orientation || 3 == moduleInfo.orientation) {
          res.y = sqrt(3.) * hit.GetDy();
        }
        else {
          res.x = sqrt(3.) * hit.GetDx();
        }
      }
    }
    else {
      // NOTE/FIXME/TODO: the values below come from the legacy tracking interface class. They should be improved
      if (0 == moduleInfo.orientation || 2 == moduleInfo.orientation) {
        res.x = 1.7;
        res.y = 3.5;
        res.t = 200.;
      }
      else {
        res.x = 3.5;
        res.y = 1.7;
        res.t = 200.;
      }
    }
    return res;
  }
 
  // -------------------------------------------------------------------------------------------------------------------
  //
  inline int RecoSetupUnit::ImplGetTrackingStationId(uint32_t address) const
  {
    return CbmTrdAddress::GetLayerId(address);
  }
}  // namespace cbm::algo::trd
 
 
#endif  // ALGO_STS_RecoSetupUnit_h