FEXAlgoSpaceDefs.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
//***************************************************************************
//                           FEXAlgoSpaceDefs.h  -
//                              -------------------
//     begin                : 08 02 2021
//     email                : jacob.julian.kempster@cern.ch
//  ***************************************************************************/
 
#ifndef FEXAlgoSpaceDefs_H
#define FEXAlgoSpaceDefs_H
 
#include <array>
 
namespace LVL1 {
 
  //Doxygen class description below:
 
  class FEXAlgoSpaceDefs {
 
  public:
 
    constexpr static int jFEX_wide_algoSpace_width = 45;
    constexpr static int jFEX_thin_algoSpace_width = 24;
    constexpr static int jFEX_algoSpace_height = 32; 
 
 
//Array breakdown of jFEX_wide_algoSpace_width matric to indicate different eta and phi regions
 
    constexpr static int jFEX_FCAL1_start =  700000; 
    constexpr static int jFEX_FCAL2_start =  900000; 
    constexpr static int jFEX_FCAL3_start = 1100000;
 
    //Pileup bitshifts
    constexpr static unsigned int pu_AreaINV = 6; 
    constexpr static unsigned int pu_Area    = 11; 
    constexpr static unsigned int pu_rhoLUT  = 20; 
    
    
//A side (jFEX Module 5):
 
    //Eta space for core area 
    constexpr static int jFEX_algoSpace_A_EMB_eta = 8;
    constexpr static int jFEX_algoSpace_A_EMIE_eta = 17;
    constexpr static int jFEX_algoSpace_A_FCAL_start_eta = 21; 
    constexpr static int jFEX_algoSpace_A_FCAL_end_eta = 33;
 
    //Eta space for core and overlaps, EM only
    constexpr static int jFEX_algoSpace_A_lowerEM_eta = 0;
    constexpr static int jFEX_algoSpace_A_upperEM_eta = 33;
    
    //Eta space for core and overlaps, FCAL 2 (33-40) and 3 (41-44)
    constexpr static int jFEX_algoSpace_A_lowerFCAL_eta = 33;
    constexpr static int jFEX_algoSpace_A_upperFCAL2_eta = 41;
    constexpr static int jFEX_algoSpace_A_upperFCAL_eta = 45;
 
//C side (jFEX module 0):
//there are more values on the C side as the matrix cannot be flipped in the bitwise framework.
 
   //Eta space for core area 
    constexpr static int jFEX_algoSpace_C_EMB_start_eta = 28;
    constexpr static int jFEX_algoSpace_C_EMB_end_eta = 37;
    constexpr static int jFEX_algoSpace_C_EMIE_start_eta = 24;
    constexpr static int jFEX_algoSpace_C_EMIE_end_eta = 28;
    constexpr static int jFEX_algoSpace_C_FCAL_start_eta = 12;
    constexpr static int jFEX_algoSpace_C_FCAL_end_eta = 24;
 
   //Eta space for core and overlaps, EM only
    constexpr static int jFEX_algoSpace_C_lowerEM_eta = 12;
    constexpr static int jFEX_algoSpace_C_upperEM_eta = 45;
    
    //Eta space for core and overlaps, FCAL 2 (4-11) and 3 (0-3)
    constexpr static int jFEX_algoSpace_C_lowerFCAL_eta = 0;
    constexpr static int jFEX_algoSpace_C_lowerFCAL2_eta = 4;
    constexpr static int jFEX_algoSpace_C_upperFCAL_eta = 12;
 
    //First and second FCAL 1st layer  eta bins
    constexpr static int jFEX_algoSpace_FCAL1_2nd =  22;
    constexpr static int jFEX_algoSpace_A_FCAL1_1st =  21;
    constexpr static int jFEX_algoSpace_C_FCAL1_1st =  23;
    
    //Lowest/highest  eta for jFEX Electrons
    constexpr static int jFEX_algoSpace_A_FwdEl_start =  14;
    constexpr static int jFEX_algoSpace_C_FwdEl_start =  30;
 
