TrigBSExtraction Class Reference

Top algorithms which unpacks objects from BS and places them in SG. More...

#include <TrigBSExtraction.h>

Inheritance diagram for TrigBSExtraction:

Collaboration diagram for TrigBSExtraction:

Public Member Functions
	TrigBSExtraction (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override
virtual StatusCode	execute () 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	repackFeaturesToSG (HLT::Navigation &navTool, const SG::ReadHandleKey< HLT::HLTResult > &key, SG::WriteHandleKey< HLT::HLTResult > &keyOut, bool equalize, bool xAODConv)
	method which does loop over objects
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< HLT::Navigation >	m_navToolL2
ToolHandle< HLT::Navigation >	m_navTool
ToolHandle< ITrigBStoxAODTool >	m_xAODTool
SG::ReadHandleKey< HLT::HLTResult >	m_l2ResultKeyIn
SG::WriteHandleKey< HLT::HLTResult >	m_l2ResultKeyOut
SG::ReadHandleKey< HLT::HLTResult >	m_hltResultKeyIn
SG::WriteHandleKey< HLT::HLTResult >	m_hltResultKeyOut
SG::ReadHandleKeyArray< HLT::HLTResult >	m_dataScoutingKeysIn
SG::WriteHandleKeyArray< HLT::HLTResult >	m_dataScoutingKeysOut
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

Top algorithms which unpacks objects from BS and places them in SG.

If the BStoxAOD tool is configured an AOD->xAOD conversion is done for the containers in the Run-1 EF result (not for L2).

Definition at line 27 of file TrigBSExtraction.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

TrigBSExtraction()

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

Definition at line 12 of file TrigBSExtraction.cxx.

  : AthAlgorithm(name, pSvcLocator)
{
}

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.

{ 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 TrigBSExtraction::execute ( )

overridevirtual

Definition at line 56 of file TrigBSExtraction.cxx.

                                     {
 
  const bool isRun1 = m_navToolL2.isEnabled();
  if ( isRun1 ) {
    if ( repackFeaturesToSG(*m_navToolL2, m_l2ResultKeyIn, m_l2ResultKeyOut, false, false).isFailure() )
      ATH_MSG_WARNING( "failed unpacking features from BS to SG for: " << m_l2ResultKeyIn  );
  }
  
  if ( !m_hltResultKeyIn.empty() ) {
    // unpack, merge with L2 result and do xAOD conversion
    // xAOD conversion is only done for HLTResult_EF in Run-1
    if ( repackFeaturesToSG(*m_navTool, m_hltResultKeyIn, m_hltResultKeyOut, isRun1, isRun1).isFailure() )
      ATH_MSG_WARNING( "failed unpacking features from BS to SG for: " << m_hltResultKeyIn  );
  }
 
  for (size_t i = 0; i<m_dataScoutingKeysIn.size(); i++ ) {
    if ( repackFeaturesToSG(*m_navTool, m_dataScoutingKeysIn[i], m_dataScoutingKeysOut[i], false, false).isFailure() )
      ATH_MSG_WARNING( "failed unpacking features from BS to SG for: " << m_dataScoutingKeysIn[i] );
  }
 
  if ( isRun1 ) m_navToolL2->reset();
  m_navTool->reset();
 
  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 TrigBSExtraction::initialize ( )

overridevirtual

Definition at line 18 of file TrigBSExtraction.cxx.

                                        {
 
  // L2 navigation tool is optional
  if ( !m_l2ResultKeyIn.empty() ) ATH_CHECK( m_navToolL2.retrieve() );
  else m_navToolL2.disable();
 
  ATH_CHECK( m_navTool.retrieve() );
 
  // xAOD converter tool (for Run-1 data)
  if ( !m_xAODTool.empty() ) ATH_CHECK( m_xAODTool.retrieve() );
  else m_xAODTool.disable();
 
  // Initialize handle keys
  ATH_CHECK( m_l2ResultKeyIn.initialize(SG::AllowEmpty) );
  ATH_CHECK( m_l2ResultKeyOut.initialize(SG::AllowEmpty) );
 
  ATH_CHECK( m_hltResultKeyIn.initialize(SG::AllowEmpty) );
  ATH_CHECK( m_hltResultKeyOut.initialize(SG::AllowEmpty) );
 
  if ( m_dataScoutingKeysIn.size() != m_dataScoutingKeysOut.size() ) {
    ATH_MSG_ERROR("Size of DSResultKeysIn/Out does not match: " << m_dataScoutingKeysIn <<
                  " vs " << m_dataScoutingKeysOut );
    return StatusCode::FAILURE;
  }
  ATH_CHECK( m_dataScoutingKeysIn.initialize() );
  ATH_CHECK( m_dataScoutingKeysOut.initialize() );
 
  // Initialize the TrigSerializeConcHelper here so that all the additional streamerinfos are read in.
  // In case of DataScouting this may give problems if the DS ROBs contain containers which
  // were not compiled with navigation (the container type information is then not known
  // for a given CLID).
  ToolHandle<ITrigSerializeConvHelper> trigCnvHelper("TrigSerializeConvHelper",this);
  ATH_CHECK( trigCnvHelper.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();
  }

repackFeaturesToSG()

StatusCode TrigBSExtraction::repackFeaturesToSG ( HLT::Navigation & navTool, const SG::ReadHandleKey< HLT::HLTResult > & key, SG::WriteHandleKey< HLT::HLTResult > & keyOut, bool equalize, bool xAODConv )

private

method which does loop over objects

Parameters

navTool	navigation tool
key	does the job for EF or L2
equalize	flattens the EDM if true
xAODCnv	do xAOD conversion of Run-1 EF containers

Definition at line 83 of file TrigBSExtraction.cxx.

                                                               {
 
  ATH_MSG_DEBUG( "Trying to deserialize content of " << key );
  auto cresult = SG::makeHandle(key);
 
  if ( !cresult.get() ) {
    ATH_MSG_WARNING( "No HLTResult found with key " << key );
    return StatusCode::SUCCESS;
  }
 
  ATH_MSG_DEBUG("HLTResult is level=" << cresult->getHLTLevel()  );
 
  const std::vector<uint32_t>& navData = cresult->getNavigationResult();
  if ( !navData.empty() ) {
    ATH_MSG_DEBUG( "Navigation payload obtained from " << key << " has size " << navData.size()  );
    navTool.deserialize( navData );
  } else {
    ATH_MSG_WARNING( "Navigation payload obtained from " << key << " has size 0" );
  }
 
  if ( equalize && m_navToolL2.isEnabled() ) {
    ATH_MSG_DEBUG( "Merging L2 and EF navigation structures for " << key );
    navTool.merge(*m_navToolL2);
  }
 
  navTool.prepare();
 
  // optional xAOD conversion for Run-1 AOD containers
  if ( xAODCnv && m_xAODTool.isEnabled() ) {
 
    ATH_CHECK( m_xAODTool->convert(&navTool) );
 
    // after AOD TrigPassBitsCollection was converted to xAOD::TrigPassBitsContainer,
    // let's fill new xAOD::TrigPassBits objects with the proper pointers to
    // converted xAOD containers
    ATH_CHECK( m_xAODTool->setTrigPassBits(&navTool) );
 
    // this will redirect all Features to the xAOD converters
    ATH_CHECK( m_xAODTool->rewireNavigation(&navTool) );
  }
 
  // Create a copy of HLTResult and pack navigation back into it
  auto result = std::make_unique<HLT::HLTResult>(*cresult);
 
  result->getNavigationResult().clear();
  bool status = navTool.serialize(result->getNavigationResult(), result->getNavigationResultCuts());
  ATH_MSG_DEBUG( "New serialized navigation for " << keyOut << " has size " << result->getNavigationResult().size() );
 
  ATH_CHECK( SG::makeHandle(keyOut).record(std::move(result)) );
 
  return StatusCode(status);
}

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_dataScoutingKeysIn

SG::ReadHandleKeyArray<HLT::HLTResult> TrigBSExtraction::m_dataScoutingKeysIn

private

Initial value:

{
    this, "DSResultKeysIn", {}, "Input keys for DataScouting HLT results"}

Definition at line 64 of file TrigBSExtraction.h.

                                                         {
    this, "DSResultKeysIn", {}, "Input keys for DataScouting HLT results"};

m_dataScoutingKeysOut

SG::WriteHandleKeyArray<HLT::HLTResult> TrigBSExtraction::m_dataScoutingKeysOut

private

Initial value:

{
    this, "DSResultKeysOut", {}, "Output keys for DataScouting HLT results"}

Definition at line 66 of file TrigBSExtraction.h.

                                                           {
    this, "DSResultKeysOut", {}, "Output keys for DataScouting HLT results"};

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_hltResultKeyIn

SG::ReadHandleKey<HLT::HLTResult> TrigBSExtraction::m_hltResultKeyIn

private

Initial value:

{
    this, "HLTResultKeyIn", "HLTResult_HLT_BS", "Input key for EF/HLT result"}

Definition at line 59 of file TrigBSExtraction.h.

                                                {
    this, "HLTResultKeyIn", "HLTResult_HLT_BS", "Input key for EF/HLT result"};

m_hltResultKeyOut

SG::WriteHandleKey<HLT::HLTResult> TrigBSExtraction::m_hltResultKeyOut

private

Initial value:

{
    this, "HLTResultKeyOut", "HLTResult_HLT", "Output key for EF/HLT result"}

Definition at line 61 of file TrigBSExtraction.h.

                                                  {
    this, "HLTResultKeyOut", "HLTResult_HLT", "Output key for EF/HLT result"};

m_l2ResultKeyIn

SG::ReadHandleKey<HLT::HLTResult> TrigBSExtraction::m_l2ResultKeyIn

private

Initial value:

{
    this, "L2ResultKeyIn", "", "Input key for L2 result (Run-1)"}

Definition at line 54 of file TrigBSExtraction.h.

                                               {
    this, "L2ResultKeyIn", "", "Input key for L2 result (Run-1)"};

m_l2ResultKeyOut

SG::WriteHandleKey<HLT::HLTResult> TrigBSExtraction::m_l2ResultKeyOut

private

Initial value:

{
    this, "L2ResultKeyOut", "", "Output key for L2 result (Run-1)"}

Definition at line 56 of file TrigBSExtraction.h.

                                                 {
    this, "L2ResultKeyOut", "", "Output key for L2 result (Run-1)"};

m_navTool

ToolHandle<HLT::Navigation> TrigBSExtraction::m_navTool

private

Initial value:

{this, "Navigation", "HLT::Navigation/Navigation",
                                        "Navigation tool for EF/HLT result"}

Definition at line 48 of file TrigBSExtraction.h.

                                     {this, "Navigation", "HLT::Navigation/Navigation",
                                        "Navigation tool for EF/HLT result"};

m_navToolL2

ToolHandle<HLT::Navigation> TrigBSExtraction::m_navToolL2

private

Initial value:

{this, "NavigationForL2", "HLT::Navigation/NavigationForL2",
                                          "Navigation tool for Run-1 L2 result"}

Definition at line 46 of file TrigBSExtraction.h.

                                       {this, "NavigationForL2", "HLT::Navigation/NavigationForL2",
                                          "Navigation tool for Run-1 L2 result"};

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.

m_xAODTool

ToolHandle<ITrigBStoxAODTool> TrigBSExtraction::m_xAODTool

private

Initial value:

{this, "BStoxAOD", "",
                                           "Optional xAOD converter tool for Run-1 EF AOD containers"}

Definition at line 51 of file TrigBSExtraction.h.

                                          {this, "BStoxAOD", "",
                                           "Optional xAOD converter tool for Run-1 EF AOD containers"};

---

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

• TrigBSExtraction.h
• TrigBSExtraction.cxx