ATLAS Offline Software
Loading...
Searching...
No Matches
HI::HIEventSelectionToolRun3 Class Reference

#include <HIEventSelectionToolRun3.h>

Inheritance diagram for HI::HIEventSelectionToolRun3:
Collaboration diagram for HI::HIEventSelectionToolRun3:

Public Member Functions

 HIEventSelectionToolRun3 (const std::string &name)
virtual ~HIEventSelectionToolRun3 ()=default
virtual StatusCode initialize () override
 Dummy implementation of the initialisation function.
virtual bool noDetectorError (const xAOD::EventInfo *eventInfo) const override
 Checks basic event flags.
virtual bool puZDCvsFCal (HI::IonDataType when, const xAOD::HIEventShapeContainer *es, const xAOD::ZdcModuleContainer *zdcModules, HI::PileupVariation variation) const override
 true if this is pileup event It computes necessary quantities and invokes method defined next to perform actual selection
virtual bool puZDCvsFCal (IonDataType dataType, float fcalEt, float zdcE, PileupVariation variation=PileupVariation::Nominal) const override
 true if this is pileup event
virtual bool puNtrkvsFCal (IonDataType dataType, float fcalEt, int ntrk, PileupVariation variation=PileupVariation::Nominal) const override
 true if this is pileup event
virtual bool puZDCPSvsFCal (IonDataType dataType, float fcalEt, float presamplerA, float presamplerC, PileupVariation variation=PileupVariation::Nominal) const override
 true if this is pileup event Code sample to obtain presampler energies Float_t PreSamplerAmp_A = 0; Float_t PreSamplerAmp_C = 0; xAOD::ZdcModuleContainer * zdcModules = 0; CHECK( evtStore()->retrieve(zdcModules, "ZdcModules") ); for (const auto ZdcModule : *zdcModules) { if (ZdcModule->zdcType()!=0) continue; if (ZdcModule->zdcSide()>0) PreSamplerAmp_C+=accPreSamplerAmpC(*ZdcModule); if (ZdcModule->zdcSide()<0) PreSamplerAmp_A+=accPreSamplerAmpA(*ZdcModule); }
virtual bool puOOVertexCuts (IonDataType dataType, const xAOD::VertexContainer *vertices) const override
 true if this is pileup event
virtual IonDataType toDataType (const xAOD::EventInfo *eventInfo) const override
 translates info in EV into HI data type
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

float zdcCutValue (IonDataType, float fcalEt, PileupVariation) const
float ntrkCutValue (IonDataType, float fcalEt, PileupVariation) const
IonDataType runNumberToDataType (uint32_t run) const
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

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 14 of file HIEventSelectionToolRun3.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

◆ HIEventSelectionToolRun3()

HI::HIEventSelectionToolRun3::HIEventSelectionToolRun3 ( const std::string & name)

Definition at line 46 of file HIEventSelectionToolRun3.cxx.

47 : AsgTool(name) {}
AsgTool(const std::string &name)
Constructor specifying the tool instance's name.
Definition AsgTool.cxx:58

◆ ~HIEventSelectionToolRun3()

virtual HI::HIEventSelectionToolRun3::~HIEventSelectionToolRun3 ( )
virtualdefault

Member Function Documentation

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

◆ initialize()

StatusCode HI::HIEventSelectionToolRun3::initialize ( void )
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 49 of file HIEventSelectionToolRun3.cxx.

49 {
50 ATH_MSG_INFO("Initializing HIEventSelectionToolRun3");
51 // add printout of overall selection that is configured
52 return StatusCode::SUCCESS;
53}
#define ATH_MSG_INFO(x)

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

◆ noDetectorError()

bool HI::HIEventSelectionToolRun3::noDetectorError ( const xAOD::EventInfo * eventInfo) const
overridevirtual

Checks basic event flags.

Parameters
eventInfo
Returns
true if no error

Implements HI::IHIEventSelectionToolRun3.

Definition at line 55 of file HIEventSelectionToolRun3.cxx.

56 {
57 if (!eventInfo)
58 return false;
59
60 // Standard ATLAS error checks
62 return false;
64 return false;
66 return false;
68 return false;
69
70 return true;
71}
@ Tile
The Tile calorimeter.
@ Pixel
The pixel tracker.
@ LAr
The LAr calorimeter.
@ Error
The sub-detector issued an error.
EventFlagErrorState errorState(EventFlagSubDet subDet) const
Get the error state for a particular sub-detector.

