KLMElementNumbers.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/bklm/BKLMElementNumbers.h>
#include <klm/dataobjects/eklm/EKLMElementNumbers.h>
 
/* C++ headers. */
#include <cstdint>
#include <string>
 
namespace Belle2 {

  class KLMElementNumbers {
 
  public:

    enum Subdetector {

      c_BKLM = 1,

      c_EKLM = 2,
 
    };

    static const KLMElementNumbers& Instance();

    KLMChannelNumber channelNumber(int subdetector, int section, int sector, int layer,
                                   int plane, int strip) const;

    static KLMChannelNumber channelNumberBKLM(int section, int sector, int layer, int plane,
                                              int strip);

    static KLMChannelNumber channelNumberBKLM(int bklmChannel);

    KLMChannelNumber channelNumberEKLM(int section, int sector, int layer, int plane,
                                       int strip) const;

    static KLMChannelNumber channelNumberEKLM(int eklmStrip);

    bool isBKLMChannel(KLMChannelNumber channel) const;

    bool isEKLMChannel(KLMChannelNumber channel) const;

    int localChannelNumberBKLM(KLMChannelNumber channel) const;

    int localChannelNumberEKLM(KLMChannelNumber channel) const;

    void channelNumberToElementNumbers(
      KLMChannelNumber channel, int* subdetector, int* section, int* sector,
      int* layer, int* plane, int* strip) const;

    KLMPlaneNumber planeNumber(int subdetector, int section, int sector,
                               int layer, int plane) const;

    static KLMPlaneNumber planeNumberBKLM(int section, int sector, int layer,
                                          int plane);

    KLMPlaneNumber planeNumberEKLM(int section, int sector, int layer,
                                   int plane) const;

    KLMModuleNumber moduleNumber(int subdetector, int section, int sector,
                                 int layer) const;

    static KLMModuleNumber moduleNumberBKLM(int section, int sector, int layer);

    KLMModuleNumber moduleNumberEKLM(int section, int sector, int layer) const;

    KLMModuleNumber moduleNumberByChannel(KLMChannelNumber channel) const;

    void moduleNumberToElementNumbers(
      KLMModuleNumber module, int* subdetector, int* section, int* sector,
      int* layer) const;

    unsigned int getNChannelsModule(KLMModuleNumber module) const;

    static KLMSectorNumber sectorNumberBKLM(int section, int sector);

    KLMSectorNumber sectorNumberEKLM(int section, int sector) const;

    static int getExtrapolationLayer(int subdetector, int layer);

    static constexpr int getMaximalExtrapolationLayer()
    {
      return EKLMElementNumbers::getMaximalLayerNumber() +
             BKLMElementNumbers::getMaximalLayerNumber();
    }

    static constexpr int getTotalModuleNumber()
    {
      return EKLMElementNumbers::getMaximalSectorGlobalNumber() +
             BKLMElementNumbers::getMaximalLayerGlobalNumber();
    }

    static int getMinimalPlaneNumber(int subdetector);

    static constexpr int getMaximalPlaneNumber()
    {
      /* BKLM plane number is 0-based! */
      return std::max(EKLMElementNumbers::getMaximalPlaneNumber(),
                      BKLMElementNumbers::getMaximalPlaneNumber() + 1);
    }

    std::string getSectorDAQName(int subdetector, int section, int sector) const;

    static constexpr int getTotalChannelNumber()
    {
      return BKLMElementNumbers::getTotalChannelNumber() +
             EKLMElementNumbers::getTotalChannelNumber();
    }
 
  private:

    KLMElementNumbers();

    ~KLMElementNumbers();

    static constexpr uint16_t m_BKLMOffset = 0x8000;

    const EKLMElementNumbers* m_eklmElementNumbers;
 
  };

}