ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
HI::HIEventSelectionTool Class Referenceabstract

#include <HIEventSelectionTool.h>

Inheritance diagram for HI::HIEventSelectionTool:
Collaboration diagram for HI::HIEventSelectionTool:

Public Member Functions

 HIEventSelectionTool (const std::string &name="HIEventSelection")
 
virtual ~HIEventSelectionTool ()
 
virtual StatusCode initialize () override
 Dummy implementation of the initialisation function. More...
 
virtual StatusCode finalize () override
 
virtual const asg::AcceptInfogetAcceptInfo () const override
 
void checkMBTSTime (asg::AcceptData &acceptData) const
 
bool isGoodMBTSTime () const
 
void checkVertex (asg::AcceptData &acceptData) const
 
unsigned int getNPrimaryVertices () const
 
std::string dumpSelection () const
 
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
 

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< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

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

const std::string m_name
 
asg::AcceptInfo m_accept
 
bool m_checkTime = false
 
float m_timeCut = -1
 
ToolHandle< HI::IHIVertexSelectionToolm_vertexSelectionTool
 
ToolHandle< HI::IHIPileupToolm_hiPileupTool
 
float m_vtx_min_sumPt = -1
 
int m_vtx_min_nTrk = -1
 
bool m_exclusive_mode = false
 
bool m_reject_pileup = true
 
std::string m_track_cutlevel = "NoCut"
 
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
 

Static Private Attributes

static const std::string m_MBTS_CNAME ="MBTSContainer"
 
static const std::string m_FWD_CNAME ="MBTSForwardEventInfo"
 
static const std::string m_VERTEX_CNAME ="PrimaryVertices"
 
static const std::string m_SHAPE_CNAME ="CaloSums"
 
static const std::string m_ZDC_CNAME ="ZdcModules"
 

Detailed Description

Definition at line 17 of file HIEventSelectionTool.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

◆ HIEventSelectionTool()

HI::HIEventSelectionTool::HIEventSelectionTool ( const std::string &  name = "HIEventSelection")

Definition at line 26 of file HIEventSelectionTool.cxx.

26  : asg::AsgTool(name),
27  m_name(name),
28  m_accept("HIEventSelection"),
30  m_hiPileupTool("")
31  {
32  // MBTS timing cut
33  declareProperty("TimeCut",m_timeCut,"maximum DeltaT cut for MBTS timing cut");
34  // Vertex
35  declareProperty("VertexSumPtCut",m_vtx_min_sumPt,"Minimum sum pT from good tracks for a good vertex");
36  declareProperty("VertexNtrkCut",m_vtx_min_nTrk,"Minimum number good tracks for a good vertex");
37  declareProperty("RejectPileup",m_reject_pileup,"If true, cut on events w/ pileup applied");
38  declareProperty("ExclusiveMode",m_exclusive_mode,"returns at first failure (for speed), doesn't evaluate subsequent cuts");
39  declareProperty("VertexSelectionTool",m_vertexSelectionTool);
40  declareProperty("PileupTool",m_hiPileupTool);
41 
42  ATH_MSG_DEBUG("Creating HIEventSelectionTool named" << m_name);
43  }

◆ ~HIEventSelectionTool()

HI::HIEventSelectionTool::~HIEventSelectionTool ( )
virtual

Definition at line 45 of file HIEventSelectionTool.cxx.

46  {
47  ATH_MSG_DEBUG(Form("Deleting HIEventSelectionTool named %s",m_name.c_str()));
48  }

Member Function Documentation

◆ checkMBTSTime()

void HI::HIEventSelectionTool::checkMBTSTime ( asg::AcceptData acceptData) const

Definition at line 104 of file HIEventSelectionTool.cxx.

105  {
106  const xAOD::ForwardEventInfoContainer* forwardEventInfoContainer = 0;
107  if(evtStore()->retrieve(forwardEventInfoContainer,m_FWD_CNAME).isFailure())
108  {
109  ATH_MSG_ERROR("Could not retrieve ForwardEventInfo object w/ name " << m_FWD_CNAME);
110  return;
111  }
112 
113  acceptData.setCutResult("goodMBTSTime",false);
114  const xAOD::ForwardEventInfo* forwardEventInfo = forwardEventInfoContainer->at(0);
115  int countA = forwardEventInfo->countA();
116  int countC = forwardEventInfo->countC();
117  float timeA = forwardEventInfo->timeA();
118  float timeC = forwardEventInfo->timeC();
119 
120  if (countA==0||countC==0) return; // if either time undefined, return false;
121 
122  float timeDiff = timeA - timeC;
123 
124  if ( (std::abs(timeDiff)<m_timeCut) ) acceptData.setCutResult("goodMBTSTime",true);
125 
126  return;
127  }

