![]() |
ATLAS Offline Software
|
#include <FeatureRequestDescriptor.h>
Public Member Functions | |
FeatureRequestDescriptor (const std::string &chainGroupName="", const unsigned int condition=TrigDefs::Physics, const std::string &containerSGKey="", const unsigned int featureCollectionMode=TrigDefs::lastFeatureOfType, const std::string &navElementLinkKey=TrigCompositeUtils::featureString(), const int restrictToLegIndex=-1) | |
Default Constructor supplying all properties except for the chain group. More... | |
~FeatureRequestDescriptor ()=default | |
Default destructor. More... | |
FeatureRequestDescriptor (FeatureRequestDescriptor &&)=default | |
Default move constructor. More... | |
FeatureRequestDescriptor (const FeatureRequestDescriptor &)=default | |
Default copy constructor. More... | |
void | reset () |
Reset the FeatureRequestDescriptor to its default configuration. More... | |
void | print (MsgStream &msg, const MSG::Level level=MSG::INFO) |
Print the configuration of the FeatureRequestDescriptor to the supplied message stream. More... | |
FeatureRequestDescriptor & | setChainGroup (const std::string &chainGroupName) |
Set the desired Chain or Chain Group. More... | |
FeatureRequestDescriptor & | setCondition (const unsigned int condition) |
Set the Condition: TrigDefs::Physics - (default), only returns features from paths through the navigation which accepted the event for at least one of the chains in the ChainGroup. More... | |
FeatureRequestDescriptor & | setRequireSGKey (const std::string &containerSGKey) |
Set the StoreGate key filter. More... | |
FeatureRequestDescriptor & | setFeatureCollectionMode (const unsigned int featureCollectionMode) |
Set the Feature Collection Mode: TrigDefs::lastFeatureOfType - (default) stop exploring up each path through the navigation as soon as one ElementLink has been collected along the path. More... | |
FeatureRequestDescriptor & | setLinkName (const std::string &navElementLinkKey) |
Set the Link Name Key. More... | |
FeatureRequestDescriptor & | setRestrictRequestToLeg (const int restrictToLegIndex) |
Set to -1 by default, indicating that all legs of multi-leg chains are searched. More... | |
const std::string & | chainGroup () const |
unsigned int | condition () const |
const std::string & | SGKey () const |
unsigned int | featureCollectionMode () const |
const std::string & | linkName () const |
int | restrictRequestToLeg () const |
Private Attributes | |
std::string | m_chainGroupName |
int | m_condition |
std::string | m_containerSGKey |
int | m_featureCollectionMode |
std::string | m_navElementLinkKey |
int | m_restrictToLegIndex |
Definition at line 32 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.
Trig::FeatureRequestDescriptor::FeatureRequestDescriptor | ( | const std::string & | chainGroupName = "" , |
const unsigned int | condition = TrigDefs::Physics , |
||
const std::string & | containerSGKey = "" , |
||
const unsigned int | featureCollectionMode = TrigDefs::lastFeatureOfType , |
||
const std::string & | navElementLinkKey = TrigCompositeUtils::featureString() , |
||
const int | restrictToLegIndex = -1 |
||
) |
Default Constructor supplying all properties except for the chain group.
See below for individual property descriptions.
[in] | chainGroupName | Chain or Chain Group, supplied by name. Regex supported with TrigDecisionTool. Only one exact individual chain name is supported in TrigDecisionToolLite. |
Definition at line 10 of file FeatureRequestDescriptor.cxx.
|
default |
Default destructor.
No heap allocations.
|
default |
Default move constructor.
|
default |
Default copy constructor.
const std::string & Trig::FeatureRequestDescriptor::chainGroup | ( | ) | const |
Definition at line 115 of file FeatureRequestDescriptor.cxx.
unsigned int Trig::FeatureRequestDescriptor::condition | ( | ) | const |
Definition at line 123 of file FeatureRequestDescriptor.cxx.
unsigned int Trig::FeatureRequestDescriptor::featureCollectionMode | ( | ) | const |
Definition at line 133 of file FeatureRequestDescriptor.cxx.
const std::string & Trig::FeatureRequestDescriptor::linkName | ( | ) | const |
Definition at line 138 of file FeatureRequestDescriptor.cxx.
void Trig::FeatureRequestDescriptor::print | ( | MsgStream & | msg, |
const MSG::Level | level = MSG::INFO |
||
) |
Print the configuration of the FeatureRequestDescriptor to the supplied message stream.
Definition at line 34 of file FeatureRequestDescriptor.cxx.
void Trig::FeatureRequestDescriptor::reset | ( | ) |
Reset the FeatureRequestDescriptor to its default configuration.
Definition at line 24 of file FeatureRequestDescriptor.cxx.
int Trig::FeatureRequestDescriptor::restrictRequestToLeg | ( | ) | const |
Definition at line 143 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setChainGroup | ( | const std::string & | chainGroupName | ) |
Set the desired Chain or Chain Group.
Regex supported with TrigDecisionTool. Only one exact individual chain name is supported in TrigDecisionToolLite.
Definition at line 73 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setCondition | ( | const unsigned int | condition | ) |
Set the Condition: TrigDefs::Physics - (default), only returns features from paths through the navigation which accepted the event for at least one of the chains in the ChainGroup.
TrigDefs::includeFailedDecisions - follows more paths through the navigation, the paths which were active for at least one of the chains in the ChainGroup, but which failed for all of these chains by some non-final Step.
Definition at line 79 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setFeatureCollectionMode | ( | const unsigned int | featureCollectionMode | ) |
Set the Feature Collection Mode: TrigDefs::lastFeatureOfType - (default) stop exploring up each path through the navigation as soon as one ElementLink has been collected along the path.
As all paths are explored from their last step backwards, this equates to collecting the "final" feature along each path (after accounting for all other filtering options). TrigDefs::allFeatureOfType - does not stop once an ElementLink is collected when exploring paths through the navigation, instead keeps exploring always back to the L1 node. Potentially returns many features along each path, corresponding to intermediate physics objects as well as the "final" physics object.
Definition at line 94 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setLinkName | ( | const std::string & | navElementLinkKey | ) |
Set the Link Name Key.
Sets which named-edges in the navigation graph are returned by the call. By default the TrigDecisionTool looks for edges named "feature", however "roi", "initialRoI" or slice-specific custom-named edges can be alternatively used here.
Definition at line 103 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setRequireSGKey | ( | const std::string & | containerSGKey | ) |
Set the StoreGate key filter.
ElementLinks will have their StoreGate collection key checked against this filter, it must match for the ElementLink to be collected. Regex supported. Set to an empty string (default) to disable the filter.
Definition at line 88 of file FeatureRequestDescriptor.cxx.
FeatureRequestDescriptor & Trig::FeatureRequestDescriptor::setRestrictRequestToLeg | ( | const int | restrictToLegIndex | ) |
Set to -1 by default, indicating that all legs of multi-leg chains are searched.
If set to an integer >= 0, the search will be restricted to the single specified leg for all chains in the ChainGroup.
Definition at line 109 of file FeatureRequestDescriptor.cxx.
const std::string & Trig::FeatureRequestDescriptor::SGKey | ( | ) | const |
Definition at line 128 of file FeatureRequestDescriptor.cxx.
|
private |
Definition at line 164 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.
|
private |
Definition at line 165 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.
|
private |
Definition at line 166 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.
|
private |
Definition at line 167 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.
|
private |
Definition at line 168 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.
|
private |
Definition at line 169 of file TrigAnalysisHelpers/TrigAnalysisHelpers/FeatureRequestDescriptor.h.