LArLATOMEDecoder.h

Go to the documentation of this file.

//Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef LARBYTESTREAM_LARLATOMEDDECODER_H
#define LARBYTESTREAM_LARLATOMEDDECODER_H
 
#define N_LATOME_CHANNELS 320
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "LArRawEvent/LArRawSCContainer.h" //why?
#include "LArRawEvent/LArLATOMEHeaderContainer.h" //why?
#include "ByteStreamData/RawEvent.h" //for OFFLINE_FRAGMENTS_NAMESPACE
 
#include "CaloDetDescr/ICaloSuperCellIDTool.h"
#include "LArCabling/LArOnOffIdMapping.h"
#include <vector>
#include <string>
#include <fstream>
#include <stdint.h>
 
 
 

 
class LArOnline_SuperCellID;
class LArDigitContainer;
class LArAccumulatedDigitContainer;
class LArAccumulatedCalibDigitContainer;
class LArLATOMEMapping;
class LArCalibLineMapping;
 
 
enum class MonDataType {
  RawADC=1,
  ADC=0,
  Energy=2,
  SelectedEnergy=3,
  Averaged=4,
  AutoCorr=5,
  Invalid=15
};
 
class LArLATOMEDecoder : public AthAlgTool {
 
public: 
  typedef unsigned int Word;
  typedef int NumWord;
  typedef int Packet;
  typedef int SuperCell;
  typedef int Sample;
  typedef int NumLATOME;
  typedef std::string Path;
  
  LArLATOMEDecoder(const std::string& type, const std::string& name, const IInterface* parent);
  static const InterfaceID& interfaceID();
  virtual ~LArLATOMEDecoder() = default;
  virtual StatusCode initialize();
  virtual StatusCode finalize() {return StatusCode::SUCCESS;};
  StatusCode convert(const std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*>& robFrags, const LArLATOMEMapping *map,
                     LArDigitContainer* adc_coll,
             LArDigitContainer* adc_bas_coll,
             LArRawSCContainer* et_coll,
             LArRawSCContainer* et_id_coll,
             LArLATOMEHeaderContainer* header_coll) const;
 
  StatusCode convert(const RawEvent* re, const LArLATOMEMapping *map, 
                     const LArOnOffIdMapping *onoffmap, const LArCalibLineMapping *clmap,
                     LArAccumulatedDigitContainer* accdigits,
                     LArAccumulatedCalibDigitContainer* caccdigits,
                     LArLATOMEHeaderContainer* header_coll) const;
  
private:

  static const int s_nBunches = 3564;
 
  class LatomeRawData{
 
  public:
    std::vector<short> adc;
    std::vector<short> adc_bas;
    std::vector<int> et;
    std::vector<int> et_id;
    std::vector<bool> saturation;
    unsigned int latomeChannel{};
  };
 
  class LatomeAveragedRawData{
 
    public:
      std::vector<unsigned long long> sum;
      std::vector<unsigned long long> sumSq;
      std::vector<unsigned int> nTrigValid;
      unsigned int latomeChannel{};
  };
 
  class LatomeCalibPatterns{
 
    public:
      unsigned int DAC=0;
      unsigned int delay=0;
      std::vector<unsigned int> patterns;
  };
 
  class EventProcess : public AthMessaging {
  public:
    typedef unsigned int Word;
    typedef int NumWord;
    typedef int Packet;
    typedef int SuperCell;
    typedef int Sample;
    typedef std::string Path;
 
    EventProcess(const LArLATOMEDecoder* decoderInput, 
                 LArDigitContainer* adc_coll,
         LArDigitContainer* adc_bas_coll,
         LArRawSCContainer* et_coll,
         LArRawSCContainer* et_id_coll,
                 LArAccumulatedDigitContainer* accdigits,
                 LArAccumulatedCalibDigitContainer* caccdigits,
         LArLATOMEHeaderContainer* header_coll);
    
 
    void fillCollection(const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment* pROB, const LArLATOMEMapping *map, 
                        const LArOnOffIdMapping *onoffmap=nullptr, const LArCalibLineMapping *clmap=nullptr);
 
