ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
TriggerSelectionAlg Class Reference

#include <TriggerSelectionAlg.h>

Inheritance diagram for TriggerSelectionAlg:
Collaboration diagram for TriggerSelectionAlg:

Public Member Functions

 TriggerSelectionAlg (const std::string &name, ISvcLocator *pSvcLocator)
 Constructor with parameters: More...
 
virtual ~TriggerSelectionAlg ()
 Destructor: More...
 
virtual StatusCode initialize ()
 Athena algorithm's initalize hook. More...
 
virtual StatusCode execute ()
 Athena algorithm's execute hook. More...
 
virtual StatusCode finalize ()
 Athena algorithm's finalize hook. More...
 
virtual StatusCode sysInitialize () override
 Initialization method invoked by the framework. More...
 
virtual void setFilterPassed (bool state) const
 Set the filter passed flag to the specified state. More...
 
void setFilterDescription (const std::string &descr)
 helper method to ease the setting of this filter's description in derived classes Note that this method should be called in the c-tor of derived classes More...
 
ServiceHandle< ICutFlowSvc > & cutFlowSvc ()
 return a handle to an ICutFlowSvc instance More...
 
CutIdentifier cutID ()
 return the CutIdentifier corresponding to the top-level cut of this filter algorithm More...
 
const SG::ReadHandleKey< xAOD::EventInfo > & eventInfoKey () const
 EventInfo key for use in derived classes. More...
 
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies. 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 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
 

Protected Member Functions

void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
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. More...
 

Private Types

typedef ServiceHandle< ICutFlowSvcICutFlowSvc_t
 
typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

void doNotResetSelfDescription (Gaudi::Details::PropertyBase &)
 
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...
 

Private Attributes

CutIdentifier m_cutID
 The CutIdentifier for this filter algorithm. More...
 
ICutFlowSvc_t m_cutFlowSvc
 handle to the service holding tables of cut-flows for filtering algs. More...
 
std::string m_filterDescr
 filter description: describes what this filter does. More...
 
bool m_resetSelfDescription
 
SG::ReadHandleKey< xAOD::EventInfom_eventInfoKey { this, "EventInfoKey", "EventInfo", "" }
 
DataObjIDColl m_extendedExtraObjects
 
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
 
The properties that can be defined via the python job options
ToolHandle< Trig::TrigDecisionToolm_trigDecisionTool
 The ToolHandle for the TrigDecisionTool. More...
 
StringArrayProperty m_triggerList
 The list of triggers to cut on. More...
 
BooleanProperty m_decoEvtInfo
 Decide if we also want to decorate the xAOD::EventInfo object with the pass/fail information. More...
 
StringProperty m_evtInfoName
 Name of the xAOD::EventInfo object that we want to decorate. More...
 
StringProperty m_varPrefix
 Prefix used for the decoration variables. More...
 
BooleanProperty m_storePrescaleInfo
 Decide if we also want to decorate the xAOD::EventInfo object with the (full-chain) prescale information. More...
 
Other private members
std::vector< std::string > m_varNameList
 The list of all variables names. More...
 

Detailed Description

Definition at line 24 of file TriggerSelectionAlg.h.

Member Typedef Documentation

◆ ICutFlowSvc_t

Definition at line 84 of file AthFilterAlgorithm.h.

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TriggerSelectionAlg()

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

Constructor with parameters:

Definition at line 13 of file TriggerSelectionAlg.cxx.

13  :
14  AthFilterAlgorithm( name, pSvcLocator ),
15  m_trigDecisionTool("Trig::TrigDecisionTool/TrigDecisionTool"),
16  m_triggerList(),
17  m_decoEvtInfo(true),
18  m_evtInfoName("EventInfo"),
19  m_varPrefix("pass_"),
20  m_storePrescaleInfo(false),
22 {
23  declareProperty("TrigDecisionTool", m_trigDecisionTool, "The TrigDecisionTool" );
24  declareProperty("TriggerList", m_triggerList, "The list of triggers to cut on" );
25  declareProperty("DecorateEventInfo", m_decoEvtInfo,
26  "Decide if we also want to decorate the xAOD::EventInfo object with the pass/fail information" );
27  declareProperty("EventInfoName", m_evtInfoName, "Name of the xAOD::EventInfo object that we want to decorate" );
28  declareProperty("VarNamePrefix", m_varPrefix, "Prefix used for the decoration variables" );
29  declareProperty("StorePrescaleInfo", m_storePrescaleInfo,
30  "Decide if we also want to decorate the xAOD::EventInfo object with the full-chain prescale information" );
31 }

