KLMUnpackerModule.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
/* KLM headers. */
#include <klm/dataobjects/KLMDigit.h>
#include <klm/dataobjects/KLMDigitEventInfo.h>
#include <klm/dataobjects/KLMDigitRaw.h>
#include <klm/dataobjects/KLMElementNumbers.h>
#include <klm/dbobjects/KLMElectronicsMap.h>
#include <klm/dbobjects/KLMScintillatorFEEParameters.h>
#include <klm/time/KLMTime.h>
 
/* Basf2 headers. */
#include <framework/core/Module.h>
#include <framework/database/DBObjPtr.h>
#include <framework/datastore/StoreArray.h>
#include <rawdata/dataobjects/RawKLM.h>
 
/* C++ headers. */
#include <string>
 
namespace Belle2 {

  class KLMUnpackerModule : public Module {
 
  public:

    KLMUnpackerModule();

    ~KLMUnpackerModule() override;

    void initialize() override;

    void beginRun() override;

    void event() override;
 
  private:

    void createDigit(
      const KLM::RawData* raw, const KLMDigitRaw* klmDigitRaw,
      KLMDigitEventInfo* klmDigitEventInfo, int subdetector, int section,
      int sector, int layer, int plane, int strip, int lastStrip);

    void unpackKLMDigit(const int* rawData, int copper, int hslb,
                        int daqSubdetector,
                        KLMDigitEventInfo* klmDigitEventInfo);

    static void convertPCIe40ToCOPPER(int channel, unsigned int* copper, int* hslb);
 
    /* Module parameters. */

    std::string m_outputKLMDigitsName;

    bool m_WriteDigitRaws;

    bool m_WriteWrongHits;

    bool m_DebugElectronicsMap;

    bool m_DAQChannelBKLMScintillators;

    int m_DAQChannelModule;
 
    /* EKLM parameters. */

    bool m_IgnoreWrongHits;

    bool m_IgnoreStrip0;
 
    /* BKLM parameters. */

    bool m_keepEvenPackages = false;
 
    /* Common database objects. */

    DBObjPtr<KLMElectronicsMap> m_ElectronicsMap;

    DBObjPtr<KLMScintillatorFEEParameters> m_FEEParameters;

    KLMTime* m_Time;

    StoreArray<RawKLM> m_RawKLMs;

    StoreArray<KLMDigit> m_Digits;

    StoreArray<KLMDigitEventInfo> m_DigitEventInfos;

    StoreArray<KLMDigit> m_klmDigitsOutOfRange;

    StoreArray<KLMDigitRaw> m_klmDigitRaws;
 
    /* Other common variables. */

    const KLMElementNumbers* m_ElementNumbers;

    unsigned int m_triggerCTimeOfPreviousEvent;
 
  };

}