p2eg::Cluster Class Reference

#include <Phase2L1CaloEGammaUtils.h>

Public Member Functions
void	applyCalibration (float factor)
	Cluster ()
	Cluster (ap_uint< 12 > clusterEnergy, ap_uint< 5 > towerEta, ap_uint< 2 > towerPhi, ap_uint< 3 > clusterEta, ap_uint< 3 > clusterPhi, ap_uint< 3 > satur, ap_uint< 15 > clusterEt5x5=0, ap_uint< 15 > clusterEt2x5=0, ap_uint< 2 > clusterBrems=0, float clusterCalib=1.0, bool cluster_is_ss=false, bool cluster_is_looseTkss=false, bool cluster_is_iso=false, bool cluster_is_looseTkiso=false, int clusterRegionIdx=0)
ap_uint< 12 >	clusterEnergy () const
ap_uint< 3 >	clusterEta () const
ap_uint< 3 >	clusterPhi () const
const int	crystaliEtaFromCardRegionInfo (int cc)
const int	crystaliPhiFromCardRegionInfo (int cc)
int	getBrems () const
float	getCalib () const
float	getEt2x5 () const
float	getEt5x5 () const
bool	getIsIso ()
bool	getIsLooseTkIso ()
bool	getIsLooseTkss ()
bool	getIsSS ()
float	getPt () const
	operator uint32_t () const
Cluster &	operator= (const Cluster &rhs)
void	printClusterInfo (int cc, std::string description="")
const float	realEta (int cc)
const float	realPhi (int cc)
int	region () const
ap_uint< 3 >	satur () const
void	setRegionIdx (int regIdx)
ap_uint< 5 >	towerEta () const
int	towerEtaInCard ()
ap_uint< 2 >	towerPhi () const
ap_uint< 15 >	uint_et2x5 () const
ap_uint< 15 >	uint_et5x5 () const

Public Attributes
ap_uint< 2 >	brems
float	calib
ap_uint< 28 >	data
ap_uint< 15 >	et2x5
ap_uint< 15 >	et5x5
bool	is_iso
bool	is_looseTkiso
bool	is_looseTkss
bool	is_ss
int	regionIdx

Detailed Description

Definition at line 803 of file Phase2L1CaloEGammaUtils.h.

Constructor & Destructor Documentation

Cluster() [1/2]

p2eg::Cluster::Cluster ( )

inline

Definition at line 816 of file Phase2L1CaloEGammaUtils.h.

References brems, data, et2x5, et5x5, is_iso, is_looseTkiso, is_looseTkss, is_ss, and regionIdx.

              {
      data = 0;
      regionIdx = -1;
      calib = 1.0;
      brems = 0;
      et5x5 = 0;
      et2x5 = 0;
      is_ss = false;
      is_looseTkss = false;
      is_iso = false;
      is_looseTkiso = false;
    }

Cluster() [2/2]

p2eg::Cluster::Cluster ( ap_uint< 12 >  clusterEnergy, ap_uint< 5 >  towerEta, ap_uint< 2 >  towerPhi, ap_uint< 3 >  clusterEta, ap_uint< 3 >  clusterPhi, ap_uint< 3 >  satur, ap_uint< 15 >  clusterEt5x5 = 0, ap_uint< 15 >  clusterEt2x5 = 0, ap_uint< 2 >  clusterBrems = 0, float  clusterCalib = 1.0, bool  cluster_is_ss = false, bool  cluster_is_looseTkss = false, bool  cluster_is_iso = false, bool  cluster_is_looseTkiso = false, int  clusterRegionIdx = 0  )

inline

Definition at line 829 of file Phase2L1CaloEGammaUtils.h.

References brems, clusterEnergy(), clusterEta(), clusterPhi(), data, et2x5, et5x5, is_iso, is_looseTkiso, is_looseTkss, is_ss, regionIdx, satur(), towerEta(), and towerPhi().

                                      {
      data = (clusterEnergy) | (((ap_uint<32>)towerEta) << 12) | (((ap_uint<32>)towerPhi) << 17) |
             (((ap_uint<32>)clusterEta) << 19) | (((ap_uint<32>)clusterPhi) << 22) | (((ap_uint<32>)satur) << 25);
      regionIdx = clusterRegionIdx, et5x5 = clusterEt5x5;
      et2x5 = clusterEt2x5;
      brems = clusterBrems;
      calib = clusterCalib;
      is_ss = cluster_is_ss;
      is_looseTkss = cluster_is_looseTkss;
      is_iso = cluster_is_iso;
      is_looseTkiso = cluster_is_looseTkiso;
    }

Member Function Documentation

applyCalibration()