◆ checkVertex()

void HI::HIEventSelectionTool::checkVertex ( asg::AcceptData acceptData) const

Definition at line 147 of file HIEventSelectionTool.cxx.

148  {
149  unsigned int numPrimaryVertices=getNPrimaryVertices();
150  acceptData.setCutResult("hasPrimaryVertex", (numPrimaryVertices > 0) );
151 
152  const xAOD::ZdcModuleContainer* zdcMod = 0;
153  if(evtStore()->retrieve(zdcMod,m_ZDC_CNAME).isFailure())
154  {
155  ATH_MSG_ERROR("Could not retrieve ZdcModule object w/ name " << m_ZDC_CNAME);
156  return;
157  }
158 
159  const xAOD::HIEventShapeContainer* hiev = 0;
160  if(evtStore()->retrieve(hiev,m_SHAPE_CNAME).isFailure())
161  {
162  ATH_MSG_ERROR("Could not retrieve HIEventShape object w/ name " << m_SHAPE_CNAME);
163  return;
164  }
165 
166  if (m_reject_pileup) acceptData.setCutResult("pileupVeto", m_hiPileupTool->is_pileup( *hiev, *zdcMod ));
167  else acceptData.setCutResult("pileupVeto", true );
168 
169 
170  return;
171  }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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; }

◆ dumpSelection()

std::string HI::HIEventSelectionTool::dumpSelection ( ) const

Definition at line 131 of file HIEventSelectionTool.cxx.

132  {
133  asg::AcceptData acceptData ( &m_accept );
134  std::stringstream ss;
135  for(unsigned int icut=0; icut < acceptData.getNCuts(); icut++)
136  {
137  std::string cname=acceptData.getCutName(icut);
138  ss << std::setw(15) << cname
139  << std::setw(10) << acceptData.getCutResult(cname)
140  << std::setw(40) << acceptData.getCutDescription(cname)
141  << std::endl;
142  }
143  return ss.str();
144  }

◆ evtStore() [1/2]

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.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

◆ 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

◆ finalize()

StatusCode HI::HIEventSelectionTool::finalize ( )
overridevirtual

Implements HI::IHIEventSelectionTool.

Definition at line 85 of file HIEventSelectionTool.cxx.

86 {
87 
88  ATH_MSG_INFO( "Finalizing event selection tool." );
89  return StatusCode::SUCCESS;
90 
91 }

◆ getAcceptInfo()

const asg::AcceptInfo & HI::HIEventSelectionTool::getAcceptInfo ( ) const
overridevirtual

Implements HI::IHIEventSelectionTool.

Definition at line 93 of file HIEventSelectionTool.cxx.

94  {
95  asg::AcceptData acceptData ( &m_accept );
96  if(m_checkTime){
97  checkMBTSTime( acceptData );
98  }
99  checkVertex( acceptData );
100  return m_accept;
101  }

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

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

◆ getNPrimaryVertices()

unsigned int HI::HIEventSelectionTool::getNPrimaryVertices ( ) const

Definition at line 174 of file HIEventSelectionTool.cxx.

175  {
176  unsigned int nPriVx = 0;
177 
178  const xAOD::VertexContainer* pv_container = 0;
179  if(evtStore()->retrieve(pv_container,m_VERTEX_CNAME).isFailure())
180  {
181  ATH_MSG_ERROR("Could not retrieve VertexContainer object w/ name " << m_VERTEX_CNAME);
182  return 0;
183  }
184  //if( pv_container->size() < 2) return 0;
185 
186  for(const auto vert: *pv_container)
187  {
188  if (m_vertexSelectionTool->accept(*vert)) nPriVx++;
189  }
190 
191  return nPriVx;
192 
193  }

◆ getProperty()

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

Get one of the tool's properties.

◆ initialize()

StatusCode HI::HIEventSelectionTool::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 50 of file HIEventSelectionTool.cxx.

