The gTower class is an interface object for gFEX trigger algorithms The purposes are twofold: More...

#include <gTower.h>

Collaboration diagram for LVL1::gTower:

Public Member Functions
	gTower ()
	Constructors.
	gTower (int eta, int phi, int nphi, int id_modifier, int posneg)
	constructs a tower and sets the coordinates and identifier
	~gTower ()
	Destructor.
void	clearET ()
	Clear supercell ET values.
void	clear_scIDs ()
	Clear and resize Identifier value vector.
void	addET (float et, int layer)
	Add ET in MeV, layer refers to EM or HAD (Tile)
int	getID () const
	Add to ET.
int	iEta () const
	Get coordinates of tower.
int	iPhi () const
float	eta () const
float	phi () const
void	setEta (const float thiseta)
int	id () const
float	constid () const
int	getET () const
	Get ET (total) in MeV.
float	getET_float () const
	Get ET (total) in MeV FLOAT VERSION.
int	getET_EM_float () const
	Get ET in MeV from EM calo FLOAT VERSION.
int	getET_HAD_float () const
	Get ET in MeV from HAD calo FLOAT VERSION.
void	setET ()
void	setTotalEt (int totEt)
void	setSCID (Identifier ID)
	Set supercell position ID.
const std::vector< Identifier > &	getSCIDs () const
bool	noiseCut (int et) const
	Apply supercell noise cut.
void	setPosNeg (int posneg)
int	getPosNeg () const
int	getFWID (int &iPhiFW, int &iEtaFW) const
	Calculates and returns the firmware ID, as well as iPhi and iEta in FT/global scheme.
int	getFWID () const
	Calculates and returns the firmware ID.
void	getEtaPhi (float &Eta, float &Phi, int iEta, int iPhi) const
	Calculates eta and phi from ieta and iphi.
void	setIsSaturated (char isSaturated)
	Sets saturation flag.
char	isSaturated () const
	Returns true if is saturated.

Private Attributes
int	m_eta = 0
	Internal data.
int	m_phi = 0
int	m_et = 0
float	m_eta_float = 0
float	m_phi_float = 0
float	m_et_float = 0
std::vector< float >	m_et_float_perlayer
std::vector< Identifier >	m_scID
int	m_tower_id = -9999999
int	m_posneg = 0
int	m_noisecut = -100000
char	m_saturated = 0

Detailed Description

The gTower class is an interface object for gFEX trigger algorithms The purposes are twofold:

to provide inputs to the algorithms in a way that reflects the cell structure within a tower (the basic element of an gFEX algorithm window)
to hide the details of the individual data sources, e.g. which hadronic cells are LAr and which are HEC, from the algorithms It needs to contain supercell ET values and a tower coordinate or identifier (not yet defined). ET values should be on the gFEX's internal ET scale, not MeV. This should be a purely transient object, but will need to enter the transient event store (so class_def etc will be needed before it can be used for real)

Definition at line 38 of file gTower.h.

Constructor & Destructor Documentation

◆ gTower() [1/2]

LVL1::gTower::gTower ( )

Constructors.

Definition at line 18 of file gTower.cxx.

  {
    this->clear_scIDs();
    this->clearET();
  }

◆ gTower() [2/2]

LVL1::gTower::gTower	(	int	eta,
		int	phi,
		int	nphi,
		int	id_modifier,
		int	posneg )

constructs a tower and sets the coordinates and identifier

Definition at line 25 of file gTower.cxx.

                                                                         :
    m_eta(ieta),
    m_phi(iphi),
    m_tower_id(id_modifier + iphi + (nphi * ieta)),
    m_posneg(posneg)
  {
    this->clear_scIDs();
    this->clearET();
    getEtaPhi(m_eta_float, m_phi_float, iEta(), iPhi());
  }

◆ ~gTower()

LVL1::gTower::~gTower ( )

inline

Destructor.

Definition at line 47 of file gTower.h.

47{};

Member Function Documentation

◆ addET()

void LVL1::gTower::addET	(	float	et,
		int	layer )

Add ET in MeV, layer refers to EM or HAD (Tile)

Add ET.

Definition at line 60 of file gTower.cxx.

  {
 
    m_et_float_perlayer[layer] += et; // for monitoring
    m_et_float += et;
 
    return;
 
  }