  private:
    bool compareOrSet(Word& param, Word value, bool compare);
    unsigned int decodeTrailer(const uint32_t* p, unsigned int offset);
    unsigned int decodeHeader(const uint32_t* p, unsigned int offset);
    unsigned int bytesPerChannel(MonDataType at0, MonDataType at1);
    void increaseWordShift(unsigned int& wordshift);
    void increaseByteShift(unsigned int& wordshift, unsigned int& byteshift);
    void decodeByte(unsigned int& byte, unsigned int wordshift, unsigned int byteshift, const uint32_t* p);
    void decodeWord(unsigned int& word, unsigned int& wordshift, unsigned int& byteshift, const uint32_t* p);
    void decodeChannel(unsigned int& wordshift, unsigned int& byteshift, const uint32_t* p,
               MonDataType at0, MonDataType at1,
               unsigned int& at0Data, unsigned int& at1Data, unsigned int& satData,
               bool& at0val, bool& at1val);
    int signEnergy(unsigned int energy);
    void fillRaw(const LArLATOMEMapping *map);
    void fillCalib(const LArLATOMEMapping *map, 
                   const LArOnOffIdMapping *onoffmap, const LArCalibLineMapping *clmap);
    void fillHeader();
    
    enum MODE {
      MON_HEADER, PAYLOAD, MON_TRAILER
    };

    // some of this values (in addition to some values from the rod header) should go to a LatomeHeader class (that replaces the current Mon class) and this class should be moved to another package and percistified (written into disk with pool format). This is not urgent and can be done later.
    static const Word m_monTrailerSize=2; 
    static const Word s_monHeaderMarker=0xff1234ff;
    static const Word s_monCheckPoint=0xdeadbeef;
    std::vector<Word> m_packetEnd;
 
    // rod header
    Word m_latomeBCID{};
    Word m_latomeID{};
    Word m_l1ID{};
    Word m_ROBFragSize{};
    Word m_LATOMEFW{};
    Word m_nPackets{};
    Word m_iPacket{};
    Word m_nWordsPerPacket{};
    Word m_monHeaderSize{};
    Word m_region{};
    Word m_nStreams{};
    Word m_streamNumber{};
    Word m_at0at1Swap{};
    Word m_at0typeRec{};
    Word m_at1typeRec{};
    Word m_at0type{};
    Word m_at1type{};
    Word m_at0nBC{};
    Word m_at1nBC{};
    Word m_at0BC{};
    Word m_at1BC{};
    Word m_activeSC{};
    Word m_nsc1{};
    Word m_nsc2{};
    Word m_nsc3{};
    Word m_nsc4{};
    Word m_nsc5{};
    Word m_nsc6{};
    bool m_headerDecoded{};
 
    short m_nBC_rawADC{};
    short m_nBC_ADC{};
    short m_nBC_E{};
    short m_nBC_EID{};
    short m_nBC_Averaged{};
    
    short m_BC_rawADC{};
    short m_BC_ADC{};
    short m_BC_E{};
    short m_BC_EID{};
 
    bool m_hasRawAdc{};
    bool m_hasAdc{};
    bool m_hasE{};
    bool m_hasEID{};
    bool m_isAveraged{};
    bool m_isAutoCorr{};
    
    const LArLATOMEDecoder *m_decoder{};
    LArDigitContainer* m_adc_coll{};
    LArDigitContainer* m_adc_bas_coll{};
    LArRawSCContainer* m_et_coll{};
    LArRawSCContainer* m_et_id_coll{};
    LArAccumulatedDigitContainer* m_accdigits{};
    LArAccumulatedCalibDigitContainer* m_caccdigits{};
    LArLATOMEHeaderContainer* m_header_coll{};
    
    // LATOME source ID is stored here:
    unsigned int m_nthLATOME = 0;
 
    std::vector<unsigned short> m_BCIDsInEvent;
    std::vector<LatomeRawData> m_rawValuesInEvent;
    std::vector<LatomeAveragedRawData> m_averagedRawValuesInEvent;
    std::vector<LatomeCalibPatterns> m_latomeCalibPatternsInEvent;
  };
 
  // propary of tool
  const LArOnline_SuperCellID* m_onlineId{};
  ToolHandle<ICaloSuperCellIDTool> m_sc2ccMappingTool;
  
  BooleanProperty m_ignoreBarrelChannels{this, "IgnoreBarrelChannels", false};
  BooleanProperty m_ignoreEndcapChannels{this, "IgnoreEndcapChannels", false};
  BooleanProperty m_protectSourceId{this, "ProtectSourceId", true, "discard main readout sourceID, should be false for reading all files from the mon path with old source IDs"};
  BooleanProperty m_keepPulsed{this, "KeepOnlyPulsed", true};
  SG::ReadCondHandleKey<LArOnOffIdMapping> m_cablingKeySC{this,"ScCablingKey","LArOnOffIdMapSC","SG Key of SC LArOnOffIdMapping object"};
 
};
 
#endif // LARBYTESTREAM_LARLATOMEDDECODER_H