ITkStripsRodEncoder.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ITkStripsRawDataByteStreamCnv_ITkStripsRodEncoder_h
#define ITkStripsRawDataByteStreamCnv_ITkStripsRodEncoder_h
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "ITkStripsByteStreamCnv/IITkStripsRodEncoder.h"
 
#include "ITkStripCabling/IITkStripCablingTool.h"
#include "GaudiKernel/ToolHandle.h"
 
#include "ITkStripDataRateMonTool.h"
 
#include <set>
#include <atomic>
 
class SCT_ID;
class SCT_RDORawData;
class Identifier;
class IdentifierHash;

class 
ITkStripsRodEncoder : public extends<AthAlgTool, IITkStripsRodEncoder>{ 
 public:
 
  using base_class::base_class;
  
  virtual ~ITkStripsRodEncoder() = default;

  virtual StatusCode initialize() override;

  virtual void fillROD(std::vector<uint32_t>& vec32Data, const uint32_t& robID, 
                       const std::vector<const SCT_RDORawData*>& vecRDOs) const override;
  
 
 private:
  
  
  mutable std::atomic<uint8_t> m_bcid = 0;
  mutable std::atomic<uint8_t> m_l0tag = 0;
 
  bool isNear(const int& eta_mod, bool isBarrel = false) const{
    if (isBarrel){
      int pos = std::abs(eta_mod) % 4;
      return (pos == 2 || pos == 3);
    }else{
      int pos = std::abs(eta_mod) % 4;
      if (eta_mod >= 10) pos = (eta_mod + 2) % 4;
      if (eta_mod >= 16) pos = (eta_mod + 4) % 4;
      return (pos == 1 || pos == 2);
    }
  }
  
  void encodeData(const std::vector<uint16_t>& clusters, const uint16_t ichannel, std::vector<uint8_t>& data_encode,
                  int typ, uint8_t l0tag, uint8_t bc_count, uint32_t hccKey, uint16_t& size) const;
  
  void packFragments(std::vector<uint8_t>& vec8Words, std::vector<uint32_t>& vec32Words) const;

  
  std::vector<uint16_t> clusterFinder(const std::bitset<256>& inputData, const uint8_t maxCluster=63) const;
  uint16_t clusterFinder_sub(uint64_t& hits_high64, uint64_t& hits_low64, bool isSecondRow) const;
  
  uint32_t set32Bits(const unsigned short int* arr8Words, 
                     const unsigned short int* position, 
                     const unsigned short int& numWords) const;
 
  bool getBit_128b(uint8_t bit_addr, uint64_t data_high64, uint64_t data_low64) const;
  void setBit_128b(uint8_t bit_addr, bool value, uint64_t& data_high64, uint64_t& data_low64) const;
  bool getParity_8bits(uint8_t val) const;
  
  int getBarrelEC(const SCT_RDORawData* rdo) const;

  uint8_t getDiskLayer(const SCT_RDORawData* rdo) const;

  uint8_t getPhiModule(const SCT_RDORawData* rdo) const;

  int getEtaModule(const SCT_RDORawData* rdo) const;

  uint16_t getStripMax(const SCT_RDORawData* rdo) const;

  int getSide(const SCT_RDORawData* rdo) const;
  
  int getTimeBin(const SCT_RDORawData* rdo) const;
  
  int getStrip(const SCT_RDORawData* rdo) const;
 
  Identifier offlineID(const SCT_RDORawData* rdo) const;

  uint32_t onlineID(const SCT_RDORawData* rdo, const EventContext& ctx) const;

  int getRODLink(const SCT_RDORawData* rdo, const EventContext& ctx) const;

  uint16_t getHeaderPhysicsPacket(int typ, uint8_t l0tag, uint8_t bc_count) const;

  uint16_t getHeaderUsingRDO(const SCT_RDORawData* rdo, const EventContext& ctx) const;
  
  uint16_t getHeaderUsingHash(const IdentifierHash& linkHash, const int& errorWord, const EventContext& ctx) const;
  
  uint16_t getTrailer(const int& errorWord) const;
  
  ToolHandle<IITkStripCablingTool> m_cabling{this, 
                                         "ITkStripCablingTool", 
                                         "ITkStripCablingTool", 
                                         "Tool to retrieve ITkStrips Cabling"};
  
  ToolHandle<ITkStripDataRateMonTool> m_dataRateMonTool{this, "DataRateMonitoringTool", "", "Monitoring tool for data rate evaluation"};  

  const SCT_ID* m_itkStripsID{nullptr};

  BooleanProperty m_condensed{this, "CondensedMode", false, "Condensed mode (true) or Expanded mode (false)"};

  std::set<Identifier> m_swapModuleID{};
};
 
#endif // ITKSTRIP_RAWDATABYTESTREAMCNV_ITKSTRIP_RODENCODER_H