The eTower class is an interface object for eFEX trigger algorithms The purposes are twofold: More...

#include <eTower.h>

Collaboration diagram for LVL1::eTower:

Public Member Functions
	eTower ()
	Constructors.
	eTower (float eta, float phi, int id_modifier, int posneg)
	constructs a tower and sets the coordinates and identifier
virtual	~eTower ()=default
	Destructor.
void	clearET ()
	Clear supercell ET values.
void	clear_scIDs ()
	Clear and resize Identifier value vector.
void	addET (float et, int cell)
	Add to ET of a specified cell in MeV.
void	recordMD_ET (float et, int cell)
	Add to ET of a specified cell.
int	iEta () const
	Get coordinates of tower.
int	iPhi () const
	Return global phi index.
float	eta () const
float	phi () const
void	setEta (const float thiseta)
int	id () const
float	constid () const
int	getET (unsigned int layer, int cell=0) const
	Get ET of a specified cell in MeV.
int	getTotalET () const
	Get ET sum of all cells in the eTower in MeV.
int	getLayerTotalET (unsigned int layer) const
	Get total ET sum of all cells in a given layer in MeV.
std::vector< int >	getLayerETvec (unsigned int layer) const
	Get vector of ET values for a given layer in MeV.
const std::vector< int > &	getETs () const
	Get vector of all ET values in MeV.
const std::vector< unsigned int > &	getETSplits () const
	Get vector of INT which describe whether a slot shared split ET from two different supercells - required information for production of CSV input files.
float	getET_float (unsigned int layer, int cell=0) const
	Get ET of a specified cell in MeV FLOAT VERSION.
float	getTotalET_float () const
	Get ET sum of all cells in the eTower in MeV FLOAT VERSION.
float	getLayerTotalET_float (unsigned int layer) const
	Get total ET sum of all cells in a given layer in MeV FLOAT VERSION.
std::vector< float >	getLayerETvec_float (unsigned int layer) const
	Get vector of ET values for a given layer in MeV FLOAT VERSION.
const std::vector< float > &	getETs_float () const
	Get vector of all ET values in MeV FLOAT VERSION.
void	setET (int cell, float et, int layer, bool ignoreDisable=false)
void	setSCID (Identifier ID, int cell, float et, int layer, bool doenergysplit)
	Set supercell position ID.
const std::vector< Identifier > &	getSCIDs () const
const std::vector< Identifier > &	getSCIDs_split () const
Identifier	getSCID (int cell) const
std::vector< Identifier >	getLayerSCIDs (unsigned int layer) const
void	setPosNeg (int posneg)
int	getPosNeg () const

Private Attributes
float	m_eta
	Internal data.
float	m_phi
std::vector< Identifier >	m_scID
std::vector< Identifier >	m_scID_split
std::vector< int >	m_et
std::vector< float >	m_et_float
std::vector< unsigned int >	m_etSplits
int	m_tower_id
int	m_posneg = 0

Detailed Description

The eTower class is an interface object for eFEX 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 eFEX 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 eFEX'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 eTower.h.

Constructor & Destructor Documentation

◆ eTower() [1/2]

LVL1::eTower::eTower ( )

Constructors.

Definition at line 25 of file eTower.cxx.

                :
    m_eta(0.),
    m_phi(0.),
    m_tower_id(-9999999),
    m_posneg(0)
  {
    this->clear_scIDs();
    this->clearET();
  }

◆ eTower() [2/2]

LVL1::eTower::eTower	(	float	eta,
		float	phi,
		int	id_modifier,
		int	posneg )

constructs a tower and sets the coordinates and identifier

Definition at line 36 of file eTower.cxx.

                                                                 :
    m_eta(eta),
    m_phi(phi),
    m_tower_id(id_modifier + phi + (64 * eta)),
    m_posneg(posneg)
  {
    this->clear_scIDs();
    this->clearET();
  }

◆ ~eTower()

virtual LVL1::eTower::~eTower ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addET()

void LVL1::eTower::addET	(	float	et,
		int	cell )

Add to ET of a specified cell in MeV.

Add ET to a specified cell.

Check cell index in range for layer - should probably throw a warning...

Definition at line 89 of file eTower.cxx.

  {
    if (cell < 0  || cell > 13){ return; }
    
    m_et_float[cell] += et;
 
    return;
 
  }

◆ clear_scIDs()

void LVL1::eTower::clear_scIDs ( )

Clear and resize Identifier value vector.

