L1TCalorimeterPhase2/interface/GCTHadDigiCluster.h

0001 #ifndef DataFormats_L1TCalorimeterPhase2_GCTHadDigiCluster_h
0002 #define DataFormats_L1TCalorimeterPhase2_GCTHadDigiCluster_h
0003
0004 #include <ap_int.h>
0005 #include <vector>
0006
0007 #include "DataFormats/L1TCalorimeterPhase2/interface/CaloPFCluster.h"
0008
0009 namespace l1tp2 {
0010
0011   class GCTHadDigiCluster {
0012   private:
0013     // Data
0014     unsigned long long int clusterData;
0015
0016     // Constants
0017     static constexpr float LSB_PT = 0.5;  // 0.5 GeV
0018
0019     // start of the unused bits
0020     static constexpr int n_bits_unused_start = 31;
0021
0022     // reference to corresponding float cluster
0023     edm::Ref<l1tp2::CaloPFClusterCollection> clusterRef_;
0024
0025   public:
0026     GCTHadDigiCluster() { clusterData = 0; }
0027
0028     GCTHadDigiCluster(ap_uint<64> data) { clusterData = data; }
0029
0030     // Note types of the constructor
0031     GCTHadDigiCluster(ap_uint<12> pt, int etaCr, int phiCr, ap_uint<4> hoe) {
0032       // To use .range() we need an ap class member
0033       ap_uint<64> temp_data;
0034
0035       ap_uint<7> etaCrDigitized = abs(etaCr);
0036       ap_int<7> phiCrDigitized = phiCr;
0037
0038       temp_data.range(11, 0) = pt.range();
0039       temp_data.range(18, 12) = etaCrDigitized.range();
0040       temp_data.range(25, 19) = phiCrDigitized.range();
0041
0042       clusterData = temp_data;
0043     }
0044
0045     // Setters
0046     void setRef(const edm::Ref<l1tp2::CaloPFClusterCollection> &clusterRef) { clusterRef_ = clusterRef; }
0047     // Getters
0048     ap_uint<64> data() const { return clusterData; }
0049
0050     // Other getters
0051     float ptLSB() const { return LSB_PT; }
0052     ap_uint<12> pt() const { return data().range(11, 0); }
0053     float ptFloat() const { return pt() * ptLSB(); }
0054
0055     // crystal eta (unsigned 7 bits)
0056     int eta() const { return (ap_uint<7>)data().range(18, 12); }
0057
0058     // crystal phi (signed 7 bits)
0059     int phi() const { return (ap_int<7>)data().range(25, 19); }
0060
0061     // HoE value
0062     ap_uint<4> hoe() const { return data().range(30, 26); }
0063
0064     // Check that unused bits are zero
0065     const int unusedBitsStart() const { return n_bits_unused_start; }
0066     bool passNullBitsCheck(void) const { return ((data() >> unusedBitsStart()) == 0); }
0067
0068     // Get the underlying ref
0069     edm::Ref<l1tp2::CaloPFClusterCollection> clusterRef() const { return clusterRef_; }
0070   };
0071
0072   // Collection typedefs
0073
0074   // This represents the 36 GCTHadDigiClusters in one link (one link spans 4 RCT cards, each RCT card sends 9 clusters (zero-padded and sorted by decreasing pT)
0075   // The ordering of the 4 RCT cards in this std::vector 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
0076   typedef std::vector<l1tp2::GCTHadDigiCluster> GCTHadDigiClusterLink;
0077
0078   // This represents the 12 links sending GCTHadDigiClusters in the full barrel: there are 12 links = (3 GCT cards) * (two SLRs per GCT) * (one positive eta link and one negative eta link)
0079   // 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)
0080   typedef std::vector<l1tp2::GCTHadDigiClusterLink> GCTHadDigiClusterCollection;
0081
0082 }  // namespace l1tp2
0083
0084 #endif