51  {
52  if (m_timeCut > 0.) {
53  m_checkTime = true;
54  ATH_MSG_INFO( "Maximum delta t = " << m_timeCut );
55  m_accept.addCut("goodMBTSTime","good MBTS timing");
56  }
57 
58  m_accept.addCut("hasPrimaryVertex","has at least one primary vertex");
59 
60  m_accept.addCut("pileupVeto","reject events with topological features indicating pileup");
61 
62  if (m_vertexSelectionTool.empty())
63  {
64 #ifdef ROOTCORE
65  HI::HIVertexSelectionTool* vxSelTool = new HIVertexSelectionTool("HIVxSel");
66  ATH_CHECK( vxSelTool->initialize() );
67  m_vertexSelectionTool = ToolHandle<HI::IHIVertexSelectionTool>(vxSelTool);
68 #endif
69  }
70  ATH_CHECK( m_vertexSelectionTool.retrieve() );
71 
72  if (m_hiPileupTool.empty())
73  {
74 #ifdef ROOTCORE
75  HI::HIPileupTool* m_hipileuptool = new HIPileupTool("HIpileup");
76  ATH_CHECK( m_hipileuptool->initialize() );
77  m_hiPileupTool = ToolHandle<HI::IHIPileupTool>(m_hipileuptool);
78 #endif
79  }
80  ATH_CHECK( m_hiPileupTool.retrieve() );
81 
82  return StatusCode::SUCCESS;
83  }

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

◆ isGoodMBTSTime()

bool HI::HIEventSelectionTool::isGoodMBTSTime ( ) const

◆ msg() [1/2]

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msg() [2/2]

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

Definition at line 27 of file AthCommonMsg.h.

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

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

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

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

◆ 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();
383  PBASE::renounce (h);
384  }

◆ 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  {
365  handlesArray.renounce();
366  }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

Member Data Documentation

◆ m_accept

asg::AcceptInfo HI::HIEventSelectionTool::m_accept
private

Definition at line 50 of file HIEventSelectionTool.h.

◆ m_checkTime

bool HI::HIEventSelectionTool::m_checkTime = false
private

Definition at line 53 of file HIEventSelectionTool.h.

◆ 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_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_exclusive_mode

bool HI::HIEventSelectionTool::m_exclusive_mode = false
private

Definition at line 61 of file HIEventSelectionTool.h.

◆ m_FWD_CNAME

const std::string HI::HIEventSelectionTool::m_FWD_CNAME ="MBTSForwardEventInfo"
staticprivate

Definition at line 44 of file HIEventSelectionTool.h.

◆ m_hiPileupTool

ToolHandle<HI::IHIPileupTool> HI::HIEventSelectionTool::m_hiPileupTool
private

Definition at line 58 of file HIEventSelectionTool.h.

◆ m_MBTS_CNAME

const std::string HI::HIEventSelectionTool::m_MBTS_CNAME ="MBTSContainer"
staticprivate

Definition at line 43 of file HIEventSelectionTool.h.

◆ m_name

const std::string HI::HIEventSelectionTool::m_name
private

Definition at line 49 of file HIEventSelectionTool.h.

◆ m_reject_pileup

bool HI::HIEventSelectionTool::m_reject_pileup = true
private

Definition at line 62 of file HIEventSelectionTool.h.

◆ m_SHAPE_CNAME

const std::string HI::HIEventSelectionTool::m_SHAPE_CNAME ="CaloSums"
staticprivate

Definition at line 46 of file HIEventSelectionTool.h.

◆ m_timeCut

float HI::HIEventSelectionTool::m_timeCut = -1
private

Definition at line 54 of file HIEventSelectionTool.h.

◆ m_track_cutlevel

std::string HI::HIEventSelectionTool::m_track_cutlevel = "NoCut"
private

Definition at line 63 of file HIEventSelectionTool.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_VERTEX_CNAME

const std::string HI::HIEventSelectionTool::m_VERTEX_CNAME ="PrimaryVertices"
staticprivate

Definition at line 45 of file HIEventSelectionTool.h.

◆ m_vertexSelectionTool

ToolHandle<HI::IHIVertexSelectionTool> HI::HIEventSelectionTool::m_vertexSelectionTool
private

Definition at line 57 of file HIEventSelectionTool.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.

◆ m_vtx_min_nTrk

int HI::HIEventSelectionTool::m_vtx_min_nTrk = -1
private

Definition at line 60 of file HIEventSelectionTool.h.

◆ m_vtx_min_sumPt

float HI::HIEventSelectionTool::m_vtx_min_sumPt = -1
private

Definition at line 59 of file HIEventSelectionTool.h.

◆ m_ZDC_CNAME

const std::string HI::HIEventSelectionTool::m_ZDC_CNAME ="ZdcModules"
staticprivate

Definition at line 47 of file HIEventSelectionTool.h.


