LVL1::jFexEmulatedTowers Class Reference

#include <jFexEmulatedTowers.h>

Inheritance diagram for LVL1::jFexEmulatedTowers:

Public Member Functions
	jFexEmulatedTowers (const std::string &name, ISvcLocator *svc)
virtual StatusCode	initialize () override
	Function initialising the algorithm.
virtual StatusCode	execute (const EventContext &) const override
	Function executing the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	ReadFibersfromFile (const std::string &)
StatusCode	ReadSCfromFile (const std::string &)
StatusCode	ReadTilefromFile (const std::string &)
bool	isBadSCellID (const std::string &) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static constexpr unsigned int	mapIndex (unsigned int jfex, unsigned int fpga, unsigned int channel, unsigned int tower)

Private Attributes
SG::ReadHandleKey< CaloCellContainer >	m_SCellKey {this, "SCell", "SCell", "SCell container"}
SG::ReadHandleKey< xAOD::TriggerTowerContainer >	m_triggerTowerKey {this, "xODTriggerTowers", "xAODTriggerTowers", "xAODTriggerTowers container"}
SG::WriteHandleKey< xAOD::jFexTowerContainer >	m_jTowersWriteKey {this,"jTowersWriteKey" ,"L1_jFexEmulatedTowers", "Write jFexEDM Trigger Tower container"}
Gaudi::Property< std::string >	m_FiberMapping {this, "jFexTowerMapping", PathResolver::find_calib_file("L1CaloFEXByteStream/2023-08-01/jFexTowerMap.txt"), "Text file to convert from hardware fiber to eta-phi location"}
Gaudi::Property< bool >	m_apply_masking {this, "SCellMasking", true, "Applies masking. Only use for data"}
Gaudi::Property< bool >	m_isDATA {this, "isDATA" , true, "Tells the algorithm if it is data. Used for xAOD::TriggerTower WARNING due to the 0 supresion"}
Gaudi::Property< bool >	m_doThinning {this, "DoThinning" , true, "Remove overlapped towers. Only FPGA Core region is saved"}
Gaudi::Property< std::string >	m_jFEX2Scellmapping {this, "jFEX2SCmapping" , PathResolver::find_calib_file("L1CaloFEXByteStream/2022-10-19/jfex_SCID.txt") , "Text file to convert from simulation ID to SuperCell Identifier"}
Gaudi::Property< std::string >	m_jFEX2Tilemapping {this, "jFEX2Tilemapping", PathResolver::find_calib_file("L1CaloFEXByteStream/2022-10-19/jfex_TileID.txt"), "Text file to convert from simulation ID to Tile Identifier"}
std::unordered_map< uint32_t, std::vector< uint64_t > >	m_map_TTower2SCellsEM
std::unordered_map< uint32_t, std::vector< uint64_t > >	m_map_TTower2SCellsHAD
std::unordered_map< uint32_t, std::tuple< uint32_t, float, float > >	m_map_TTower2Tile
std::unordered_map< unsigned int, std::array< float, 6 > >	m_Firm2Tower_map
SG::ReadHandleKey< CaloCellContainer >	m_CaloCellKey {this, "CaloCell", "", "Calo Cell container, supply AllCalo to activate"}
	{map index, {IDsimulation,eta,phi,source,iEta,iPhi}}
ToolHandle< ICaloSuperCellIDTool >	m_scellIdTool {this, "CaloSuperCellIDTool", "", "Offline / SuperCell ID mapping tool"}
const CaloCell_ID *	m_caloCellIdHelper {}
SG::ReadDecorHandleKey< xAOD::TriggerTowerContainer >	m_readTileOfflineDecorKey { this, "TileOfflineETKey", m_triggerTowerKey, "", "decoration of offline energy from Tile Towers" }
SG::WriteDecorHandleKey< xAOD::jFexTowerContainer >	m_caloCellSumETdecorKey {this, "CaloCellSumEtdecorKey", m_jTowersWriteKey, "", "Offline Calo Cell Et information of the jTower in MeV"}
SG::WriteDecorHandleKey< xAOD::jFexTowerContainer >	m_jtowerEtMeVdecorKey { this, "jtowerEtMeVdecorKey", m_jTowersWriteKey, "jtowerEtMeV", "jFex Tower Et in MeV"}
SG::WriteDecorHandleKey< xAOD::jFexTowerContainer >	m_jtowerEtTimingMeVdecorKey { this, "jtowerEtTimingMeVdecorKey", m_jTowersWriteKey, "jtowerEtTimingMeV", "jFex Tower Et, after timing cut, in MeV"}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 37 of file jFexEmulatedTowers.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