    //Phi space breakdown
    constexpr static int jFEX_algoSpace_EMB_start_phi =  8;    
    constexpr static int jFEX_algoSpace_EMB_end_phi  = 24; 
    constexpr static int jFEX_algoSpace_EMIE_start_phi =  4;  
    constexpr static int jFEX_algoSpace_EMIE_end_phi =  12;
    constexpr static int jFEX_algoSpace_FCAL_start_phi =  2;
    constexpr static int jFEX_algoSpace_FCAL_end_phi =  6;
    
// JFEX bit shifting in the TOB words
    // jFEX Taus (jTau)
      // Data locations within word
      constexpr static int jTau_isoBit = 21;
      constexpr static int jTau_etBit  = 10;
      constexpr static int jTau_etaBit = 5;
      constexpr static int jTau_phiBit = 1;
      constexpr static int jTau_satBit = 0;
 
      // jFEX Forward Electrons (jEM)
      // Data locations within word
      constexpr static int jEM_resBit  = 27;
      constexpr static int jEM_emf2Bit = 25;
      constexpr static int jEM_emf1Bit = 23;
      constexpr static int jEM_isoBit  = 21;
      constexpr static int jEM_etBit   = 10;
      constexpr static int jEM_etaBit  = 5;
      constexpr static int jEM_phiBit  = 1;
      constexpr static int jEM_satBit  = 0;
      
    // jFEX SRJets (jJ)
      // Data locations within word
      constexpr static int jJ_resBit = 21;
      constexpr static int jJ_etBit  = 10;
      constexpr static int jJ_etaBit = 5;
      constexpr static int jJ_phiBit = 1;
      constexpr static int jJ_satBit = 0;
      
    // jFEX LRJets (jLJ)
      // Data locations within word
      constexpr static int jLJ_resBit = 23;
      constexpr static int jLJ_etBit  = 10;
      constexpr static int jLJ_etaBit = 5;
      constexpr static int jLJ_phiBit = 1;
      constexpr static int jLJ_satBit = 0; 
      
    // jFEX MET (jXE)
      // Data locations within word
      constexpr static int jXE_ResBit   = 31;
      constexpr static int jXE_Ey_Bit   = 16;
      constexpr static int jXE_Ex_Bit   = 1;
      constexpr static int jXE_SatBit   = 0;
      
    // jFEX SumET (jTE)
      // Data locations within word
      constexpr static int jTE_Sat_upperBit = 31;
      constexpr static int jTE_Et_upperBit  = 16;
      constexpr static int jTE_Et_lowerBit  = 1; 
      constexpr static int jTE_Sat_lowerBit = 0; 
 
 
   //define constants needed by gFEX Jet algorithm
    constexpr static int centralNphi = 32;
    constexpr static int forwardNphi = 16;
    constexpr static int centralNeta = 12;
    constexpr static int forwardNeta = 6;
    constexpr static int totalNeta = 40;
 
    constexpr static int n_partial = 4;
    constexpr static int ABCrows = 32;
    constexpr static int ABcolumns = 12;
    constexpr static int ABCcolumnsEng = 6;
    constexpr static int gJetMax = 0x00000FFF; //Corresponds to the maximum value with 12 bits (4095)
    constexpr static int gBlockMax = 0x00000FFF; //Corresponds to the maximum value with 12 bits (4095)
    constexpr static int jetThr = 0x001E;
    
    constexpr static bool ENABLE_INTER_AB = true;
    constexpr static bool ENABLE_INTER_C = true;
    constexpr static bool ENABLE_INTER_ABC = false;
    constexpr static int gJetTOBfib = 6;
    constexpr static int BTOBFIB = 6;
    constexpr static bool ENABLE_PUC = true;
    constexpr static bool APPLY_TRUNC = false;
    //define constants needed by gFEX JwoJ algorithm
    constexpr static bool ENABLE_JWOJ_C = false;
 
    constexpr static int PS_UPPER_AB =  2047;
    constexpr static int PS_LOWER_AB = -2048;
    constexpr static int PS_SHIFT_AB = 3;
    constexpr static int PS_UPPER_C  =  511;
    constexpr static int PS_LOWER_C  = -511;
    constexpr static int PS_SHIFT_C  = 3;
 
    constexpr static int fineCeiling = 255;
    constexpr static int fineFloor   = -256; 
 
