The algorithm responsible for simulating the Jet trigger. More...

#include <JEMJetSim.h>

Inheritance diagram for LVL1::JEMJetSim:

Collaboration diagram for LVL1::JEMJetSim:

Public Member Functions
	JEMJetSim (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	initialize ()
StatusCode	execute ()
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
void	storeModuleRoIs ()
	Store TOB RoI objects in the TES.
void	storeBackplaneTOBs ()
	Store module outputs in TES as inputs to CMX simulation.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
DataVector< JEMTobRoI > *	m_allTOBs
	TOB RoIs for RoIB input and DAQ output simulation.
DataVector< JetCMXData > *	m_JetCMXData
	Backplane data objects: CPM outputs to CMX.
SG::ReadHandleKey< xAOD::JetElementContainer >	m_JetElementInputKey { this, "JetElementLocation", TrigT1CaloDefs::JetElementLocation, "Input JetElement container" }
	Where to find the JetElements.
SG::WriteHandleKey< DataVector< JEMTobRoI > >	m_JEMTobRoIOutputKey { this, "JEMTOBRoILocation", TrigT1CaloDefs::JEMTobRoILocation, "Output Jet ROI container" }
	Locations of outputs in StoreGate.
SG::WriteHandleKey< DataVector< JetCMXData > >	m_JetCMXDataOutputKey { this, "JetCMXDataLocation", TrigT1CaloDefs::JetCMXDataLocation, "Output Jet CMX data container" }
ToolHandle< LVL1::IL1JEMJetTools >	m_JetTool
	The essentials - data access, configuration, tools.
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

The algorithm responsible for simulating the Jet trigger.

Definition at line 46 of file JEMJetSim.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

◆ JEMJetSim()

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

Definition at line 46 of file JEMJetSim.cxx.

    : AthAlgorithm( name, pSvcLocator ), 
      m_allTOBs(0),
      m_JetCMXData(0),
      m_JetTool("LVL1::L1JEMJetTools/L1JEMJetTools")
{
}

Member Function Documentation

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode LVL1::JEMJetSim::execute ( )

Clean up JetInputs

Definition at line 76 of file JEMJetSim.cxx.

{
    
  /* 
    Retrieve collection of JetElements 
    Fill a std::map of JetInputs from them
    Loop over crates/modules
      For each crate, loop over towers and find TOBs 
                      form backplane data objects
                      form daq objects    
  */
 
  //make a message logging stream
 
  ATH_MSG_DEBUG ( "starting JEMJetSim" ); 
 
  // Create containers for this event
  m_JetCMXData   = new DataVector<JetCMXData>;  //Container of backplane data objects
  m_allTOBs      = new DataVector<JEMTobRoI>;  // Container to hold all TOB RoIs in event
 
  // Retrieve the JetElementContainer
  auto rh = SG::makeHandle(m_JetElementInputKey);
 
  if (rh.isValid()) {
     const DataVector<xAOD::JetElement>* storedJEs = &(*rh);
    if ( true ) {
       // Check size of JetElementCollection - zero would indicate a problem
      if (storedJEs->size() == 0)
         ATH_MSG_WARNING("Empty JetElementContainer - looks like a problem" );
    
      // Form JetInputs and put them in a map
      std::map<int, JetInput*>* inputMap = new std::map<int, JetInput*> ;
      m_JetTool->mapJetInputs(storedJEs, inputMap);
     
      // Loop over crates and modules
      for (int iCrate = 0; iCrate < 2; ++iCrate) {
    for (int iModule = 0; iModule < 16; ++iModule) {
        
       // For each module, find TOBs and backplane data
       std::vector<unsigned int> jetCMXData;
       m_JetTool->findJEMResults(inputMap,iCrate,iModule,m_allTOBs,jetCMXData);
       // Push backplane data into output DataVectors
       JetCMXData* bpData = new JetCMXData(iCrate,iModule,jetCMXData);
       m_JetCMXData -> push_back(bpData);
       
    } // loop over modules
      } // loop over crates
  
      for (std::map<int, JetInput*>::iterator it = inputMap->begin(); it != inputMap->end(); ++it) {
        delete (*it).second;
      }
      delete inputMap;
  
    } // found TriggerTowers
    
    else ATH_MSG_WARNING("Error retrieving JetElements" );
  }
  else ATH_MSG_WARNING("No JetElementContainer at " << m_JetElementInputKey );
  
       
  // Store module readout and backplane results in the TES
  storeBackplaneTOBs();
  storeModuleRoIs();
  
  // Clean up at end of event
  m_JetCMXData  = 0;
  m_allTOBs    = 0;
 
  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();
}

◆ initialize()

StatusCode LVL1::JEMJetSim::initialize ( )

Definition at line 60 of file JEMJetSim.cxx.

{
  ATH_CHECK( m_JetElementInputKey.initialize() );
  ATH_CHECK( m_JEMTobRoIOutputKey.initialize() );
  ATH_CHECK( m_JetCMXDataOutputKey.initialize() );
  ATH_CHECK( m_JetTool.retrieve() );
  return StatusCode::SUCCESS ;
}

◆ 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.

◆ 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();
  }

◆ storeBackplaneTOBs()

