|
ATLAS Offline Software
|
#include <R3MatchingTool.h>
|
| R3MatchingTool (const std::string &name) |
|
| ~R3MatchingTool () |
|
virtual StatusCode | initialize () override |
| Dummy implementation of the initialisation function. More...
|
|
virtual bool | match (const std::vector< const xAOD::IParticle * > &recoObjects, const std::string &chain, double matchThreshold, bool rerun) const override |
| multi-object trigger matching More...
|
|
virtual bool | match (const xAOD::IParticle &recoObject, const std::string &chain, double matchThreshold, bool rerun) const override |
| single object trigger matching. matchThreshold is typically the deltaR requirement to obtain positive matching More...
|
|
virtual void | print () const |
| Print the state of the tool. More...
|
|
ServiceHandle< StoreGateSvc > & | evtStore () |
| The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc . More...
|
|
const ServiceHandle< StoreGateSvc > & | evtStore () const |
| The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc . More...
|
|
const ServiceHandle< StoreGateSvc > & | detStore () const |
| The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc . More...
|
|
virtual StatusCode | sysInitialize () override |
| Perform system initialization for an algorithm. More...
|
|
virtual StatusCode | sysStart () override |
| Handle START transition. More...
|
|
virtual std::vector< Gaudi::DataHandle * > | inputHandles () const override |
| Return this algorithm's input handles. More...
|
|
virtual std::vector< Gaudi::DataHandle * > | outputHandles () const override |
| Return this algorithm's output handles. More...
|
|
Gaudi::Details::PropertyBase & | declareProperty (Gaudi::Property< T > &t) |
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &) |
| Declare a new Gaudi property. More...
|
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &) |
| Declare a new Gaudi property. More...
|
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &) |
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &) |
| Declare a new Gaudi property. More...
|
|
Gaudi::Details::PropertyBase * | declareProperty (const std::string &name, T &property, const std::string &doc="none") |
| Declare a new Gaudi property. More...
|
|
void | updateVHKA (Gaudi::Details::PropertyBase &) |
|
MsgStream & | msg () const |
|
MsgStream & | msg (const MSG::Level lvl) const |
|
bool | msgLvl (const MSG::Level lvl) const |
|
|
bool | matchObjects (const xAOD::IParticle *reco, const ElementLink< xAOD::IParticleContainer > &onlineLink, xAODType::ObjectType onlineType, std::map< std::pair< uint32_t, uint32_t >, bool > &cache, double drThreshold) const |
|
const chainInfo_t & | getChainInfo (const std::string &chain) const |
|
virtual MatchingImplementation * | impl () const override |
| Inherited from the interface but does nothing. More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &) |
| specialization for handling Gaudi::Property<SG::VarHandleBase> More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &) |
| specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
|
|
Definition at line 19 of file R3MatchingTool.h.
◆ chainInfo_t
◆ multInfo_t
◆ StoreGateSvc_t
◆ typeInfo_t
◆ R3MatchingTool()
Trig::R3MatchingTool::R3MatchingTool |
( |
const std::string & |
name | ) |
|
◆ ~R3MatchingTool()
Trig::R3MatchingTool::~R3MatchingTool |
( |
| ) |
|
◆ declareGaudiProperty() [1/4]
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
175 hndl.documentation());
◆ declareGaudiProperty() [2/4]
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
161 hndl.documentation());
◆ declareGaudiProperty() [3/4]
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
189 hndl.documentation());
◆ declareGaudiProperty() [4/4]
◆ declareProperty() [1/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation string for the property. |
This is the version for types that derive from SG::VarHandleBase
. The property value object is put on the input and output lists as appropriate; then we forward to the base class.
Definition at line 245 of file AthCommonDataStore.h.
250 this->declare(hndl.
vhKey());
251 hndl.
vhKey().setOwner(
this);
253 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [2/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation string for the property. |
This is the version for types that derive from SG::VarHandleKey
. The property value object is put on the input and output lists as appropriate; then we forward to the base class.
Definition at line 221 of file AthCommonDataStore.h.
229 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [3/6]
◆ declareProperty() [4/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation string for the property. |
This is the generic version, for types that do not derive from SG::VarHandleKey
. It just forwards to the base class version of declareProperty
.
Definition at line 333 of file AthCommonDataStore.h.
338 return PBASE::declareProperty(
name, property,
doc);
◆ declareProperty() [5/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation string for the property. |
This dispatches to either the generic declareProperty
or the one for VarHandle/Key/KeyArray.
Definition at line 352 of file AthCommonDataStore.h.
◆ declareProperty() [6/6]
◆ detStore()
◆ evtStore() [1/2]
◆ evtStore() [2/2]
◆ extraDeps_update_handler()
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
◆ getChainInfo()
Definition at line 178 of file R3MatchingTool.cxx.
180 std::lock_guard<std::mutex> guard(m_chainInfoMutex);
181 auto cacheItr = m_chainInfoCache.find(
chain);
182 if (cacheItr == m_chainInfoCache.end())
191 info.first.push_back(0);
195 info.first.push_back(legInfo.multiplicity);
196 for (std::size_t
idx = 0;
idx < legInfo.multiplicity; ++
idx)
200 cacheItr = m_chainInfoCache.insert(std::make_pair(
chain, std::move(
info))).first;
202 return cacheItr->second;
◆ getKey()
Get the (hashed) key of an object that is in the event store.
This is a bit of a special one. StoreGateSvc
and xAOD::TEvent
both provide ways for getting the SG::sgkey_t
key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
- See also
- asg::AsgTool::getName
- Parameters
-
ptr | The bare pointer to the object that the event store should know about |
- Returns
- The hashed key of the object in the store. If not found, an invalid (zero) key.
Definition at line 119 of file AsgTool.cxx.
121 #ifdef XAOD_STANDALONE
127 return (
proxy ==
nullptr ? 0 :
proxy->sgkey() );
128 #endif // XAOD_STANDALONE
◆ getName()
const std::string & asg::AsgTool::getName |
( |
const void * |
ptr | ) |
const |
|
inherited |
Get the name of an object that is / should be in the event store.
This is a bit of a special one. StoreGateSvc
and xAOD::TEvent
both provide ways for getting the std::string
name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.
In order to allow tools to efficiently perform this operation, they can use this helper function.
- See also
- asg::AsgTool::getKey
- Parameters
-
ptr | The bare pointer to the object that the event store should know about |
- Returns
- The string name of the object in the store. If not found, an empty string.
Definition at line 106 of file AsgTool.cxx.
108 #ifdef XAOD_STANDALONE
114 static const std::string
dummy =
"";
116 #endif // XAOD_STANDALONE
◆ getProperty()
template<class T >
const T* asg::AsgTool::getProperty |
( |
const std::string & |
name | ) |
const |
|
inherited |
Get one of the tool's properties.
◆ impl()
|
inlineoverrideprivatevirtual |
◆ initialize()
StatusCode Trig::R3MatchingTool::initialize |
( |
| ) |
|
|
overridevirtual |
Dummy implementation of the initialisation function.
It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...
Reimplemented from asg::AsgTool.
Definition at line 24 of file R3MatchingTool.cxx.
28 return StatusCode::SUCCESS;
◆ inputHandles()
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.
◆ match() [1/2]
bool Trig::R3MatchingTool::match |
( |
const std::vector< const xAOD::IParticle * > & |
recoObjects, |
|
|
const std::string & |
chain, |
|
|
double |
matchThreshold, |
|
|
bool |
rerun |
|
) |
| const |
|
overridevirtual |
multi-object trigger matching
Implements Trig::IMatchingTool.
Definition at line 31 of file R3MatchingTool.cxx.
37 if (recoObjects.size() == 0)
42 using VecLinkInfo_t = std::vector<IPartLinkInfo_t>;
52 std::vector<std::map<std::pair<uint32_t, uint32_t>,
bool>> cachedComparisons(recoObjects.size());
60 if (!
m_trigDecTool->isPassed(
chainName, rerun ? TrigDefs::Physics | TrigDefs::allowResurrectedDecision : TrigDefs::Physics))
70 for (IPartLinkInfo_t &linkInfo : features)
72 if (!linkInfo.isValid())
75 throw std::runtime_error(
"Bad link info");
90 "Chain " <<
chainName <<
" (matching pattern " <<
chain <<
") has too few objects ("
91 <<
combinations.size() <<
") to match the number of provided reco objects (" << recoObjects.size() <<
")");
98 std::vector<std::size_t> onlineIndices(combination.size());
99 std::iota(onlineIndices.begin(), onlineIndices.end(), 0);
103 for (std::size_t recoIdx = 0; recoIdx < recoObjects.size(); ++recoIdx)
105 std::size_t onlineIdx = onlineIndices[recoIdx];
107 recoObjects[recoIdx],
108 combination[onlineIdx].link,
109 chainInfo.second[onlineIdx],
110 cachedComparisons[recoIdx],
119 }
while (std::next_permutation(onlineIndices.begin(), onlineIndices.end()));
◆ match() [2/2]
bool Trig::R3MatchingTool::match |
( |
const xAOD::IParticle & |
recoObject, |
|
|
const std::string & |
chain, |
|
|
double |
matchThreshold, |
|
|
bool |
rerun |
|
) |
| const |
|
overridevirtual |
single object trigger matching. matchThreshold is typically the deltaR requirement to obtain positive matching
Implements Trig::IMatchingTool.
Definition at line 127 of file R3MatchingTool.cxx.
133 std::vector<const xAOD::IParticle *> tmpVec{&recoObject};
134 return match(tmpVec,
chain, matchThreshold, rerun);
◆ matchObjects()
Definition at line 137 of file R3MatchingTool.cxx.
149 std::pair<uint32_t, uint32_t> linkIndices(onlineLink.persKey(), onlineLink.persIndex());
150 auto cacheItr = cache.find(linkIndices);
151 if (cacheItr == cache.end())
163 throw std::runtime_error(
"Failed to cast to egamma object");
168 ATH_MSG_WARNING(
"Cannot retrieve egamma object's primary calorimeter cluster, will match to the egamma object");
173 cacheItr = cache.insert(std::make_pair(linkIndices,
match)).first;
175 return cacheItr->second;
◆ msg() [1/2]
◆ msg() [2/2]
◆ msg_level_name()
const std::string & asg::AsgTool::msg_level_name |
( |
| ) |
const |
|
inherited |
A deprecated function for getting the message level's name.
Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:
MSG::name( msg().level() )
This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.
- Returns
- The string name of the current minimum message level that's printed
Definition at line 101 of file AsgTool.cxx.
◆ msgLvl()
◆ outputHandles()
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.
◆ print()
void asg::AsgTool::print |
( |
| ) |
const |
|
virtualinherited |
Print the state of the tool.
Implements asg::IAsgTool.
Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
Definition at line 131 of file AsgTool.cxx.
◆ renounce()
◆ renounceArray()
◆ sysInitialize()
◆ sysStart()
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
◆ updateVHKA()
◆ ATLAS_THREAD_SAFE [1/2]
std::map<std::string, chainInfo_t> m_chainInfoCache Trig::R3MatchingTool::ATLAS_THREAD_SAFE |
|
mutableprivate |
◆ ATLAS_THREAD_SAFE [2/2]
std::mutex m_chainInfoMutex Trig::R3MatchingTool::ATLAS_THREAD_SAFE |
|
mutableprivate |
◆ m_detStore
◆ m_evtStore
◆ m_scoreTool
Initial value:{
this, "ScoringTool", "Trig::DRScoringTool","Tool to score pairs of particles"}
Definition at line 46 of file R3MatchingTool.h.
◆ m_trigDecTool
◆ m_varHandleArraysDeclared
◆ m_vhka
The documentation for this class was generated from the following files:
Combinations buildCombinations(const std::string &chainName, const std::vector< LinkInfo< xAOD::IParticleContainer >> &features, const std::vector< std::size_t > &legMultiplicities, const std::function< bool(const std::vector< LinkInfo< xAOD::IParticleContainer >> &)> &filter)
Produce the combinations for a set of features.
Electron_v1 Electron
Definition of the current "egamma version".
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
@ UniqueObjects
Do not allow any repeated objects.
Helper class that provides access to information about individual legs.
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
Class providing the definition of the 4-vector interface.
bool isValid() const
Test to see if the link can be dereferenced.
CaloCluster_v1 CaloCluster
Define the latest version of the calorimeter cluster class.
virtual void setOwner(IDataHandleHolder *o)=0
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
@ Other
An object not falling into any of the other categories.
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Struct containing information on each leg of a chain.
Photon_v1 Photon
Definition of the current "egamma version".
def combinations(items, n)
#define ATH_MSG_WARNING(x)
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
std::vector< std::string > getListOfTriggers() const
ObjectType
Type of objects that have a representation in the xAOD EDM.
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>