void p2eg::Cluster::applyCalibration ( float  factor )

inline

Definition at line 899 of file Phase2L1CaloEGammaUtils.h.

References data, p2eg::ECAL_LSB, and getPt().

                                        {
      float newPt = getPt() * factor;
      // Convert the new pT to an unsigned int, 28 bits to take the logical OR with the mask
      ap_uint<28> newPt_uint = (ap_uint<28>)(int)(newPt / ECAL_LSB);
      // Make sure that the new pT only takes up the last twelve bits
      newPt_uint = (newPt_uint & 0x0000FFF);

      // Modify 'data'
      ap_uint<28> bitMask = 0xFFFF000;  // last twelve digits are zero
      data = (data & bitMask);          // zero out the last twelve digits
      data = (data | newPt_uint);       // write in the new ET
    }

clusterEnergy()

ap_uint<12> p2eg::Cluster::clusterEnergy ( ) const

inline

Definition at line 872 of file Phase2L1CaloEGammaUtils.h.

References data.

Referenced by Cluster(), p2eg::compareClusterET(), getPt(), Phase2L1CaloEGammaEmulator::produce(), and p2eg::stitchClusterOverRegionBoundary().

{ return (data & 0xFFF); }

clusterEta()

ap_uint<3> p2eg::Cluster::clusterEta ( ) const

inline

Definition at line 875 of file Phase2L1CaloEGammaUtils.h.

References data.

Referenced by Cluster(), crystaliEtaFromCardRegionInfo(), and p2eg::stitchClusterOverRegionBoundary().

{ return ((data >> 19) & 0x7); }

clusterPhi()

ap_uint<3> p2eg::Cluster::clusterPhi ( ) const

inline

Definition at line 876 of file Phase2L1CaloEGammaUtils.h.

References data.

Referenced by Cluster(), crystaliPhiFromCardRegionInfo(), and p2eg::stitchClusterOverRegionBoundary().

{ return ((data >> 22) & 0x7); }

crystaliEtaFromCardRegionInfo()

const int p2eg::Cluster::crystaliEtaFromCardRegionInfo ( int  cc )

inline

Definition at line 913 of file Phase2L1CaloEGammaUtils.h.

References gpuPixelDoublets::cc, clusterEta(), p2eg::CRYSTALS_IN_TOWER_ETA, p2eg::getCard_refCrystal_iEta(), region(), p2eg::TOWER_IN_ETA, and towerEta().

Referenced by realEta().

                                                    {
      int crystalEta_in_card =
          ((region() * TOWER_IN_ETA * CRYSTALS_IN_TOWER_ETA) + (towerEta() * CRYSTALS_IN_TOWER_ETA) + clusterEta());
      if ((cc % 2) == 1) {
        return (getCard_refCrystal_iEta(cc) + crystalEta_in_card);
      } else {
        // if card is even (negative eta)
        return (getCard_refCrystal_iEta(cc) - crystalEta_in_card);
      }
    }

crystaliPhiFromCardRegionInfo()

const int p2eg::Cluster::crystaliPhiFromCardRegionInfo ( int  cc )

inline

Definition at line 925 of file Phase2L1CaloEGammaUtils.h.

References gpuPixelDoublets::cc, clusterPhi(), p2eg::CRYSTALS_IN_TOWER_PHI, p2eg::getCard_refCrystal_iPhi(), and towerPhi().

Referenced by realPhi().

                                                    {
      int crystalPhi_in_card = (towerPhi() * CRYSTALS_IN_TOWER_PHI) + clusterPhi();
      if ((cc % 2) == 1) {
        // if card is odd (positive eta)
        return (getCard_refCrystal_iPhi(cc) + crystalPhi_in_card);
      } else {
        // if card is even (negative eta)
        return (getCard_refCrystal_iPhi(cc) - crystalPhi_in_card);
      }
    }

getBrems()

int p2eg::Cluster::getBrems ( ) const

inline

Definition at line 883 of file Phase2L1CaloEGammaUtils.h.

References brems.

Referenced by p2eg::stitchClusterOverRegionBoundary().

{ return (int)brems; }

getCalib()

float p2eg::Cluster::getCalib ( ) const

inline

Definition at line 884 of file Phase2L1CaloEGammaUtils.h.

References calib.

{ return (float)calib; }

getEt2x5()

float p2eg::Cluster::getEt2x5 ( ) const

inline

Definition at line 887 of file Phase2L1CaloEGammaUtils.h.

References p2eg::ECAL_LSB, and et2x5.

{ return ((float)et2x5 * ECAL_LSB); }         // Return ET2x5 as a float

getEt5x5()

float p2eg::Cluster::getEt5x5 ( ) const