Definition at line 67 of file eTower.cxx.

  {
    m_scID.clear();
    m_scID.resize(14);
    m_scID_split.clear();
    m_scID_split.resize(14);
    for (unsigned int i=0; i<m_scID.size(); i++){
      m_scID[i] = Identifier();
      m_scID_split[i] = Identifier();
    }
  }

◆ clearET()

void LVL1::eTower::clearET ( )

Clear supercell ET values.

Clear and resize ET value vector.

Definition at line 47 of file eTower.cxx.

  {
    m_et.clear();
    m_et.resize(14);
    m_et_float.clear();
    m_et_float.resize(14);
    for (unsigned int i=0; i<m_et.size(); i++){
      m_et[i] = 0;
      m_et_float[i] = 0.0;
    }
 
    m_etSplits.clear();
    m_etSplits.resize(14);
    for (unsigned int i=0; i<m_etSplits.size(); i++){
      m_etSplits[i] = 0;
    }
 
  }

◆ constid()

float LVL1::eTower::constid ( ) const

inline

Definition at line 71 of file eTower.h.

71{return m_tower_id;};

◆ eta()

float LVL1::eTower::eta ( ) const

inline

Definition at line 64 of file eTower.h.

64{return m_eta;};

◆ getET()

int LVL1::eTower::getET	(	unsigned int	layer,
		int	cell = 0 ) const

Get ET of a specified cell in MeV.

Return ET of specified supercell.

Check cell index in range for layer

Definition at line 172 of file eTower.cxx.

                                                       {
    
    if (layer >= s_nLayers || cell < 0 || cell >= s_cells[layer]) return 0;
    
    // Return ET
    return m_et[s_offsets[layer] + cell];
    
  }

◆ getET_float()

float LVL1::eTower::getET_float	(	unsigned int	layer,
		int	cell = 0 ) const

Get ET of a specified cell in MeV FLOAT VERSION.

Return ET of specified supercell FLOAT VERSION.

Check cell index in range for layer

Definition at line 183 of file eTower.cxx.

                                                              {
    if (layer >= s_nLayers || cell < 0 || cell >= s_cells[layer]) return 0;
 
    // Return ET
    return m_et_float[s_offsets[layer] + cell];
 
  }

◆ getETs()

const std::vector< int > & LVL1::eTower::getETs ( ) const

inline

Get vector of all ET values in MeV.

Definition at line 86 of file eTower.h.

86{return m_et;};

◆ getETs_float()

const std::vector< float > & LVL1::eTower::getETs_float ( ) const

inline

Get vector of all ET values in MeV FLOAT VERSION.

Definition at line 104 of file eTower.h.

104{return m_et_float;};

◆ getETSplits()

const std::vector< unsigned int > & LVL1::eTower::getETSplits ( ) const

inline

Get vector of INT which describe whether a slot shared split ET from two different supercells - required information for production of CSV input files.

Definition at line 89 of file eTower.h.

89{return m_etSplits;};

◆ getLayerETvec()

std::vector< int > LVL1::eTower::getLayerETvec ( unsigned int layer ) const

Get vector of ET values for a given layer in MeV.

Return supercell ET values for specified layer.

Create empty vector of data

Check cell index in range for layer

Fill output vector

Definition at line 217 of file eTower.cxx.

                                                               {
    
    std::vector<int> cells;
    
    if (layer >= s_nLayers) return cells;
    
    for (int cell = 0; cell < s_cells[layer]; ++cell) cells.push_back(m_et[s_offsets[layer] + cell]);
    
    return cells;
  }

◆ getLayerETvec_float()

std::vector< float > LVL1::eTower::getLayerETvec_float ( unsigned int layer ) const

Get vector of ET values for a given layer in MeV FLOAT VERSION.

Return supercell ET values for specified layer FLOAT VERSION.

Create empty vector of data

Check cell index in range for layer

Fill output vector

Definition at line 233 of file eTower.cxx.

                                                                       {
    std::vector<float> cells;
    if (layer >= s_nLayers) return cells;
    for (int cell = 0; cell < s_cells[layer]; ++cell) cells.push_back(m_et_float[s_offsets[layer] + cell]);
 
    return cells;
  }

◆ getLayerSCIDs()

std::vector< Identifier > LVL1::eTower::getLayerSCIDs ( unsigned int layer ) const

