TotemRPDetId.h

Go to the documentation of this file.

/****************************************************************************
 *
 * This is a part of TOTEM offline software.
 * Authors: 
 *  Hubert Niewiadomski
 *  Jan Kašpar (jan.kaspar@gmail.com) 
 *
 ****************************************************************************/

#ifndef DataFormats_TotemRPDetId_TotemRPDetId
#define DataFormats_TotemRPDetId_TotemRPDetId

#include "DataFormats/DetId/interface/DetId.h"

#include "FWCore/Utilities/interface/Exception.h"

#include <iosfwd>
#include <iostream>
#include <string>

class TotemRPDetId : public DetId
{  
  public:
    TotemRPDetId();
  
    explicit TotemRPDetId(uint32_t id);
  
    TotemRPDetId(unsigned int Arm, unsigned int Station, unsigned int RomanPot, unsigned int Detector);

    static const unsigned int totem_rp_subdet_id = 3;
  
    static const unsigned int startArmBit = 24, maskArm = 0x1, maxArm = 1;
    static const unsigned int startStationBit = 22, maskStation = 0x3, maxStation = 2;
    static const unsigned int startRPBit = 19, maskRP = 0x7, maxRP = 5;
    static const unsigned int startDetBit = 15, maskDet = 0xF, maxDet = 9;
     
    inline int arm() const
    {
      return int ((id_>>startArmBit) & maskArm);
    }

    inline int station() const
    {
      return int ((id_>>startStationBit) & maskStation);
    }

    inline int romanPot() const
    {
      return int ((id_>>startRPBit) & maskRP);
    }

    inline int detector() const
    {
      return int ((id_>>startDetBit) & maskDet);
    }

    int rpCopyNumber() const
    {
      return romanPot() + 10*station() + 100*arm();
    }

    bool isStripsCoordinateUDirection() const
    {
      return detector()%2;
    }

    bool isStripsCoordinateVDirection() const
    {
      return !isStripsCoordinateUDirection();
    }
    
    inline unsigned int detectorDecId() const
    {
      return detector() + romanPot()*10 + station()*100 + arm()*1000;
    }

    //-------------------------------- static members ---------------------------------------
    
    static bool check(unsigned int raw)
    {
      return ((raw >> DetId::kDetOffset) & 0xF) == DetId::VeryForward &&
        ((raw >> DetId::kSubdetOffset) & 0x7) == totem_rp_subdet_id;
    }

    static unsigned int rawToDecId(unsigned int raw)
    {
      return ((raw >> startArmBit) & maskArm) * 1000
        + ((raw >> startStationBit) & maskStation) * 100
        + ((raw >> startRPBit) & maskRP) * 10
        + ((raw >> startDetBit) & maskDet);
    }

    static unsigned int decToRawId(unsigned int dec)
    {
      unsigned int i = (DetId::VeryForward << DetId::kDetOffset) | (totem_rp_subdet_id << DetId::kSubdetOffset);
      i &= 0xFE000000;
      i |= ((dec % 10) & maskDet) << startDetBit; dec /= 10;
      i |= ((dec % 10) & maskRP) << startRPBit; dec /= 10;
      i |= ((dec % 10) & maskStation) << startStationBit; dec /= 10;
      i |= ((dec % 10) & maskArm) << startArmBit;
      return i;
    }

    static unsigned int rpOfDet(unsigned int i) { return i / 10; }

    static unsigned int stOfDet(unsigned int i) { return i / 100; }

    static unsigned int armOfDet(unsigned int i) { return i / 1000; }

    static unsigned int stOfRP(unsigned int i) { return i / 10; }

    static unsigned int armOfRP(unsigned int i) { return i / 100; }

    static unsigned int armOfSt(unsigned int i) { return i / 10; }
     

    static bool isStripsCoordinateUDirection(int Detector)
    {
      return Detector%2;
    }


    enum NameFlag {nShort, nFull, nPath};

    enum ElementLevel {lSystem, lArm, lStation, lRP, lPlane, lChip, lStrip};

    static std::string systemName(NameFlag flag = nFull);

    static std::string armName(unsigned int id, NameFlag flag = nFull);

    static std::string stationName(unsigned int id, NameFlag flag = nFull);
  
    static std::string rpName(unsigned int id, NameFlag flag = nFull);
  
    static std::string planeName(unsigned int id, NameFlag flag = nFull);
  
    static std::string chipName(unsigned int id, NameFlag flag = nFull);
  
    static std::string stripName(unsigned int id, unsigned char strip, NameFlag flag = nFull);

    static std::string officialName(ElementLevel level, unsigned int id, NameFlag flag = nFull, unsigned char strip = 0);

  private:
    inline void init(unsigned int Arm, unsigned int Station, unsigned int RomanPot, unsigned int Detector);
};

std::ostream& operator<<(std::ostream& os, const TotemRPDetId& id);

#endif