EcalSelectiveReadout.h

Go to the documentation of this file.

//emacs settings:-*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil -*-"
/*
 */

#ifndef ECALSELECTIVEREADOUT_H
#define ECALSELECTIVEREADOUT_H

#include <vector>
#include <iosfwd>
#include "DataFormats/EcalDetId/interface/EBDetId.h"
#include "DataFormats/EcalDetId/interface/EEDetId.h"
#include "DataFormats/EcalDetId/interface/EcalScDetId.h"
#include "DataFormats/EcalDetId/interface/EcalTrigTowerDetId.h"
#include "Geometry/CaloTopology/interface/EcalTrigTowerConstituentsMap.h"
#include "Geometry/EcalMapping/interface/EcalElectronicsMapping.h"

#define ECALSELECTIVEREADOUT_NOGEOM  //version w/o geometry dependency.

#ifndef ECALSELECTIVEREADOUT_NOGEOM
#include "Geometry/CaloGeometry/interface/CaloGeometry.h"
#endif  //ECALSELECTIVEREADOUT_NOGEOM not defined

class EcalSelectiveReadout {
public:
  static const int FORCED_MASK = 0x4;

  //type definitions
  typedef enum {
    UNKNOWN = -1 & ~FORCED_MASK,
    LOWINTEREST = 0x0,
    SINGLE = 0x1,
    NEIGHBOUR = 0x2,
    CENTER = 0x3,
    FORCED_LOWINTEREST = 0x4,  //0x0 | 0x4
    FORCED_SINGLE = 0x5,       //0x1 | 0x4
    FORCED_NEIGHBOUR = 0x6,    //0x2 | 0x4
    FORCED_CENTER = 0x7        //0x3 | 0x4
  } towerInterest_t;

  typedef enum {
    TTF_UNKNOWN = -1,
    TTF_LOW_INTEREST = 0x0,
    TTF_MID_INTEREST = 0x1,
    /* 0x2 not used */
    TTF_HIGH_INTEREST = 0X3,
    TTF_FORCED_LOW_INTEREST = 0x4,  //0x0 | 0x4
    TTF_FORCED_MID_INTEREST = 0x5,  //0x1 | 0x4
    /* 0x6 not used*/
    TTF_FORCED_HIGH_INTEREST = 0x7  //0x3 | 0x4
                                    //     TTF_FORCED_RO_LINK_SYNC_ERR = 0x4,
                                    //     TTF_FORCED_RO_HAMMING_ERR = 0X5,
                                    //     TTF_FORCED_RO_OTHER1 = 0X6,
                                    //     TTF_FORCED_RO_OTHER2 = 0X7
  } ttFlag_t;

  //deprecated. Use instead FORCED_MASK
  static const int TTF_FORCED_RO_MASK = FORCED_MASK;

  //constants
public:
  const static size_t nBarrelEtaBins = 170;
  const static size_t nBarrelPhiBins = 360;
  const static size_t nEndcapXBins = 100;
  const static size_t nEndcapYBins = 100;
  const static size_t supercrystalEdge = 5;
  const static size_t nSupercrystalXBins = nEndcapXBins / supercrystalEdge;
  const static size_t nSupercrystalYBins = nEndcapYBins / supercrystalEdge;
  const static size_t nBarrelTowerEtaBins = nBarrelEtaBins / 5;
  const static size_t nBarrelTowerPhiBins = nBarrelPhiBins / 5;
  const static size_t nEndcaps = 2;
  const static size_t nEndcapTriggerTowersInEta = 11;
  const static size_t nBarrelTriggerTowersInEta = 34;
  const static size_t nTriggerTowersInEta = 2 * nEndcapTriggerTowersInEta + nBarrelTriggerTowersInEta;
  const static size_t nTriggerTowersInPhi = 72;

  const static int maxDccChs = 68;

  const static int nDccPerEe = 9;

  //constructor(s) and destructor(s)
public:
  EcalSelectiveReadout(int dEta = 1, int dPhi = 1);

