GctFormatTranslateMCLegacy.h

Go to the documentation of this file.

#ifndef GctFormatTranslateMCLegacy_h_
#define GctFormatTranslateMCLegacy_h_

#include "EventFilter/GctRawToDigi/src/GctFormatTranslateBase.h"

// ************************************************************************
// ***  THE TRANSLATION PROCESS MUST NEVER THROW ANY KIND OF EXCEPTION! ***
// ************************************************************************

class GctFormatTranslateMCLegacy : public GctFormatTranslateBase {
public:
  /* PUBLIC METHODS */


  explicit GctFormatTranslateMCLegacy(bool hltMode = false, bool unpackSharedRegions = false);

  ~GctFormatTranslateMCLegacy() override;  

  GctBlockHeader generateBlockHeader(const unsigned char* data) const override;

  bool convertBlock(const unsigned char* d, const GctBlockHeader& hdr) override;

  /* ------------------------------ */
  /* Public Block Packing Functions */
  /* ------------------------------ */


  void writeGctOutEmAndEnergyBlock(unsigned char* d,
                                   const L1GctEmCandCollection* iso,
                                   const L1GctEmCandCollection* nonIso,
                                   const L1GctEtTotalCollection* etTotal,
                                   const L1GctEtHadCollection* etHad,
                                   const L1GctEtMissCollection* etMiss);


  void writeGctOutJetBlock(unsigned char* d,
                           const L1GctJetCandCollection* cenJets,
                           const L1GctJetCandCollection* forJets,
                           const L1GctJetCandCollection* tauJets,
                           const L1GctHFRingEtSumsCollection* hfRingSums,
                           const L1GctHFBitCountsCollection* hfBitCounts,
                           const L1GctHtMissCollection* htMiss);

  void writeRctEmCandBlocks(unsigned char* d, const L1CaloEmCollection* rctEm);

  void writeAllRctCaloRegionBlock(unsigned char* d, const L1CaloRegionCollection* rctCalo);

protected:
  /* PROTECTED METHODS */

  /* Static data member access methods */
  const BlockLengthMap& blockLengthMap() const final {
    return m_blockLength;
  }  

  const BlockNameMap& blockNameMap() const final { return m_blockName; }  

  const BlkToRctCrateMap& rctEmCrateMap() const final {
    return m_rctEmCrate;
  }  

  const BlkToRctCrateMap& rctJetCrateMap() const final {
    return m_rctJetCrate;
  }  

  const BlockIdToEmCandIsoBoundMap& internEmIsoBounds() const final {
    return m_internEmIsoBounds;
  }  

  /* Other general methods */
  uint32_t generateRawHeader(const uint32_t blockId,
                             const uint32_t nSamples,
                             const uint32_t bxId,
                             const uint32_t eventId) const override;

private:
  /* PRIVATE TYPES & TYPEDEFS */

  typedef void (GctFormatTranslateMCLegacy::*PtrToUnpackFn)(const unsigned char*, const GctBlockHeader&);
  typedef std::map<unsigned int, PtrToUnpackFn> BlockIdToUnpackFnMap;

  /* PRIVATE MEMBER DATA */

  static const BlockLengthMap m_blockLength;

  static const BlockNameMap m_blockName;

  static const BlkToRctCrateMap m_rctEmCrate;

  static const BlkToRctCrateMap m_rctJetCrate;

  static const BlockIdToEmCandIsoBoundMap m_internEmIsoBounds;

  static const BlockIdToUnpackFnMap m_blockUnpackFn;

  /* PRIVATE METHODS */

  /* --------------------------------- */
  /* Private Block Unpacking Functions */
  /* --------------------------------- */

  void blockToGctEmCandsAndEnergySums(const unsigned char* d, const GctBlockHeader& hdr);

  void blockToGctJetCandsAndCounts(const unsigned char* d, const GctBlockHeader& hdr);

  void blockToRctEmCand(const unsigned char* d, const GctBlockHeader& hdr);

  void blockToFibres(const unsigned char* d, const GctBlockHeader& hdr);

  void blockToFibresAndToRctEmCand(const unsigned char* d, const GctBlockHeader& hdr);

  void blockToAllRctCaloRegions(const unsigned char* d, const GctBlockHeader& hdr);

  /* ----------------------------- */
  /* Miscellaneous Private Methods */
  /* ----------------------------- */


  template <typename Collection>
  bool findBx0OffsetInCollection(unsigned& bx0Offset, const Collection* coll);
};

#endif