inline

Definition at line 886 of file Phase2L1CaloEGammaUtils.h.

References p2eg::ECAL_LSB, and et5x5.

{ return ((float)et5x5 * ECAL_LSB); }         // Return ET5x5 as a float

getIsIso()

bool p2eg::Cluster::getIsIso ( )

inline

Definition at line 893 of file Phase2L1CaloEGammaUtils.h.

References is_iso.

{ return is_iso; }

getIsLooseTkIso()

bool p2eg::Cluster::getIsLooseTkIso ( )

inline

Definition at line 894 of file Phase2L1CaloEGammaUtils.h.

References is_looseTkiso.

{ return is_looseTkiso; }

getIsLooseTkss()

bool p2eg::Cluster::getIsLooseTkss ( )

inline

Definition at line 892 of file Phase2L1CaloEGammaUtils.h.

References is_looseTkss.

Referenced by p2eg::stitchClusterOverRegionBoundary().

{ return is_looseTkss; }

getIsSS()

bool p2eg::Cluster::getIsSS ( )

inline

Definition at line 891 of file Phase2L1CaloEGammaUtils.h.

References is_ss.

Referenced by p2eg::stitchClusterOverRegionBoundary().

{ return is_ss; }

getPt()

float p2eg::Cluster::getPt ( ) const

inline

Definition at line 885 of file Phase2L1CaloEGammaUtils.h.

References clusterEnergy(), and p2eg::ECAL_LSB.

Referenced by applyCalibration(), and printClusterInfo().

{ return ((float)clusterEnergy() * ECAL_LSB); }  // Return pT as a float

operator uint32_t()

p2eg::Cluster::operator uint32_t ( ) const

inline

Definition at line 881 of file Phase2L1CaloEGammaUtils.h.

References data.

{ return (ap_uint<28>)data; }

operator=()

Cluster& p2eg::Cluster::operator= ( const Cluster &  rhs )

inline

Definition at line 856 of file Phase2L1CaloEGammaUtils.h.

References brems, calib, data, et2x5, et5x5, is_iso, is_looseTkiso, is_looseTkss, is_ss, and regionIdx.

                                           {
      data = rhs.data;
      regionIdx = rhs.regionIdx;
      calib = rhs.calib;
      brems = rhs.brems;
      et5x5 = rhs.et5x5;
      et2x5 = rhs.et2x5;
      is_ss = rhs.is_ss;
      is_looseTkss = rhs.is_looseTkss;
      is_iso = rhs.is_iso;
      is_looseTkiso = rhs.is_looseTkiso;
      return *this;
    }

printClusterInfo()

void p2eg::Cluster::printClusterInfo ( int  cc, std::string  description = ""  )

inline

Definition at line 949 of file Phase2L1CaloEGammaUtils.h.

References gpuPixelDoublets::cc, gather_cfg::cout, makeListRunsInFiles::description, getPt(), realEta(), and realPhi().

                                                              {
      std::cout << "[Print Cluster class info:] [" << description << "]: "
                << "card " << cc << ", "
                << "et (float): " << getPt() << ", "
                << "eta: " << realEta(cc) << ", "
                << "phi: " << realPhi(cc) << std::endl;
    }

realEta()

const float p2eg::Cluster::realEta ( int  cc )

inline

Definition at line 937 of file Phase2L1CaloEGammaUtils.h.

References gpuPixelDoublets::cc, crystaliEtaFromCardRegionInfo(), p2eg::CRYSTALS_IN_TOWER_ETA, p2eg::ECAL_eta_range, p2eg::half_crystal_size, and p2eg::n_towers_Eta.

Referenced by printClusterInfo().

                                {
      float size_cell = 2 * ECAL_eta_range / (CRYSTALS_IN_TOWER_ETA * n_towers_Eta);
      return crystaliEtaFromCardRegionInfo(cc) * size_cell - ECAL_eta_range + half_crystal_size;
    }

realPhi()

const float p2eg::Cluster::realPhi ( int  cc )

inline

Definition at line 943 of file Phase2L1CaloEGammaUtils.h.

References gpuPixelDoublets::cc, crystaliPhiFromCardRegionInfo(), p2eg::CRYSTALS_IN_TOWER_PHI, p2eg::half_crystal_size, M_PI, and p2eg::n_towers_Phi.

Referenced by printClusterInfo().

                                {
      float size_cell = 2 * M_PI / (CRYSTALS_IN_TOWER_PHI * n_towers_Phi);
      return crystaliPhiFromCardRegionInfo(cc) * size_cell - M_PI + half_crystal_size;
    }

region()

int p2eg::Cluster::region ( ) const

inline