  //method(s)

  void setTriggerMap(const EcalTrigTowerConstituentsMap* map) { theTriggerMap = map; }

  void setElecMap(const EcalElectronicsMapping* map) { theElecMap = map; }

#ifndef ECALSELECTIVEREADOUT_NOGEOM
  void setGeometry(const CaloGeometry* caloGeometry) { theGeometry = caloGeometry; }
#endif  //ECALSELECTIVEREADOUT_NOGEOM not defined

  void runSelectiveReadout0(const ttFlag_t towerFlags[nTriggerTowersInEta][nTriggerTowersInPhi]);

  towerInterest_t getCrystalInterest(const EBDetId& ebDetId) const;

  towerInterest_t getCrystalInterest(const EEDetId& eeDetId) const;

  towerInterest_t getSuperCrystalInterest(const EcalScDetId& scDetId) const;

  towerInterest_t getTowerInterest(const EcalTrigTowerDetId& towerId) const;

  void printHeader(std::ostream& os) const;

  void print(std::ostream& os) const;

  void printBarrel(std::ostream& os) const;
  void printEndcap(int endcap, std::ostream& s) const;

private:
  towerInterest_t& eeRuInterest(const EEDetId& id);

  towerInterest_t& eeRuInterest(const EcalScDetId& id);

  void classifyTriggerTowers(const ttFlag_t ttFlags[nTriggerTowersInEta][nTriggerTowersInPhi]);

  void resetEeRuInterest();

  void setLower(int& var, int val) const {
    if (val < var)
      var = val;
  }

  template <class T>
  void setHigher(T& var, T val) const {
    if (val > var)
      var = val;
  }

  template <class T>
  void combineFlags(T& var, T val) const {
    var = (T)(std::max(val & ~TTF_FORCED_RO_MASK,  //actual flag value:
                       //                            take highest
                       var & ~TTF_FORCED_RO_MASK)  //beware: must work also
              //                                     for UNKNOW=-1
              //                                     ->compare the whole
              //                                     integer but with
              //                                     the forced bit masked.
              | ((val | var) & 0x4));  //forced bit: set it if any of the two is
    //                                 already set

    if (var < 0 || var > 7) {
      std::cout << __FILE__ << ":" << __LINE__ << ": ---------->" << var << " " << val << " "
                << std::max(val & 0x3, var & 0x3) << " " << (val | var) << " " << ((val | var) & 0x4) << " "
                << (std::max(val & 0x3, var & 0x3) | ((val | var) & 0x4)) << " "
                << (T)(std::max(val & 0x3, var & 0x3) | ((val | var) & 0x4)) << "\n";
    }
  }

  //   /** Propagate TTF flag bit on towerInterest. TT interest forced bit is set
  //    * if TTF forced bit is set, otherwise it is not touched.
  //    * @param ttFlags TT flags
  //    */
  //   void propagateTtForcedBit(const ttFlag_t ttFlags[nTriggerTowersInEta][nTriggerTowersInPhi]);

  void printDccChMap(std::ostream& os) const;

  //attribute(s)
private:
  const EcalTrigTowerConstituentsMap* theTriggerMap;
  const EcalElectronicsMapping* theElecMap;

#ifndef ECALSELECTIVEREADOUT_NOGEOM
  const CaloGeometry* theGeometry;
#endif  //ECALSELECTIVEREADOUT_NOGEOM not defined
  towerInterest_t towerInterest[nTriggerTowersInEta][nTriggerTowersInPhi];
  //towerInterest_t supercrystalInterest[nEndcaps][nSupercrystalXBins][nSupercrystalYBins];
  towerInterest_t eeRuInterest_[nEndcaps][nDccPerEe][maxDccChs];
  int dEta;
  int dPhi;

  // for printout
  const static char srpFlagMarker[];
};

std::ostream& operator<<(std::ostream& os, const EcalSelectiveReadout& selectiveReadout);

#endif