ATLAS Offline Software
Loading...
Searching...
No Matches
IDTPM::RoiSelectionTool Class Referenceabstract

#include <RoiSelectionTool.h>

Inheritance diagram for IDTPM::RoiSelectionTool:
Collaboration diagram for IDTPM::RoiSelectionTool:

Public Member Functions

 RoiSelectionTool (const std::string &name)
 Constructor.
virtual ~RoiSelectionTool ()=default
 Destructor.
virtual StatusCode initialize () override
 RoiSelectionTool methods.
std::vector< roiCollection_tgetRois (const std::string &chainName) const
 Main method to get selected RoIs.
virtual void print () const =0
 Print the state of the tool.
virtual void print () const
 Print the state of the tool.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T * getProperty (const std::string &name) const
 Get one of the tool's properties.
const std::string & msg_level_name () const __attribute__((deprecated))
 A deprecated function for getting the message level's name.
const std::string & getName (const void *ptr) const
 Get the name of an object that is / should be in the event store.
SG::sgkey_t getKey (const void *ptr) const
 Get the (hashed) key of an object that is in the event store.

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

 ASG_TOOL_CLASS (RoiSelectionTool, IAsgTool)
std::vector< roiCollection_tretrieveRois (const std::string &chainName, const std::string &roiKey, const int &chainLeg=-1) const
 Retrieve RoIs.
std::vector< roiCollection_tgetRoisStandard (const std::string &chainName) const
 get selected RoIs (non-Tag&Probe selection)
std::vector< roiCollection_tgetRoisTnP (const std::string &chainName) const
 get selected RoIs (Tag&Probe selection)
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

StringProperty m_roiKey { this, "RoiKey", "", "RoI name to process" }
 Properties to fine-tune the tool behaviour.
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::TrigDecisionToolm_trigDecTool
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

Definition at line 32 of file RoiSelectionTool.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

◆ RoiSelectionTool()

IDTPM::RoiSelectionTool::RoiSelectionTool ( const std::string & name)

Constructor.


----— parametrized constructor ----—

Definition at line 16 of file RoiSelectionTool.cxx.

17 :
18 asg::AsgTool( name ) { }

◆ ~RoiSelectionTool()

virtual IDTPM::RoiSelectionTool::~RoiSelectionTool ( )
virtualdefault

Destructor.

Member Function Documentation

◆ ASG_TOOL_CLASS()

IDTPM::RoiSelectionTool::ASG_TOOL_CLASS ( RoiSelectionTool ,
IAsgTool  )
private

◆ 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.

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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::evtStore ( )
inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

◆ 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

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr) const
inherited

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
ptrThe 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.

119 {
120
121#ifdef XAOD_STANDALONE
122 // In case we use @c xAOD::TEvent, we have a direct function call
123 // for this.
124 return evtStore()->event()->getKey( ptr );
125#else
126 const SG::DataProxy* proxy = evtStore()->proxy( ptr );
127 return ( proxy == nullptr ? 0 : proxy->sgkey() );
128#endif // XAOD_STANDALONE
129 }
ServiceHandle< StoreGateSvc > & evtStore()

◆ 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
ptrThe 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.

106 {
107
108#ifdef XAOD_STANDALONE
109 // In case we use @c xAOD::TEvent, we have a direct function call
110 // for this.
111 return evtStore()->event()->getName( ptr );
112#else
113 const SG::DataProxy* proxy = evtStore()->proxy( ptr );
114 static const std::string dummy = "";
115 return ( proxy == nullptr ? dummy : proxy->name() );
116#endif // XAOD_STANDALONE
117 }

◆ getProperty()

template<class T>
const T * asg::AsgTool::getProperty ( const std::string & name) const
inherited

Get one of the tool's properties.

◆ getRois()

std::vector< IDTPM::roiCollection_t > IDTPM::RoiSelectionTool::getRois ( const std::string & chainName) const

Main method to get selected RoIs.


--— getRois --—

Definition at line 137 of file RoiSelectionTool.cxx.

138 {
139
140 return ( m_doTnP.value() ) ?
141 getRoisTnP( chainName ) :
142 getRoisStandard( chainName );
143}
std::vector< roiCollection_t > getRoisStandard(const std::string &chainName) const
get selected RoIs (non-Tag&Probe selection)
std::vector< roiCollection_t > getRoisTnP(const std::string &chainName) const
get selected RoIs (Tag&Probe selection)

◆ getRoisStandard()

std::vector< IDTPM::roiCollection_t > IDTPM::RoiSelectionTool::getRoisStandard ( const std::string & chainName) const
private

get selected RoIs (non-Tag&Probe selection)


--— getRoisStandard --—

Definition at line 98 of file RoiSelectionTool.cxx.

99 {
100
101 return retrieveRois( chainName,
102 m_roiKey.value(),
103 m_chainLeg.value() );
104}
StringProperty m_roiKey
Properties to fine-tune the tool behaviour.
std::vector< roiCollection_t > retrieveRois(const std::string &chainName, const std::string &roiKey, const int &chainLeg=-1) const
Retrieve RoIs.

◆ getRoisTnP()

std::vector< IDTPM::roiCollection_t > IDTPM::RoiSelectionTool::getRoisTnP ( const std::string & chainName) const
private

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.

111 {
112
114 std::vector< roiCollection_t > selectedRoisTag =
115 retrieveRois( chainName,
116 m_roiKeyTag.value(),
117 m_chainLegTag.value() );
118
120 std::vector< roiCollection_t > selectedRoisProbe =
121 retrieveRois( chainName,
122 m_roiKeyProbe.value(),
123 m_chainLegProbe.value() );
124
126 //std::vector< roiCollection_t > selectedRois =
127 // m_TnPselectionTool( selectedRoisTag, selectedRoisProbe, tracks );
128 std::vector< roiCollection_t > selectedRois = selectedRoisProbe;
129
130 return selectedRois;
131}
IntegerProperty m_chainLegProbe
IntegerProperty m_chainLegTag

