ATLAS Offline Software
Loading...
Searching...
No Matches
MuonChainFilterAlg Class Reference

(de)select chains for muon trigger algorithms initially designed to pass if at least one active chain is NOT in the list to be filtered (NotGate = false) the filter will also pass if NotGate = true and at least one active chain is FOUND in the list More...

#include <MuonChainFilterAlg.h>

Inheritance diagram for MuonChainFilterAlg:
Collaboration diagram for MuonChainFilterAlg:

Public Member Functions

 MuonChainFilterAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override
virtual StatusCode execute (const EventContext &ctx) const override
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual bool isClonable () const override
 Specify if the algorithm is clonable.
virtual unsigned int cardinality () const override
 Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode sysExecute (const EventContext &ctx) override
 Execute an algorithm.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
virtual bool filterPassed (const EventContext &ctx) const
virtual void setFilterPassed (bool state, const EventContext &ctx) const
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< StoreGateSvcStoreGateSvc_t

Private Member Functions

StatusCode createDummyMuonContainers (const EventContext &ctx) const
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

Gaudi::Property< std::vector< std::string > > m_filterChains {this, "ChainsToFilter", {}, "Vector of chains to filter out"}
SG::ReadHandleKeyArray< TrigCompositeUtils::DecisionContainerm_inputDecisionKeys {this, "InputDecisions", {}, "Inputs to the filter"}
Gaudi::Property< bool > m_writeL2muComb {this, "WriteMuComb", false, "Flag to record muComb muons"}
SG::WriteHandleKey< xAOD::L2CombinedMuonContainerm_muCombKey {this, "L2MuCombContainer", "MuonL2CBInfo", "Output container for muComb"}
Gaudi::Property< bool > m_writeL2muFast {this, "WriteMuFast", false, "Flag to record muFast muons"}
SG::WriteHandleKey< xAOD::L2StandAloneMuonContainerm_muFastKey {this, "L2MuFastContainer", "MuonL2SAInfo", "Output container for muFast"}
Gaudi::Property< bool > m_notGate {this, "NotGate", false, "filtering if not contained in ChainsToFilter"}
TrigCompositeUtils::DecisionIDContainer m_filterChainIDs
DataObjIDColl m_extendedExtraObjects
 Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

(de)select chains for muon trigger algorithms initially designed to pass if at least one active chain is NOT in the list to be filtered (NotGate = false) the filter will also pass if NotGate = true and at least one active chain is FOUND in the list

Definition at line 20 of file MuonChainFilterAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MuonChainFilterAlg()

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

Definition at line 11 of file MuonChainFilterAlg.cxx.

12 : ::AthReentrantAlgorithm(name, pSvcLocator) {}

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const
overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

64{
65 return 0;
66}

◆ createDummyMuonContainers()

StatusCode MuonChainFilterAlg::createDummyMuonContainers ( const EventContext & ctx) const
private

Definition at line 93 of file MuonChainFilterAlg.cxx.

93 {
94
95 // write out empty muComb/muFast container since EDM creator expects the container to always be present in the view
96 if (m_writeL2muComb) {
97 SG::WriteHandle handle(m_muCombKey, ctx);
98 ATH_CHECK( handle.record(std::make_unique<xAOD::L2CombinedMuonContainer>(), std::make_unique<xAOD::L2CombinedMuonAuxContainer>()) );
99 }
100 if (m_writeL2muFast) {
101 SG::WriteHandle handle(m_muFastKey, ctx);
102 ATH_CHECK( handle.record(std::make_unique<xAOD::L2StandAloneMuonContainer>(), std::make_unique<xAOD::L2StandAloneMuonAuxContainer>()) );
103 }
104 return StatusCode::SUCCESS;
105}
#define ATH_CHECK
Evaluate an expression and check for errors.
Gaudi::Property< bool > m_writeL2muFast
SG::WriteHandleKey< xAOD::L2CombinedMuonContainer > m_muCombKey
SG::WriteHandleKey< xAOD::L2StandAloneMuonContainer > m_muFastKey
Gaudi::Property< bool > m_writeL2muComb

◆ declareGaudiProperty()

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

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const
inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

◆ execute()

StatusCode MuonChainFilterAlg::execute ( const EventContext & ctx) const
overridevirtual

Definition at line 33 of file MuonChainFilterAlg.cxx.

