Base class for tools used by PEBInfoWriterAlg. More...

#include <PEBInfoWriterToolBase.h>

Inheritance diagram for PEBInfoWriterToolBase:

Collaboration diagram for PEBInfoWriterToolBase:

Classes
struct	Input
	Input to the tool's `decide` method. More...
struct	PEBInfo
	Structure holding the list of ROBs and SubDets. More...

Public Member Functions
	PEBInfoWriterToolBase (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual	~PEBInfoWriterToolBase ()
	Standard destructor.
StatusCode	decide (const EventContext &ctx, std::vector< Input > &inputs) const
	Adds a pass-through decision with attached PEB information created by `createPEBInfo` for each input.
HLT::Identifier	id () const
	Returns the decision id.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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

Static Public Member Functions
static std::string	robListKey ()
	Returns the key used to record/retrieve the ROB list.
static std::string	subDetListKey ()
	Returns the key used to record/retrieve the SubDet list.

Protected Member Functions
virtual PEBInfo	createPEBInfo (const EventContext &ctx, const Input &input) const =0
	Creates the PEBInfo which is attached to the decision in `decide`. Has to be implemented by the derived class.
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.

Protected Attributes
Gaudi::Property< int >	m_maxRoIs
	MaxRoIs property.
Gaudi::Property< std::vector< unsigned int > >	m_matchTriggerType

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
HLT::Identifier	m_decisionId
	The decision id of the tool instance.
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

Base class for tools used by PEBInfoWriterAlg.

Derived classes have to implement createPEBInfo, which is used in decide

Definition at line 21 of file PEBInfoWriterToolBase.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ PEBInfoWriterToolBase()

PEBInfoWriterToolBase::PEBInfoWriterToolBase	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard constructor.

Definition at line 20 of file PEBInfoWriterToolBase.cxx.

21: AthAlgTool(type,name,parent),

22 m_decisionId(HLT::Identifier::fromToolName(name)) {}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

HLT::Identifier::fromToolName

static HLT::Identifier fromToolName(const std::string &tname)

Definition HLTIdentifier.cxx:21

PEBInfoWriterToolBase::m_decisionId

HLT::Identifier m_decisionId

The decision id of the tool instance.

Definition PEBInfoWriterToolBase.h:79

◆ ~PEBInfoWriterToolBase()

PEBInfoWriterToolBase::~PEBInfoWriterToolBase ( )

virtual

Standard destructor.

Definition at line 26 of file PEBInfoWriterToolBase.cxx.

26{}

Member Function Documentation

◆ createPEBInfo()

virtual PEBInfo PEBInfoWriterToolBase::createPEBInfo	(	const EventContext &	ctx,
		const Input &	input ) const

protectedpure virtual

Creates the PEBInfo which is attached to the decision in decide. Has to be implemented by the derived class.

Implemented in RoIPEBInfoWriterTool, and StaticPEBInfoWriterTool.

◆ decide()

StatusCode PEBInfoWriterToolBase::decide	(	const EventContext &	ctx,
		std::vector< Input > &	inputs ) const

Adds a pass-through decision with attached PEB information created by createPEBInfo for each input.

Definition at line 30 of file PEBInfoWriterToolBase.cxx.

                                                                                                {
  std::set<ElementLink<TrigRoiDescriptorCollection>> uniqueRoIs;
  for (Input& input : inputs) {
    // Skip if previous step for this chain didn't pass
    if (not TrigCompositeUtils::passed(m_decisionId.numeric(), input.previousDecisionIDs)) {
      ATH_MSG_DEBUG("Skipping chain because previous step didn't pass");
      continue;
    }
    
    if (!m_matchTriggerType.empty()) {
      if (std::none_of(
        m_matchTriggerType.begin(),
        m_matchTriggerType.end(),
        [&input](uint8_t test_tt) { return (test_tt & input.tt) == test_tt; }
      )){
      continue;
      }
    }
 
    // Count unique RoIs
    bool isUnique = uniqueRoIs.insert(input.roiEL).second;
    ATH_MSG_DEBUG("RoI eta/phi = " << (*input.roiEL)->eta() << "/" << (*input.roiEL)->phi() << " has "
                  << (isUnique ? "not yet" : "already") << " been processed. So far seen "
                  << uniqueRoIs.size() << " unique RoIs including this one");
 
    // Skip processing if max RoIs limit reached
    bool maxRoIsReached{false};
    if (m_maxRoIs>=0 && static_cast<int>(uniqueRoIs.size()) > m_maxRoIs) {
      ATH_MSG_DEBUG("Will attach empty PEB Info to this decision because the number of "
                    << "processed RoIs reached MaxRoIs (" << m_maxRoIs.value() << ")");
      maxRoIsReached = true;
    }
 
    // Create new PEB Info for this input (empty if max RoIs limit is reached)
    PEBInfo pebInfo = maxRoIsReached ? PEBInfo{} : createPEBInfo(ctx, input);
 
    // Merge with previous ROBs    
    std::vector<uint32_t> previousRobs;
    ATH_CHECK(input.decision->getDetail(robListKey(), previousRobs));
    pebInfo.robs.insert(previousRobs.begin(), previousRobs.end());
 
    // Merge with previous SubDets
    std::vector<uint32_t> previousSubDets;
    ATH_CHECK(input.decision->getDetail(subDetListKey(), previousSubDets));
    pebInfo.subdets.insert(previousSubDets.begin(), previousSubDets.end());
 
    // Attach the PEB Info to the decision
    std::vector<uint32_t> robVec(pebInfo.robs.begin(), pebInfo.robs.end());
    if (not input.decision->setDetail(robListKey(), robVec)) {
      ATH_MSG_ERROR("Failed to attach the detail " << robListKey() << " to the decision");
      return StatusCode::FAILURE;
    }
    std::vector<uint32_t> subDetVec(pebInfo.subdets.begin(), pebInfo.subdets.end());
    if (not input.decision->setDetail(subDetListKey(), subDetVec)) {
      ATH_MSG_ERROR("Failed to attach the detail " << subDetListKey() << " to the decision");
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_DEBUG("Attached PEB Info with " << robVec.size() << " ROBs and "
                  << subDetVec.size() << " SubDets to the decision object.");
    ATH_MSG_DEBUG("PEBInfo: " << pebInfo);
 
    // Make an accept decision
    TrigCompositeUtils::addDecisionID(m_decisionId, input.decision);
  }
  return StatusCode::SUCCESS;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ id()

HLT::Identifier PEBInfoWriterToolBase::id ( ) const

inline

Returns the decision id.

Definition at line 59 of file PEBInfoWriterToolBase.h.

59{return m_decisionId;}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ robListKey()

std::string PEBInfoWriterToolBase::robListKey ( )

inlinestatic

Returns the key used to record/retrieve the ROB list.

Definition at line 61 of file PEBInfoWriterToolBase.h.

61{return "PEBROBList";}

◆ subDetListKey()

std::string PEBInfoWriterToolBase::subDetListKey ( )

inlinestatic

Returns the key used to record/retrieve the SubDet list.

Definition at line 63 of file PEBInfoWriterToolBase.h.

63{return "PEBSubDetList";}

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_decisionId

HLT::Identifier PEBInfoWriterToolBase::m_decisionId

private

The decision id of the tool instance.

Definition at line 79 of file PEBInfoWriterToolBase.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_matchTriggerType

Gaudi::Property<std::vector<unsigned int> > PEBInfoWriterToolBase::m_matchTriggerType

protected

Initial value:

{
    this, "MatchTriggerType", {}, "L1 trigger type to match"
  }

Definition at line 73 of file PEBInfoWriterToolBase.h.

                                                            {
    this, "MatchTriggerType", {}, "L1 trigger type to match"
  };

◆ m_maxRoIs

Gaudi::Property<int> PEBInfoWriterToolBase::m_maxRoIs

protected

Initial value:

{
    this, "MaxRoIs", -1, "Create PEB list only for the first N RoIs from input decisions (<0 means no limit)"
  }

MaxRoIs property.

Definition at line 69 of file PEBInfoWriterToolBase.h.

                               {
    this, "MaxRoIs", -1, "Create PEB list only for the first N RoIs from input decisions (<0 means no limit)"
  };

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PEBInfoWriterToolBase()

◆ ~PEBInfoWriterToolBase()

Member Function Documentation

◆ createPEBInfo()

◆ decide()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ id()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ robListKey()

◆ subDetListKey()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decisionId

◆ m_detStore

◆ m_evtStore

◆ m_matchTriggerType

◆ m_maxRoIs

◆ m_varHandleArraysDeclared

◆ m_vhka