The documentation for this class was generated from the following files:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
xAOD::ForwardEventInfo_v1::countC
unsigned short countC() const
HI::HIEventSelectionTool::getNPrimaryVertices
unsigned int getNPrimaryVertices() const
Definition: HIEventSelectionTool.cxx:174
HI::HIEventSelectionTool::m_name
const std::string m_name
Definition: HIEventSelectionTool.h:49
HI::HIEventSelectionTool::checkMBTSTime
void checkMBTSTime(asg::AcceptData &acceptData) const
Definition: HIEventSelectionTool.cxx:104
HI::HIEventSelectionTool::m_vertexSelectionTool
ToolHandle< HI::IHIVertexSelectionTool > m_vertexSelectionTool
Definition: HIEventSelectionTool.h:57
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition: AsgTool.h:47
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
PowhegControl_ttHplus_NLO.ss
ss
Definition: PowhegControl_ttHplus_NLO.py:83
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
HI::HIPileupTool
Definition: HIPileupTool.h:27
HI::HIEventSelectionTool::m_ZDC_CNAME
static const std::string m_ZDC_CNAME
Definition: HIEventSelectionTool.h:47
HI::HIEventSelectionTool::m_accept
asg::AcceptInfo m_accept
Definition: HIEventSelectionTool.h:50
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
HI::HIEventSelectionTool::m_hiPileupTool
ToolHandle< HI::IHIPileupTool > m_hiPileupTool
Definition: HIEventSelectionTool.h:58
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
HI::HIEventSelectionTool::m_FWD_CNAME
static const std::string m_FWD_CNAME
Definition: HIEventSelectionTool.h:44
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
HI::HIEventSelectionTool::m_VERTEX_CNAME
static const std::string m_VERTEX_CNAME
Definition: HIEventSelectionTool.h:45
xAOD::ForwardEventInfo_v1::timeC
float timeC() const
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
HI::HIEventSelectionTool::m_checkTime
bool m_checkTime
Definition: HIEventSelectionTool.h:53
HI::HIEventSelectionTool::m_reject_pileup
bool m_reject_pileup
Definition: HIEventSelectionTool.h:62
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
HI::HIVertexSelectionTool
Definition: HIVertexSelectionTool.h:19
python.xAODType.dummy
dummy
Definition: xAODType.py:4
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
HI::HIEventSelectionTool::m_vtx_min_sumPt
float m_vtx_min_sumPt
Definition: HIEventSelectionTool.h:59
xAOD::ForwardEventInfo_v1::timeA
float timeA() const
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
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
HI::HIVertexSelectionTool::initialize
virtual StatusCode initialize() override
Dummy implementation of the initialisation function.
Definition: HIVertexSelectionTool.cxx:29
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
HI::HIEventSelectionTool::m_timeCut
float m_timeCut
Definition: HIEventSelectionTool.h:54
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
HI::HIEventSelectionTool::m_vtx_min_nTrk
int m_vtx_min_nTrk
Definition: HIEventSelectionTool.h:60
a
TList * a
Definition: liststreamerinfos.cxx:10
asg::AcceptData::setCutResult
void setCutResult(const std::string &cutName, bool cutResult)
Set the result of a cut, based on the cut name (safer)
Definition: AcceptData.h:134
h
xAOD::ForwardEventInfo_v1::countA
unsigned short countA() const
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
xAOD::ForwardEventInfo_v1
add description
Definition: ForwardEventInfo_v1.h:17
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
HI::HIPileupTool::initialize
virtual StatusCode initialize() override
Dummy implementation of the initialisation function.
Definition: HIPileupTool.cxx:45
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
HI::HIEventSelectionTool::m_exclusive_mode
bool m_exclusive_mode
Definition: HIEventSelectionTool.h:61
DataVector::at
const T * at(size_type n) const
Access an element, as an rvalue.
HI::HIEventSelectionTool::m_SHAPE_CNAME
static const std::string m_SHAPE_CNAME
Definition: HIEventSelectionTool.h:46
asg::AcceptData
Definition: AcceptData.h:30
HI::HIEventSelectionTool::checkVertex
void checkVertex(asg::AcceptData &acceptData) const
Definition: HIEventSelectionTool.cxx:147
SG::DataProxy
Definition: DataProxy.h:44
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
fitman.k
k
Definition: fitman.py:528
asg::AcceptInfo::addCut
int addCut(const std::string &cutName, const std::string &cutDescription)
Add a cut; returning the cut position.
Definition: AcceptInfo.h:53