◆ ntrkCutValue()

float HI::HIEventSelectionToolRun3::ntrkCutValue ( HI::IonDataType ,
float fcalEt,
HI::PileupVariation  ) const
private

Definition at line 189 of file HIEventSelectionToolRun3.cxx.

190 {
191 return 0;
192}

◆ 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()

◆ puNtrkvsFCal()

bool HI::HIEventSelectionToolRun3::puNtrkvsFCal ( IonDataType dataType,
float fcalEt,
int ntrk,
PileupVariation variation = PileupVariation::Nominal ) const
overridevirtual

true if this is pileup event

Implements HI::IHIEventSelectionToolRun3.

Definition at line 105 of file HIEventSelectionToolRun3.cxx.

107 {
108 const float cut = ntrkCutValue(when, fcalEt, variation);
109 return ntrk < cut;
110}
float ntrkCutValue(IonDataType, float fcalEt, PileupVariation) const
cut
This script demonstrates how to call a C++ class from Python Also how to use PyROOT is shown.

◆ puOOVertexCuts()

bool HI::HIEventSelectionToolRun3::puOOVertexCuts ( IonDataType dataType,
const xAOD::VertexContainer * vertices ) const
overridevirtual

true if this is pileup event

Implements HI::IHIEventSelectionToolRun3.

Definition at line 139 of file HIEventSelectionToolRun3.cxx.

140 {
141 if (!vertices)
142 return false;
143
144 unsigned int nPrimary = 0;
145 for (const xAOD::Vertex* vx : *vertices) {
146 if (vx->vertexType() == xAOD::VxType::PriVtx)
147 ++nPrimary;
148 }
149
150 // Typical HI requirement: exactly one PV
151 return (nPrimary == 1);
152}
@ PriVtx
Primary vertex.
Vertex_v1 Vertex
Define the latest version of the vertex class.

◆ puZDCPSvsFCal()

bool HI::HIEventSelectionToolRun3::puZDCPSvsFCal ( IonDataType dataType,
float fcalEt,
float presamplerA,
float presamplerC,
PileupVariation variation = PileupVariation::Nominal ) const
overridevirtual

true if this is pileup event Code sample to obtain presampler energies Float_t PreSamplerAmp_A = 0; Float_t PreSamplerAmp_C = 0; xAOD::ZdcModuleContainer * zdcModules = 0; CHECK( evtStore()->retrieve(zdcModules, "ZdcModules") ); for (const auto ZdcModule : *zdcModules) { if (ZdcModule->zdcType()!=0) continue; if (ZdcModule->zdcSide()>0) PreSamplerAmp_C+=accPreSamplerAmpC(*ZdcModule); if (ZdcModule->zdcSide()<0) PreSamplerAmp_A+=accPreSamplerAmpA(*ZdcModule); }

Implements HI::IHIEventSelectionToolRun3.

Definition at line 112 of file HIEventSelectionToolRun3.cxx.

114 {
115 // not sure if fcalEt will be involved i.e. apply this cut only above certain
116 // fcalEt
117
118 if (when == HI::IonDataType::PbPb2023) {
119 // from ATL-COM-PHYS-2025-033 + priv. communication F.Pauwels
120 const float peakPositionA = -56;
121 const float peakPositionC = -156;
122 const float peakWidthA = 51.8;
123 const float peakWidthC = 51.8;
124 float sigma = 7;
125 if (variation == HI::PileupVariation::Tight) {
126 sigma = 8;
127 }
128 if (variation == HI::PileupVariation::Loose) {
129 sigma = 6;
130 }
131 if (presamplerA > (peakPositionA + sigma * peakWidthA) and
132 presamplerC > (peakPositionC + sigma * peakWidthC)) {
133 return true; // it is pileup
134 }
135 }
136 return false;
137}

◆ puZDCvsFCal() [1/2]

bool HI::HIEventSelectionToolRun3::puZDCvsFCal ( HI::IonDataType when,
const xAOD::HIEventShapeContainer * es,
const xAOD::ZdcModuleContainer * zdcModules,
HI::PileupVariation variation ) const
overridevirtual