Definition at line 296 of file eTower.cxx.

                                                                     {
 
    std::vector<Identifier> cells_in_layer;
    
    if (layer == 0){
      cells_in_layer.push_back(m_scID[0]);
    }
    else if (layer == 1){
      cells_in_layer.push_back(m_scID[1]);
      cells_in_layer.push_back(m_scID[2]);
      cells_in_layer.push_back(m_scID[3]);
      cells_in_layer.push_back(m_scID[4]);
    }
    else if (layer == 2){
      cells_in_layer.push_back(m_scID[5]);
      cells_in_layer.push_back(m_scID[6]);
      cells_in_layer.push_back(m_scID[7]);
      cells_in_layer.push_back(m_scID[8]);
    }
    else if (layer == 3){
      cells_in_layer.push_back(m_scID[9]);
    }
    else if (layer == 4){
      cells_in_layer.push_back(m_scID[10]);
      cells_in_layer.push_back(m_scID[11]);
    }
 
    return cells_in_layer;
 
  }

◆ getLayerTotalET()

int LVL1::eTower::getLayerTotalET ( unsigned int layer ) const

Get total ET sum of all cells in a given layer in MeV.

Return supercell ET values for specified layer.

Definition at line 249 of file eTower.cxx.

                                                      {
        
    if (layer == 0){
      return m_et[0];
    }
    else if (layer == 1){
      return (m_et[1] + m_et[2] + m_et[3] + m_et[4]);
    }
    else if (layer == 2){
      return (m_et[5] + m_et[6] + m_et[7] + m_et[8]);
    }
    else if (layer == 3){
      return m_et[9];
    }
    else if (layer == 4){
      return (m_et[10] + m_et[11]);
    }
 
    
    return 0;
    
  }

◆ getLayerTotalET_float()

float LVL1::eTower::getLayerTotalET_float ( unsigned int layer ) const

Get total ET sum of all cells in a given layer in MeV FLOAT VERSION.

Return supercell ET values for specified layer FLOAT VERSION.

Definition at line 273 of file eTower.cxx.

                                                              {
 
    if (layer == 0){
      return m_et_float[0];
    }
    else if (layer == 1){
      return (m_et_float[1] + m_et_float[2] + m_et_float[3] + m_et_float[4]);
    }
    else if (layer == 2){
      return (m_et_float[5] + m_et_float[6] + m_et_float[7] + m_et_float[8]);
    }
    else if (layer == 3){
      return m_et_float[9];
    }
    else if (layer == 4){
      return (m_et_float[10] + m_et_float[11]);
    }
 
 
    return 0;
 
  }

◆ getPosNeg()

int LVL1::eTower::getPosNeg ( ) const

inline

Definition at line 121 of file eTower.h.

121{return m_posneg;}

◆ getSCID()

Identifier LVL1::eTower::getSCID ( int cell ) const

inline

Definition at line 115 of file eTower.h.

115{ return m_scID[cell]; }

◆ getSCIDs()

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

inline

Definition at line 111 of file eTower.h.

111{ return m_scID; }

◆ getSCIDs_split()

const std::vector< Identifier > & LVL1::eTower::getSCIDs_split ( ) const

inline

Definition at line 113 of file eTower.h.

113{ return m_scID_split; }

◆ getTotalET()

int LVL1::eTower::getTotalET ( ) const

Get ET sum of all cells in the eTower in MeV.

Return ET of all supercells together.

Definition at line 194 of file eTower.cxx.

                              {
    int tmp = 0;
    for (unsigned int i=0; i<m_et.size(); i++){
      tmp += m_et[i];
    }
    // Sum saturates at 16 bits
    return std::min(tmp,s_eFEXOverflow);
  }

◆ getTotalET_float()

float LVL1::eTower::getTotalET_float ( ) const

Get ET sum of all cells in the eTower in MeV FLOAT VERSION.

Return ET of all supercells together FLOAT VERSION.

Definition at line 204 of file eTower.cxx.

                                      {
 
    float tmp = 0;
    for (unsigned int i=0; i<m_et_float.size(); i++){
      tmp += m_et_float[i];
    }
 
    return tmp;
 
  }

◆ id()

int LVL1::eTower::id ( ) const

inline

Definition at line 69 of file eTower.h.

69{return m_tower_id;}

◆ iEta()

int LVL1::eTower::iEta ( ) const

Get coordinates of tower.

Return global eta index.

Should be derived from tower ID, should be corrected in the future. Need to also think what index range should be (thinking ahead to Run2)

Definition at line 159 of file eTower.cxx.

                         {
    const int index = (m_eta * m_posneg);
    return index;
  }

◆ iPhi()

int LVL1::eTower::iPhi ( ) const

Return global phi index.

Should be derived from tower ID, should be corrected in the future. Decision here is whether phi is signed or not

Definition at line 167 of file eTower.cxx.

                         {
    return m_phi;
  }

◆ phi()

float LVL1::eTower::phi ( ) const

inline

