L1TCalorimeterPhase2/interface/GCTEmDigiCluster.h

0001 #ifndef DataFormats_L1TCalorimeterPhase2_GCTEmDigiCluster_h
0002 #define DataFormats_L1TCalorimeterPhase2_GCTEmDigiCluster_h
0003
0004 #include <ap_int.h>
0005 #include <vector>
0006
0007 #include "DataFormats/L1TCalorimeterPhase2/interface/CaloCrystalCluster.h"
0008 #include "DataFormats/L1TCalorimeterPhase2/interface/DigitizedClusterCorrelator.h"
0009
0010 namespace l1tp2 {
0011
0012   class GCTEmDigiCluster {
0013   private:
0014     // Data
0015     unsigned long long int clusterData;
0016
0017     // Constants
0018     static constexpr float LSB_PT = 0.5;  // 0.5 GeV
0019
0020     // start of the unused bits
0021     static constexpr int n_bits_unused_start = 52;
0022
0023     // Reference to the original float cluster
0024     edm::Ref<l1tp2::CaloCrystalClusterCollection> clusterRef_;
0025
0026     // reference to the original digitized cluster (before duplication in the output links)
0027     edm::Ref<l1tp2::DigitizedClusterCorrelatorCollection> digiClusterRef_;
0028
0029   public:
0030     GCTEmDigiCluster() { clusterData = 0; }
0031
0032     GCTEmDigiCluster(ap_uint<64> data) { clusterData = data; }
0033
0034     GCTEmDigiCluster(ap_uint<12> pt,
0035                      int etaCr,
0036                      int phiCr,
0037                      ap_uint<4> hoe,
0038                      ap_uint<2> hoeFlag,
0039                      ap_uint<3> iso,
0040                      ap_uint<2> isoFlag,
0041                      ap_uint<6> fb,
0042                      ap_uint<5> timing,
0043                      ap_uint<2> shapeFlag,
0044                      ap_uint<2> brems) {
0045       // To use .range() we need an ap class member
0046       ap_uint<64> temp_data;
0047       ap_uint<7> etaCrDigitized = abs(etaCr);
0048       ap_int<7> phiCrDigitized = phiCr;
0049
0050       temp_data.range(11, 0) = pt.range();
0051       temp_data.range(18, 12) = etaCrDigitized.range();
0052       temp_data.range(25, 19) = phiCrDigitized.range();
0053       temp_data.range(29, 26) = hoe.range();
0054       temp_data.range(31, 30) = hoeFlag.range();
0055       temp_data.range(34, 32) = iso.range();
0056       temp_data.range(36, 35) = isoFlag.range();
0057       temp_data.range(42, 37) = fb.range();
0058       temp_data.range(47, 43) = timing.range();
0059       temp_data.range(49, 48) = shapeFlag.range();
0060       temp_data.range(51, 50) = brems.range();
0061
0062       clusterData = temp_data;
0063     }
0064
0065     // Setters
0066     void setRef(const edm::Ref<l1tp2::CaloCrystalClusterCollection>& clusterRef) { clusterRef_ = clusterRef; }
0067
0068     void setDigiRef(const edm::Ref<l1tp2::DigitizedClusterCorrelatorCollection>& digiClusterRef) {
0069       digiClusterRef_ = digiClusterRef;
0070     }
0071
0072     // Getters
0073     ap_uint<64> data() const { return clusterData; }
0074
0075     // Other getters
0076     float ptLSB() const { return LSB_PT; }
0077     ap_uint<12> pt() const { return data().range(11, 0); }
0078     float ptFloat() const { return pt() * ptLSB(); }
0079
0080     // crystal eta (unsigned, 7 bits), starting at 0 at real eta = 0, and increasing in the direction of larger abs(real eta)
0081     // to convert to real eta, need to know which link this cluster is in
0082     int eta() const { return (ap_uint<7>)data().range(18, 12); }
0083
0084     // crystal phi (signed, 7 bits), relative to center of the SLR
0085     // to convert to real phi, need to know which SLR this cluster is in
0086     int phi() const { return (ap_int<7>)data().range(25, 19); }
0087
0088     // HoE value and flag: not defined yet in the emulator
0089     ap_uint<4> hoe() const { return data().range(29, 26); }
0090     ap_uint<2> hoeFlag() const { return data().range(31, 30); }
0091
0092     // Raw isolation sum: not saved in the emulator
0093     ap_uint<3> iso() const { return data().range(34, 32); }
0094
0095     // iso flag: two bits, least significant bit is the standalone WP (true or false), second bit is the looseTk WP (true or false)
0096     // e.g. 0b01 : standalone iso flag passed, loose Tk iso flag did not pass
0097     ap_uint<2> isoFlags() const { return data().range(36, 35); }
0098     bool passes_iso() const { return (isoFlags() & 0x1); }         // standalone iso WP
0099     bool passes_looseTkiso() const { return (isoFlags() & 0x2); }  // loose Tk iso WP
0100
0101     // fb and timing: not saved in the current emulator
0102     ap_uint<6> fb() const { return data().range(42, 37); }
0103     ap_uint<5> timing() const { return data().range(47, 43); }
0104
0105     // shower shape shape flag: two bits, least significant bit is the standalone WP, second bit is the looseTk WP
0106     // e.g. 0b01 : standalone shower shape flag passed, loose Tk shower shape flag did not pass
0107     ap_uint<2> shapeFlags() const { return data().range(49, 48); }
0108
0109     bool passes_ss() const { return (shapeFlags() & 0x1); }         // standalone shower shape WP
0110     bool passes_looseTkss() const { return (shapeFlags() & 0x2); }  // loose Tk shower shape WP
0111
0112     // brems: not saved in the current emulator
0113     ap_uint<2> brems() const { return data().range(51, 50); }
0114
0115     // Check that unused bits are zero
0116     const int unusedBitsStart() const { return n_bits_unused_start; }
0117     bool passNullBitsCheck(void) const { return ((data() >> unusedBitsStart()) == 0); }
0118
0119     // Get the underlying float cluster
0120     const edm::Ref<l1tp2::CaloCrystalClusterCollection>& clusterRef() const { return clusterRef_; }
0121     // Get the underlying digitized cluster (before duplication and zero-padding)
0122     const edm::Ref<l1tp2::DigitizedClusterCorrelatorCollection>& digiClusterRef() const { return digiClusterRef_; }
0123   };
0124
0125   // Collection typedefs
0126
0127   // This represents the 36 GCTEmDigiClusters in one link (one link spans 4 RCT cards, each RCT card sends 9 clusters (zero-padded and sorted by decreasing pT))
0128   // The ordering of the 4 RCT cards in the link is, e.g. for GCT1.SLR3, real phi -50 to -20 degrees, then real phi -20 to 10 degrees, then real phi 10 to 40 degrees, and lastly real phi 40 to 70 degrees
0129   typedef std::vector<l1tp2::GCTEmDigiCluster> GCTEmDigiClusterLink;
0130
0131   // This represents the 12 links sending GCTEmDigiClusters in the full barrel: there are 12 links = (3 GCT cards) * (two SLRs per GCT) * (one positive eta link and one negative eta link)
0132   // The ordering of the links in this std::vector is (GCT1.SLR1 negEta, GCT.SLR1 posEta, GCT1.SLR3 negEta, GCT1.SLR3 posEta, then analogously for GCT2 and GCT3)
0133   typedef std::vector<l1tp2::GCTEmDigiClusterLink> GCTEmDigiClusterCollection;
0134
0135 }  // namespace l1tp2
0136
0137 #endif