LVL1::L1TopoSimulation Class Reference

#include <L1TopoSimulation.h>

Inheritance diagram for LVL1::L1TopoSimulation:

Collaboration diagram for LVL1::L1TopoSimulation:

Public Member Functions
	L1TopoSimulation (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize	ATLAS_NOT_THREAD_SAFE () override
virtual StatusCode	start () override
virtual StatusCode	execute () override
virtual StatusCode	finalize () override
virtual bool	isClonable () const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	retrieveHardwareDecision (bool isLegacy, const EventContext &ctx)
	Retrieve the L1Topo hardware bits from the DAQ RODs.
StatusCode	hardwareDecisionPhase1 (const EventContext &ctx)
StatusCode	hardwareDecisionLegacy ()
void	WriteEDM (SG::WriteHandle< xAOD::L1TopoSimResultsContainer > &handle, const std::string &name, unsigned int clock, uint32_t word)
void	WriteEDM_Overflow (SG::WriteHandle< xAOD::L1TopoSimResultsContainer > &handle, const std::string &name, unsigned int clock, uint32_t word)
void	WriteEDM (SG::WriteHandle< xAOD::L1TopoSimResultsContainer > &handle, const std::string &name, unsigned int clock, uint64_t word)
void	WriteEDM_Overflow (SG::WriteHandle< xAOD::L1TopoSimResultsContainer > &handle, const std::string &name, unsigned int clock, uint64_t word)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::unique_ptr< TCS::TopoSteering >	m_topoSteering
	the topo steering
std::unique_ptr< LVL1::PeriodicScaler >	m_scaler {nullptr}
ServiceHandle< ITHistSvc >	m_histSvc { this, "HistSvc", "THistSvc/THistSvc", "Histogramming service for L1Topo algorithms" }
	prescale decision tool
ToolHandle< IInputTOBConverter >	m_emtauInputProvider { this, "EMTAUInputProvider", "LVL1::EMTauInputProvider/EMTauInputProvider", "Tool to fill the EMTAU TOBs of the topo input event" }
ToolHandle< IInputTOBConverter >	m_jetInputProvider { this, "JetInputProvider", "LVL1::JetInputProvider/JetInputProvider", "Tool to fill the Jet TOBs of the topo input event" }
ToolHandle< IInputTOBConverter >	m_energyInputProvider { this, "EnergyInputProvider", "LVL1::EnergyInputProvider/EnergyInputProvider", "Tool to fill the energy and MET TOBs of the topo input event"}
ToolHandle< IInputTOBConverter >	m_muonInputProvider { this, "MuonInputProvider", "LVL1::MuonInputProvider/MuonInputProvider", "Tool to fill the muon TOBs of the topo input event" }
ToolHandle< IControlHistSvc >	m_ControlHistSvc { this, "ControlHistSvc", "LVL1::ControlHistSvc/ControlHistSvc", "Tool to change the histogramming service when needed." }
SG::WriteHandleKey< LVL1::FrontPanelCTP >	m_topoCTPLocation { this, "TopoCTPLocation", LVL1::DEFAULT_L1TopoCTPLocation, "StoreGate key of topo decision output for CTP"}
	SG key of decision bits for CTP.
SG::WriteHandleKey< LVL1::FrontPanelCTP >	m_topoOverflowCTPLocation { this, "TopoOverflowCTPLocation", LVL1::DEFAULT_L1TopoOverflowCTPLocation, "StoreGate key of topo overflow output for CTP"}
	SG key of overflow bits for CTP.
SG::WriteHandleKey< LVL1::FrontPanelCTP >	m_legacyTopoCTPLocation { this, "LegacyTopoCTPLocation", LVL1::DEFAULT_L1TopoLegacyCTPLocation, "StoreGate key of topo decision output for CTP"}
	SG key of decision bits for CTP.
SG::WriteHandleKey< LVL1::FrontPanelCTP >	m_legacyTopoOverflowCTPLocation { this, "LegacyTopoOverflowCTPLocation", LVL1::DEFAULT_L1TopoLegacyOverflowCTPLocation, "StoreGate key of topo overflow output for CTP"}
	SG key of overflow bits for CTP.
SG::WriteHandleKey< xAOD::L1TopoSimResultsContainer >	m_legacyL1topoKey {this,"Key_LegacyL1TopoSimContainer","L1_LegacyTopoSimResults","Output legacy l1topo container"}
SG::WriteHandleKey< xAOD::L1TopoSimResultsContainer >	m_l1topoKey {this,"Key_L1TopoSimContainer","L1_TopoSimResults","Output l1topo container"}
SG::ReadHandleKey< xAOD::L1TopoRawDataContainer >	m_l1topoRawDataKey {this, "L1_TopoRawDataKey", "L1_Phase1L1TopoRAWData", "l1topo Raw Data"}
Gaudi::Property< bool >	m_doMonitoring { this, "doMonitoring", false, "Do Monitoring of L1Topo Algorithms" }
Gaudi::Property< bool >	m_isLegacyTopo { this, "IsLegacyTopo", false, "Simulation of Legacy L1Topo boards" }
Gaudi::Property< bool >	m_enableInputDump { this, "EnableInputDump", false, "Enable writing of input data for standalone running" }
Gaudi::Property< bool >	m_enableBitwise { this, "UseBitwise", true, "Boolean to enable the bitwise version of software algorithms"}
Gaudi::Property< std::string >	m_inputDumpFile { this, "InputDumpFile", "inputdump.txt", "File name for dumping input data" }
Gaudi::Property< int >	m_topoOutputLevel { this, "TopoOutputLevel", TrigConf::MSGTC::WARNING, "OutputLevel for L1Topo algorithms"}
Gaudi::Property< int >	m_topoSteeringOutputLevel { this, "TopoSteeringOutputLevel", TrigConf::MSGTC::WARNING, "OutputLevel for L1Topo steering"}
Gaudi::Property< bool >	m_fillHistogramsBasedOnHardwareDecision { this, "FillHistoBasedOnHardware", false, "Fill accept/reject histograms based on hdw; default based on sim" }
Gaudi::Property< unsigned int >	m_prescaleForDAQROBAccess { this, "PrescaleDAQROBAccess", 4, "Prescale factor for requests for DAQ ROBs: can be used to avoid overloading ROS. Zero means disabled, 1 means always, N means sample only 1 in N events"}
Gaudi::Property< unsigned int >	m_prescale { this, "Prescale", 1, "Internal prescale factor for this algorithm, implemented with a periodic scaler: so 1 means run every time, N means run every 1 in N times it is called; the other times it will exit without doing anything"}
Gaudi::Property< std::string >	m_histBaseDir { this, "MonHistBaseDir", "L1/L1TopoAlgorithms", "Base directory for monitoring histograms will be /EXPERT/<MonHistBaseDir>"}
DataObjIDColl	m_extendedExtraObjects
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 34 of file L1TopoSimulation.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

L1TopoSimulation()

L1TopoSimulation::L1TopoSimulation	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 36 of file L1TopoSimulation.cxx.

                                                                                  :
   AthAlgorithm(name, pSvcLocator),
   m_topoSteering( std::make_unique<TCS::TopoSteering>() ),
   m_scaler( std::make_unique<LVL1::PeriodicScaler>() )
{
}

Member Function Documentation

ATLAS_NOT_THREAD_SAFE()

virtual StatusCode initialize LVL1::L1TopoSimulation::ATLAS_NOT_THREAD_SAFE ( )

overridevirtual

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< 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< 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< 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< 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 L1TopoSimulation::execute ( )

overridevirtual

Get the decision output and store for the CTP simulation

note the the topo simulation currently uses modules 0 and 1 while the CTP front panel expects the topo on cables 1 and 2 (cable 0 is coming from ALFA)

Definition at line 162 of file L1TopoSimulation.cxx.

                          {
   const EventContext& ctx = Gaudi::Hive::currentContext();
 
   if (m_prescale>1 && not m_scaler->decision(m_prescale)){
      ATH_MSG_DEBUG( "This event not processed due to prescale");
      return StatusCode::SUCCESS;
      // do not record dummy output: 
      // LVL1::FrontPanelCTP is initialised with all 6 32-bit words set to 0 which is valid data
      // LVL1::FrontPanelCTP * topo2CTP = new LVL1::FrontPanelCTP();
      // CHECK(evtStore()->record( topo2CTP, m_topoCTPLocation ));
   } 
   else {
     ATH_MSG_DEBUG( "This event is processed - not prescaled");
   }
 
   // reset input and internal state
   m_topoSteering->reset();
 
   // fill the L1Topo Input Event
   TCS::TopoInputEvent & inputEvent = m_topoSteering->inputEvent();
 
   inputEvent.setEventInfo(ctx.eventID().run_number(),
                           ctx.eventID().event_number(),
                           ctx.eventID().lumi_block(),
                           ctx.eventID().bunch_crossing_id());
 
   // EM TAU
   if (m_emtauInputProvider.isEnabled()) {
      CHECK(m_emtauInputProvider->fillTopoInputEvent(inputEvent));
   }
   // JET
   if (m_jetInputProvider.isEnabled()) {
      CHECK(m_jetInputProvider->fillTopoInputEvent(inputEvent));
   }
   // ET sum, ET miss
   if (m_energyInputProvider.isEnabled()) {
      CHECK(m_energyInputProvider->fillTopoInputEvent(inputEvent));
   }
   // Muon
   if (m_muonInputProvider.isEnabled()) {
      CHECK(m_muonInputProvider->fillTopoInputEvent(inputEvent));
   }
 
   ATH_MSG_DEBUG("" << inputEvent);
 
   inputEvent.dump();
   
   if(m_fillHistogramsBasedOnHardwareDecision){
     if (retrieveHardwareDecision(m_isLegacyTopo, ctx).isSuccess()) {
       m_topoSteering->propagateHardwareBitsToAlgos();
       m_topoSteering->setOutputAlgosSkipHistograms(false);
     }
     else {
       m_topoSteering->setOutputAlgosSkipHistograms(true);
     }
     if (!m_scaler->decision(m_prescaleForDAQROBAccess) and m_prescaleForDAQROBAccess>1) {
       m_topoSteering->setOutputAlgosSkipHistograms(true);
     }
   }
 
   // execute the toposteering
   m_topoSteering->executeEvent();
 
   ATH_MSG_DEBUG("Global Decision:\n" << m_topoSteering->simulationResult().globalOutput());
   

 
   // Format for CTP still undecided
 
   const TCS::GlobalOutput & globalOutput = m_topoSteering->simulationResult().globalOutput();
   auto topoOutput2CTP = std::make_unique< LVL1::FrontPanelCTP >();
   auto topoOverflow2CTP = std::make_unique< LVL1::FrontPanelCTP >();
 
   const TrigConf::L1Menu * l1menu = nullptr;
   ATH_CHECK( detStore()->retrieve(l1menu) );
 
 
   SG::WriteHandle<xAOD::L1TopoSimResultsContainer> outputHandle(m_isLegacyTopo ? m_legacyL1topoKey : m_l1topoKey, ctx);
   ATH_MSG_DEBUG("  write: " << outputHandle.key() << " = " << "..." );
   ATH_CHECK(outputHandle.record(std::make_unique<xAOD::L1TopoSimResultsContainer>(), std::make_unique<xAOD::L1TopoSimResultsAuxContainer>()));
    
   
   if( m_isLegacyTopo ) {
     // set electrical connectors 
     std::string conn1 = l1menu->board("LegacyTopo0").connectorNames()[0];
     std::string conn2 = l1menu->board("LegacyTopo1").connectorNames()[0];
     for(unsigned int clock=0; clock<2; ++clock) {
       topoOutput2CTP->setCableWord0( clock, 0 ); // ALFA
       ATH_MSG_DEBUG("Word 1 " << conn1 << " clock " << clock << "  " << globalOutput.decision_field( conn1, clock) );
       topoOutput2CTP->setCableWord1( clock, globalOutput.decision_field( conn1, clock) );  // TOPO 0
       WriteEDM(outputHandle,conn1,clock,globalOutput.decision_field( conn1, clock));
       ATH_MSG_DEBUG("Word 2 " << conn2 << " clock " << clock << "  " << globalOutput.decision_field( conn2, clock) );
       topoOutput2CTP->setCableWord2( clock, globalOutput.decision_field( conn2, clock) );  // TOPO 1
       WriteEDM(outputHandle,conn2,clock,globalOutput.decision_field( conn2, clock));
       // topoOverflow2CTP->setCableWord0( clock, 0 ); // ALFA
       // topoOverflow2CTP->setCableWord1( clock, dec.overflow( 0, clock) );  // TOPO 0
       // topoOverflow2CTP->setCableWord2( clock, dec.overflow( 1, clock) );  // TOPO 1
     }    
    
     CHECK(SG::makeHandle(m_legacyTopoCTPLocation)        .record(std::move(topoOutput2CTP)));
     CHECK(SG::makeHandle(m_legacyTopoOverflowCTPLocation).record(std::move(topoOverflow2CTP)));
     
   } else {
     // set electrical connectors 
     std::string conn1 = l1menu->board("Topo2").connectorNames()[0];
     std::string conn2 = l1menu->board("Topo3").connectorNames()[0];
     for(unsigned int clock=0; clock<2; ++clock) {
       ATH_MSG_DEBUG("Word 1 " << conn1 << " clock " << clock << "  " << globalOutput.decision_field( conn1, clock) );
       topoOutput2CTP->setCableWord1( clock, globalOutput.decision_field( conn1, clock) | globalOutput.overflow_field(conn1, clock) );  // TOPO 0
       WriteEDM(outputHandle,conn1,clock,globalOutput.decision_field( conn1, clock));
       ATH_MSG_DEBUG("Word 2 " << conn2 << " clock " << clock << "  " << globalOutput.decision_field( conn2, clock) );
       topoOutput2CTP->setCableWord2( clock, globalOutput.decision_field( conn2, clock) | globalOutput.overflow_field(conn2, clock) );  // TOPO 1
       WriteEDM(outputHandle,conn2,clock,globalOutput.decision_field( conn2, clock));
       
       topoOverflow2CTP->setCableWord0( clock, 0 ); // ALFA
       topoOverflow2CTP->setCableWord1( clock, globalOutput.overflow_field( conn1, clock) );  // TOPO 0
       WriteEDM_Overflow(outputHandle,"Overflow"+conn1,clock,globalOutput.overflow_field( conn1, clock));
       topoOverflow2CTP->setCableWord2( clock, globalOutput.overflow_field( conn2, clock) );  // TOPO 1
       WriteEDM_Overflow(outputHandle,"Overflow"+conn2,clock,globalOutput.overflow_field( conn2, clock));
 
       WriteEDM(outputHandle,"Ambiguity"+conn1,clock,globalOutput.ambiguity_field( conn1, clock));
       WriteEDM(outputHandle,"Ambiguity"+conn2,clock,globalOutput.ambiguity_field( conn2, clock));
     }    
 
     // set optical connectors
     for( const auto& connOpt : l1menu->board("Topo1").connectorNames() ) {
       auto outputOpt = globalOutput.count_field(connOpt);
       std::bitset<64> outputOpt_1(outputOpt.to_string());
       std::bitset<64> outputOpt_2((outputOpt<<64).to_string());
       topoOutput2CTP->setOptCableWord( connOpt, outputOpt );
       WriteEDM(outputHandle,connOpt,1,outputOpt_1.to_ulong());
       WriteEDM(outputHandle,connOpt,0,outputOpt_2.to_ulong());
     }
    
     CHECK(SG::makeHandle(m_topoCTPLocation)        .record(std::move(topoOutput2CTP)));
     CHECK(SG::makeHandle(m_topoOverflowCTPLocation).record(std::move(topoOverflow2CTP)));
   }
 
   return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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 & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.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 Algorithm::extraOutputDeps();
}

finalize()

StatusCode L1TopoSimulation::finalize ( )

overridevirtual

Definition at line 313 of file L1TopoSimulation.cxx.

                           {
   m_topoSteering->inputEvent().dumpFinish();
   return StatusCode::SUCCESS;
}

hardwareDecisionLegacy()

StatusCode L1TopoSimulation::hardwareDecisionLegacy ( )

private

Definition at line 374 of file L1TopoSimulation.cxx.

{
    // some duplication with L1TopoRDO::Helpers
    // getDecisionAndOverflowBits() ?
    StatusCode sc = StatusCode::SUCCESS;
    std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobTriggerBits;
    std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobOvrflowBits;
    bool prescalForDAQROBAccess = true; // DG-2017-06-30 decide what to do when the hdw dec is not to be retrieved
    if (prescalForDAQROBAccess){
        std::vector<L1Topo::L1TopoTOB> daqTobsBC0;
        std::vector<uint32_t> tobsbc0SourceIds; // to compute bit indices
        const L1TopoRDOCollection* rdos = 0;
        sc = evtStore()->retrieve(rdos);
        if (sc.isFailure() or 0 == rdos) {
            ATH_MSG_INFO ( "Could not retrieve L1Topo DAQ RDO collection from StoreGate" );
        } else if (rdos->empty()) {
            ATH_MSG_INFO ( "L1Topo DAQ RDO collection is empty" );
        } else {
            for (const L1TopoRDO* rdo : *rdos){
                const std::vector<uint32_t> cDataWords = rdo->getDataWords();
                // initialise header: set version 15, BCN -7, which is unlikely
                L1Topo::Header header(0xf,0,0,0,0,1,0x7);
                for (const uint32_t word : cDataWords){
                    switch (L1Topo::blockType(word)){
                    case L1Topo::BlockTypes::HEADER: {
                        header = L1Topo::Header(word);
                        break;
                    }
                    case L1Topo::BlockTypes::L1TOPO_TOB: {
                        auto tob = L1Topo::L1TopoTOB(word);
                        if (header.bcn_offset()==0){
                            daqTobsBC0.push_back(tob);
                            tobsbc0SourceIds.push_back(rdo->getSourceID());
                        }
                        break;
                    }
                    default: break;
                    }
                } // for(word)
            } // for(rdo)
        }
        for(uint32_t iTob=0; iTob<daqTobsBC0.size(); ++iTob){
            const L1Topo::L1TopoTOB &tob = daqTobsBC0[iTob];
            const uint32_t &sourceId = tobsbc0SourceIds[iTob];
            for(unsigned int i=0; i<8; ++i){
                unsigned int index = L1Topo::triggerBitIndexNew(sourceId, tob, i);
                hardwareDaqRobTriggerBits[index] = (tob.trigger_bits()>>i)&1;
                hardwareDaqRobOvrflowBits[index] = (tob.overflow_bits()>>i)&1;
            }
        }
        m_topoSteering->setHardwareBits(hardwareDaqRobTriggerBits,
                                        hardwareDaqRobOvrflowBits);
    }
    return sc;
}

hardwareDecisionPhase1()

StatusCode L1TopoSimulation::hardwareDecisionPhase1 ( const EventContext & ctx )

private

Definition at line 432 of file L1TopoSimulation.cxx.

{
    // some duplication with L1TopoRDO::Helpers
    // getDecisionAndOverflowBits() ?
  StatusCode sc = StatusCode::SUCCESS;
    
  std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobTriggerBits;
  std::bitset<TCS::TopoSteering::numberOfL1TopoBits> hardwareDaqRobOvrflowBits;
 
  SG::ReadHandle<xAOD::L1TopoRawDataContainer> cont(m_l1topoRawDataKey, ctx);
  if(!cont.isValid()){
    ATH_MSG_FATAL("Could not retrieve L1Topo RAW Data Container from the BS data.");
    return StatusCode::FAILURE;
  }
 
  std::unique_ptr<L1Topo::L1TopoResult> l1topoResult = std::make_unique<L1Topo::L1TopoResult>(*cont);
  if (!l1topoResult->getStatus()) {
    ATH_MSG_WARNING("Decoding L1Topo results failed!!");
    return StatusCode::FAILURE;
  }
  hardwareDaqRobTriggerBits = l1topoResult->getDecisions();
  hardwareDaqRobOvrflowBits = l1topoResult->getOverflows();
 
 
  
  m_topoSteering->setHardwareBits(hardwareDaqRobTriggerBits,
                  hardwareDaqRobOvrflowBits);
  
  return sc;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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.

isClonable()

bool L1TopoSimulation::isClonable ( ) const

overridevirtual

Definition at line 45 of file L1TopoSimulation.cxx.

{
   return true;
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< 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< 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.

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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

retrieveHardwareDecision()

StatusCode L1TopoSimulation::retrieveHardwareDecision ( bool isLegacy, const EventContext & ctx )

private

Retrieve the L1Topo hardware bits from the DAQ RODs.

No need to cache them within this AthAlgorithm; just pass them to TopoSteering, which will then do all the work with them.

Definition at line 367 of file L1TopoSimulation.cxx.

{
  if (isLegacy) {return hardwareDecisionLegacy();}
  else          {return hardwareDecisionPhase1(ctx);}
}

start()

StatusCode L1TopoSimulation::start ( )

overridevirtual

Definition at line 138 of file L1TopoSimulation.cxx.

                        {
   ATH_MSG_DEBUG("start");
 
   m_scaler->reset();
 
   try {
      m_topoSteering->initializeAlgorithms();
   }
   catch(std::exception & e) {
      ATH_MSG_FATAL("Caught exception when initializing topo algorithms" << e.what() );
      return StatusCode::FAILURE;
   }
 
   if( m_enableInputDump ) {
      m_topoSteering->inputEvent().enableInputDump( m_inputDumpFile );
      m_topoSteering->inputEvent().dumpStart();
   }
 
   return StatusCode::SUCCESS;
}

sysInitialize()

StatusCode AthAlgorithm::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< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::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< 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< 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);
      }
    }
  }