◆ ~TriggerSelectionAlg()

TriggerSelectionAlg::~TriggerSelectionAlg ( )
virtual

Destructor:

Definition at line 34 of file TriggerSelectionAlg.cxx.

34 {}

Member Function Documentation

◆ cutFlowSvc()

ServiceHandle< ICutFlowSvc > & AthFilterAlgorithm::cutFlowSvc ( )
inlineinherited

return a handle to an ICutFlowSvc instance

Definition at line 108 of file AthFilterAlgorithm.h.

109 {
110  return m_cutFlowSvc;
111 }

◆ cutID()

CutIdentifier AthFilterAlgorithm::cutID ( )
inlineinherited

return the CutIdentifier corresponding to the top-level cut of this filter algorithm

Definition at line 116 of file AthFilterAlgorithm.h.

117 {
118  return m_cutID;
119 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation 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.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation 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.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

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

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

◆ detStore()

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

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

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ doNotResetSelfDescription()

void AthFilterAlgorithm::doNotResetSelfDescription ( Gaudi::Details::PropertyBase &  )
inlineprivateinherited

Definition at line 124 of file AthFilterAlgorithm.h.

125 {
126  m_resetSelfDescription=false;
127 }

◆ eventInfoKey()

const SG::ReadHandleKey< xAOD::EventInfo > & AthFilterAlgorithm::eventInfoKey ( ) const
inherited

EventInfo key for use in derived classes.

Definition at line 134 of file AthFilterAlgorithm.cxx.

135 {
136  return m_eventInfoKey;
137 }

◆ evtStore() [1/2]

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

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

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode TriggerSelectionAlg::execute ( )
virtual

Athena algorithm's execute hook.

Definition at line 72 of file TriggerSelectionAlg.cxx.

73 {
74  ATH_MSG_DEBUG("Executing " << name() << "...");
75 
76  // Get the xAOD::EventInfo object, if requested
77  const xAOD::EventInfo* evtInfo = nullptr;
78  if ( m_decoEvtInfo.value() ){
79  ATH_CHECK( evtStore()->retrieve( evtInfo, m_evtInfoName.value() ) );
80  }
81 
82  // Create a results Vector
83  std::vector<bool> trigResultsVec( m_triggerList.value().size(), false );
84  std::vector<float> trigPrescalesVec( m_triggerList.value().size(), 0. );
85 
86  //Check if event passes trigger selection
87  bool eventPasses = false;
88  if( !(m_triggerList.value().empty()) ) {
89  for( std::size_t i=0; i<m_triggerList.value().size(); ++i ) {
90  if( m_trigDecisionTool->isPassed(m_triggerList.value().at(i)) ) {
91  trigResultsVec[i] = true;
92  eventPasses = true;
93  ATH_MSG_VERBOSE("Name of passed trigger: " << m_triggerList.value().at(i));
94  if ( !(m_decoEvtInfo.value()) ){
95  break; // Found a trigger which we passed, nothing more to do here
96  }
97  }
98  //We sometimes want to keep track of the chain prescale
99  if (m_storePrescaleInfo) {
100  trigPrescalesVec[i] = m_trigDecisionTool->getPrescale(m_triggerList.value().at(i));
101  ATH_MSG_VERBOSE("Retrieved prescale of " << trigPrescalesVec[i] << " for trigger: " << m_triggerList.value().at(i));
102  }
103  }
104  }
105 
106  // Decorate the EventInfo, if requested
107  if ( m_decoEvtInfo.value() ){
108  const size_t decoSize = trigResultsVec.size();
109  if ( decoSize != m_varNameList.size() ){
110  ATH_MSG_FATAL("Different number of trigger results and variable names");
111  return StatusCode::FAILURE;
112  }
113  // We also want to decorate the xAOD::EventInfo object with the results
114  for( std::size_t i=0; i<decoSize; ++i ) {
116  decoPassTrig(*evtInfo) = static_cast<char>(trigResultsVec[i]);
117  //We sometimes want to keep track of the chain prescale
118  if (m_storePrescaleInfo) {
119  SG::AuxElement::Decorator<float> decoPrescaleTrig("prescale_"+m_triggerList.value().at(i));
120  decoPrescaleTrig(*evtInfo) = static_cast<float>(trigPrescalesVec[i]);
121  }
122  }
123  }
124 
125  // Say if this event should be accepted or not
126  this->setFilterPassed( eventPasses );
127  ATH_MSG_DEBUG("Event passes trigger selection: " << eventPasses );
128 
129  return StatusCode::SUCCESS;
130 }

◆ extraDeps_update_handler()

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

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

51 {
52  // If we didn't find any symlinks to add, just return the collection
53  // from the base class. Otherwise, return the extended collection.
54  if (!m_extendedExtraObjects.empty()) {
56  }
57  return Algorithm::extraOutputDeps();
58 }

◆ finalize()

StatusCode TriggerSelectionAlg::finalize ( )
virtual

Athena algorithm's finalize hook.

Definition at line 61 of file TriggerSelectionAlg.cxx.

62 {
63  ATH_MSG_DEBUG("Finalizing " << name() << "...");
64 
65  // Release all tools
66  ATH_CHECK( m_trigDecisionTool.release() );
67 
68  return StatusCode::SUCCESS;
69 }

◆ initialize()

StatusCode TriggerSelectionAlg::initialize ( )
virtual

Athena algorithm's initalize hook.

Definition at line 37 of file TriggerSelectionAlg.cxx.

38 {
39  ATH_MSG_DEBUG ("Initializing " << name() << "...");
40 
41  // Print the configuration to the log file
42  ATH_MSG_DEBUG( "Using: " << m_trigDecisionTool );
43  ATH_MSG_DEBUG( "Using: " << m_triggerList );
44  ATH_MSG_DEBUG( "Using: " << m_decoEvtInfo );
45  ATH_MSG_DEBUG( "Using: " << m_evtInfoName );
46  ATH_MSG_DEBUG( "Using: " << m_varPrefix );
47  ATH_MSG_DEBUG( "Using: " << m_storePrescaleInfo );
48 
49  // Retrieve the TrigDecisionTool
50  ATH_CHECK(m_trigDecisionTool.retrieve());
51 
52  // Create the list of decoration variables
53  for ( const std::string& trigName : m_triggerList.value() ){
54  m_varNameList.push_back( m_varPrefix.value() + trigName );
55  }
56 
57  return StatusCode::SUCCESS;
58 }

◆ inputHandles()

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

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

◆ msgLvl()

bool AthCommonMsg< 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< 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< Algorithm > >::renounce ( T &  h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

◆ renounceArray()

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

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364  {
365  handlesArray.renounce();
366  }

◆ setFilterDescription()

void AthFilterAlgorithm::setFilterDescription ( const std::string &  descr)
inherited

helper method to ease the setting of this filter's description in derived classes Note that this method should be called in the c-tor of derived classes

helper function to ease the setting of this filter's description in derived classes

Definition at line 118 of file AthFilterAlgorithm.cxx.

119 {
120  if( cutFlowSvc()==0 ){
122  }
123  else if( m_resetSelfDescription and cutID() ){
124  cutFlowSvc()->setFilterDescription(cutID(),descr);
125  }
126  else{
127  ATH_MSG_INFO("problem setting filter description with cutflow-svc");
128  }
129 
130  return;
131 }

◆ setFilterPassed()

void AthFilterAlgorithm::setFilterPassed ( bool  state) const
virtualinherited

Set the filter passed flag to the specified state.

Definition at line 99 of file AthFilterAlgorithm.cxx.

100 {
101  AthAlgorithm::setFilterPassed(state);
102 
103  if (state) {
104  const EventContext& ctx = Gaudi::Hive::currentContext();
106  // Only try to access the mcEventWeight if we are running on Monte Carlo, duhhh!
107  if ( evtInfo->eventType(xAOD::EventInfo::IS_SIMULATION) ) {
108  m_cutFlowSvc->addEvent(m_cutID, evtInfo->mcEventWeights());
109  } else {
110  m_cutFlowSvc->addEvent(m_cutID, 1.0);
111  }
112  }
113 }

◆ sysInitialize()

StatusCode AthFilterAlgorithm::sysInitialize ( )
overridevirtualinherited

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Reimplemented from AthAlgorithm.

Definition at line 65 of file AthFilterAlgorithm.cxx.

66 {
67  // ---- stolen from GaudiKernel/Algorithm::sysInitialize -------
68  // Bypass the initialization if the algorithm
69  // has already been initialized.
70  if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
71 
72  // Set the Algorithm's properties
73  bindPropertiesTo( serviceLocator()->getOptsSvc() );
74 
75  // Bypass the initialization if the algorithm is disabled.
76  // Need to do this after bindPropertiesTo.
77  if ( !isEnabled( ) ) return StatusCode::SUCCESS;
78 
79  // ---- stolen from GaudiKernel/Algorithm::sysInitialize ------- END ---
80 
81  // register ourselves with the cutFlowSvc
82  if ( cutFlowSvc().retrieve().isSuccess()) {
83  m_cutID = cutFlowSvc()->registerFilter(this->name(), m_filterDescr, false);
84  if (0 == m_cutID) {
85  ATH_MSG_INFO("problem registering myself with cutflow-svc");
86  } else {
87  ATH_MSG_VERBOSE("registered with cutflow-svc");
88  }
89  }
90 
92 
93  // re-direct to base class...
95 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< 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< 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) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_cutFlowSvc

ICutFlowSvc_t AthFilterAlgorithm::m_cutFlowSvc
privateinherited

handle to the service holding tables of cut-flows for filtering algs.

Definition at line 86 of file AthFilterAlgorithm.h.

◆ m_cutID

CutIdentifier AthFilterAlgorithm::m_cutID
privateinherited

The CutIdentifier for this filter algorithm.

Definition at line 82 of file AthFilterAlgorithm.h.

◆ m_decoEvtInfo

BooleanProperty TriggerSelectionAlg::m_decoEvtInfo
private

Decide if we also want to decorate the xAOD::EventInfo object with the pass/fail information.

Definition at line 60 of file TriggerSelectionAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> AthFilterAlgorithm::m_eventInfoKey { this, "EventInfoKey", "EventInfo", "" }
privateinherited

Definition at line 96 of file AthFilterAlgorithm.h.

◆ m_evtInfoName

StringProperty TriggerSelectionAlg::m_evtInfoName
private

Name of the xAOD::EventInfo object that we want to decorate.

Definition at line 63 of file TriggerSelectionAlg.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects
privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_filterDescr

std::string AthFilterAlgorithm::m_filterDescr
privateinherited

filter description: describes what this filter does.

this is usually pushed to the ICutFlowSvc

Definition at line 90 of file AthFilterAlgorithm.h.

◆ m_resetSelfDescription

bool AthFilterAlgorithm::m_resetSelfDescription
privateinherited

Definition at line 93 of file AthFilterAlgorithm.h.

◆ m_storePrescaleInfo

BooleanProperty TriggerSelectionAlg::m_storePrescaleInfo
private

Decide if we also want to decorate the xAOD::EventInfo object with the (full-chain) prescale information.

Definition at line 69 of file TriggerSelectionAlg.h.

◆ m_trigDecisionTool

ToolHandle<Trig::TrigDecisionTool> TriggerSelectionAlg::m_trigDecisionTool
private

The ToolHandle for the TrigDecisionTool.

Definition at line 54 of file TriggerSelectionAlg.h.

◆ m_triggerList

StringArrayProperty TriggerSelectionAlg::m_triggerList
private

The list of triggers to cut on.

Definition at line 57 of file TriggerSelectionAlg.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_varNameList

std::vector<std::string> TriggerSelectionAlg::m_varNameList
private

The list of all variables names.

Definition at line 77 of file TriggerSelectionAlg.h.

◆ m_varPrefix

StringProperty TriggerSelectionAlg::m_varPrefix
private

Prefix used for the decoration variables.

Definition at line 66 of file TriggerSelectionAlg.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
AthFilterAlgorithm::setFilterPassed
virtual void setFilterPassed(bool state) const
Set the filter passed flag to the specified state.
Definition: AthFilterAlgorithm.cxx:99
ATH_MSG_FATAL
#define ATH_MSG_FATAL(x)
Definition: AthMsgStreamMacros.h:34
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
AthFilterAlgorithm::m_eventInfoKey
SG::ReadHandleKey< xAOD::EventInfo > m_eventInfoKey
Definition: AthFilterAlgorithm.h:97
SG::ReadHandle
Definition: StoreGate/StoreGate/ReadHandle.h:70
AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
AthFilterAlgorithm::cutID
CutIdentifier cutID()
return the CutIdentifier corresponding to the top-level cut of this filter algorithm
Definition: AthFilterAlgorithm.h:116
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
ATH_MSG_VERBOSE
#define ATH_MSG_VERBOSE(x)
Definition: AthMsgStreamMacros.h:28
xAOD::EventInfo_v1::IS_SIMULATION
@ IS_SIMULATION
true: simulation, false: data
Definition: EventInfo_v1.h:151
AthFilterAlgorithm::m_filterDescr
std::string m_filterDescr
filter description: describes what this filter does.
Definition: AthFilterAlgorithm.h:90
TriggerSelectionAlg::m_varPrefix
StringProperty m_varPrefix
Prefix used for the decoration variables.
Definition: TriggerSelectionAlg.h:66
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
TriggerSelectionAlg::m_varNameList
std::vector< std::string > m_varNameList
The list of all variables names.
Definition: TriggerSelectionAlg.h:77
python.setupRTTAlg.size
int size
Definition: setupRTTAlg.py:39
AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
AthFilterAlgorithm::m_cutFlowSvc
ICutFlowSvc_t m_cutFlowSvc
handle to the service holding tables of cut-flows for filtering algs.
Definition: AthFilterAlgorithm.h:86
AthCommonDataStore
Definition: AthCommonDataStore.h:52
AthAlgorithm::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition: AthAlgorithm.cxx:66
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
SG::Decorator
Helper class to provide type-safe access to aux data.
Definition: Decorator.h:58
lumiFormat.i
int i
Definition: lumiFormat.py:92
AthFilterAlgorithm::AthFilterAlgorithm
AthFilterAlgorithm()
Default constructor:
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
TriggerSelectionAlg::m_triggerList
StringArrayProperty m_triggerList
The list of triggers to cut on.
Definition: TriggerSelectionAlg.h:57
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
TriggerSelectionAlg::m_evtInfoName
StringProperty m_evtInfoName
Name of the xAOD::EventInfo object that we want to decorate.
Definition: TriggerSelectionAlg.h:63
python.TransformConfig.descr
descr
print "%s.properties()" % self.__name__
Definition: TransformConfig.py:360
TriggerSelectionAlg::m_decoEvtInfo
BooleanProperty m_decoEvtInfo
Decide if we also want to decorate the xAOD::EventInfo object with the pass/fail information.
Definition: TriggerSelectionAlg.h:60
AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
SG::VarHandleKey::initialize
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
Definition: AthToolSupport/AsgDataHandles/Root/VarHandleKey.cxx:103
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
AthFilterAlgorithm::m_resetSelfDescription
bool m_resetSelfDescription
Definition: AthFilterAlgorithm.h:93
TriggerSelectionAlg::m_trigDecisionTool
ToolHandle< Trig::TrigDecisionTool > m_trigDecisionTool
The ToolHandle for the TrigDecisionTool.
Definition: TriggerSelectionAlg.h:54
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:195
xAOD::EventInfo_v1
Class describing the basic event information.
Definition: EventInfo_v1.h:43
AthFilterAlgorithm::m_cutID
CutIdentifier m_cutID
The CutIdentifier for this filter algorithm.
Definition: AthFilterAlgorithm.h:82
AthAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Definition: AthAlgorithm.h:79
a
TList * a
Definition: liststreamerinfos.cxx:10
h
AthFilterAlgorithm::cutFlowSvc
ServiceHandle< ICutFlowSvc > & cutFlowSvc()
return a handle to an ICutFlowSvc instance
Definition: AthFilterAlgorithm.h:108
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
TriggerSelectionAlg::m_storePrescaleInfo
BooleanProperty m_storePrescaleInfo
Decide if we also want to decorate the xAOD::EventInfo object with the (full-chain) prescale informat...
Definition: TriggerSelectionAlg.h:69
fitman.k
k
Definition: fitman.py:528