    // per tower assuming 0.4 MeV LSB 
    constexpr static std::array<unsigned int, 513> jwjinv19  = {
        0x00000,0x10000,0x08000,0x05555,0x04000,0x03333,0x02AAA,0x02492,
        0x02000,0x01C71,0x01999,0x01745,0x01555,0x013B1,0x01249,0x01111,
        0x01000,0x00F0F,0x00E38,0x00D79,0x00CCC,0x00C30,0x00BA2,0x00B21,
        0x00AAA,0x00A3D,0x009D8,0x0097B,0x00924,0x008D3,0x00888,0x00842,
        0x00800,0x007C1,0x00787,0x00750,0x0071C,0x006EB,0x006BC,0x00690,
        0x00666,0x0063E,0x00618,0x005F4,0x005D1,0x005B0,0x00590,0x00572,
        0x00555,0x00539,0x0051E,0x00505,0x004EC,0x004D4,0x004BD,0x004A7,
        0x00492,0x0047D,0x00469,0x00456,0x00444,0x00432,0x00421,0x00410,
        0x00400,0x003F0,0x003E0,0x003D2,0x003C3,0x003B5,0x003A8,0x0039B,
        0x0038E,0x00381,0x00375,0x00369,0x0035E,0x00353,0x00348,0x0033D,
        0x00333,0x00329,0x0031F,0x00315,0x0030C,0x00303,0x002FA,0x002F1,
        0x002E8,0x002E0,0x002D8,0x002D0,0x002C8,0x002C0,0x002B9,0x002B1,
        0x002AA,0x002A3,0x0029C,0x00295,0x0028F,0x00288,0x00282,0x0027C,
        0x00276,0x00270,0x0026A,0x00264,0x0025E,0x00259,0x00253,0x0024E,
        0x00249,0x00243,0x0023E,0x00239,0x00234,0x00230,0x0022B,0x00226,
        0x00222,0x0021D,0x00219,0x00214,0x00210,0x0020C,0x00208,0x00204,
        0x00200,0x001FC,0x001F8,0x001F4,0x001F0,0x001EC,0x001E9,0x001E5,
        0x001E1,0x001DE,0x001DA,0x001D7,0x001D4,0x001D0,0x001CD,0x001CA,
        0x001C7,0x001C3,0x001C0,0x001BD,0x001BA,0x001B7,0x001B4,0x001B2,
        0x001AF,0x001AC,0x001A9,0x001A6,0x001A4,0x001A1,0x0019E,0x0019C,
        0x00199,0x00197,0x00194,0x00192,0x0018F,0x0018D,0x0018A,0x00188,
        0x00186,0x00183,0x00181,0x0017F,0x0017D,0x0017A,0x00178,0x00176,
        0x00174,0x00172,0x00170,0x0016E,0x0016C,0x0016A,0x00168,0x00166,
        0x00164,0x00162,0x00160,0x0015E,0x0015C,0x0015A,0x00158,0x00157,
        0x00155,0x00153,0x00151,0x00150,0x0014E,0x0014C,0x0014A,0x00149,
        0x00147,0x00146,0x00144,0x00142,0x00141,0x0013F,0x0013E,0x0013C,
        0x0013B,0x00139,0x00138,0x00136,0x00135,0x00133,0x00132,0x00130,
        0x0012F,0x0012E,0x0012C,0x0012B,0x00129,0x00128,0x00127,0x00125,
        0x00124,0x00123,0x00121,0x00120,0x0011F,0x0011E,0x0011C,0x0011B,
        0x0011A,0x00119,0x00118,0x00116,0x00115,0x00114,0x00113,0x00112,
        0x00111,0x0010F,0x0010E,0x0010D,0x0010C,0x0010B,0x0010A,0x00109,
        0x00108,0x00107,0x00106,0x00105,0x00104,0x00103,0x00102,0x00101,
        0x00100,0x000FF,0x000FE,0x000FD,0x000FC,0x000FB,0x000FA,0x000F9,
        0x000F8,0x000F7,0x000F6,0x000F5,0x000F4,0x000F3,0x000F2,0x000F1,
        0x000F0,0x000F0,0x000EF,0x000EE,0x000ED,0x000EC,0x000EB,0x000EA,
        0x000EA,0x000E9,0x000E8,0x000E7,0x000E6,0x000E5,0x000E5,0x000E4,
        0x000E3,0x000E2,0x000E1,0x000E1,0x000E0,0x000DF,0x000DE,0x000DE,
        0x000DD,0x000DC,0x000DB,0x000DB,0x000DA,0x000D9,0x000D9,0x000D8,
        0x000D7,0x000D6,0x000D6,0x000D5,0x000D4,0x000D4,0x000D3,0x000D2,
        0x000D2,0x000D1,0x000D0,0x000D0,0x000CF,0x000CE,0x000CE,0x000CD,
        0x000CC,0x000CC,0x000CB,0x000CA,0x000CA,0x000C9,0x000C9,0x000C8,
        0x000C7,0x000C7,0x000C6,0x000C5,0x000C5,0x000C4,0x000C4,0x000C3,
        0x000C3,0x000C2,0x000C1,0x000C1,0x000C0,0x000C0,0x000BF,0x000BF,
        0x000BE,0x000BD,0x000BD,0x000BC,0x000BC,0x000BB,0x000BB,0x000BA,
        0x000BA,0x000B9,0x000B9,0x000B8,0x000B8,0x000B7,0x000B7,0x000B6,
        0x000B6,0x000B5,0x000B5,0x000B4,0x000B4,0x000B3,0x000B3,0x000B2,
        0x000B2,0x000B1,0x000B1,0x000B0,0x000B0,0x000AF,0x000AF,0x000AE,
        0x000AE,0x000AD,0x000AD,0x000AC,0x000AC,0x000AC,0x000AB,0x000AB,
        0x000AA,0x000AA,0x000A9,0x000A9,0x000A8,0x000A8,0x000A8,0x000A7,
        0x000A7,0x000A6,0x000A6,0x000A5,0x000A5,0x000A5,0x000A4,0x000A4,
        0x000A3,0x000A3,0x000A3,0x000A2,0x000A2,0x000A1,0x000A1,0x000A1,
        0x000A0,0x000A0,0x0009F,0x0009F,0x0009F,0x0009E,0x0009E,0x0009D,
        0x0009D,0x0009D,0x0009C,0x0009C,0x0009C,0x0009B,0x0009B,0x0009A,
        0x0009A,0x0009A,0x00099,0x00099,0x00099,0x00098,0x00098,0x00098,
        0x00097,0x00097,0x00097,0x00096,0x00096,0x00095,0x00095,0x00095,
        0x00094,0x00094,0x00094,0x00093,0x00093,0x00093,0x00092,0x00092,
        0x00092,0x00091,0x00091,0x00091,0x00090,0x00090,0x00090,0x00090,
        0x0008F,0x0008F,0x0008F,0x0008E,0x0008E,0x0008E,0x0008D,0x0008D,
        0x0008D,0x0008C,0x0008C,0x0008C,0x0008C,0x0008B,0x0008B,0x0008B,
        0x0008A,0x0008A,0x0008A,0x00089,0x00089,0x00089,0x00089,0x00088,
        0x00088,0x00088,0x00087,0x00087,0x00087,0x00087,0x00086,0x00086,
        0x00086,0x00086,0x00085,0x00085,0x00085,0x00084,0x00084,0x00084,
        0x00084,0x00083,0x00083,0x00083,0x00083,0x00082,0x00082,0x00082,
        0x00082,0x00081,0x00081,0x00081,0x00081,0x00080,0x00080,0x00080};
 