WriteEDM() [1/2]

void L1TopoSimulation::WriteEDM ( SG::WriteHandle< xAOD::L1TopoSimResultsContainer > & handle, const std::string & name, unsigned int clock, uint32_t word )

private

Definition at line 319 of file L1TopoSimulation.cxx.

                                                                                                                                         {
 
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(32);
  handle->back()->setTopoWord(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}

WriteEDM() [2/2]

void L1TopoSimulation::WriteEDM ( SG::WriteHandle< xAOD::L1TopoSimResultsContainer > & handle, const std::string & name, unsigned int clock, uint64_t word )

private

Definition at line 343 of file L1TopoSimulation.cxx.

                                                                                                                                         {
  
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(64);
  handle->back()->setTopoWord64(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}

WriteEDM_Overflow() [1/2]

void L1TopoSimulation::WriteEDM_Overflow ( SG::WriteHandle< xAOD::L1TopoSimResultsContainer > & handle, const std::string & name, unsigned int clock, uint32_t word )

private

Definition at line 331 of file L1TopoSimulation.cxx.

                                                                                                                                                  {
 
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(32);
  handle->back()->setTopoWordOverflow(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}

WriteEDM_Overflow() [2/2]

void L1TopoSimulation::WriteEDM_Overflow ( SG::WriteHandle< xAOD::L1TopoSimResultsContainer > & handle, const std::string & name, unsigned int clock, uint64_t word )

private

Definition at line 355 of file L1TopoSimulation.cxx.

                                                                                                                                                  {
  
  handle->push_back(std::make_unique<xAOD::L1TopoSimResults>());
  handle->back()->setConnectionId(TCS::outputType(name));
  handle->back()->setClock(clock);
  handle->back()->setBitWidth(64);
  handle->back()->setTopoWord64Overflow(word);
 
  ATH_MSG_DEBUG( "L1Topo EDM:: Connection Id: " << handle->back()->connectionId() << " Clock: " << handle->back()->clock() << " Decision: " << handle->back()->topoWord() );
}

Member Data Documentation

m_ControlHistSvc

ToolHandle<IControlHistSvc> LVL1::L1TopoSimulation::m_ControlHistSvc { this, "ControlHistSvc", "LVL1::ControlHistSvc/ControlHistSvc", "Tool to change the histogramming service when needed." }

private

Definition at line 76 of file L1TopoSimulation.h.

{ this, "ControlHistSvc",   "LVL1::ControlHistSvc/ControlHistSvc",     "Tool to change the histogramming service when needed."          };

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doMonitoring

Gaudi::Property<bool> LVL1::L1TopoSimulation::m_doMonitoring { this, "doMonitoring", false, "Do Monitoring of L1Topo Algorithms" }

private

Definition at line 93 of file L1TopoSimulation.h.

{ this, "doMonitoring", false, "Do Monitoring of L1Topo Algorithms" };

m_emtauInputProvider

ToolHandle<IInputTOBConverter> LVL1::L1TopoSimulation::m_emtauInputProvider { this, "EMTAUInputProvider", "LVL1::EMTauInputProvider/EMTauInputProvider", "Tool to fill the EMTAU TOBs of the topo input event" }

private

Definition at line 71 of file L1TopoSimulation.h.

{ this, "EMTAUInputProvider",  "LVL1::EMTauInputProvider/EMTauInputProvider",   "Tool to fill the EMTAU TOBs of the topo input event"         };

m_enableBitwise

Gaudi::Property<bool> LVL1::L1TopoSimulation::m_enableBitwise { this, "UseBitwise", true, "Boolean to enable the bitwise version of software algorithms"}

private

Definition at line 96 of file L1TopoSimulation.h.

{ this, "UseBitwise", true, "Boolean to enable the bitwise version of software algorithms"}; 

m_enableInputDump

Gaudi::Property<bool> LVL1::L1TopoSimulation::m_enableInputDump { this, "EnableInputDump", false, "Enable writing of input data for standalone running" }

private

Definition at line 95 of file L1TopoSimulation.h.

{ this, "EnableInputDump", false, "Enable writing of input data for standalone running" };

m_energyInputProvider

ToolHandle<IInputTOBConverter> LVL1::L1TopoSimulation::m_energyInputProvider { this, "EnergyInputProvider", "LVL1::EnergyInputProvider/EnergyInputProvider", "Tool to fill the energy and MET TOBs of the topo input event"}

private

Definition at line 73 of file L1TopoSimulation.h.

{ this, "EnergyInputProvider", "LVL1::EnergyInputProvider/EnergyInputProvider", "Tool to fill the energy and MET TOBs of the topo input event"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_fillHistogramsBasedOnHardwareDecision

Gaudi::Property<bool> LVL1::L1TopoSimulation::m_fillHistogramsBasedOnHardwareDecision { this, "FillHistoBasedOnHardware", false, "Fill accept/reject histograms based on hdw; default based on sim" }

private

Definition at line 102 of file L1TopoSimulation.h.

{ this, "FillHistoBasedOnHardware", false, "Fill accept/reject histograms based on hdw; default based on sim" };

m_histBaseDir

Gaudi::Property<std::string> LVL1::L1TopoSimulation::m_histBaseDir { this, "MonHistBaseDir", "L1/L1TopoAlgorithms", "Base directory for monitoring histograms will be /EXPERT/<MonHistBaseDir>"}

private

Definition at line 105 of file L1TopoSimulation.h.

{ this, "MonHistBaseDir", "L1/L1TopoAlgorithms", "Base directory for monitoring histograms will be /EXPERT/<MonHistBaseDir>"}; 

m_histSvc

ServiceHandle<ITHistSvc> LVL1::L1TopoSimulation::m_histSvc { this, "HistSvc", "THistSvc/THistSvc", "Histogramming service for L1Topo algorithms" }

private

prescale decision tool

Definition at line 69 of file L1TopoSimulation.h.

{ this, "HistSvc", "THistSvc/THistSvc", "Histogramming service for L1Topo algorithms" };

m_inputDumpFile

Gaudi::Property<std::string> LVL1::L1TopoSimulation::m_inputDumpFile { this, "InputDumpFile", "inputdump.txt", "File name for dumping input data" }

private

Definition at line 97 of file L1TopoSimulation.h.

{ this, "InputDumpFile", "inputdump.txt", "File name for dumping input data" };

m_isLegacyTopo

Gaudi::Property<bool> LVL1::L1TopoSimulation::m_isLegacyTopo { this, "IsLegacyTopo", false, "Simulation of Legacy L1Topo boards" }

private

Definition at line 94 of file L1TopoSimulation.h.

{ this, "IsLegacyTopo", false, "Simulation of Legacy L1Topo boards" };

m_jetInputProvider

ToolHandle<IInputTOBConverter> LVL1::L1TopoSimulation::m_jetInputProvider { this, "JetInputProvider", "LVL1::JetInputProvider/JetInputProvider", "Tool to fill the Jet TOBs of the topo input event" }

private

Definition at line 72 of file L1TopoSimulation.h.

{ this, "JetInputProvider",    "LVL1::JetInputProvider/JetInputProvider",       "Tool to fill the Jet TOBs of the topo input event"           };

m_l1topoKey

SG::WriteHandleKey< xAOD::L1TopoSimResultsContainer > LVL1::L1TopoSimulation::m_l1topoKey {this,"Key_L1TopoSimContainer","L1_TopoSimResults","Output l1topo container"}

private

Definition at line 88 of file L1TopoSimulation.h.

{this,"Key_L1TopoSimContainer","L1_TopoSimResults","Output l1topo container"};

m_l1topoRawDataKey

SG::ReadHandleKey<xAOD::L1TopoRawDataContainer> LVL1::L1TopoSimulation::m_l1topoRawDataKey {this, "L1_TopoRawDataKey", "L1_Phase1L1TopoRAWData", "l1topo Raw Data"}

private

Definition at line 90 of file L1TopoSimulation.h.

{this, "L1_TopoRawDataKey", "L1_Phase1L1TopoRAWData", "l1topo Raw Data"};

m_legacyL1topoKey

SG::WriteHandleKey< xAOD::L1TopoSimResultsContainer > LVL1::L1TopoSimulation::m_legacyL1topoKey {this,"Key_LegacyL1TopoSimContainer","L1_LegacyTopoSimResults","Output legacy l1topo container"}

private

Definition at line 87 of file L1TopoSimulation.h.

{this,"Key_LegacyL1TopoSimContainer","L1_LegacyTopoSimResults","Output legacy l1topo container"};

m_legacyTopoCTPLocation

SG::WriteHandleKey<LVL1::FrontPanelCTP> LVL1::L1TopoSimulation::m_legacyTopoCTPLocation { this, "LegacyTopoCTPLocation", LVL1::DEFAULT_L1TopoLegacyCTPLocation, "StoreGate key of topo decision output for CTP"}

private

SG key of decision bits for CTP.

Definition at line 83 of file L1TopoSimulation.h.

{ this, "LegacyTopoCTPLocation", LVL1::DEFAULT_L1TopoLegacyCTPLocation, "StoreGate key of topo decision output for CTP"}; 

m_legacyTopoOverflowCTPLocation

SG::WriteHandleKey<LVL1::FrontPanelCTP> LVL1::L1TopoSimulation::m_legacyTopoOverflowCTPLocation { this, "LegacyTopoOverflowCTPLocation", LVL1::DEFAULT_L1TopoLegacyOverflowCTPLocation, "StoreGate key of topo overflow output for CTP"}

private

SG key of overflow bits for CTP.

Definition at line 84 of file L1TopoSimulation.h.

{ this, "LegacyTopoOverflowCTPLocation", LVL1::DEFAULT_L1TopoLegacyOverflowCTPLocation, "StoreGate key of topo overflow output for CTP"}; 

m_muonInputProvider

ToolHandle<IInputTOBConverter> LVL1::L1TopoSimulation::m_muonInputProvider { this, "MuonInputProvider", "LVL1::MuonInputProvider/MuonInputProvider", "Tool to fill the muon TOBs of the topo input event" }

private

Definition at line 74 of file L1TopoSimulation.h.

{ this, "MuonInputProvider",   "LVL1::MuonInputProvider/MuonInputProvider",     "Tool to fill the muon TOBs of the topo input event"          };

m_prescale

Gaudi::Property<unsigned int> LVL1::L1TopoSimulation::m_prescale { this, "Prescale", 1, "Internal prescale factor for this algorithm, implemented with a periodic scaler: so 1 means run every time, N means run every 1 in N times it is called; the other times it will exit without doing anything"}

private

Definition at line 104 of file L1TopoSimulation.h.

{ this, "Prescale", 1, "Internal prescale factor for this algorithm, implemented with a periodic scaler: so 1 means run every time, N means run every 1 in N times it is called; the other times it will exit without doing anything"};

m_prescaleForDAQROBAccess

Gaudi::Property<unsigned int> LVL1::L1TopoSimulation::m_prescaleForDAQROBAccess { this, "PrescaleDAQROBAccess", 4, "Prescale factor for requests for DAQ ROBs: can be used to avoid overloading ROS. Zero means disabled, 1 means always, N means sample only 1 in N events"}

private

Definition at line 103 of file L1TopoSimulation.h.

{ this, "PrescaleDAQROBAccess", 4, "Prescale factor for requests for DAQ ROBs: can be used to avoid overloading ROS. Zero means disabled, 1 means always, N means sample only 1 in N events"}; 

m_scaler

std::unique_ptr<LVL1::PeriodicScaler> LVL1::L1TopoSimulation::m_scaler {nullptr}

private

Definition at line 66 of file L1TopoSimulation.h.

{nullptr}; 

m_topoCTPLocation

SG::WriteHandleKey<LVL1::FrontPanelCTP> LVL1::L1TopoSimulation::m_topoCTPLocation { this, "TopoCTPLocation", LVL1::DEFAULT_L1TopoCTPLocation, "StoreGate key of topo decision output for CTP"}

private

SG key of decision bits for CTP.

Definition at line 80 of file L1TopoSimulation.h.

{ this, "TopoCTPLocation", LVL1::DEFAULT_L1TopoCTPLocation, "StoreGate key of topo decision output for CTP"}; 

m_topoOutputLevel

Gaudi::Property<int> LVL1::L1TopoSimulation::m_topoOutputLevel { this, "TopoOutputLevel", TrigConf::MSGTC::WARNING, "OutputLevel for L1Topo algorithms"}

private

Definition at line 98 of file L1TopoSimulation.h.

{ this, "TopoOutputLevel", TrigConf::MSGTC::WARNING, "OutputLevel for L1Topo algorithms"};

m_topoOverflowCTPLocation

SG::WriteHandleKey<LVL1::FrontPanelCTP> LVL1::L1TopoSimulation::m_topoOverflowCTPLocation { this, "TopoOverflowCTPLocation", LVL1::DEFAULT_L1TopoOverflowCTPLocation, "StoreGate key of topo overflow output for CTP"}

private

SG key of overflow bits for CTP.

Definition at line 81 of file L1TopoSimulation.h.

{ this, "TopoOverflowCTPLocation", LVL1::DEFAULT_L1TopoOverflowCTPLocation, "StoreGate key of topo overflow output for CTP"}; 

m_topoSteering

std::unique_ptr<TCS::TopoSteering> LVL1::L1TopoSimulation::m_topoSteering

private

the topo steering

Definition at line 65 of file L1TopoSimulation.h.

m_topoSteeringOutputLevel

Gaudi::Property<int> LVL1::L1TopoSimulation::m_topoSteeringOutputLevel { this, "TopoSteeringOutputLevel", TrigConf::MSGTC::WARNING, "OutputLevel for L1Topo steering"}

private

Definition at line 99 of file L1TopoSimulation.h.

{ this, "TopoSteeringOutputLevel", TrigConf::MSGTC::WARNING, "OutputLevel for L1Topo steering"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• L1TopoSimulation.h
• L1TopoSimulation.cxx