This class simulates the missing ET and total ET triggers. More...

#include <JEMEnergySim.h>

Inheritance diagram for LVL1::JEMEnergySim:

Collaboration diagram for LVL1::JEMEnergySim:

Public Member Functions
	JEMEnergySim (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 DataVector< JEMEtSums >	JEMEtSumsCollection
typedef DataVector< EnergyCMXData >	EnergyCMXDataCollection
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	storeJEMEtSums ()
	put results into SG
void	storeBackplaneData ()
	Form EnergyCMXData and put into SG.
void	cleanup ()
	delete pointers etc.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< LVL1::IL1EtTools >	m_EtTool
SG::ReadHandleKey< xAOD::JetElementContainer >	m_JetElementInputKey { this, "JetElementLocation", TrigT1CaloDefs::JetElementLocation, "Input JetElement container" }
std::string	m_jemEtSumsLocation
SG::WriteHandleKey< DataVector< JEMEtSums > >	m_jemEtSumsOutputKey { this, "JEMEtSumsLocation", TrigT1CaloDefs::JEMEtSumsLocation, "Output Jet energy sums container" }
std::string	m_energyCMXDataLocation
SG::WriteHandleKey< DataVector< EnergyCMXData > >	m_energyCMXDataOutputKey { this, "EnergyCMXDataLocation", TrigT1CaloDefs::EnergyCMXDataLocation, "Output Jet CMX energy sum container" }
DataVector< ModuleEnergy > *	m_jemContainer
	vector of ModuleEnergy objects
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

This class simulates the missing ET and total ET triggers.

JEMEnergySim uses EnergyCrate and JetElement objects in order to closely follow the layout of the hardware.

Definition at line 47 of file JEMEnergySim.h.

Member Typedef Documentation

◆ EnergyCMXDataCollection

typedef DataVector<EnergyCMXData> LVL1::JEMEnergySim::EnergyCMXDataCollection

private

Definition at line 50 of file JEMEnergySim.h.

◆ JEMEtSumsCollection

typedef DataVector<JEMEtSums> LVL1::JEMEnergySim::JEMEtSumsCollection

private

Definition at line 49 of file JEMEnergySim.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ JEMEnergySim()

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

Definition at line 38 of file JEMEnergySim.cxx.

    : AthAlgorithm( name, pSvcLocator ), 
      m_EtTool("LVL1::L1EtTools/L1EtTools"),
      m_jemContainer(0)
{}

Member Function Documentation

◆ cleanup()

void LVL1::JEMEnergySim::cleanup ( )

private

delete pointers etc.

Definition at line 103 of file JEMEnergySim.cxx.

                              {
 
  delete m_jemContainer;
}

◆ 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::JEMEnergySim::execute ( )

Definition at line 66 of file JEMEnergySim.cxx.

{
   ATH_MSG_DEBUG ( "Executing" );
 
  // form module sums
  m_jemContainer = new DataVector<ModuleEnergy>;  
 
  auto rh = SG::makeHandle(m_JetElementInputKey);
 
  if (rh.isValid()) {
    const DataVector<xAOD::JetElement>* jetelements = &(*rh);
    
    // Warn if we find an empty container
    if (jetelements->size() == 0)
      ATH_MSG_WARNING("Empty JetElementContainer - looks like a problem" );
    
    m_EtTool->moduleSums(jetelements, m_jemContainer);
  }
  else ATH_MSG_WARNING("No JetElementCollection at " << m_JetElementInputKey );
    
  // Done the processing. Now form & save the various output data
 
  // For CMX simulation
  storeBackplaneData();
  
  // for Bytestream simulation
  storeJEMEtSums();
  
  cleanup();
 
  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::JEMEnergySim::initialize ( )

Definition at line 50 of file JEMEnergySim.cxx.

{
  ATH_CHECK( m_JetElementInputKey.initialize() );
  ATH_CHECK( m_jemEtSumsOutputKey.initialize() );
  ATH_CHECK( m_energyCMXDataOutputKey.initialize() );
 
  ATH_CHECK( m_EtTool.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();
  }

◆ storeBackplaneData()

void LVL1::JEMEnergySim::storeBackplaneData ( )

private

Form EnergyCMXData and put into SG.

Definition at line 138 of file JEMEnergySim.cxx.

                                          {
  
  ATH_MSG_DEBUG("storeBackplaneData running");
  
  EnergyCMXDataCollection* bpVector = new  EnergyCMXDataCollection;
 
  DataVector<ModuleEnergy>::iterator it;
  for ( it=m_jemContainer->begin(); it!=m_jemContainer->end(); ++it ) {
    EnergyCMXData* bpData = new EnergyCMXData((*it)->crate(), (*it)->module(),
                          (*it)->ex(),(*it)->ey(),(*it)->et());
    bpVector->push_back(bpData);
  }
 
  ATH_MSG_DEBUG( bpVector->size()<<" EnergyCMXData objects are being saved");
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
  StatusCode sc = SG::makeHandle(m_energyCMXDataOutputKey, ctx).record( std::unique_ptr<DataVector<EnergyCMXData>>(bpVector) );
  if (sc != StatusCode::SUCCESS) {
    ATH_MSG_ERROR ( "Error registering EnergyCMXData collection in TDS " );
  }
 
}

◆ storeJEMEtSums()

void LVL1::JEMEnergySim::storeJEMEtSums ( )

private

put results into SG

Form JEMEtSums and put into SG.

Definition at line 109 of file JEMEnergySim.cxx.

                                      {
  
  ATH_MSG_DEBUG("storeJEMEtSums running");
  
  JEMEtSumsCollection* JEMRvector = new  JEMEtSumsCollection;
 
  DataVector<ModuleEnergy>::iterator it;
  for ( it=m_jemContainer->begin(); it!=m_jemContainer->end(); ++it ) {
    std::vector<unsigned int> eX;
    eX.push_back((*it)->ex());
    std::vector<unsigned int> eY;
    eY.push_back((*it)->ey());
    std::vector<unsigned int> eT;
    eT.push_back((*it)->et());
    JEMEtSums* jemEtSums = new JEMEtSums((*it)->crate(), (*it)->module(),eT,eX,eY,0);
    JEMRvector->push_back(jemEtSums);
  }
 
  ATH_MSG_DEBUG( JEMRvector->size()<<" JEMEtSums objects are being saved");
  
  const EventContext& ctx = Gaudi::Hive::currentContext();
  StatusCode sc = SG::makeHandle(m_jemEtSumsOutputKey, ctx).record( std::unique_ptr<DataVector<JEMEtSums>>(JEMRvector) );
  if (sc != StatusCode::SUCCESS) {
    ATH_MSG_ERROR ( "Error registering JEMEtSums collection in TDS " );
  }
 
}

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

std::string LVL1::JEMEnergySim::m_energyCMXDataLocation

private

Definition at line 80 of file JEMEnergySim.h.

◆ m_energyCMXDataOutputKey

SG::WriteHandleKey<DataVector<EnergyCMXData> > LVL1::JEMEnergySim::m_energyCMXDataOutputKey { this, "EnergyCMXDataLocation", TrigT1CaloDefs::EnergyCMXDataLocation, "Output Jet CMX energy sum container" }

private

Definition at line 81 of file JEMEnergySim.h.

81{ this, "EnergyCMXDataLocation", TrigT1CaloDefs::EnergyCMXDataLocation, "Output Jet CMX energy sum container" };

LVL1::TrigT1CaloDefs::EnergyCMXDataLocation

static const std::string EnergyCMXDataLocation

Definition TrigT1CaloDefs.h:45

◆ m_EtTool

ToolHandle<LVL1::IL1EtTools> LVL1::JEMEnergySim::m_EtTool

private

Definition at line 72 of file JEMEnergySim.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_jemContainer

DataVector<ModuleEnergy>* LVL1::JEMEnergySim::m_jemContainer

private

vector of ModuleEnergy objects

Definition at line 84 of file JEMEnergySim.h.

◆ m_jemEtSumsLocation

std::string LVL1::JEMEnergySim::m_jemEtSumsLocation

private

Definition at line 77 of file JEMEnergySim.h.

◆ m_jemEtSumsOutputKey

SG::WriteHandleKey<DataVector<JEMEtSums> > LVL1::JEMEnergySim::m_jemEtSumsOutputKey { this, "JEMEtSumsLocation", TrigT1CaloDefs::JEMEtSumsLocation, "Output Jet energy sums container" }

private

Definition at line 78 of file JEMEnergySim.h.

78{ this, "JEMEtSumsLocation", TrigT1CaloDefs::JEMEtSumsLocation, "Output Jet energy sums container" };

LVL1::TrigT1CaloDefs::JEMEtSumsLocation

static const std::string JEMEtSumsLocation

Definition TrigT1CaloDefs.h:49

◆ m_JetElementInputKey

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

private

Definition at line 75 of file JEMEnergySim.h.

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

LVL1::TrigT1CaloDefs::JetElementLocation

static const std::string JetElementLocation

Definition TrigT1CaloDefs.h:39

◆ 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

◆ EnergyCMXDataCollection

◆ JEMEtSumsCollection

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JEMEnergySim()

Member Function Documentation

◆ cleanup()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ storeBackplaneData()

◆ storeJEMEtSums()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_energyCMXDataLocation

◆ m_energyCMXDataOutputKey

◆ m_EtTool

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_jemContainer

◆ m_jemEtSumsLocation

◆ m_jemEtSumsOutputKey

◆ m_JetElementInputKey

◆ m_varHandleArraysDeclared

◆ m_vhka