◆ clear_scIDs()

void LVL1::gTower::clear_scIDs ( )

Clear and resize Identifier value vector.

Definition at line 45 of file gTower.cxx.

  {
    m_scID.clear();
  }

◆ clearET()

void LVL1::gTower::clearET ( )

Clear supercell ET values.

Clear and resize ET value vector.

Definition at line 37 of file gTower.cxx.

  {
    m_et = 0;
    m_et_float = 0.0;
    m_et_float_perlayer.assign(2, 0.0);
  }

◆ constid()

float LVL1::gTower::constid ( ) const

inline

Definition at line 75 of file gTower.h.

75{return m_tower_id;};

◆ eta()

float LVL1::gTower::eta ( ) const

inline

Definition at line 68 of file gTower.h.

68{return m_eta_float;};

◆ getET()

int LVL1::gTower::getET ( ) const

Get ET (total) in MeV.

Return ET (total)

Definition at line 142 of file gTower.cxx.

                          {
 
    return m_et;
 
  }

◆ getET_EM_float()

int LVL1::gTower::getET_EM_float ( ) const

Get ET in MeV from EM calo FLOAT VERSION.

Return ET for EM.

Definition at line 157 of file gTower.cxx.

                                   {
 
    return m_et_float_perlayer[0];
 
  }

◆ getET_float()

float LVL1::gTower::getET_float ( ) const

Get ET (total) in MeV FLOAT VERSION.

Return ET (total) FLOAT VERSION.

Definition at line 149 of file gTower.cxx.

                                  {
 
    // Return ET
    return m_et_float;
 
  }

◆ getET_HAD_float()

int LVL1::gTower::getET_HAD_float ( ) const

Get ET in MeV from HAD calo FLOAT VERSION.

Return ET for HAD.

Definition at line 164 of file gTower.cxx.

                                    {
 
    return m_et_float_perlayer[1];
 
  }

◆ getEtaPhi()

void LVL1::gTower::getEtaPhi	(	float &	Eta,
		float &	Phi,
		int	iEta,
		int	iPhi ) const

Calculates eta and phi from ieta and iphi.

Definition at line 290 of file gTower.cxx.

                                                                          {
    
    float s_centralPhiWidth = (2*M_PI)/32; //In central region, gFex has 32 bins in phi
    float s_forwardPhiWidth = (2*M_PI)/16; //In forward region, gFex has 16 bins in phi (before rearranging bins)
 
    constexpr std::array<float, 40> s_EtaCenter = { -4.5, -3.8, -3.38, -3.18, -3.15, -3, 
                                                  -2.8, -2.6, -2.35, -2.1, -1.9, -1.7, -1.5, -1.3, -1.1, -0.9,  
                                                  -0.7, -0.5, -0.3, -0.1, 0.1, 0.3, 0.5, 0.7, 0.9, 1.1,                                                 
                                                  1.3, 1.5, 1.7, 1.9, 2.1, 2.35, 2.6, 2.8, 3.0,
                                                  3.15, 3.18, 3.38, 3.8, 4.5};
 
    Eta = s_EtaCenter.at(iEta); 
 
    float Phi_gFex = -99;
    if (( iEta <= 3 ) || ( (iEta >= 36) )){
      Phi_gFex = ( (iPhi * s_forwardPhiWidth) + s_forwardPhiWidth/2);
    }  
    else {
      Phi_gFex = ( (iPhi * s_centralPhiWidth) + s_centralPhiWidth/2);
    }
   
    if (Phi_gFex < M_PI) {
      Phi = Phi_gFex;
    }
    else {
      Phi = (Phi_gFex - 2*M_PI);
    }
  }

◆ getFWID() [1/2]

int LVL1::gTower::getFWID ( ) const

Calculates and returns the firmware ID.

Definition at line 179 of file gTower.cxx.

                            {
    int iPhiFW, iEtaFW;
    return getFWID(iPhiFW, iEtaFW);
  }

◆ getFWID() [2/2]

int LVL1::gTower::getFWID	(	int &	iPhiFW,
		int &	iEtaFW ) const

Calculates and returns the firmware ID, as well as iPhi and iEta in FT/global scheme.

Return the firmware ID from the software ID.