Definition at line 65 of file eTower.h.

65{return m_phi;};

◆ recordMD_ET()

void LVL1::eTower::recordMD_ET	(	float	et,
		int	cell )

Add to ET of a specified cell.

◆ setET()

void LVL1::eTower::setET	(	int	cell,
		float	et,
		int	layer,
		bool	ignoreDisable = false )

Check cell index in range for layer

Definition at line 99 of file eTower.cxx.

                                                                      {
    if (cell < 0  || cell > 13){ return; }
      
    addET(et, cell);
    
    //multi linear digitisation encoding ... except in tile (indicated by passing layer=5) .. just convert to 25 MeV steps
    m_et[cell] = (layer==5) ? std::round(m_et_float[cell]/25) : eFEXCompression::decode(std::round(m_et_float[cell]),layer, ignoreDisable);
  }

◆ setEta()

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

inline

Definition at line 67 of file eTower.h.

67{ m_eta = thiseta; }

◆ setPosNeg()

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

Definition at line 80 of file eTower.cxx.

                                  {
    
    m_posneg = posneg;
 
    return;
 
  }

◆ setSCID()

void LVL1::eTower::setSCID	(	Identifier	ID,
		int	cell,
		float	et,
		int	layer,
		bool	doenergysplit )

Set supercell position ID.

Set supercell position ID and ET.

Check cell index in range for layer

Definition at line 110 of file eTower.cxx.

  {
    
    if (cell < 0  || cell > 13){ return; }
 
    if(!doenergysplit){
      
      addET(et, cell);
      
      m_scID[cell] = ID;
    
      //multi linear digitisation encoding
      int outET = eFEXCompression::decode(std::round(m_et_float[cell]),layer);
      m_et[cell] = outET;
    }
    else{
 
      float et_half = et*0.5;
      addET(et_half, cell);
      addET(et_half, cell+1);
 
      m_etSplits[cell] = 1;
      m_etSplits[cell+1] = 1;
      
      if(cell==1){
          m_scID[12] = ID;
      }
      else if(cell==3){
          m_scID[13] = ID;
      }
      
      
      m_scID_split[cell] = ID;
      m_scID_split[cell+1] = ID;
      
      m_scID.push_back(ID);
 
      m_et[cell] = eFEXCompression::decode(std::round(m_et_float[cell]),layer);
      m_et[cell+1] = eFEXCompression::decode(std::round(m_et_float[cell+1]),layer);
    }
 
    return;
 
  }

Member Data Documentation

◆ m_et

std::vector<int> LVL1::eTower::m_et

private

Definition at line 129 of file eTower.h.

◆ m_et_float

std::vector<float> LVL1::eTower::m_et_float

private

Definition at line 130 of file eTower.h.

◆ m_eta

float LVL1::eTower::m_eta

private

Internal data.

Definition at line 125 of file eTower.h.

◆ m_etSplits

std::vector<unsigned int> LVL1::eTower::m_etSplits

private

Definition at line 131 of file eTower.h.

◆ m_phi

float LVL1::eTower::m_phi

private

Definition at line 126 of file eTower.h.

◆ m_posneg

int LVL1::eTower::m_posneg = 0

private

Definition at line 133 of file eTower.h.

◆ m_scID

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

private

Definition at line 127 of file eTower.h.

◆ m_scID_split

std::vector<Identifier> LVL1::eTower::m_scID_split

private

Definition at line 128 of file eTower.h.

◆ m_tower_id

int LVL1::eTower::m_tower_id

private

Definition at line 132 of file eTower.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ eTower() [1/2]

◆ eTower() [2/2]

◆ ~eTower()

Member Function Documentation

◆ addET()

◆ clear_scIDs()

◆ clearET()

◆ constid()

◆ eta()

◆ getET()

◆ getET_float()

◆ getETs()

◆ getETs_float()

◆ getETSplits()

◆ getLayerETvec()

◆ getLayerETvec_float()

◆ getLayerSCIDs()

◆ getLayerTotalET()

◆ getLayerTotalET_float()

◆ getPosNeg()

◆ getSCID()

◆ getSCIDs()

◆ getSCIDs_split()

◆ getTotalET()

◆ getTotalET_float()

◆ id()

◆ iEta()

◆ iPhi()

◆ phi()

◆ recordMD_ET()

◆ setET()

◆ setEta()

◆ setPosNeg()

◆ setSCID()

Member Data Documentation

◆ m_et

◆ m_et_float

◆ m_eta

◆ m_etSplits

◆ m_phi

◆ m_posneg

◆ m_scID

◆ m_scID_split

◆ m_tower_id