CbmTrdUnpackFaspAlgo.h

Go to the documentation of this file.

/* Copyright (C) 2021 Goethe-University Frankfurt, Frankfurt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Pascal Raisig [committer], Alexandru Bercuci */
 
#ifndef CbmTrdUnpackFaspAlgo_H
#define CbmTrdUnpackFaspAlgo_H
 
#include "CbmRecoUnpackAlgo.tmpl"
#include "CbmTrdDigi.h"
#include "CbmTrdParFasp.h"
#include "CbmTrdParSetAsic.h"
#include "CbmTrdUnpackFaspMonitor.h"
#include "Timeslice.hpp"  // timeslice
 
#include <Rtypes.h>  // for types
#include <RtypesCore.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <utility>
 
// TODO to be defined in correlation with time offsets (AB 20.05.22)
#define NCRI 40  // no of CRI in the system (5/TRD-2D_FASP module)
#define NCOLS 8  // no of cols / FASP
 
class CbmTrdParSetDigi;
class CbmTrdUnpackFaspAlgo : public CbmRecoUnpackAlgo<CbmTrdDigi> {
 public:
  enum class eMessageLength : int
  {
    kMessCh    = 4,
    kMessType  = 1,
    kMessTlab  = 7,
    kMessData  = 14,
    kMessFasp  = 6,
    kMessEpoch = 21
  };
  enum eMessageType
  {
    kData  = 0,
    kEpoch = 1,
    kNone
  };
  enum class eMessageVersion : int
  {
    kMessLegacy = 2,  
    kMess24     = 3,  
    kMessNoDef        
  };
  CbmTrdUnpackFaspAlgo();
 
  virtual ~CbmTrdUnpackFaspAlgo();
 
  CbmTrdUnpackFaspAlgo(const CbmTrdUnpackFaspAlgo&) = delete;
 
  CbmTrdUnpackFaspAlgo& operator=(const CbmTrdUnpackFaspAlgo&) = delete;
 
 
  class CbmTrdFaspMessage {
   public:
    CbmTrdFaspMessage()                         = default;
    CbmTrdFaspMessage(const CbmTrdFaspMessage&) = default;
    virtual ~CbmTrdFaspMessage()                = default;
    CbmTrdFaspMessage(uint8_t rob, uint8_t asic, uint8_t c, uint8_t typ, uint8_t t, uint16_t d, uint8_t l);
    virtual int getFaspIdMod() const { return fasp + rob * NFASPCROB; }
    virtual eMessageType getType(uint32_t w) const;
    virtual void print() const;
    virtual void readDW(uint32_t w);
    virtual void readEW(uint32_t w);
 
   public:
    eMessageVersion version = eMessageVersion::kMessLegacy;  
    uint8_t ch              = 0;                             
    uint8_t type            = 0;                             
    uint8_t tlab            = 0;                             
    uint16_t data           = 0;                             
    uint32_t epoch          = 0;                             
    uint32_t mod            = 0;                             
    uint8_t rob             = 0;                             
    uint8_t elink           = 0;  
    uint8_t fasp            = 0;  
  };
  class CbmTrdFaspMessage24 : public CbmTrdFaspMessage {
   public:
    CbmTrdFaspMessage24();
    virtual eMessageType getType(uint32_t w) const;
    virtual void readDW(uint32_t w);
    virtual void readEW(uint32_t w);
  };
  virtual const CbmTrdParSetAsic* GetAsicPar() const { return &fAsicSet; }
  virtual std::vector<std::pair<std::string, std::shared_ptr<FairParGenericSet>>>*
  GetParContainerRequest(std::string geoTag, std::uint32_t runId);
  void SetMonitor(std::shared_ptr<CbmTrdUnpackFaspMonitor> monitor) { fMonitor = monitor; }
 
  uint32_t ResetTimeslice();
 
 protected:
  eMessageType mess_type(uint32_t wd);
  bool pushDigis(std::vector<CbmTrdUnpackFaspAlgo::CbmTrdFaspMessage> messages, const uint16_t mod_id);
  ULong64_t fTime = 0;
 
  void finish()
  {
    if (fMonitor) fMonitor->Finish();
  }
 
  virtual Bool_t init() { return kTRUE; }
 
  // Initialise par set, the base function handles the casting to distribute the pointers to their explicit functions
 
  Bool_t initParSet(FairParGenericSet* parset);
 
  bool unpack(const fles::Timeslice* ts, std::uint16_t icomp, UInt_t imslice);
 
  void FinalizeComponent();
 
  // Constants
  static const std::uint8_t fBytesPerWord = 4;
 
 private:
  std::map<uint16_t, std::pair<uint16_t, uint16_t>>* fCompMap        = nullptr;  
  std::array<std::vector<CbmTrdDigi>, NFASPMOD* NFASPCH> fDigiBuffer = {
    {}};  
  std::shared_ptr<CbmTrdUnpackFaspMonitor> fMonitor = nullptr;
  std::vector<uint16_t> fModuleId = {};  
  CbmTrdParSetAsic fAsicSet;
  CbmTrdParSetDigi* fDigiSet = nullptr;
  CbmTrdFaspMessage* fMess   = nullptr;  
 
  ClassDef(CbmTrdUnpackFaspAlgo, 4)  // unpack FASP read-out detectors
};
 
#endif  // CbmTrdUnpackFaspAlgo_H