Definition at line 197 of file gTower.cxx.

                                                      {
 
    int gFEXtowerID; // the firmware ID to be calculated
 
    int iEta = this->iEta();
    int iPhi = this->iPhi();
    float Eta = this->eta();
 
    iPhiFW = iPhi;
    iEtaFW = iEta;
 
    bool is_central = true;
    if (iEta <= 7 || iEta >= 32) is_central = false;
 
    if (is_central)
    {
 
      if (iEta < 20)
      {
        // FPGA 0
        gFEXtowerID = (iEta - 8) + (iPhi * 12);
      } else
      {
        // FPGA 1
        gFEXtowerID = 10000 + (iEta - 20) + (iPhi * 12);
 
      }
 
    } else
    {
      gFEXtowerID = 20000;
 
      if ( Eta < 0 ){
 
        if ( iEta == 0 ){
          gFEXtowerID = gFEXtowerID + (iPhi*24);
          iPhiFW = iPhi*2;
          iEtaFW = 2;
        }
        else if ( iEta == 1 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 12);
          iPhiFW = (iPhi*2)+1;
          iEtaFW = 2;
        }   
        else if ( iEta == 2 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 1);
          iPhiFW = iPhi*2;
          iEtaFW = 3;
        } 
        else if ( iEta == 3 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 13);
          iPhiFW = (iPhi*2)+1;
          iEtaFW = 3;
        }
        else if ( iEta >= 4 and iEta <= 7 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*12) + (iEta -2));
        } 
 
      }
 
      else if ( Eta > 0 ){
 
        if ( iEta >= 32 and iEta <= 35){
          gFEXtowerID = gFEXtowerID + (iPhi*12) + (iEta -32 +6);
        }
        else if ( iEta == 36 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 22);
          iPhiFW = (iPhi*2)+1;
          iEtaFW = 36;
        }   
        else if ( iEta == 37 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 10);
          iPhiFW = iPhi*2;
          iEtaFW = 36;
        } 
        else if ( iEta == 38 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 23);
          iPhiFW = (iPhi*2)+1;
          iEtaFW = 37;
        }
        else if ( iEta == 39 ){
          gFEXtowerID = gFEXtowerID + ((iPhi*24) + 11);
          iPhiFW = iPhi*2;
          iEtaFW = 37;
        }  
      }
 
    }
 
    return gFEXtowerID;
 
  }

◆ getID()

int LVL1::gTower::getID ( ) const

Add to ET.

Return unique identifier.

Get unique ID of tower

Definition at line 119 of file gTower.cxx.

                          {
    return m_tower_id;
  }

◆ getPosNeg()

int LVL1::gTower::getPosNeg ( ) const

inline

Definition at line 103 of file gTower.h.

103{return m_posneg;}

◆ getSCIDs()

const std::vector< Identifier > & LVL1::gTower::getSCIDs ( ) const

inline

Definition at line 96 of file gTower.h.

96{ return m_scID; }

◆ id()

int LVL1::gTower::id ( ) const

inline

Definition at line 73 of file gTower.h.

73{return m_tower_id;}

◆ iEta()

int LVL1::gTower::iEta ( ) const

Get coordinates of tower.

Definition at line 124 of file gTower.cxx.

                         {
    int index = (m_eta * m_posneg);
    if (m_posneg < 0){
      index = index + 19;
    }
    else if ((m_posneg > 0)){
      index = index + 20;
    }
    
    return index;
  }

◆ iPhi()

int LVL1::gTower::iPhi ( ) const

Definition at line 137 of file gTower.cxx.

                         {
    return m_phi;
  }

◆ isSaturated()

char LVL1::gTower::isSaturated ( ) const

Returns true if is saturated.

Definition at line 174 of file gTower.cxx.

                                 {
    return m_saturated;
  }

◆ noiseCut()

bool LVL1::gTower::noiseCut ( int et ) const

Apply supercell noise cut.

Apply noise cut per layer.

Definition at line 107 of file gTower.cxx.

  {
 
    bool pass = true;
 
    if(et < m_noisecut){ pass = false; }
 
    return pass;
 
  }

◆ phi()

float LVL1::gTower::phi ( ) const

inline

Definition at line 69 of file gTower.h.

69{return m_phi_float;};

◆ setET()