    constexpr static std::array<unsigned int, 385> inv19 = {
      0x00000,0x45000,0x22800,0x17000,0x11400,0x0DCC8,0x0B800,0x09DB0,
      0x08A00,0x07AA8,0x06E60,0x06458,0x05C00,0x054E8,0x04ED8,0x04998,
      0x04500,0x040F0,0x03D50,0x03A18,0x03730,0x03490,0x03228,0x03000,
      0x02E00,0x02C28,0x02A70,0x028E0,0x02768,0x02610,0x024C8,0x02398,
      0x02280,0x02170,0x02078,0x01F88,0x01EA8,0x01DD0,0x01D08,0x01C48,
      0x01B98,0x01AE8,0x01A48,0x019A8,0x01910,0x01888,0x01800,0x01778,
      0x01700,0x01680,0x01610,0x015A0,0x01538,0x014D0,0x01470,0x01410,
      0x013B0,0x01358,0x01308,0x012B0,0x01260,0x01218,0x011C8,0x01180,
      0x01140,0x010F8,0x010B8,0x01078,0x01038,0x01000,0x00FC0,0x00F88,
      0x00F50,0x00F18,0x00EE8,0x00EB8,0x00E80,0x00E50,0x00E20,0x00DF8,
      0x00DC8,0x00DA0,0x00D70,0x00D48,0x00D20,0x00CF8,0x00CD0,0x00CB0,
      0x00C88,0x00C60,0x00C40,0x00C20,0x00C00,0x00BD8,0x00BB8,0x00B98,
      0x00B80,0x00B60,0x00B40,0x00B20,0x00B08,0x00AE8,0x00AD0,0x00AB0,
      0x00A98,0x00A80,0x00A68,0x00A50,0x00A38,0x00A20,0x00A08,0x009F0,
      0x009D8,0x009C0,0x009A8,0x00998,0x00980,0x00968,0x00958,0x00940,
      0x00930,0x00918,0x00908,0x008F8,0x008E0,0x008D0,0x008C0,0x008B0,
      0x008A0,0x00888,0x00878,0x00868,0x00858,0x00848,0x00838,0x00828,
      0x00818,0x00808,0x00800,0x007F0,0x007E0,0x007D0,0x007C0,0x007B8,
      0x007A8,0x00798,0x00788,0x00780,0x00770,0x00768,0x00758,0x00748,
      0x00740,0x00730,0x00728,0x00718,0x00710,0x00708,0x006F8,0x006F0,
      0x006E0,0x006D8,0x006D0,0x006C0,0x006B8,0x006B0,0x006A0,0x00698,
      0x00690,0x00688,0x00678,0x00670,0x00668,0x00660,0x00658,0x00648,
      0x00640,0x00638,0x00630,0x00628,0x00620,0x00618,0x00610,0x00608,
      0x00600,0x005F0,0x005E8,0x005E0,0x005D8,0x005D0,0x005C8,0x005C0,
      0x005C0,0x005B8,0x005B0,0x005A8,0x005A0,0x00598,0x00590,0x00588,
      0x00580,0x00578,0x00574,0x00570,0x00568,0x00560,0x00558,0x00550,
      0x0054C,0x00548,0x00540,0x00538,0x00530,0x0052C,0x00528,0x00520,
      0x00518,0x00514,0x00510,0x00508,0x00500,0x004FC,0x004F8,0x004F0,
      0x004EC,0x004E8,0x004E0,0x004D8,0x004D4,0x004D0,0x004C8,0x004C4,
      0x004C0,0x004B8,0x004B4,0x004B0,0x004AC,0x004A8,0x004A0,0x0049C,
      0x00498,0x00490,0x0048C,0x00488,0x00484,0x00480,0x0047C,0x00478,
      0x00470,0x0046C,0x00468,0x00464,0x00460,0x0045C,0x00458,0x00454,
      0x00450,0x00448,0x00444,0x00440,0x0043C,0x00438,0x00434,0x00430,
      0x0042C,0x00428,0x00424,0x00420,0x0041C,0x00418,0x00414,0x00410,
      0x0040C,0x00408,0x00405,0x00402,0x00400,0x003FC,0x003F8,0x003F4,
      0x003F0,0x003EC,0x003E8,0x003E4,0x003E0,0x003DD,0x003DA,0x003D8,
      0x003D4,0x003D0,0x003CC,0x003C8,0x003C5,0x003C2,0x003C0,0x003BC,
      0x003B8,0x003B5,0x003B2,0x003B0,0x003AC,0x003A8,0x003A5,0x003A2,
      0x003A0,0x0039D,0x0039A,0x00398,0x00394,0x00390,0x0038D,0x0038A,
      0x00388,0x00385,0x00382,0x00380,0x0037D,0x0037A,0x00378,0x00375,
      0x00372,0x00370,0x0036D,0x0036A,0x00368,0x00365,0x00362,0x00360,
      0x0035D,0x0035A,0x00358,0x00355,0x00352,0x00350,0x0034D,0x0034A,
      0x00348,0x00345,0x00342,0x00340,0x0033D,0x0033A,0x00338,0x00336,
      0x00334,0x00332,0x00330,0x0032D,0x0032A,0x00328,0x00326,0x00324,
      0x00322,0x00320,0x0031D,0x0031A,0x00318,0x00316,0x00314,0x00312,
      0x00310,0x0030E,0x0030C,0x0030A,0x00308,0x00306,0x00304,0x00302,
      0x00300,0x002FD,0x002FA,0x002F8,0x002F6,0x002F4,0x002F2,0x002F0,
      0x002EE,0x002EC,0x002EA,0x002E8,0x002E6,0x002E5,0x002E3,0x002E1,
      0x002E0}; 
 
  };
 
} // end of namespace
 
#endif