void LVL1::JEMJetSim::storeBackplaneTOBs ( )

private

Store module outputs in TES as inputs to CMX simulation.

place backplane data objects (CPM -> CMX) in StoreGate

StatusCode sc = evtStore()->overwrite(m_JetCMXData, m_JetCMXDataLocation, true);

Definition at line 149 of file JEMJetSim.cxx.

                                       {
   
  size_t datasize = m_JetCMXData->size();
 
  // Store backplane data objects
  const EventContext& ctx = Gaudi::Hive::currentContext();
  StatusCode sc = SG::makeHandle(m_JetCMXDataOutputKey, ctx).record( std::unique_ptr<DataVector<JetCMXData>>(m_JetCMXData) );
  m_JetCMXData = nullptr;
 
  if (sc.isSuccess()) {
    ATH_MSG_VERBOSE ( "Stored " << datasize
                      << " JetCMXData at " << m_JetCMXDataOutputKey );
  }
  else {
     ATH_MSG_ERROR("failed to write JetCMXData to  "
         << m_JetCMXDataOutputKey );
  } 
    
  return;
 
} //end storeBackplaneTOBs

◆ storeModuleRoIs()

void LVL1::JEMJetSim::storeModuleRoIs ( )

private

Store TOB RoI objects in the TES.

place final ROI objects in the TES.

Definition at line 174 of file JEMJetSim.cxx.

                                    {
 
   size_t n_jetsTobs = m_allTOBs->size();
 
   const EventContext& ctx = Gaudi::Hive::currentContext();
   StatusCode sc = SG::makeHandle(m_JEMTobRoIOutputKey, ctx).record( std::unique_ptr<DataVector<JEMTobRoI>>(m_allTOBs) );
   m_allTOBs = nullptr;
   
   if (sc.isSuccess()) {
      ATH_MSG_VERBOSE ( "Stored " << n_jetsTobs
                        << " Jet TOBs at " << m_JEMTobRoIOutputKey );
   }
   else {
      ATH_MSG_ERROR("failed to write JEMTobRoIs to  "
                    << m_JEMTobRoIOutputKey );
   } 
 
} //end storeModuleRoIs

◆ 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);
      }
    }
  }

Member Data Documentation

◆ m_allTOBs

DataVector<JEMTobRoI>* LVL1::JEMJetSim::m_allTOBs

private

TOB RoIs for RoIB input and DAQ output simulation.

Definition at line 75 of file JEMJetSim.h.

◆ 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_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_JEMTobRoIOutputKey

SG::WriteHandleKey<DataVector<JEMTobRoI> > LVL1::JEMJetSim::m_JEMTobRoIOutputKey { this, "JEMTOBRoILocation", TrigT1CaloDefs::JEMTobRoILocation, "Output Jet ROI container" }

private

Locations of outputs in StoreGate.

Definition at line 84 of file JEMJetSim.h.

84{ this, "JEMTOBRoILocation", TrigT1CaloDefs::JEMTobRoILocation, "Output Jet ROI container" };

LVL1::TrigT1CaloDefs::JEMTobRoILocation

static const std::string JEMTobRoILocation

Definition TrigT1CaloDefs.h:64

◆ m_JetCMXData

DataVector<JetCMXData>* LVL1::JEMJetSim::m_JetCMXData

private

Backplane data objects: CPM outputs to CMX.

Definition at line 78 of file JEMJetSim.h.

◆ m_JetCMXDataOutputKey

SG::WriteHandleKey<DataVector<JetCMXData> > LVL1::JEMJetSim::m_JetCMXDataOutputKey { this, "JetCMXDataLocation", TrigT1CaloDefs::JetCMXDataLocation, "Output Jet CMX data container" }

private

Definition at line 85 of file JEMJetSim.h.

85{ this, "JetCMXDataLocation", TrigT1CaloDefs::JetCMXDataLocation, "Output Jet CMX data container" };

LVL1::TrigT1CaloDefs::JetCMXDataLocation

static const std::string JetCMXDataLocation

Definition TrigT1CaloDefs.h:44

◆ m_JetElementInputKey

SG::ReadHandleKey<xAOD::JetElementContainer> LVL1::JEMJetSim::m_JetElementInputKey { this, "JetElementLocation", TrigT1CaloDefs::JetElementLocation, "Input JetElement container" }

private

Where to find the JetElements.

Definition at line 81 of file JEMJetSim.h.

81{ this, "JetElementLocation", TrigT1CaloDefs::JetElementLocation, "Input JetElement container" };

LVL1::TrigT1CaloDefs::JetElementLocation

static const std::string JetElementLocation

Definition TrigT1CaloDefs.h:39

◆ m_JetTool

ToolHandle<LVL1::IL1JEMJetTools> LVL1::JEMJetSim::m_JetTool

private

The essentials - data access, configuration, tools.

Definition at line 88 of file JEMJetSim.h.

◆ 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JEMJetSim()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ storeBackplaneTOBs()

◆ storeModuleRoIs()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_allTOBs

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_JEMTobRoIOutputKey

◆ m_JetCMXData

◆ m_JetCMXDataOutputKey

◆ m_JetElementInputKey

◆ m_JetTool

◆ m_varHandleArraysDeclared

◆ m_vhka