Definition at line 882 of file Phase2L1CaloEGammaUtils.h.

References regionIdx.

Referenced by crystaliEtaFromCardRegionInfo(), Phase2L1CaloEGammaEmulator::produce(), p2eg::stitchClusterOverRegionBoundary(), and towerEtaInCard().

{ return regionIdx; }  // Newly added

satur()

ap_uint<3> p2eg::Cluster::satur ( ) const

inline

Definition at line 877 of file Phase2L1CaloEGammaUtils.h.

References data.

Referenced by Cluster(), and p2eg::stitchClusterOverRegionBoundary().

{ return ((data >> 25) & 0x7); }

setRegionIdx()

void p2eg::Cluster::setRegionIdx ( int  regIdx )

inline

Definition at line 870 of file Phase2L1CaloEGammaUtils.h.

References regionIdx.

Referenced by Phase2L1CaloEGammaEmulator::produce().

{ regionIdx = regIdx; }  // Newly added

towerEta()

ap_uint<5> p2eg::Cluster::towerEta ( ) const

inline

Definition at line 873 of file Phase2L1CaloEGammaUtils.h.

References data.

Referenced by Cluster(), crystaliEtaFromCardRegionInfo(), Phase2L1CaloEGammaEmulator::produce(), p2eg::stitchClusterOverRegionBoundary(), and towerEtaInCard().

{ return ((data >> 12) & 0x1F); }  // goes from 0 to 3 (need region for full info)

towerEtaInCard()

int p2eg::Cluster::towerEtaInCard ( )

inline

Definition at line 889 of file Phase2L1CaloEGammaUtils.h.

References region(), p2eg::TOWER_IN_ETA, and towerEta().

Referenced by p2eg::stitchClusterOverRegionBoundary().

{ return ((int)(region() * TOWER_IN_ETA) + towerEta()); }

towerPhi()

ap_uint<2> p2eg::Cluster::towerPhi ( ) const

inline

Definition at line 874 of file Phase2L1CaloEGammaUtils.h.

References data.

Referenced by Cluster(), crystaliPhiFromCardRegionInfo(), Phase2L1CaloEGammaEmulator::produce(), and p2eg::stitchClusterOverRegionBoundary().

{ return ((data >> 17) & 0x3); }

uint_et2x5()

ap_uint<15> p2eg::Cluster::uint_et2x5 ( ) const

inline

Definition at line 878 of file Phase2L1CaloEGammaUtils.h.

References et2x5.

Referenced by p2eg::stitchClusterOverRegionBoundary().

{ return et2x5; }

uint_et5x5()

ap_uint<15> p2eg::Cluster::uint_et5x5 ( ) const

inline

Definition at line 879 of file Phase2L1CaloEGammaUtils.h.

References et5x5.

Referenced by p2eg::stitchClusterOverRegionBoundary().

{ return et5x5; }

Member Data Documentation

brems

ap_uint<2> p2eg::Cluster::brems

Definition at line 808 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getBrems(), and operator=().

calib

float p2eg::Cluster::calib

Definition at line 807 of file Phase2L1CaloEGammaUtils.h.

Referenced by getCalib(), and operator=().

data

ap_uint<28> p2eg::Cluster::data

Definition at line 805 of file Phase2L1CaloEGammaUtils.h.

Referenced by data_sources.node::__str__(), applyCalibration(), data_sources.json_list::as_dicts(), data_sources.json_list::as_table(), Cluster(), clusterEnergy(), clusterEta(), clusterPhi(), data_sources.json_list::get_members(), data_sources.json_list::last(), operator uint32_t(), operator=(), satur(), cuy.FindIssue::startElement(), towerEta(), and towerPhi().

et2x5

ap_uint<15> p2eg::Cluster::et2x5

Definition at line 810 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getEt2x5(), operator=(), and uint_et2x5().

et5x5

ap_uint<15> p2eg::Cluster::et5x5

Definition at line 809 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getEt5x5(), operator=(), and uint_et5x5().

is_iso

bool p2eg::Cluster::is_iso

Definition at line 813 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getIsIso(), and operator=().

is_looseTkiso

bool p2eg::Cluster::is_looseTkiso

Definition at line 814 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getIsLooseTkIso(), and operator=().

is_looseTkss

bool p2eg::Cluster::is_looseTkss

Definition at line 812 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getIsLooseTkss(), and operator=().

is_ss

bool p2eg::Cluster::is_ss

Definition at line 811 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), getIsSS(), and operator=().

regionIdx

int p2eg::Cluster::regionIdx

Definition at line 806 of file Phase2L1CaloEGammaUtils.h.

Referenced by Cluster(), operator=(), region(), and setRegionIdx().