◆ initialize()

StatusCode IDTPM::RoiSelectionTool::initialize ( void )
overridevirtual

RoiSelectionTool methods.


----— Initialize ----—

Reimplemented from asg::AsgTool.

Definition at line 24 of file RoiSelectionTool.cxx.

24 {
25
27
28 ATH_MSG_DEBUG( "Initializing " << name() );
29
30 ATH_CHECK( m_trigDecTool.retrieve() );
31
32 return StatusCode::SUCCESS;
33}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_DEBUG(x)
PublicToolHandle< Trig::TrigDecisionTool > m_trigDecTool
virtual StatusCode initialize()
Dummy implementation of the initialisation function.
Definition AsgTool.h:133

◆ 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.

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

◆ 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.

101 {
102
103 return MSG::name( msg().level() );
104 }
MsgStream & msg() const
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition MsgLevel.cxx:19

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< 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.

◆ print() [1/2]

void asg::AsgTool::print ( ) const
virtualinherited

◆ print() [2/2]

◆ 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.

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< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ retrieveRois()

std::vector< IDTPM::roiCollection_t > IDTPM::RoiSelectionTool::retrieveRois ( const std::string & chainName,
const std::string & roiKey,
const int & chainLeg = -1 ) const
private

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.

42 {
43
44 unsigned decisionType = TrigDefs::Physics; // TrigDefs::includeFailedDecisions;
45
46 unsigned featureType = ( roiKey.empty() ) ?
49
50 std::vector< roiCollection_t > rois =
52 Trig::FeatureRequestDescriptor(
53 chainName,
54 decisionType,
55 roiKey,
56 featureType,
58 chainLeg ) );
59
60 ATH_MSG_DEBUG( "Retrieved " << rois.size() <<
61 " RoIs for chain " << chainName <<
62 " , RoI key : " << roiKey <<
63 " , leg = " << chainLeg );
64
65 std::vector< roiCollection_t > selectedRois;
66
68 for( size_t ir=0 ; ir<rois.size() ; ir++ ) {
69
72 if( roiKey == "SuperRoi" && ir > 0 ) continue;
73
74 const ElementLink< TrigRoiDescriptorCollection > thisRoiLink = rois[ir].link;
75
77 if( !roiKey.empty() && thisRoiLink.dataID() != roiKey ) continue;
78
79 const TrigRoiDescriptor* const* thisRoi = thisRoiLink.cptr();
80
82 if( thisRoi == 0 ) continue;
83
84 ATH_MSG_DEBUG( "Retrieved RoI descriptor for chain " <<
85 chainName << " " << **thisRoi );
86
87 selectedRois.push_back( rois[ir] );
88
89 } // close rois loop
90
91 return selectedRois;
92}
Athena::TPCnvVers::Current Athena::TPCnvVers::Old TrigRoiDescriptorCollection
Athena::TPCnvVers::Current TrigRoiDescriptor
int ir
counter of the current depth
Definition fastadd.cxx:49
const std::string & roiString()
static const unsigned int lastFeatureOfType
Run 3 "enum". Only return the final feature along each route through the navigation.
static const unsigned int allFeaturesOfType
Run 3 "enum". Return all features along legs (still with type and container checks)

◆ 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.

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 }
std::vector< SG::VarHandleKeyArray * > m_vhka

Member Data Documentation

◆ 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.

72 {
73 this, "ChainLeg", -1, "Restrict to a specific \"leg\" of a multi-object trigger chain (default = all)" };

◆ 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.

84 {
85 this, "ChainLegProbe", 1, "Probe \"leg\" of a multi-object trigger chain (default = 1)" };

◆ 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.

79 {
80 this, "ChainLegTag", 0, "Tag \"leg\" of a multi-object trigger chain (default = 0)" };

◆ 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_doTnP

BooleanProperty IDTPM::RoiSelectionTool::m_doTnP { this, "doTagNProbe", false, "Do Tag&Probe RoI selection" }
private

Definition at line 75 of file RoiSelectionTool.h.

75{ this, "doTagNProbe", false, "Do Tag&Probe RoI selection" };

◆ 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_roiKey

StringProperty IDTPM::RoiSelectionTool::m_roiKey { this, "RoiKey", "", "RoI name to process" }
private

Properties to fine-tune the tool behaviour.

Definition at line 70 of file RoiSelectionTool.h.

70{ this, "RoiKey", "", "RoI name to process" };

◆ m_roiKeyProbe

StringProperty IDTPM::RoiSelectionTool::m_roiKeyProbe { this, "RoiKeyProbe", "", "RoI name for the probe" }
private

Definition at line 82 of file RoiSelectionTool.h.

82{ this, "RoiKeyProbe", "", "RoI name for the probe" };

◆ m_roiKeyTag

StringProperty IDTPM::RoiSelectionTool::m_roiKeyTag { this, "RoiKeyTag", "", "RoI name for the tag" }
private

Definition at line 77 of file RoiSelectionTool.h.

77{ this, "RoiKeyTag", "", "RoI name for the tag" };

◆ m_trigDecTool

PublicToolHandle<Trig::TrigDecisionTool> IDTPM::RoiSelectionTool::m_trigDecTool
private
Initial value:
{
this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool", "" }

Definition at line 87 of file RoiSelectionTool.h.

87 {
88 this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool", "" };

◆ 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: