First implementation of PHOS trigger (#5821)

Implementation of calibration devices

Co-authored-by: Dmitri Peresunko <Dmitri.Peresunko@cern.ch>

Author: peressounko

DataFormats/Detectors/PHOS/include/DataFormatsPHOS/Cell.h

@@ -34,7 +34,8 @@ constexpr float kTime0 = 150.e-9;       //-Minimal time to be digitized
 enum ChannelType_t {
   HIGH_GAIN, ///< High gain channel
   LOW_GAIN,  ///< Low gain channel
-  TRU        ///< TRU channel
+  TRU2x2,    ///< TRU channel, 2x2 trigger
+  TRU4x4     ///< TRU channel, 4x4 trigger
 };
 
 class Cell

DataFormats/Detectors/PHOS/include/DataFormatsPHOS/Cluster.h

@@ -64,10 +64,14 @@ class Cluster
 
   float getTime() const { return mTime; }
 
+  char firedTrigger() const { return mFiredTrigger; }
+  void setFiredTrigger(char t) { mFiredTrigger = t; }
+
  protected:
   char mMulDigit = 0;            ///< Digit nultiplicity
   char mModule = 0;              ///< Module number
   char mNExMax = -1;             ///< number of (Ex-)maxima before unfolding
+  char mFiredTrigger = 0;        ///< matched with PHOS trigger: 0 no match, bit 1 with 2x2, bit 2 with 4x4
   float mLocalPosX = 0.;         ///< Center of gravity position in local module coordunates (phi direction)
   float mLocalPosZ = 0.;         ///< Center of gravity position in local module coordunates (z direction)
   float mFullEnergy = 0.;        ///< full energy of a shower
@@ -78,7 +82,7 @@ class Cluster
   float mTime = 0.;              ///< Time of the digit with maximal energy deposition
   float mDistToBadChannel = 999; ///< Distance to nearest bad crystal
 
-  ClassDefNV(Cluster, 2);
+  ClassDefNV(Cluster, 3);
 };
 } // namespace phos
 } // namespace o2

DataFormats/Detectors/PHOS/include/DataFormatsPHOS/Digit.h

@@ -38,6 +38,10 @@ class Digit : public DigitBase
   /// particle in case of MC \return constructed Digit
   Digit(short cell, float amplitude, float time, int label);
 
+  /// \brief Contructor for TRU Digits
+  /// \param cell truId of a tile, amplitude energy deposited in a tile, time, triggerType 2x2 or 4x4, dummy label
+  Digit(short cell, float amplitude, float time, bool isTrigger2x2, int label);
+
   /// \brief Digit constructor from Hit
   /// \param PHOS Hit
   /// \return constructed Digit
@@ -94,10 +98,16 @@ class Digit : public DigitBase
 
   void addEnergyTime(float energy, float time);
 
+  // true if tru and not readount digit
+  bool isTRU() const { return mAbsId >= NREADOUTCHANNELS; }
+
   /// \brief Absolute sell id
   short getAbsId() const { return mAbsId; }
   void setAbsId(short cellId) { mAbsId = cellId; }
 
+  short getTRUId() const { return mAbsId - NREADOUTCHANNELS; }
+  void setTRUId(short cellId) { mAbsId = cellId + NREADOUTCHANNELS; }
+
   /// \brief Energy deposited in a cell
   float getAmplitude() const { return mAmplitude; }
   void setAmplitude(float amplitude) { mAmplitude = amplitude; }
@@ -110,6 +120,8 @@ class Digit : public DigitBase
   bool isHighGain() const { return mIsHighGain; }
   void setHighGain(Bool_t isHG) { mIsHighGain = isHG; }
 
+  bool is2x2Tile() { return isTRU() && isHighGain(); }
+
   /// \brief index of entry in MCLabels array
   /// \return ndex of entry in MCLabels array
   int getLabel() const { return mLabel; }
@@ -127,7 +139,7 @@ class Digit : public DigitBase
   void PrintStream(std::ostream& stream) const;
 
  private:
-  // friend class boost::serialization::access;
+  static constexpr short NREADOUTCHANNELS = 14337; ///< Number of channels starting from 1
 
   bool mIsHighGain = true; ///< High Gain or Low Gain channel (for calibration)
   short mAbsId = 0;        ///< cell index (absolute cell ID)

DataFormats/Detectors/PHOS/src/Cell.cxx

@@ -22,7 +22,7 @@ using namespace o2::phos;
 
 Cell::Cell(short absId, float energy, float time, ChannelType_t ctype)
 {
-  if (ctype == ChannelType_t::TRU) {
+  if (ctype == ChannelType_t::TRU2x2 || ctype == ChannelType_t::TRU4x4) {
     setTRUId(absId);
   } else {
     setAbsId(absId);
@@ -127,9 +127,11 @@ void Cell::setType(ChannelType_t ctype)
 {
   switch (ctype) {
     case ChannelType_t::HIGH_GAIN:
+    case ChannelType_t::TRU2x2:
       setHighGain();
       break;
     case ChannelType_t::LOW_GAIN:
+    case ChannelType_t::TRU4x4:
       setLowGain();
       break;
     default:;
@@ -138,12 +140,19 @@ void Cell::setType(ChannelType_t ctype)
 
 ChannelType_t Cell::getType() const
 {
-  if (getHighGain()) {
-    return ChannelType_t::HIGH_GAIN;
-  } else if (getTRU()) {
-    return ChannelType_t::TRU;
+  if (getTRU()) {
+    if (getHighGain()) {
+      return ChannelType_t::TRU2x2;
+    } else {
+      return ChannelType_t::TRU4x4;
+    }
+  } else {
+    if (getHighGain()) {
+      return ChannelType_t::HIGH_GAIN;
+    } else {
+      return ChannelType_t::LOW_GAIN;
+    }
   }
-  return ChannelType_t::LOW_GAIN;
 }
 
 void Cell::setLowGain()

DataFormats/Detectors/PHOS/src/Digit.cxx

@@ -21,6 +21,11 @@ Digit::Digit(short absId, float amplitude, float time, int label)
   : DigitBase(time), mAmplitude(amplitude), mTime(time), mAbsId(absId), mLabel(label)
 {
 }
+Digit::Digit(short truId, float amplitude, float time, bool isTrigger2x2, int /*dummy*/)
+  : DigitBase(time), mAmplitude(amplitude), mTime(time), mAbsId(truId + NREADOUTCHANNELS), mLabel(-1)
+{
+  setHighGain(isTrigger2x2);
+}
 Digit::Digit(const Hit& hit, int label) : mAbsId(hit.GetDetectorID()), mAmplitude(hit.GetEnergyLoss()), mTime(hit.GetTime()), mLabel(label)
 {
 }

Detectors/CTF/test/test_ctf_io_phos.cxx

@@ -37,8 +37,8 @@ BOOST_AUTO_TEST_CASE(CTFTest)
     auto start = cells.size();
     int n = 1 + gRandom->Poisson(100);
     for (int i = n; i--;) {
-      ChannelType_t tp = gRandom->Rndm() > 0.5 ? TRU : (gRandom->Rndm() > 0.5 ? HIGH_GAIN : LOW_GAIN);
-      uint16_t id = tp == TRU ? 3000 : gRandom->Integer(kNmaxCell);
+      ChannelType_t tp = gRandom->Rndm() > 0.5 ? (gRandom->Rndm() > 0.5 ? TRU2x2 : TRU4x4) : (gRandom->Rndm() > 0.5 ? HIGH_GAIN : LOW_GAIN);
+      uint16_t id = (tp == TRU2x2 || tp == TRU4x4) ? 3000 : gRandom->Integer(kNmaxCell);
       float timeCell = gRandom->Rndm() * 3.00e-07 - 0.3e-9;
       float en = gRandom->Rndm() * 160.;
       cells.emplace_back(id, en, timeCell, tp);

Detectors/PHOS/README.md

@@ -0,0 +1,14 @@
+<!-- doxy
+\page refDetectorsPHOS PHOS
+/doxy -->
+
+# PHOS
+
+This is a top page for the PHOS detector documentation.
+
+<!-- doxy
+\subpage refDetectorsPHOSGeometry
+*\subpage refDetectorsPHOSsimulation
+*\subpage refDetectorsPHOSreconstruction
+\subpage refDetectorsPHOScalibration
+/doxy -->

Detectors/PHOS/base/README.md

@@ -0,0 +1,26 @@
+<!-- doxy
+\page refDetectorsPHOSGeometry PHOS Geometry
+/doxy -->
+
+# PHOS geometry
+
+Module numbering:  start from module 0 (non-existing), 1 (half-module), 2 (bottom),... 4(highest)
+
+All channels have unique absId: start from 1 till 4*64*56. Numbering in each module starts at bottom left and first go in z direction:
+  56   112   3584
+  ...  ...    ...
+  1    57 ...3529
+
+One can use also relative numbering  relid[3]: 
+(module number[0...3], iphi[1...64], iz[1...56])
+
+  Then TRU channels go 112 per branch, 2 branches per ddl
+tru channels have absId after readout channels:
+  absId = getTotalNCells() + TRUabsId ;
+  relId for TRU
+  relid: [DDL id=0..13] [x in 2x2 system: 0..7] [z in 2x2 system 0..27] 
+
+Mapping is realized with class Mapping and mapping files are stored as MODxRCUy.data  
+
+<!-- doxy
+/doxy -->

Detectors/PHOS/base/include/PHOSBase/Geometry.h

@@ -106,6 +106,12 @@ class Geometry
   static void absIdToRelPosInModule(short absId, float& x, float& z);
   static bool relToAbsNumbering(const char* RelId, short& AbsId);
 
+  //Converters for TRU digits
+  static bool truAbsToRelNumbering(short truId, char* relid);
+  static short truRelToAbsNumbering(const char* relId);
+  static bool truRelId2RelId(const char* truRelId, char* relId);
+  static short relPosToTruId(char mod, float x, float z, short& ddl);
+
   //local position to absId
   static void relPosToAbsId(char module, float x, float z, short& absId);
 

Detectors/PHOS/base/include/PHOSBase/Mapping.h

@@ -38,10 +38,13 @@ class Mapping
                      kWrongAbsId,
                      kWrongCaloFlag,
                      kNotInitialized };
-  static constexpr short NCHANNELS = 14337;    ///< Number of channels starting from 1
-  static constexpr short NHWPERDDL = 2048;     ///< Number of HW addressed per DDL
-  static constexpr short NMaxHWAddress = 3929; ///< Maximal HW address (size of array)
-  static constexpr short NDDL = 14;            ///< Total number of DDLs
+  static constexpr short NCHANNELS = 14337;               ///< Number of channels starting from 1
+  static constexpr short NHWPERDDL = 2048;                ///< Number of HW addressed per DDL
+  static constexpr short NMaxHWAddress = 3929;            ///< Maximal HW address (size of array)
+  static constexpr short NDDL = 14;                       ///< Total number of DDLs
+  static constexpr short NTRUBranchReadoutChannels = 112; ///< Number of TRU readout channels per branch
+  static constexpr short NTRUReadoutChannels = 3136;      ///< Total number of TRU readout channels
+  static constexpr short TRUFinalProductionChannel = 123; // The last channel of production bits, contains markesr to choose between 2x2 and 4x4 algorithm
 
   enum CaloFlag { kHighGain,
                   kLowGain,
@@ -65,6 +68,9 @@ class Mapping
 
   ErrorStatus setMapping();
 
+  //Select TRU readout channels or TRU flag channels
+  static bool isTRUReadoutchannel(short hwAddress) { return (hwAddress < 112) || (hwAddress > 2048 && hwAddress < 2048 + 112); }
+
  protected:
   /// \brief Construct vector for conversion only if necessary
   ErrorStatus constructAbsToHWMatrix();