CSCIndexerBase.h

Go to the documentation of this file.

#ifndef CSCIndexerBase_H
#define CSCIndexerBase_H

#include <DataFormats/MuonDetId/interface/CSCDetId.h>
#include <boost/tuple/tuple.hpp>
#include <utility>  // for pair
#include <vector>

class CSCIndexerBase {
public:
  typedef uint16_t IndexType;
  typedef uint32_t LongIndexType;
  typedef boost::tuple<CSCDetId,   // id
                       IndexType,  // HV segment
                       IndexType   // chip
                       >
      GasGainIndexType;

  CSCIndexerBase();
  virtual ~CSCIndexerBase();

  virtual std::string name() const { return "CSCIndexerBase"; }

  IndexType maxChamberIndex() const { return 540; }
  IndexType maxLayerIndex() const { return 3240; }
  virtual LongIndexType maxStripChannelIndex() const = 0;
  virtual IndexType maxChipIndex() const = 0;
  virtual IndexType maxGasGainIndex() const = 0;



  IndexType ringsInStation(IndexType is) const {
    const IndexType nrins[5] = {0, 3, 2, 2, 2};  // physical rings per station
    return nrins[is];
  }

  virtual IndexType onlineRingsInStation(IndexType is) const = 0;

  IndexType offlineRingsInStation(IndexType is) const {
    const IndexType nrings[5] = {0, 4, 2, 2, 2};  // offline rings per station
    return nrings[is];
  }

  IndexType chambersInRingOfStation(IndexType is, IndexType ir) const {
    const IndexType nCinR[16] = {36, 36, 36, 36, 18, 36, 0, 0, 18, 36, 0, 0, 18, 36, 0, 0};  // chambers in ring
    return nCinR[(is - 1) * 4 + ir - 1];
  }

  virtual IndexType stripChannelsPerOfflineLayer(IndexType is, IndexType ir) const = 0;

  virtual IndexType stripChannelsPerOnlineLayer(IndexType is, IndexType ir) const = 0;

  virtual IndexType chipsPerOnlineLayer(IndexType is, IndexType ir) const = 0;

  IndexType sectorsPerOnlineLayer(IndexType is, IndexType ir) const {
    return chipsPerOnlineLayer(is, ir) * hvSegmentsPerLayer(is, ir);
  }




  IndexType startChamberIndexInEndcap(IndexType ie, IndexType is, IndexType ir) const {
    const IndexType nschin[32] = {1,   37,  73,  1,   109, 127, 0, 0, 163, 181, 0, 0, 217, 469, 0, 0,
                                  235, 271, 307, 235, 343, 361, 0, 0, 397, 415, 0, 0, 451, 505, 0, 0};
    return nschin[(ie - 1) * 16 + (is - 1) * 4 + ir - 1];
  }

  IndexType chamberIndex(IndexType ie, IndexType is, IndexType ir, IndexType ic) const {
    return startChamberIndexInEndcap(ie, is, ir) + ic - 1;  // -1 so start index _is_ ic=1
  }

  IndexType chamberIndex(const CSCDetId &id) const {
    return chamberIndex(id.endcap(), id.station(), id.ring(), id.chamber());
  }



  IndexType layerIndex(IndexType ie, IndexType is, IndexType ir, IndexType ic, IndexType il) const {
    const IndexType layersInChamber = 6;
    return (chamberIndex(ie, is, ir, ic) - 1) * layersInChamber + il;
  }

  IndexType layerIndex(const CSCDetId &id) const {
    return layerIndex(id.endcap(), id.station(), id.ring(), id.chamber(), id.layer());
  }



  virtual IndexType stripChannelsPerLayer(IndexType is, IndexType ir) const = 0;

  virtual LongIndexType stripChannelStart(IndexType ie, IndexType is, IndexType ir) const = 0;

  LongIndexType stripChannelIndex(
      IndexType ie, IndexType is, IndexType ir, IndexType ic, IndexType il, IndexType istrip) const {
    return stripChannelStart(ie, is, ir) + ((ic - 1) * 6 + il - 1) * stripChannelsPerLayer(is, ir) + (istrip - 1);
  }

  LongIndexType stripChannelIndex(const CSCDetId &id, IndexType istrip) const {
    return stripChannelIndex(id.endcap(), id.station(), id.ring(), id.chamber(), id.layer(), istrip);
  }



  virtual IndexType chipsPerLayer(IndexType is, IndexType ir) const = 0;

  virtual IndexType chipStart(IndexType ie, IndexType is, IndexType ir) const = 0;

  IndexType chipIndex(IndexType ie, IndexType is, IndexType ir, IndexType ic, IndexType il, IndexType ichip) const {
    return chipStart(ie, is, ir) + ((ic - 1) * 6 + il - 1) * chipsPerLayer(is, ir) + (ichip - 1);
  }

  IndexType chipIndex(const CSCDetId &id, IndexType ichip) const {
    return chipIndex(id.endcap(), id.station(), id.ring(), id.chamber(), id.layer(), ichip);
  }

  IndexType chipIndex(IndexType istrip) const { return (istrip - 1) / 16 + 1; }



  IndexType hvSegmentsPerLayer(IndexType is, IndexType ir) const {
    const IndexType nSinL[16] = {1, 3, 3, 1, 3, 5, 0, 0, 3, 5, 0, 0, 3, 5, 0, 0};
    return nSinL[(is - 1) * 4 + ir - 1];
  }

  IndexType hvSegmentIndex(IndexType is, IndexType ir, IndexType iwire) const;

  IndexType sectorsPerLayer(IndexType is, IndexType ir) const {
    return chipsPerLayer(is, ir) * hvSegmentsPerLayer(is, ir);
  }

  virtual IndexType sectorStart(IndexType ie, IndexType is, IndexType ir) const = 0;

  IndexType gasGainIndex(IndexType ie,
                         IndexType is,
                         IndexType ir,
                         IndexType ic,
                         IndexType il,
                         IndexType ihvsegment,
                         IndexType ichip) const {
    return sectorStart(ie, is, ir) + ((ic - 1) * 6 + il - 1) * sectorsPerLayer(is, ir) +
           (ihvsegment - 1) * chipsPerLayer(is, ir) + (ichip - 1);
  }

  IndexType gasGainIndex(const CSCDetId &id, IndexType istrip, IndexType iwire) const {
    return gasGainIndex(id.endcap(),
                        id.station(),
                        id.ring(),
                        id.chamber(),
                        id.layer(),
                        hvSegmentIndex(id.station(), id.ring(), iwire),
                        chipIndex(istrip));
  }

  IndexType gasGainIndex(IndexType ihvsegment, IndexType ichip, const CSCDetId &id) const {
    return gasGainIndex(id.endcap(), id.station(), id.ring(), id.chamber(), id.layer(), ihvsegment, ichip);
  }



  CSCDetId detIdFromChamberIndex(IndexType ici) const;

  CSCDetId detIdFromLayerIndex(IndexType ili) const;

  virtual std::pair<CSCDetId, IndexType> detIdFromStripChannelIndex(LongIndexType ichi) const = 0;

  virtual std::pair<CSCDetId, IndexType> detIdFromChipIndex(IndexType ichi) const = 0;

  virtual GasGainIndexType detIdFromGasGainIndex(IndexType igg) const = 0;


  virtual int dbIndex(const CSCDetId &id, int &channel) const = 0;

  IndexType chamberLabelFromChamberIndex(IndexType) const;

protected:
  CSCDetId detIdFromChamberLabel(IndexType ie, IndexType icl) const;

  std::vector<IndexType> chamberLabel_;
};

#endif