33 {
34
35 // check if there is anything in the filter list
36 if (m_filterChains.empty()) {
37 ATH_MSG_DEBUG( "Nothing to filter, pass = " << (m_notGate ? "false" : "true") );
38
39 if (m_notGate) {
41 }
43 return StatusCode::SUCCESS;
44 }
45
46 // get input decisions (from output of input maker)
47 for (auto inputKey : m_inputDecisionKeys) {
48 auto inputDecisions = SG::makeHandle(inputKey, ctx);
49 ATH_CHECK( inputDecisions.isValid() );
50 ATH_MSG_DEBUG( "Checking inputHandle " << inputDecisions.key() << " with size: " << inputDecisions->size() );
51 for (const TrigCompositeUtils::Decision* dec : *inputDecisions) {
54 for (const auto& legID : decIDs) {
55 // in case of asymmetric trigger we should use HLT identifier which corresponds to a whole chain,
56 // i.e. use HLT_mu6_mu4_bJpsimumu_L1MU6_2MU4 instead of leg001_HLT_mu6_mu4_bJpsimumu_L1MU6_2MU4;
57 // TrigCompositeUtils::getIDFromLeg() will return unchanged id for the symmetric trigger
58 HLT::Identifier id = TrigCompositeUtils::getIDFromLeg(HLT::Identifier(legID));
59 const auto itr = m_filterChainIDs.find(id.numeric());
60 if (!m_notGate) { // pass if id does NOT match to any trigger from the filter list
61 if (itr != m_filterChainIDs.end()) {
62 ATH_MSG_DEBUG( "chain " << id.name() << " is on the filter list, keep looking" );
63 }
64 else {
65 ATH_MSG_DEBUG( "chain " << id.name() << " is not on the filter list, passing" );
66 setFilterPassed(true, ctx);
67 return StatusCode::SUCCESS;
68 }
69 }
70 else { // pass if id is found in the filter list
71 if (itr != m_filterChainIDs.end()) {
72 ATH_MSG_DEBUG( "chain " << id.name() << " is on the not-filter list, passing" );
73 setFilterPassed(true, ctx);
74 return StatusCode::SUCCESS;
75 }
76 else {
77 ATH_MSG_DEBUG( "chain " << id.name() << " is not on the not-filter list, keep looking" );
78 }
79 }
80 }
81 }
82 }
83
84 // if we've reached this point, the only active chains were on the filter list, so the filter will fail
85 ATH_MSG_DEBUG( "No trigger chains found, pass = false" );
87 setFilterPassed(false, ctx);
88
89 return StatusCode::SUCCESS;
90}
#define ATH_MSG_DEBUG(x)
virtual void setFilterPassed(bool state, const EventContext &ctx) const
TrigCompositeUtils::DecisionIDContainer m_filterChainIDs
Gaudi::Property< std::vector< std::string > > m_filterChains
StatusCode createDummyMuonContainers(const EventContext &ctx) const
Gaudi::Property< bool > m_notGate
SG::ReadHandleKeyArray< TrigCompositeUtils::DecisionContainer > m_inputDecisionKeys
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
HLT::Identifier getIDFromLeg(const HLT::Identifier &legIdentifier)
Generate the HLT::Identifier which corresponds to the chain name from the leg name.
std::set< DecisionID > DecisionIDContainer
void decisionIDs(const Decision *d, DecisionIDContainer &destination)
Extracts DecisionIDs stored in the Decision object.

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const
overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ initialize()

StatusCode MuonChainFilterAlg::initialize ( )
overridevirtual

Definition at line 15 of file MuonChainFilterAlg.cxx.

15 {
16
17 ATH_CHECK( m_inputDecisionKeys.initialize() );
20
21 // convert chain names into hashes
22 if (!m_filterChains.empty()) {
23 for (size_t i = 0; i < m_filterChains.size(); ++i) {
24 const auto id = HLT::Identifier(m_filterChains[i]);
25 m_filterChainIDs.insert(id.numeric());
26 ATH_MSG_DEBUG( i << " filter chain >> " << m_filterChains[i] );
27 }
28 }
29 return StatusCode::SUCCESS;
30}

◆ inputHandles()

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

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::renounce ( T & h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381 {
382 h.renounce();
384 }
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)

◆ renounceArray()

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

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state,
const EventContext & ctx ) const
inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx)
overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

77{
78 return BaseAlg::sysExecute (ctx);
79}

◆ sysInitialize()

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

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
#define ATH_MSG_ERROR(x)
#define ATH_MSG_WARNING(x)
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_filterChainIDs

TrigCompositeUtils::DecisionIDContainer MuonChainFilterAlg::m_filterChainIDs
private

Definition at line 40 of file MuonChainFilterAlg.h.

◆ m_filterChains

Gaudi::Property<std::vector<std::string> > MuonChainFilterAlg::m_filterChains {this, "ChainsToFilter", {}, "Vector of chains to filter out"}
private

Definition at line 29 of file MuonChainFilterAlg.h.

29{this, "ChainsToFilter", {}, "Vector of chains to filter out"};

◆ m_inputDecisionKeys

SG::ReadHandleKeyArray<TrigCompositeUtils::DecisionContainer> MuonChainFilterAlg::m_inputDecisionKeys {this, "InputDecisions", {}, "Inputs to the filter"}
private

Definition at line 30 of file MuonChainFilterAlg.h.

30{this, "InputDecisions", {}, "Inputs to the filter"};

◆ m_muCombKey

SG::WriteHandleKey<xAOD::L2CombinedMuonContainer> MuonChainFilterAlg::m_muCombKey {this, "L2MuCombContainer", "MuonL2CBInfo", "Output container for muComb"}
private

Definition at line 33 of file MuonChainFilterAlg.h.

33{this, "L2MuCombContainer", "MuonL2CBInfo", "Output container for muComb"};

◆ m_muFastKey

SG::WriteHandleKey<xAOD::L2StandAloneMuonContainer> MuonChainFilterAlg::m_muFastKey {this, "L2MuFastContainer", "MuonL2SAInfo", "Output container for muFast"}
private

Definition at line 36 of file MuonChainFilterAlg.h.

36{this, "L2MuFastContainer", "MuonL2SAInfo", "Output container for muFast"};

◆ m_notGate

Gaudi::Property<bool> MuonChainFilterAlg::m_notGate {this, "NotGate", false, "filtering if not contained in ChainsToFilter"}
private

Definition at line 38 of file MuonChainFilterAlg.h.

38{this, "NotGate", false, "filtering if not contained in ChainsToFilter"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writeL2muComb

Gaudi::Property<bool> MuonChainFilterAlg::m_writeL2muComb {this, "WriteMuComb", false, "Flag to record muComb muons"}
private

Definition at line 32 of file MuonChainFilterAlg.h.

32{this, "WriteMuComb", false, "Flag to record muComb muons"};

◆ m_writeL2muFast

Gaudi::Property<bool> MuonChainFilterAlg::m_writeL2muFast {this, "WriteMuFast", false, "Flag to record muFast muons"}
private

Definition at line 35 of file MuonChainFilterAlg.h.

35{this, "WriteMuFast", false, "Flag to record muFast muons"};

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