|
ATLAS Offline Software
|
#include <RoiSelectionTool.h>
|
| RoiSelectionTool (const std::string &name) |
| Constructor. More...
|
|
virtual | ~RoiSelectionTool ()=default |
| Destructor. More...
|
|
virtual StatusCode | initialize () override |
| RoiSelectionTool methods. More...
|
|
std::vector< roiCollection_t > | getRois (const std::string &chainName) const |
| Main method to get selected RoIs. More...
|
|
virtual void | print () const =0 |
| Print the state of the tool. 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 |
|
|
StringProperty | m_roiKey { this, "RoiKey", "", "RoI name to process" } |
| Properties to fine-tune the tool behaviour. More...
|
|
IntegerProperty | m_chainLeg |
|
BooleanProperty | m_doTnP { this, "doTagNProbe", false, "Do Tag&Probe RoI selection" } |
|
StringProperty | m_roiKeyTag { this, "RoiKeyTag", "", "RoI name for the tag" } |
|
IntegerProperty | m_chainLegTag |
|
StringProperty | m_roiKeyProbe { this, "RoiKeyProbe", "", "RoI name for the probe" } |
|
IntegerProperty | m_chainLegProbe |
|
PublicToolHandle< Trig::TrigDecisionTool > | m_trigDecTool |
|
StoreGateSvc_t | m_evtStore |
| Pointer to StoreGate (event store by default) More...
|
|
StoreGateSvc_t | m_detStore |
| Pointer to StoreGate (detector store by default) More...
|
|
std::vector< SG::VarHandleKeyArray * > | m_vhka |
|
bool | m_varHandleArraysDeclared |
|
Definition at line 32 of file RoiSelectionTool.h.
◆ StoreGateSvc_t
◆ RoiSelectionTool()
IDTPM::RoiSelectionTool::RoiSelectionTool |
( |
const std::string & |
name | ) |
|
◆ ~RoiSelectionTool()
virtual IDTPM::RoiSelectionTool::~RoiSelectionTool |
( |
| ) |
|
|
virtualdefault |
◆ ASG_TOOL_CLASS()
◆ 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
◆ 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.
◆ getRois()
◆ getRoisStandard()
get selected RoIs (non-Tag&Probe selection)
--— getRoisStandard --—
Definition at line 98 of file RoiSelectionTool.cxx.
◆ getRoisTnP()
get selected RoIs (Tag&Probe selection)
--— getRoisTnP --—
retrieving tag rois
retrieving probe rois
TODO - add TnP selection
Definition at line 110 of file RoiSelectionTool.cxx.
114 std::vector< roiCollection_t > selectedRoisTag =
120 std::vector< roiCollection_t > selectedRoisProbe =
128 std::vector< roiCollection_t > selectedRois = selectedRoisProbe;
◆ initialize()
StatusCode IDTPM::RoiSelectionTool::initialize |
( |
| ) |
|
|
overridevirtual |
◆ 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.
◆ 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() [1/2]
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.
◆ print() [2/2]
virtual void asg::IAsgTool::print |
( |
| ) |
const |
|
pure virtualinherited |
Print the state of the tool.
Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
◆ renounce()
◆ renounceArray()
◆ retrieveRois()
Retrieve RoIs.
--— retrieveRois --—
loop to select RoIs
Don't extract any additional RoIs if a superRoi is requested: In this case, the superRoi would be shared between the different chains
check this is not a spurious TDT match
remove roi with corrupted link
Definition at line 39 of file RoiSelectionTool.cxx.
44 unsigned decisionType = TrigDefs::Physics;
46 unsigned featureType = ( roiKey.empty() ) ?
47 TrigDefs::lastFeatureOfType :
48 TrigDefs::allFeaturesOfType;
50 std::vector< roiCollection_t >
rois =
62 " , RoI key : " << roiKey <<
63 " , leg = " << chainLeg );
65 std::vector< roiCollection_t > selectedRois;
72 if( roiKey ==
"SuperRoi" &&
ir > 0 )
continue;
77 if( !roiKey.empty() && thisRoiLink.
dataID() != roiKey )
continue;
82 if( thisRoi == 0 )
continue;
87 selectedRois.push_back(
rois[
ir] );
◆ 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()
◆ m_chainLeg
IntegerProperty IDTPM::RoiSelectionTool::m_chainLeg |
|
private |
Initial value:{
this, "ChainLeg", -1, "Restrict to a specific \"leg\" of a multi-object trigger chain (default = all)" }
Definition at line 72 of file RoiSelectionTool.h.
◆ m_chainLegProbe
IntegerProperty IDTPM::RoiSelectionTool::m_chainLegProbe |
|
private |
Initial value:{
this, "ChainLegProbe", 1, "Probe \"leg\" of a multi-object trigger chain (default = 1)" }
Definition at line 84 of file RoiSelectionTool.h.
◆ m_chainLegTag
IntegerProperty IDTPM::RoiSelectionTool::m_chainLegTag |
|
private |
Initial value:{
this, "ChainLegTag", 0, "Tag \"leg\" of a multi-object trigger chain (default = 0)" }
Definition at line 79 of file RoiSelectionTool.h.
◆ m_detStore
◆ m_doTnP
BooleanProperty IDTPM::RoiSelectionTool::m_doTnP { this, "doTagNProbe", false, "Do Tag&Probe RoI selection" } |
|
private |
◆ m_evtStore
◆ m_roiKey
StringProperty IDTPM::RoiSelectionTool::m_roiKey { this, "RoiKey", "", "RoI name to process" } |
|
private |
◆ m_roiKeyProbe
StringProperty IDTPM::RoiSelectionTool::m_roiKeyProbe { this, "RoiKeyProbe", "", "RoI name for the probe" } |
|
private |
◆ m_roiKeyTag
StringProperty IDTPM::RoiSelectionTool::m_roiKeyTag { this, "RoiKeyTag", "", "RoI name for the tag" } |
|
private |
◆ m_trigDecTool
Initial value:{
this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool", "" }
Definition at line 87 of file RoiSelectionTool.h.
◆ m_varHandleArraysDeclared
◆ m_vhka
The documentation for this class was generated from the following files:
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
nope - should be used for standalone also, perhaps need to protect the class def bits #ifndef XAOD_AN...
const ID_type & dataID() const
Get the key that we reference, as a string.
virtual void setOwner(IDataHandleHolder *o)=0
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
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
ElementConstPointer cptr() const
Return a pointer to the referenced element.
int ir
counter of the current depth
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
const std::string & roiString()
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>