LArRodBlockCalibrationV3.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_LARRODBLOCKCALIBRATIONV3_H
#define LARBYTESTREAM_LARRODBLOCKCALIBRATIONV3_H

 
#include "LArByteStream/LArRodBlockStructure.h"
#include "CaloIdentifier/CaloGain.h"
 
class LArRodBlockCalibrationV3 : public LArRodBlockStructure
{
public:
  // ----------------- Header words indexes -----------------
  enum {
    NWTot,            // First words: DSP event header
    NWTot_h,
    FEBID,
    FEBID_h,
    FEB_SN,           // FEB serial number
    FEB_SN_h,         // FEB serial number
    ResultsOff1,      // Size of results (Calibration averages in DSP)
    ResultsDim1,      // Offset to results
    ResultsOff2,      // Size of times (in physics)
    ResultsDim2,      // Offset to times (in physics)
    RawDataBlkOff,
    RawDataBlkDim, // Raw FEB event offset
    EventStatus,      // Bits describing the event
    EventStatus_h,      
    NGains,
    NSamples, 
    FirstSampleIndex,  
    FebConfig,
    InFPGAFormat, // added 08.09.2005 - wrong 28.09.2005?
    InFPGAFormat_h,
    endtag          //This tag needs to be an odd number, see *) for constructor
  };
  enum{
    NTrigger,
    NTrigger_h,
    Dac,
    Dac_h,
    Delay,
    Delay_h,
    IsPulsed,
    IsPulsed1,
    IsPulsed2,
    IsPulsed3,
    IsPulsed4,
    IsPulsed5,
    IsPulsed6,
    IsPulsed7,
    StepIndex,
    NStep,
    feb_ssw,  
    feb_ssw1,
    feb_ssw2,
    feb_ssw3,
    feb_ssw4,
    feb_ssw5,
    feb_ssw6,
    feb_ssw7
  };
  // constructor
  LArRodBlockCalibrationV3(IMessageSvc* msgSvc);
 
  // ------ Identify RodBlockStructure -------
  static std::string BlockType() { return std::string("RodBlockCalibrationV3");}
 public:
  //void dumpFragment() { dumpFragment(m_FebBlock); }
  // ----------------- Encoding methods -----------------
  // Never to be used while decoding!
  // ----------------- Decoding methods -----------------
  // Never to be used while encoding!
  // set full ROD fragment before trying to get anything!
  // in case there is more than 1 FEB in 1 fragment, jump to next FEB
  virtual uint8_t getTDCPhase() const;
  virtual int  getNextRawData(int& channelNumber, std::vector<short>& samples, uint32_t& gain);
  virtual int  getNextAccumulatedCalibDigit(int& channelNumber,  std::vector < uint64_t >& samplesSum,  std::vector < uint64_t >& samples2Sum,  uint32_t& iStepTrigger, uint32_t& gain);
  virtual uint32_t getNumberOfSamples() const;
  virtual uint32_t getNumberOfGains() const;
  virtual uint32_t getRadd(uint32_t adc, uint32_t sample) const;
  virtual uint16_t getResults1Size() const;
  virtual uint16_t getResults2Size() const;
  virtual uint16_t getRawDataSize() const;
  virtual uint16_t getCtrl1(uint32_t adc) const;
  virtual uint16_t getCtrl2(uint32_t adc) const;
  virtual uint16_t getCtrl3(uint32_t adc) const;
  virtual uint32_t getStatus() const;
 
  virtual inline int setGain(const int GainValue); // ---------------- Define gain for decoding
  virtual inline  uint32_t  hasCalibBlock()   const {return getHeader16(ResultsOff1);} ; 
  virtual inline  uint32_t  hasRawDataBlock() const {return getHeader16(RawDataBlkOff);} ;
  virtual inline  uint32_t  hasControlWords() const {return getHeader16(RawDataBlkOff);} ;
 
private:
  void clearBlocks();
  virtual void resetPointers();
  //Separated blocks for encoding
  
  // One raw data block per gain to start with
  std::vector<uint32_t> m_RawDataBlock;
  //Counter for channels inside of a FEB
  int m_Result1Counter = 0;
  int m_Result1Index = 0;
  int m_Result2Counter = 0;
  int m_Result2Index = 0;
  int m_RawDataCounter = 0;
  int m_RawDataIndex = 0;
  //For fixed gain mode
  unsigned m_fixedGain;
  //FIXME, very ugly hack! See explanation in LArRodDecoder.h 
public:
  inline uint16_t getNTrigger() const;
  inline uint16_t getStepIndex() const;
  inline uint16_t getNStep() const;
  inline uint16_t getDAC() const;
  inline uint16_t getDelay() const;
  inline uint16_t getFebConfig() const;
  inline uint16_t getFirstSampleIndex() const;
 
  inline bool getPulsed(const unsigned channelNumber) const;
 
  virtual bool canSetCalibration() {return false;}
};
 
 
inline int LArRodBlockCalibrationV3::setGain(const int GainValue)
{//This RodBlockStructure allows only predefined gains 
  if (GainValue<0 || GainValue>3)
    return 0;
  m_fixedGain=GainValue;
  return 1;
}
 
inline uint16_t  LArRodBlockCalibrationV3::getFebConfig() const
{
  return getHeader16(FebConfig);
}
 
inline uint16_t  LArRodBlockCalibrationV3::getFirstSampleIndex() const
{
  return getHeader16(FirstSampleIndex);
}
 
inline bool  LArRodBlockCalibrationV3::getPulsed(const unsigned channelNumber) const
{
  int index=getHeader16(ResultsOff1);
  return getBit(m_FebBlock+index+IsPulsed/2,channelNumber);
}
 
 
 
#endif