eclUnpackerModule.h

/**************************************************************************
 * BASF2 (Belle Analysis Framework 2)                                     *
 * Copyright(C) 2020 - Belle II Collaboration                             *
 *                                                                        *
 * Author: The Belle II Collaboration                                     *
 * Contributors: Vasily Shebalin, Mikhail Remnev                          *
 *                                                                        *
 * This software is provided "as is" without any warranty.                *
 **************************************************************************/
#pragma once
 
// Framework
#include <framework/datastore/StoreArray.h>
#include <framework/datastore/StoreObjPtr.h>
#include <framework/database/DBObjPtr.h>
#include <framework/core/FrameworkExceptions.h>
#include <framework/core/Module.h>
 
// ECL
#include <ecl/utility/ECLChannelMapper.h>
 
namespace Belle2 {
  class EventMetaData;
  class RawECL;
  class ECLDigit;
  class ECLTrig;
  class ECLDsp;
 
  class ECLUnpackerModule : public Module {
  public:
    ECLUnpackerModule();
    virtual ~ECLUnpackerModule();
 
    virtual void initialize() override;
    virtual void beginRun() override;
    virtual void event() override;
    virtual void endRun() override;
    virtual void terminate() override;
 
    BELLE2_DEFINE_EXCEPTION(Unexpected_end_of_FINESSE_buffer,
                            "Unexpected end of the FINESS buffer is reached while reading ShpaerDSP data");
    BELLE2_DEFINE_EXCEPTION(Bad_ShaperDSP_header, "Corrupted Shaper DSP header");
 
    enum ECLUnpack {
      ECL_DISCARD_DSP_DATA   = 0x00000001,
      ECL_KEEP_GOOD_DSP_DATA = 0x00000002,
      ECL_OFFLINE_ADC_FIT = 0x00000004,
    };
 
  protected:
 
 
  private:
    int m_globalEvtNum;
    int m_localEvtNum;
 
    unsigned int* m_bufPtr;
    int m_bufPos;
    int m_bufLength;
    int m_bitPos;
 
    bool m_storeTrigTime;
    bool m_storeUnmapped;
    bool m_useUnpackingParameters;
 
    long m_evtNumReportedMask = 0;
    long m_tagsReportedMask = 0;
    long m_phasesReportedMask = 0;
    long m_badHeaderReportedMask = 0;
 
    void doEvtNumReport(unsigned int iCrate, int tag, int evt_number);
    void doTagsReport(unsigned int iCrate, int tag0, int tag1);
    void doPhasesReport(unsigned int iCrate, int phase0, int phase1);
    void doBadHeaderReport(unsigned int iCrate);
 
    bool evtNumReported(unsigned int iCrate) { return m_evtNumReportedMask & (1L << (iCrate - 1)); }
    bool tagsReported(unsigned int iCrate) { return m_tagsReportedMask & (1L << (iCrate - 1)); }
    bool phasesReported(unsigned int iCrate) { return m_phasesReportedMask & (1L << (iCrate - 1)); }
    bool badHeaderReported(unsigned int iCrate) { return m_badHeaderReportedMask & (1L << (iCrate - 1)); }
 
    std::string m_eclDigitsName;
    std::string m_eclTrigsName;
    std::string m_eclDspsName;
    std::string m_eclMapperInitFileName;
 
    ECL::ECLChannelMapper m_eclMapper;
 
    DBObjPtr<ECLChannelMap> m_unpackingParams;
 
    /*   Input data   */
 
    StoreArray<RawECL>   m_rawEcl;
    StoreObjPtr<EventMetaData> m_eventMetaData;
 
    /*   Output data  */
 
    StoreArray<ECLDigit> m_eclDigits;
    StoreArray<ECLTrig>  m_eclTrigs;
    StoreArray<ECLDsp>   m_eclDsps;
 
    int m_debugLevel;
 
    unsigned int readNextCollectorWord();
    unsigned int readNBits(int bitsToRead);
    void readRawECLData(RawECL* rawCOPPERData, int n);
    bool isDSPValid(int cellID, int crate, int shaper, int channel, int amp, int time, int quality);
 
  };
}//namespace Belle2