void LVL1::gTower::setET ( )

Definition at line 70 of file gTower.cxx.

  {
 
    // addET(et, layer);
 
    //multi linear digitisation encoding
    unsigned int gcode = gFEXCompression::compress(m_et_float_perlayer[0]);//Only decode EM energy
    int emET = gFEXCompression::expand(gcode);
    int outET = emET + m_et_float_perlayer[1];//Sum EM and HAD energy 
 
    outET = outET/200.;//Convert to gFEX digit scale (200 MeV tbc)
    
    //noise cut
    const bool SCpass = noiseCut(outET);
    if (SCpass){ m_et = outET; }
    else{ m_et = 0; }
  }

◆ setEta()

void LVL1::gTower::setEta ( const float thiseta )

inline

Definition at line 71 of file gTower.h.

71{ m_eta = thiseta; }

◆ setIsSaturated()

void LVL1::gTower::setIsSaturated ( char isSaturated )

Sets saturation flag.

Definition at line 170 of file gTower.cxx.

                                              {
    m_saturated = isSaturated;
  }

◆ setPosNeg()

void LVL1::gTower::setPosNeg ( int posneg )

Definition at line 50 of file gTower.cxx.

                                  {
 
    m_posneg = posneg;
 
    return;
 
  }

◆ setSCID()

void LVL1::gTower::setSCID ( Identifier ID )

Set supercell position ID.

Definition at line 97 of file gTower.cxx.

  {
 
    m_scID.push_back(ID);
 
    return;
 
  }

◆ setTotalEt()

void LVL1::gTower::setTotalEt ( int totEt )

Definition at line 88 of file gTower.cxx.

  {
 
    m_et = totEt;
 
    return;
  }

Member Data Documentation

◆ m_et

int LVL1::gTower::m_et = 0

private

Definition at line 124 of file gTower.h.

◆ m_et_float

float LVL1::gTower::m_et_float = 0

private

Definition at line 127 of file gTower.h.

◆ m_et_float_perlayer

std::vector<float> LVL1::gTower::m_et_float_perlayer

private

Definition at line 128 of file gTower.h.

◆ m_eta

int LVL1::gTower::m_eta = 0

private

Internal data.

Definition at line 122 of file gTower.h.

◆ m_eta_float

float LVL1::gTower::m_eta_float = 0

private

Definition at line 125 of file gTower.h.

◆ m_noisecut

int LVL1::gTower::m_noisecut = -100000

private

Definition at line 133 of file gTower.h.

◆ m_phi

int LVL1::gTower::m_phi = 0

private

Definition at line 123 of file gTower.h.

◆ m_phi_float

float LVL1::gTower::m_phi_float = 0

private

Definition at line 126 of file gTower.h.

◆ m_posneg

int LVL1::gTower::m_posneg = 0

private

Definition at line 132 of file gTower.h.

◆ m_saturated

char LVL1::gTower::m_saturated = 0

private

Definition at line 135 of file gTower.h.

◆ m_scID

std::vector<Identifier> LVL1::gTower::m_scID

private

Definition at line 129 of file gTower.h.

◆ m_tower_id

int LVL1::gTower::m_tower_id = -9999999

private

Definition at line 131 of file gTower.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ gTower() [1/2]

◆ gTower() [2/2]

◆ ~gTower()

Member Function Documentation

◆ addET()

◆ clear_scIDs()

◆ clearET()

◆ constid()

◆ eta()

◆ getET()

◆ getET_EM_float()

◆ getET_float()

◆ getET_HAD_float()

◆ getEtaPhi()

◆ getFWID() [1/2]

◆ getFWID() [2/2]

◆ getID()

◆ getPosNeg()

◆ getSCIDs()

◆ id()

◆ iEta()

◆ iPhi()

◆ isSaturated()

◆ noiseCut()

◆ phi()

◆ setET()

◆ setEta()

◆ setIsSaturated()

◆ setPosNeg()

◆ setSCID()

◆ setTotalEt()

Member Data Documentation

◆ m_et

◆ m_et_float

◆ m_et_float_perlayer

◆ m_eta

◆ m_eta_float

◆ m_noisecut

◆ m_phi

◆ m_phi_float

◆ m_posneg

◆ m_saturated

◆ m_scID

◆ m_tower_id