jFexEmulatedTowers()

LVL1::jFexEmulatedTowers::jFexEmulatedTowers	(	const std::string &	name,
		ISvcLocator *	svc )

Definition at line 30 of file jFexEmulatedTowers.cxx.

: AthReentrantAlgorithm(name, svc){}

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode LVL1::jFexEmulatedTowers::execute ( const EventContext & ctx ) const

overridevirtual

Function executing the algorithm.

Definition at line 74 of file jFexEmulatedTowers.cxx.

                                                                    {
 
    //Reading the Scell container
    SG::ReadHandle<CaloCellContainer> ScellContainer(m_SCellKey, ctx);
    if(!ScellContainer.isValid()) {
        ATH_MSG_ERROR("Could not retrieve collection " << ScellContainer.key() );
        return StatusCode::FAILURE;
    }
    
    //Reading the TriggerTower container
    SG::ReadHandle<xAOD::TriggerTowerContainer> triggerTowerContainer(m_triggerTowerKey, ctx);
    if(!triggerTowerContainer.isValid()) {
        ATH_MSG_ERROR("Could not retrieve collection " << triggerTowerContainer.key() );
        return StatusCode::FAILURE;
    }
 
    // Reading the offline Calo cell container
    const CaloCellContainer* caloCells = nullptr;
    if (!m_CaloCellKey.empty()) {
      SG::ReadHandle<CaloCellContainer> caloCellContainer(m_CaloCellKey, ctx);
      if(!caloCellContainer.isValid()) {
        ATH_MSG_ERROR("Could not retrieve collection " << caloCellContainer.key() );
        return StatusCode::FAILURE;
      }
      caloCells = caloCellContainer.cptr();
    }
 
    //WriteHandle for jFEX EDMs
    //---jTower EDM
    SG::WriteHandle<xAOD::jFexTowerContainer> jTowersContainer(m_jTowersWriteKey, ctx);
    ATH_CHECK(jTowersContainer.record(std::make_unique<xAOD::jFexTowerContainer>(), std::make_unique<xAOD::jFexTowerAuxContainer>()));
    ATH_MSG_DEBUG("Recorded jFexEmulatedTower container with key " << jTowersContainer.key());
 
    if(ScellContainer->empty() || triggerTowerContainer->empty() ){
        ATH_MSG_WARNING("Cannot fill jTowers here, at least one container is empty. ScellContainer.size="<<ScellContainer->size() << " or triggerTowerContainer.size=" << triggerTowerContainer->size() );
        return StatusCode::SUCCESS;
    }
 
    std::optional<SG::ReadDecorHandle<xAOD::TriggerTowerContainer, std::vector<float>>> cellEtByLayer_handle;
    if (!m_CaloCellKey.empty()) {
      cellEtByLayer_handle.emplace(m_readTileOfflineDecorKey, ctx);
    }
    std::optional<SG::WriteDecorHandle<xAOD::jFexTowerContainer, float>> jTowerCaloCellSumEt;
    if (!m_caloCellSumETdecorKey.empty()) {
      jTowerCaloCellSumEt.emplace(m_caloCellSumETdecorKey, ctx);
    }
    std::optional<SG::WriteDecorHandle<xAOD::jFexTowerContainer, int>> jTowerEtMeV;
    if (!m_jtowerEtMeVdecorKey.empty()) {
      jTowerEtMeV.emplace(m_jtowerEtMeVdecorKey , ctx);
    }
    std::optional<SG::WriteDecorHandle<xAOD::jFexTowerContainer, int>> jTowerEtTimingMeV;
    if (!m_jtowerEtTimingMeVdecorKey.empty()) {
      jTowerEtTimingMeV.emplace(m_jtowerEtTimingMeVdecorKey , ctx);
    }
 
    // building Scell ID pointers
    std::unordered_map< uint64_t, const CaloCell*> map_ScellID2ptr;
    map_ScellID2ptr.reserve(ScellContainer->size());
    
    for(const CaloCell* scell : *ScellContainer){
        const uint64_t ID = scell->ID().get_compact();
        map_ScellID2ptr[ID] = scell;
    }
    
    // building Tile ID pointers
    std::unordered_map< uint32_t, const xAOD::TriggerTower*> map_TileID2ptr;
    
    for(const xAOD::TriggerTower* tower : *triggerTowerContainer){
        
        // keeping just tile information
        if(std::abs(tower->eta())>1.5 || tower->sampling()!=1) continue;
        
        map_TileID2ptr[tower->coolId()]=tower;
    }
    
    
    for( const auto& [key, element] : m_Firm2Tower_map){
        
        unsigned int jfex    = (key >> 16) & 0xf;
        unsigned int fpga    = (key >> 12) & 0xf;
        unsigned int channel = (key >> 4 ) & 0xff;
        unsigned int tower   = (key >> 0 ) & 0xf; 
               
        const auto [f_IDSimulation, eta, phi, f_source, f_iEta, f_iPhi] = element;
        
        //elements that need to be casted
        unsigned int IDSimulation = static_cast<int>(f_IDSimulation);
        unsigned int source       = static_cast<int>(f_source);
        unsigned int iEta         = static_cast<int>(f_iEta);
        unsigned int iPhi         = static_cast<int>(f_iPhi);
        
        uint16_t Total_Et_encoded = 0;
        uint16_t Total_Et_Timing_encoded = 0;
        char jTower_sat = 0;
 
    float caloCellSumET(0); // Readout Et for Tower
    int Total_Et_decoded(0);
    int Total_Et_Timing_decoded(0);
        if( source != 1 ){
            
            const std::unordered_map< uint32_t, std::vector<uint64_t> > * ptr_TTower2Cells;
            
            //HAD layer for HEC, FCAL2 and FCAL3
            if(source == 3 or source > 4){
                ptr_TTower2Cells = &m_map_TTower2SCellsHAD;
            } 
            else{
                ptr_TTower2Cells = &m_map_TTower2SCellsEM;
            }  
            
            //check that the jFEX Tower ID exists in the map
            auto it_TTower2SCells = (*ptr_TTower2Cells).find(IDSimulation);
            if(it_TTower2SCells == (*ptr_TTower2Cells).end()) {
                ATH_MSG_ERROR("jFEX ID: "<<IDSimulation<< " not found on map m_map_TTower2SCellsEM/HAD");
                return StatusCode::FAILURE;
            }
        
            int Total_Et = 0;
            int Total_Timing_Et = 0;
            float Total_Et_float = 0;
            bool invalid = m_apply_masking&&m_isDATA; // the isDATA is because there is no concept of invalid supercell in MC (the provenance bit is actually used for BCID in MC), so can never have an invalid jTower. 
            bool masked = m_apply_masking;
            for (auto const& SCellID : it_TTower2SCells->second ) {
                //check that the SCell Identifier exists in the map
                auto it_ScellID2ptr = map_ScellID2ptr.find(SCellID);
                if(it_ScellID2ptr == map_ScellID2ptr.end()) {
                    if(m_isDATA) ATH_MSG_DEBUG("Scell ID: 0x"<<std::hex<< (SCellID >> 32) <<std::dec<< " not found in the CaloCell Container, skipping");
                    // this is equivalent to treat the scell as a masked input, since masking takes precedence over invalidity
                    continue;
                }
 
                const CaloCell* myCell = it_ScellID2ptr->second;
                int val =  std::round(myCell->energy()/(12.5*std::cosh(myCell->eta()))); // 12.5 is b.c. energy is in units of 12.5MeV per count
                bool isMasked = m_apply_masking ? (myCell->provenance()&0x80) : false;
                bool isInvalid = (m_apply_masking&&m_isDATA) ? (myCell->provenance()&0x40) : false;
                bool isSaturated = (m_isDATA) ? myCell->quality() : false; // saturation algorithm not implemented in MC yet
                bool passTiming = ( myCell->provenance() & 0x200 );
 
                invalid &= isInvalid;
                masked &= isMasked;
        if (!isMasked) {
          jTower_sat |= isSaturated;
        }
 
                if( isMasked ) {
                    //if masked then Et = 0
                    val = 0;
                    //countMasked++;
                } else if( isInvalid ) {
                    val = 0;
                }
                
                Total_Et += val;
                if(val!=0) Total_Et_float += myCell->et();
 
        // tau timing cut
        Total_Timing_Et += (passTiming) ? val : 0;
 
        // Readout path energy sum
        if ( !m_CaloCellKey.empty() ) {
          const std::vector<Identifier> caloCellIds = m_scellIdTool->superCellToOfflineID(myCell->ID());
          float caloCellEt(0.);  // offline Et for the SCell
          //use findCell function of CaloCellContainer, which takes an identifier hash
          for(auto& caloCellId : caloCellIds) {
            const CaloCell* caloCell = caloCells->findCell(m_caloCellIdHelper->calo_cell_hash(caloCellId));
            if(!caloCell) { ATH_MSG_WARNING("Could not find cell"); continue; }
            caloCellEt += caloCell->e()*caloCell->sinTh();
          }
          caloCellSumET += caloCellEt;
        }
                
            } // SCell loop
 
            // now must convert Total_Et int value into fex value: multi-level encoding
            if(masked) {
                Total_Et_encoded = 0; // no data
        Total_Et_Timing_encoded = 0;
            } else if(invalid) {
                Total_Et_encoded = 4095; // invalid
                Total_Et_Timing_encoded = 4095;
            } else {
                Total_Et_encoded = jFEXCompression::Compress( Total_Et*12.5);
                Total_Et_Timing_encoded = jFEXCompression::Compress( Total_Timing_Et*12.5);
            }
 
            // leaving this commented while outstanding questions above about treatment of supercells
            // using floating point for MC until determine correct procedure for MC values re invalid/masking
            if(!m_isDATA) Total_Et_encoded = jFEXCompression::Compress( Total_Et_float, masked );
 
        Total_Et_decoded = jFEXCompression::Expand( Total_Et_encoded );
        Total_Et_Timing_decoded = jFEXCompression::Expand( Total_Et_Timing_encoded );
        }
        else{
            
            //check that the jFEX Tower ID exists in the map
            auto it_TTower2Tile = m_map_TTower2Tile.find(IDSimulation);
            if(it_TTower2Tile == m_map_TTower2Tile.end()) {
                ATH_MSG_ERROR("ID: "<<IDSimulation<< " not found on map m_map_TTower2Tile");
                return StatusCode::FAILURE;
            }
            
            uint32_t TileID = std::get<0>( it_TTower2Tile->second );
            
            //check that the Tile Identifier exists in the map
            auto it_TileID2ptr = map_TileID2ptr.find(TileID);
            if(it_TileID2ptr == map_TileID2ptr.end()) {
                if(m_isDATA) ATH_MSG_WARNING("Tile cool ID: "<<TileID<< " not found in the xAOD::TriggerTower, skipping");
                continue;
            }
 
        Total_Et_encoded = (it_TileID2ptr->second)->cpET();
 
        Total_Et_decoded = Total_Et_encoded * 500;
        Total_Et_Timing_decoded = Total_Et_encoded * 500;
 
        // get the offline reconstructed energy from xAODTriggerTower decoration
        if ( !m_CaloCellKey.empty() ) {
          if ( cellEtByLayer_handle->isAvailable() ) {
        const std::vector<float>& cellEtByLayer = (*cellEtByLayer_handle)(*it_TileID2ptr->second);
        // Stored in GeV, see TrigT1CaloCalibTools/src/L1CaloCells2TriggerTowers.cxx
        caloCellSumET = 1000.0 * std::accumulate(cellEtByLayer.begin(), cellEtByLayer.end(), 0.0);
          }
        }
        } // end of Tile
        std::vector<uint16_t> vtower_ET;
        vtower_ET.push_back(Total_Et_encoded);
        
        std::vector<char> vtower_SAT;
        
        //Needs to be updated with Saturation flag from LAr CaloCell container, not ready yet!
        vtower_SAT.push_back(jTower_sat);  
        
        jTowersContainer->push_back( std::make_unique<xAOD::jFexTower>() );
        jTowersContainer->back()->initialize(eta, phi, iEta, iPhi, IDSimulation, source, vtower_ET, jfex, fpga, channel, tower, vtower_SAT ); 
        
        if( m_doThinning && !jTowersContainer->back()->isCore() ){
            jTowersContainer->pop_back();
        } else {
      // decorate with offline energy
      if (!m_caloCellSumETdecorKey.empty()) {
        (*jTowerCaloCellSumEt) (*jTowersContainer->back()) = caloCellSumET;
      }
      // decorate tower energies in MeV without/with timing cut
      if (!m_jtowerEtMeVdecorKey.empty()) {
        (*jTowerEtMeV) (*jTowersContainer->back()) = Total_Et_decoded;
      }
      if (!m_jtowerEtTimingMeVdecorKey.empty()) {
        (*jTowerEtTimingMeV) (*jTowersContainer->back()) = Total_Et_Timing_decoded;
      }
    }
    } // firmware tower map
    
    // Return gracefully
    return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

initialize()

StatusCode LVL1::jFexEmulatedTowers::initialize ( )

overridevirtual

Function initialising the algorithm.

Definition at line 32 of file jFexEmulatedTowers.cxx.

                                          {
    
    ATH_MSG_INFO( "Initializing L1CaloFEXAlgos/jFexEmulatedTowers algorithm with name: "<< name());
    ATH_MSG_INFO( "Writting into SG key: "<< m_jTowersWriteKey);
    ATH_MSG_INFO( "SCell masking: "<< m_apply_masking);
    ATH_MSG_INFO( "Thinnig towers: "<< m_doThinning);
    
    ATH_CHECK( m_SCellKey.initialize() );
    ATH_CHECK( m_triggerTowerKey.initialize() );
    ATH_CHECK( m_jTowersWriteKey.initialize() );    
 
    //Reading from CVMFS Fiber mapping
    ATH_CHECK(ReadFibersfromFile(m_FiberMapping));    
    
    //Reading from CVMFS Trigger Tower and their corresponding SCell ID
    ATH_CHECK(ReadSCfromFile(m_jFEX2Scellmapping));
    ATH_CHECK(ReadTilefromFile(m_jFEX2Tilemapping));
 
    // offline energy decoration setup
    // SCell to Cell mapping
    if (!m_CaloCellKey.empty()) {
      ATH_CHECK( m_scellIdTool.retrieve() );
      ATH_CHECK( detStore()->retrieve (m_caloCellIdHelper, "CaloCell_ID") );
    }
 
    // Calo cell container
    ATH_CHECK( m_CaloCellKey.initialize(SG::AllowEmpty) );
 
    // read Tile Tower decoration
    ATH_CHECK( m_readTileOfflineDecorKey.initialize(SG::AllowEmpty) );
 
    // Readout path cell sum Et decoration
    ATH_CHECK( m_caloCellSumETdecorKey.initialize(SG::AllowEmpty) );
 
    // tower energy decorations
    ATH_CHECK( m_jtowerEtMeVdecorKey.initialize(SG::AllowEmpty) );
    ATH_CHECK( m_jtowerEtTimingMeVdecorKey.initialize(SG::AllowEmpty) );
 
 
    return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isBadSCellID()

bool LVL1::jFexEmulatedTowers::isBadSCellID ( const std::string & ID ) const

private

Definition at line 444 of file jFexEmulatedTowers.cxx.

                                                              {
    
    // does it start with "0x"?, if so then is a GOOD SCell ID!
    if (ID.find("0x") == std::string::npos) {
        ATH_MSG_ERROR("Invalid SuperCell ID " << ID << ". Expecting hexadecimal number on the mapping file");
        return true;
    }
    return false;
}

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

mapIndex()

unsigned int LVL1::jFexEmulatedTowers::mapIndex ( unsigned int jfex, unsigned int fpga, unsigned int channel, unsigned int tower )

staticconstexprprivate

Definition at line 379 of file jFexEmulatedTowers.cxx.

                                                                                                                                  {
  // values from hardware: jfex=[0,5] 4 bits, fpga=[0,3] 4 bits, channel=[0,59] 8 bits, tower=[0,15] 4 bits
  return (jfex << 16) | (fpga << 12) | (channel << 4) | tower;
}

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

ReadFibersfromFile()

StatusCode LVL1::jFexEmulatedTowers::ReadFibersfromFile ( const std::string & fileName )

private

Definition at line 331 of file jFexEmulatedTowers.cxx.

                                                                           {
 
    //opening file with ifstream
    std::ifstream file(fileName);
    
    if ( !file.is_open() ){
        ATH_MSG_ERROR("Could not open file:" << fileName);
        return StatusCode::FAILURE;
    }
    
    std::string line;
    //loading the mapping information
    while ( std::getline (file, line) ) {
 
        //removing the header of the file (it is just information!)
        if(line[0] == '#') continue;
        
        //Splitting line in different substrings
        std::stringstream oneLine(line);
        
        //reading elements
        std::vector<float> elements;
    elements.reserve(10);
        std::string element;
        while(std::getline(oneLine, element, ' '))
        {
            elements.push_back(std::stof(element));
        }
        
        // It should have 10 elements
        // ordered as:  jfex fpga channel towerNr source globalEtaIndex globalPhiIndex IDSimulation eta phi
        if(elements.size() != 10){
            ATH_MSG_ERROR("Unexpected number of elemennts (10 expected) in file: "<< fileName);
            return StatusCode::FAILURE;
        }
        // building array of  <IDSimulation, eta, phi, source, iEta, iPhi>
        std::array<float,6> aux_arr{ {elements.at(7),elements.at(8),elements.at(9),elements.at(4),elements.at(5),elements.at(6)} };
        
        //filling the map with the hash given by mapIndex()
        m_Firm2Tower_map[ mapIndex(elements.at(0),elements.at(1),elements.at(2),elements.at(3)) ] = aux_arr;
        
    }
    file.close();
 
    return StatusCode::SUCCESS;
}

ReadSCfromFile()

StatusCode LVL1::jFexEmulatedTowers::ReadSCfromFile ( const std::string & fileName )

private

Definition at line 384 of file jFexEmulatedTowers.cxx.

                                                                       {
 
    //opening file with ifstream
    std::ifstream file(fileName);
    
    if ( !file.is_open() ){
        ATH_MSG_ERROR("Could not open file:" << fileName);
        return StatusCode::FAILURE;
    }
    
    std::string line;
    //loading the mapping information into an unordered_map <Fex Tower ID, vector of SCell IDs>
    while ( std::getline (file, line) ) {
        //removing the header of the file (it is just information!)
        if(line[0] == '#') continue;
 
    std::vector<uint64_t> SCellvectorEM;
    std::vector<uint64_t> SCellvectorHAD;
 
        //Splitting line in different substrings
        std::stringstream oneSCellID(line);
        
        //reading elements
        std::string substr = "";
        int TTID = 0;
        int elem = 0;
        
        while(std::getline(oneSCellID, substr, ' '))
        {
            ++elem;
            if(elem == 1){
               TTID =  std::stoi(substr);
            }
            else{
                //Check if it looks like a SCell Identifier
                if(isBadSCellID(substr)){
                    return StatusCode::FAILURE;
                }
                
                // converts hex number to unsigned long long int
                uint64_t scid_uint64 = std::strtoull(substr.c_str(), nullptr, 0);
                
                //empty slots are filled with 0xffffffffffffffff
                if(scid_uint64 == 0xffffffffffffffff) continue;
                
                //from element from 2 to 13 are EM SCells, element 14 is a HAD SCell
                if(elem<14) SCellvectorEM.push_back(scid_uint64);
                else        SCellvectorHAD.push_back(scid_uint64);          
            }
        }        
        
        m_map_TTower2SCellsEM[TTID] = std::move(SCellvectorEM);
        m_map_TTower2SCellsHAD[TTID] = std::move(SCellvectorHAD);
        
    }
    file.close();
 
    return StatusCode::SUCCESS;
}

ReadTilefromFile()

StatusCode LVL1::jFexEmulatedTowers::ReadTilefromFile ( const std::string & fileName )

private

Definition at line 457 of file jFexEmulatedTowers.cxx.

                                                                         {
    
    //opening file with ifstream
    std::ifstream file(fileName);
    
    if ( !file.is_open() ){
        ATH_MSG_ERROR("Could not open file:" << fileName);
        return StatusCode::FAILURE;
    }
    
    std::string line;
    //loading the mapping information into an unordered_map <Fex Tower ID, vector of SCell IDs>
    while ( std::getline (file, line) ) {
 
        //removing the header of the file (it is just information!)
        if(line[0] == '#') continue;
        
        //Splitting line in different substrings
        std::stringstream oneLine(line);
        
        std::vector<std::string> elements;
        std::string element = "";
        
        while(std::getline(oneLine, element, ' ')){
            elements.push_back(element);
        }
        
        if(elements.size() != 4){
            ATH_MSG_ERROR("Invalid number of element in " << line << ". Expecting 4 elements {jFexID, TileID, eta, phi}");
            return StatusCode::FAILURE;
        }
        
        uint32_t jFexID = std::stoi( elements.at(0) );
        uint32_t TileID = std::stoi( elements.at(1) );
        float eta       = std::stof( elements.at(2) );
        float phi       = std::stof( elements.at(3) );
        
        m_map_TTower2Tile[jFexID] = {TileID,eta,phi};
        
    }
    file.close();
    
    return StatusCode::SUCCESS;
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_apply_masking

Gaudi::Property<bool> LVL1::jFexEmulatedTowers::m_apply_masking {this, "SCellMasking", true, "Applies masking. Only use for data"}

private

Definition at line 61 of file jFexEmulatedTowers.h.

{this, "SCellMasking", true, "Applies masking. Only use for data"};

m_caloCellIdHelper

const CaloCell_ID* LVL1::jFexEmulatedTowers::m_caloCellIdHelper {}

private

Definition at line 90 of file jFexEmulatedTowers.h.

{};

m_CaloCellKey

SG::ReadHandleKey<CaloCellContainer> LVL1::jFexEmulatedTowers::m_CaloCellKey {this, "CaloCell", "", "Calo Cell container, supply AllCalo to activate"}

private

{map index, {IDsimulation,eta,phi,source,iEta,iPhi}}

Definition at line 86 of file jFexEmulatedTowers.h.

{this, "CaloCell", "", "Calo Cell container, supply AllCalo to activate"};

m_caloCellSumETdecorKey

SG::WriteDecorHandleKey<xAOD::jFexTowerContainer> LVL1::jFexEmulatedTowers::m_caloCellSumETdecorKey {this, "CaloCellSumEtdecorKey", m_jTowersWriteKey, "", "Offline Calo Cell Et information of the jTower in MeV"}

private

Definition at line 96 of file jFexEmulatedTowers.h.

{this, "CaloCellSumEtdecorKey", m_jTowersWriteKey, "", "Offline Calo Cell Et information of the jTower in MeV"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doThinning

Gaudi::Property<bool> LVL1::jFexEmulatedTowers::m_doThinning {this, "DoThinning" , true, "Remove overlapped towers. Only FPGA Core region is saved"}

private

Definition at line 63 of file jFexEmulatedTowers.h.

{this, "DoThinning"  , true, "Remove overlapped towers. Only FPGA Core region is saved"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_FiberMapping

Gaudi::Property<std::string> LVL1::jFexEmulatedTowers::m_FiberMapping {this, "jFexTowerMapping", PathResolver::find_calib_file("L1CaloFEXByteStream/2023-08-01/jFexTowerMap.txt"), "Text file to convert from hardware fiber to eta-phi location"}

private

Definition at line 58 of file jFexEmulatedTowers.h.

{this, "jFexTowerMapping", PathResolver::find_calib_file("L1CaloFEXByteStream/2023-08-01/jFexTowerMap.txt"), "Text file to convert from hardware fiber to eta-phi location"};

m_Firm2Tower_map

std::unordered_map<unsigned int, std::array<float,6> > LVL1::jFexEmulatedTowers::m_Firm2Tower_map

private

Definition at line 82 of file jFexEmulatedTowers.h.

m_isDATA

Gaudi::Property<bool> LVL1::jFexEmulatedTowers::m_isDATA {this, "isDATA" , true, "Tells the algorithm if it is data. Used for xAOD::TriggerTower WARNING due to the 0 supresion"}

private

Definition at line 62 of file jFexEmulatedTowers.h.

{this, "isDATA"      , true, "Tells the algorithm if it is data. Used for xAOD::TriggerTower WARNING due to the 0 supresion"};

m_jFEX2Scellmapping

Gaudi::Property<std::string> LVL1::jFexEmulatedTowers::m_jFEX2Scellmapping {this, "jFEX2SCmapping" , PathResolver::find_calib_file("L1CaloFEXByteStream/2022-10-19/jfex_SCID.txt") , "Text file to convert from simulation ID to SuperCell Identifier"}

private

Definition at line 66 of file jFexEmulatedTowers.h.

{this, "jFEX2SCmapping"  , PathResolver::find_calib_file("L1CaloFEXByteStream/2022-10-19/jfex_SCID.txt")  , "Text file to convert from simulation ID to SuperCell Identifier"};

m_jFEX2Tilemapping

Gaudi::Property<std::string> LVL1::jFexEmulatedTowers::m_jFEX2Tilemapping {this, "jFEX2Tilemapping", PathResolver::find_calib_file("L1CaloFEXByteStream/2022-10-19/jfex_TileID.txt"), "Text file to convert from simulation ID to Tile Identifier"}

private

Definition at line 67 of file jFexEmulatedTowers.h.

{this, "jFEX2Tilemapping", PathResolver::find_calib_file("L1CaloFEXByteStream/2022-10-19/jfex_TileID.txt"), "Text file to convert from simulation ID to Tile Identifier"};

m_jtowerEtMeVdecorKey

SG::WriteDecorHandleKey<xAOD::jFexTowerContainer> LVL1::jFexEmulatedTowers::m_jtowerEtMeVdecorKey { this, "jtowerEtMeVdecorKey", m_jTowersWriteKey, "jtowerEtMeV", "jFex Tower Et in MeV"}

private

Definition at line 97 of file jFexEmulatedTowers.h.

{ this, "jtowerEtMeVdecorKey", m_jTowersWriteKey, "jtowerEtMeV", "jFex Tower Et in MeV"};

m_jtowerEtTimingMeVdecorKey

SG::WriteDecorHandleKey<xAOD::jFexTowerContainer> LVL1::jFexEmulatedTowers::m_jtowerEtTimingMeVdecorKey { this, "jtowerEtTimingMeVdecorKey", m_jTowersWriteKey, "jtowerEtTimingMeV", "jFex Tower Et, after timing cut, in MeV"}

private

Definition at line 98 of file jFexEmulatedTowers.h.

{ this, "jtowerEtTimingMeVdecorKey", m_jTowersWriteKey, "jtowerEtTimingMeV", "jFex Tower Et, after timing cut, in MeV"};

m_jTowersWriteKey

SG::WriteHandleKey< xAOD::jFexTowerContainer > LVL1::jFexEmulatedTowers::m_jTowersWriteKey {this,"jTowersWriteKey" ,"L1_jFexEmulatedTowers", "Write jFexEDM Trigger Tower container"}

private

Definition at line 55 of file jFexEmulatedTowers.h.

{this,"jTowersWriteKey"   ,"L1_jFexEmulatedTowers", "Write jFexEDM Trigger Tower container"};

m_map_TTower2SCellsEM

std::unordered_map< uint32_t, std::vector<uint64_t> > LVL1::jFexEmulatedTowers::m_map_TTower2SCellsEM

private

Definition at line 76 of file jFexEmulatedTowers.h.

m_map_TTower2SCellsHAD

std::unordered_map< uint32_t, std::vector<uint64_t> > LVL1::jFexEmulatedTowers::m_map_TTower2SCellsHAD

private

Definition at line 77 of file jFexEmulatedTowers.h.

m_map_TTower2Tile

std::unordered_map< uint32_t, std::tuple<uint32_t,float,float> > LVL1::jFexEmulatedTowers::m_map_TTower2Tile

private

Definition at line 78 of file jFexEmulatedTowers.h.

m_readTileOfflineDecorKey

SG::ReadDecorHandleKey<xAOD::TriggerTowerContainer> LVL1::jFexEmulatedTowers::m_readTileOfflineDecorKey { this, "TileOfflineETKey", m_triggerTowerKey, "", "decoration of offline energy from Tile Towers" }

private

Definition at line 93 of file jFexEmulatedTowers.h.

{ this, "TileOfflineETKey", m_triggerTowerKey, "", "decoration of offline energy from Tile Towers" };

m_scellIdTool

ToolHandle<ICaloSuperCellIDTool> LVL1::jFexEmulatedTowers::m_scellIdTool {this, "CaloSuperCellIDTool", "", "Offline / SuperCell ID mapping tool"}

private

Definition at line 88 of file jFexEmulatedTowers.h.

{this, "CaloSuperCellIDTool", "", "Offline / SuperCell ID mapping tool"};

m_SCellKey

SG::ReadHandleKey<CaloCellContainer> LVL1::jFexEmulatedTowers::m_SCellKey {this, "SCell", "SCell", "SCell container"}

private

Definition at line 49 of file jFexEmulatedTowers.h.

{this, "SCell", "SCell", "SCell container"};

m_triggerTowerKey

SG::ReadHandleKey<xAOD::TriggerTowerContainer> LVL1::jFexEmulatedTowers::m_triggerTowerKey {this, "xODTriggerTowers", "xAODTriggerTowers", "xAODTriggerTowers container"}

private

Definition at line 52 of file jFexEmulatedTowers.h.

{this, "xODTriggerTowers", "xAODTriggerTowers", "xAODTriggerTowers container"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• jFexEmulatedTowers.h
• jFexEmulatedTowers.cxx