true if this is pileup event It computes necessary quantities and invokes method defined next to perform actual selection

Implements HI::IHIEventSelectionToolRun3.

Definition at line 91 of file HIEventSelectionToolRun3.cxx.

94 {
95 return puZDCvsFCal(when, calcFcalEt(es), calcZDCE(zdcModules), variation);
96}
float calcZDCE(const xAOD::ZdcModuleContainer *zdcModules)
float calcFcalEt(const xAOD::HIEventShapeContainer *es)
virtual bool puZDCvsFCal(HI::IonDataType when, const xAOD::HIEventShapeContainer *es, const xAOD::ZdcModuleContainer *zdcModules, HI::PileupVariation variation) const override
true if this is pileup event It computes necessary quantities and invokes method defined next to perf...

◆ puZDCvsFCal() [2/2]

bool HI::HIEventSelectionToolRun3::puZDCvsFCal ( IonDataType dataType,
float fcalEt,
float zdcE,
PileupVariation variation = PileupVariation::Nominal ) const
overridevirtual

true if this is pileup event

Implements HI::IHIEventSelectionToolRun3.

Definition at line 98 of file HIEventSelectionToolRun3.cxx.

100 {
101 const float cut = zdcCutValue(when, fcalEt, variation);
102 return zdcE > cut;
103}
float zdcCutValue(IonDataType, float fcalEt, PileupVariation) const

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

◆ runNumberToDataType()

HI::IonDataType HI::HIEventSelectionToolRun3::runNumberToDataType ( uint32_t run) const
private

Definition at line 199 of file HIEventSelectionToolRun3.cxx.

200 {
201 if (run < 365498)
202 throw std::runtime_error(std::to_string(run) +
203 " not handled by selection tool");
204 if (run <= 367384)
206 if (run <= 461633)
208 if (run <= 489691)
210 if (run <= 490223)
212 if (run <= 501969)
214 if (run <= 502008)
216 if (run <= 512049)
218 // fill it up with 2026
219 throw std::runtime_error(std::to_string(run) +
220 " not handled by selection tool");
221}
int run(int argc, char *argv[])

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

◆ toDataType()

HI::IonDataType HI::HIEventSelectionToolRun3::toDataType ( const xAOD::EventInfo * eventInfo) const
overridevirtual

translates info in EV into HI data type

Implements HI::IHIEventSelectionToolRun3.

Definition at line 194 of file HIEventSelectionToolRun3.cxx.

195 {
196 return runNumberToDataType(eventInfo->runNumber());
197}
IonDataType runNumberToDataType(uint32_t run) const
uint32_t runNumber() const
The current event's run number.

◆ 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

◆ zdcCutValue()

float HI::HIEventSelectionToolRun3::zdcCutValue ( HI::IonDataType when,
float fcalEt,
HI::PileupVariation variation ) const
private

Definition at line 154 of file HIEventSelectionToolRun3.cxx.

155 {
156 if (fcalEt > 100.0)
157 throw std::runtime_error(
158 std::to_string(fcalEt) +
159 " the energy that is given to zdcCutValue is well above 100 TeV?, "
160 "likely you call it not converting energy to TeV");
161
162 if (when == HI::IonDataType::PbPb2023) {
163
164 auto cutFunction = [](float et) {
165 const static double a = 334.29, b = -20.39,
166 c = -2.38; // from ATL-COM-PHYS-2025-033
167 return a + b * et + c * et * et;
168 };
169
170 float cut = cutFunction(fcalEt);
171 if (fcalEt <= 1.0) // below 1 TeV use flat
172 cut = cutFunction(1.0);
173 if (fcalEt >= 4.0) // below 1 TeV use flat
174 cut = cutFunction(4.0);
175
176 if (variation == HI::PileupVariation::Tight) {
177 cut *= 1.02;
178 }
179 if (variation == HI::PileupVariation::Loose) {
180 cut *= 0.98;
181 }
182 return cut;
183 }
184 throw std::runtime_error(std::string("period of id ") + HI::toString(when) +
185 "is not handled");
186 ;
187 return 0;
188}
float et(const xAOD::jFexSRJetRoI *j)
static Double_t a
std::string toString(IonDataType)

Member Data Documentation

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