ATLAS Offline Software
Loading...
Searching...
No Matches
QCDTruthMultiJetFilter Class Reference

#include <QCDTruthMultiJetFilter.h>

Inheritance diagram for QCDTruthMultiJetFilter:
Collaboration diagram for QCDTruthMultiJetFilter:

Public Member Functions

 QCDTruthMultiJetFilter (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode filterInitialize ()
StatusCode filterFinalize ()
StatusCode filterEvent (const EventContext &ctx)
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual bool isClonable () const override
 Specify if the algorithm is clonable.
virtual StatusCode sysExecute (const EventContext &ctx) override
 Execute an algorithm.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
virtual bool filterPassed (const EventContext &ctx) const
 Get filter decision:
virtual void setFilterPassed (bool state, const EventContext &ctx) const
 Set filter decision:
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 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
Event loop algorithm methods: not to be overloaded
StatusCode initialize ()
StatusCode execute (const EventContext &ctx)
 Execute method.
StatusCode finalize ()
Counters
int nPassed () const
int nFailed () const
int nNeeded () const
bool keepAll () const
Event collection accessors (const and non-const)
HepMC::GenEvent *event ATLAS_NOT_CONST_THREAD_SAFE ()
 Access the current signal event (first in the McEventCollection).
McEventCollection *events ATLAS_NOT_CONST_THREAD_SAFE ()
 Access the current event's McEventCollection.
const HepMC::GenEventevent_const (const EventContext &ctx) const
 Access the current signal event (const).
const McEventCollectionevents_const (const EventContext &ctx) const
 Access the current event's McEventCollection (const).

Static Public Member Functions

static double fitFnR (const double *x, const double *)
static double fitFn (const double x)

Protected Member Functions

virtual bool isReEntrant () const override final
 Legacy algorithms are not thread-safe.
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.

Protected Attributes

Counters and requirements
int m_nPass
int m_nFail
int m_nNeeded
bool m_keepAll

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t

Private Member Functions

CLHEP::HepRandomEngine * getRandomEngine (const std::string &streamName, const EventContext &ctx) const
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

int m_Njet
 Number of truth jets required above m_NjetMinPt.
double m_NjetMinPt
 Min pT for N jets truth jets required.
double m_MinLeadJetPt
 Min pT for the leading truth jet.
double m_MaxLeadJetPt
 Max pT for the leading truth jet.
double m_MaxEta
 Max eta for the truth jets.
std::string m_TruthJetContainerName
 Name of the truth jet container.
ServiceHandle< IAthRNGSvcm_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
 Random number generator.
long m_total
 Total number of events tested.
long m_passed
 Number of events passing all cuts.
long m_ptfailed
 Number of events failing the pT cuts.
long m_nJetsFailed
 Number of events failing the nJets cuts.
double m_norm
 Normalization for weights.
double m_high
 High-side function level.
bool m_doShape
 Attempt to flatten the pT distribution.
DataObjIDColl m_extendedExtraObjects
 Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Properties

SG::ReadHandleKey< McEventCollectionm_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
 Const handle to the MC event collection.
std::string m_mcEventKey {}
 StoreGate key for the MC event collection (defaults to GEN_EVENT).
BooleanProperty m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
 Flag to determine if a new MC event collection should be made if it doesn't exist.

Detailed Description

Definition at line 17 of file QCDTruthMultiJetFilter.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ QCDTruthMultiJetFilter()

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

Definition at line 12 of file QCDTruthMultiJetFilter.cxx.

13 : GenFilter(name,pSvcLocator)
14 , m_total(0)
15 , m_passed(0)
16 , m_ptfailed(0)
17 , m_nJetsFailed(0)
18 , m_norm(1.)
19 , m_high(1.)
20{
21 declareProperty("Njet",m_Njet = -1.);
22 declareProperty("NjetMinPt",m_NjetMinPt = 0*Gaudi::Units::GeV);
23 declareProperty("MinLeadJetPt",m_MinLeadJetPt = 0*Gaudi::Units::GeV);
24 declareProperty("MaxLeadJetPt",m_MaxLeadJetPt = 7000*Gaudi::Units::GeV); // LHC kinematic limit...
25 declareProperty("MaxEta",m_MaxEta = 10.0);
26 declareProperty("TruthJetContainer", m_TruthJetContainerName = "AntiKt6TruthJets");
27 declareProperty("DoShape",m_doShape = true);
28}
Base class for event generator filtering modules.
Definition GenFilter.h:30

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )
inherited

Access the current event's McEventCollection.

Note
This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )
inlineinherited

Access the current signal event (first in the McEventCollection).

Note
This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 74 of file GenBase.h.

74 {
75 if (events()->empty())
76 ATH_MSG_ERROR("McEventCollection is empty during first event access");
77 return *(events()->begin());
78 }
#define ATH_MSG_ERROR(x)
static const Attributes_t empty

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::detStore ( ) const
inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

◆ event_const()

const HepMC::GenEvent * GenBase::event_const ( const EventContext & ctx) const
inlineinherited

Access the current signal event (const).

Definition at line 81 of file GenBase.h.

81 {
82 const McEventCollection* coll = events_const(ctx);
83 if (coll->empty())
84 ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
85 return *(coll->begin());
86 }
const_iterator begin() const noexcept
Return a const_iterator pointing at the beginning of the collection.
bool empty() const noexcept
Returns true if the collection is empty.
const McEventCollection * events_const(const EventContext &ctx) const
Access the current event's McEventCollection (const).
Definition GenBase.h:95

◆ events_const()

const McEventCollection * GenBase::events_const ( const EventContext & ctx) const
inlineinherited

Access the current event's McEventCollection (const).

Definition at line 95 of file GenBase.h.

95 {
96 SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
97 if (!ret.isValid())
98 ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
99 return ret.cptr();
100 }
SG::ReadHandleKey< McEventCollection > m_mcevents_const
Const handle to the MC event collection.
Definition GenBase.h:119
virtual bool isValid() override final
Can the handle be successfully dereferenced?
const_pointer_type cptr()
Dereference the pointer.
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())

◆ evtStore()

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

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

Definition at line 85 of file AthCommonDataStore.h.

◆ execute()

StatusCode GenFilter::execute ( const EventContext & ctx)
virtualinherited

Execute method.

Todo
Probably the filter should only look at the first event... right?

Reimplemented from GenBase.

Definition at line 27 of file GenFilter.cxx.

27 {
28 if (events_const(ctx)->empty()) {
29 ATH_MSG_ERROR("No events found in McEventCollection");
30 return StatusCode::FAILURE;
31 } else if (events_const(ctx)->size() > 1) {
33 ATH_MSG_WARNING("More than one event in current McEventCollection -- which is valid?");
34 }
36 if (filterPassed(ctx) || m_keepAll ) {
37 ATH_MSG_DEBUG("Event passed filter");
38 m_nPass += 1;
39 } else {
40 ATH_MSG_DEBUG("Event failed filter");
41 m_nFail += 1;
42 }
43 // Bail out once we have enough events
44 if (m_nPass >= m_nNeeded && m_nNeeded > 0)
45 sc = StatusCode::FAILURE;
46 return sc;
47}
#define ATH_MSG_WARNING(x)
#define ATH_MSG_DEBUG(x)
static Double_t sc
size_t size() const
Number of registered mappings.
virtual bool filterPassed(const EventContext &ctx) const
bool m_keepAll
Definition GenFilter.h:66
int m_nPass
Definition GenFilter.h:63
int m_nNeeded
Definition GenFilter.h:65
virtual StatusCode filterEvent(const EventContext &ctx)=0
int m_nFail
Definition GenFilter.h:64
::StatusCode StatusCode
StatusCode definition for legacy code.

◆ extraDeps_update_handler()

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

Return the list of extra output dependencies.

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

Definition at line 89 of file AthCommonAlgorithm.cxx.

54{
55 // If we didn't find any symlinks to add, just return the collection
56 // from the base class. Otherwise, return the extended collection.
57 if (!m_extendedExtraObjects.empty()) {
59 }
61}
Common base class for algorithms.

◆ filterEvent()

StatusCode QCDTruthMultiJetFilter::filterEvent ( const EventContext & ctx)
virtual

Implements GenFilter.

Definition at line 61 of file QCDTruthMultiJetFilter.cxx.

61 {
62 m_total++; // Bookkeeping
63
64 // Grab random number engine - this is kept with the QCDTruthJetFilter engine
65 CLHEP::HepRandomEngine* rndm = this->getRandomEngine(name(), ctx);
66 if (!rndm) {
67 ATH_MSG_WARNING("Failed to retrieve random number engine QCDTruthJetFilter");
68 setFilterPassed(false, ctx);
69 return StatusCode::SUCCESS;
70 }
71
72 // Get jet container out
73 const xAOD::JetContainer* truthjetTES = 0;
74 if (!evtStore()->contains<xAOD::JetContainer>(m_TruthJetContainerName) ||
75 evtStore()->retrieve(truthjetTES, m_TruthJetContainerName).isFailure() || !truthjetTES) {
76 ATH_MSG_ERROR("No xAOD::JetContainer found in StoreGate with key " << m_TruthJetContainerName);
77 setFilterPassed(m_MinLeadJetPt < 1, ctx);
78 return StatusCode::SUCCESS;
79 }
80
81 // Count jets above m_NjetMinPt and find pT of leading jet
82 int Njet=0;
83 double pt_lead = -1;
84 for (xAOD::JetContainer::const_iterator it_truth = (*truthjetTES).begin(); it_truth != (*truthjetTES).end() ; ++it_truth) {
85 if (!(*it_truth)) continue;
86 if (std::abs( (*it_truth)->eta() ) > m_MaxEta) continue;
87 if ((*it_truth)->pt() > m_NjetMinPt*Gaudi::Units::GeV) Njet++;
88 if (pt_lead < (*it_truth)->pt()) pt_lead = (*it_truth)->pt();
89 }
90 pt_lead /= Gaudi::Units::GeV; // Make sure we're in GeV
91
92 // See if the leading jet is in the right range
93 if (Njet < m_Njet && m_Njet > 0) {
95 setFilterPassed(false, ctx);
96 ATH_MSG_DEBUG("Failed filter on: " << Njet << " jets found with pT>" << m_NjetMinPt << " GeV -> less than required " << m_Njet << " jets");
97 return StatusCode::SUCCESS;
98 }
99
100 // See if the leading jet is in the right range
101 if ((pt_lead<=m_MinLeadJetPt || (pt_lead>m_MaxLeadJetPt && m_MaxLeadJetPt>0)) && !(pt_lead<=m_MinLeadJetPt && m_MinLeadJetPt<1)) {
102 m_ptfailed++;
103 setFilterPassed(false, ctx);
104 ATH_MSG_DEBUG("Failed filter on jet pT: " << pt_lead << " is not between " << m_MinLeadJetPt << " and " << m_MaxLeadJetPt);
105 return StatusCode::SUCCESS;
106 }
107
108 // Unweight the pT spectrum
109 double w = 1.;
110 if (m_doShape) w = fitFn(pt_lead);
111 double rnd = rndm->flat();
112 if (m_high/w < rnd) {
113 setFilterPassed(false, ctx);
114 ATH_MSG_DEBUG("Event failed weighting cut. Weight is " << w << " for pt_lead of " << pt_lead << " high end is " << m_high << " rnd is " << rnd);
115 return StatusCode::SUCCESS;
116 }
117
118 // Made it to the end - success!
119 m_passed++;
120 setFilterPassed(true, ctx);
121
122 // Get MC event collection for setting weight
123 const McEventCollection* mecc = 0;
124 CHECK(evtStore()->retrieve(mecc));
125 ATH_MSG_DEBUG("Event passed. Will mod event weights by " << w*m_norm << " for pt_lead of " << pt_lead << " norm " << m_norm << " w " << w << " high " << m_high << " rnd " << rnd);
126 double orig = 1.;
127 McEventCollection* mec = const_cast<McEventCollection*> (&(*mecc));
128 for (unsigned int i=0;i<mec->size();++i) {
129 if ( !(*mec)[i] ) continue;
130 orig = (*mec)[i]->weights().size()>0?(*mec)[i]->weights()[0]:1.;
131 if ((*mec)[i]->weights().size()>0) (*mec)[i]->weights()[0] = orig*w*m_norm;
132 else (*mec)[i]->weights().push_back( w*m_norm*orig );
133 }
134 return StatusCode::SUCCESS;
135}
#define CHECK(...)
Evaluate an expression and check for errors.
static TRandom * rnd
virtual void setFilterPassed(bool state, const EventContext &ctx) const
DataModel_detail::const_iterator< DataVector > const_iterator
Definition DataVector.h:838
size_type size() const noexcept
Returns the number of elements in the collection.
double m_norm
Normalization for weights.
long m_ptfailed
Number of events failing the pT cuts.
static double fitFn(const double x)
long m_nJetsFailed
Number of events failing the nJets cuts.
long m_passed
Number of events passing all cuts.
bool contains(const std::string &s, const std::string &regx)
does a string contain the substring
Definition hcg.cxx:116
const std::string weights
JetContainer_v1 JetContainer
Definition of the current "jet container version".

◆ filterFinalize()

StatusCode QCDTruthMultiJetFilter::filterFinalize ( )
virtual

Reimplemented from GenFilter.

Definition at line 55 of file QCDTruthMultiJetFilter.cxx.

55 {
56 ATH_MSG_INFO("Total efficiency: " << 100.*double(m_passed)/double(m_total) << "% (" << 100.*double(m_ptfailed)/double(m_total) << "% failed lead pT cut, " << 100.*double(m_nJetsFailed)/double(m_total) << "% failed nJets cut)");
57 return StatusCode::SUCCESS;
58}
#define ATH_MSG_INFO(x)

◆ filterInitialize()

StatusCode QCDTruthMultiJetFilter::filterInitialize ( )
virtual

Reimplemented from GenFilter.

Definition at line 31 of file QCDTruthMultiJetFilter.cxx.

31 {
32
33 CHECK(m_rndmSvc.retrieve());
34
35 m_NjetMinPt /= Gaudi::Units::GeV;
36 m_MinLeadJetPt /= Gaudi::Units::GeV;
37 m_MaxLeadJetPt /= Gaudi::Units::GeV;
38
39 ATH_MSG_INFO("Configured with " << m_Njet << " jets with p_T>" << m_NjetMinPt << " GeV, " << "|eta|<" << m_MaxEta << " and " << m_MinLeadJetPt << "<lead jet p_T<" << m_MaxLeadJetPt << " for jets in " << m_TruthJetContainerName);
40
41 // Special cases: min pT is above 2 TeV or max pT is below 20 GeV, use no weighting - hard-coded range of the fit in this filter
42 if (m_MinLeadJetPt < 1999. && m_MaxLeadJetPt > 21. && m_doShape) {
43 // Use the fit in all its glory
44 m_high = fitFn(m_MaxLeadJetPt);
45 m_norm = 1./(m_high==0?1.:m_high); //(m_MaxLeadJetPt-m_MinLeadJetPt) / (m_norm!=0?m_norm:1.);
46 ATH_MSG_INFO("Initialized and set high to " << m_high << " and norm to " << m_norm);
47 } else if (m_doShape) {
48 ATH_MSG_INFO("Requested shaping with bounds of " << m_MinLeadJetPt << " , " << m_MaxLeadJetPt << " which cannot be done. Turning off shaping (sorry).");
49 m_doShape=false;
50 }
51 return StatusCode::SUCCESS;
52}

◆ filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

93 {
94 return execState( ctx ).filterPassed();
95 }

◆ finalize()

StatusCode GenFilter::finalize ( )
inherited

Definition at line 50 of file GenFilter.cxx.

50 {
51 ATH_MSG_INFO("Events passed = " << m_nPass << " Events failed = " << m_nFail);
53 return StatusCode::SUCCESS;
54}
virtual StatusCode filterFinalize()
Definition GenFilter.h:47

◆ fitFn()

double QCDTruthMultiJetFilter::fitFn ( const double x)
inlinestatic
Todo
Move to an inline in the cc

Definition at line 60 of file QCDTruthMultiJetFilter.h.

60 {
61 static const double p[7] = //{100000,-5,0.0004,0.0000001,1./3600.,23,0.8};
62 { 1000000, -5.5, 0.0001, 0.00000012, 1./4150., 23, 0.4 };
63 return p[0]*std::pow(x,p[1]+p[2]*x+p[3]*pow(x,2))*pow(1-x*p[4],p[5])*pow(x,p[6]);
64 }
#define x

◆ fitFnR()

double QCDTruthMultiJetFilter::fitFnR ( const double * x,
const double *  )
inlinestatic
Todo
Move to an inline in the cc

Definition at line 53 of file QCDTruthMultiJetFilter.h.

53 {
54 static const double p[7] = //{100000,-5,0.0004,0.0000001,1./3600.,23,0.8};
55 { 1000000, -5.5, 0.0001, 0.00000012, 1./4150., 23, 0.4 };
56 return p[0]*std::pow(x[0],p[1]+p[2]*x[0]+p[3]*pow(x[0],2))*pow(1-x[0]*p[4],p[5])*pow(x[0],p[6]);
57 }

◆ getRandomEngine()

CLHEP::HepRandomEngine * QCDTruthMultiJetFilter::getRandomEngine ( const std::string & streamName,
const EventContext & ctx ) const
private

Definition at line 138 of file QCDTruthMultiJetFilter.cxx.

140{
141 ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
142 std::string rngName = name()+streamName;
143 rngWrapper->setSeed( rngName, ctx );
144 return rngWrapper->getEngine(ctx);
145}
A wrapper class for event-slot-local random engines.
Definition RNGWrapper.h:56
void setSeed(const std::string &algName, const EventContext &ctx)
Set the random seed using a string (e.g.
Definition RNGWrapper.h:154
CLHEP::HepRandomEngine * getEngine(const EventContext &ctx) const
Retrieve the random engine corresponding to the provided EventContext.
Definition RNGWrapper.h:108

◆ initialize()

StatusCode GenFilter::initialize ( )
virtualinherited

Reimplemented from GenBase.

Definition at line 18 of file GenFilter.cxx.

18 {
20 m_nPass = 0;
21 m_nFail = 0;
23 return StatusCode::SUCCESS;
24}
virtual StatusCode initialize() override
Definition GenBase.cxx:17
virtual StatusCode filterInitialize()
Definition GenFilter.h:45

◆ inputHandles()

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

◆ isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const
inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

68 {
69 return true;
70 }

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const
inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

47{ return false; }

◆ keepAll()

bool GenFilter::keepAll ( ) const
inlineinherited

Definition at line 55 of file GenFilter.h.

55{return m_keepAll; }

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ nFailed()

int GenFilter::nFailed ( ) const
inlineinherited

Definition at line 53 of file GenFilter.h.

53{ return m_nFail; }

◆ nNeeded()

int GenFilter::nNeeded ( ) const
inlineinherited

Definition at line 54 of file GenFilter.h.

54{ return m_nNeeded; }

◆ nPassed()

int GenFilter::nPassed ( ) const
inlineinherited

Definition at line 52 of file GenFilter.h.

52{ return m_nPass; }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state,
const EventContext & ctx ) const
inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

99 {
101 }

◆ sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx)
overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

41{
42 return BaseAlg::sysExecute (ctx);
43}

◆ sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )
overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

71 {
73
74 if (sc.isFailure()) {
75 return sc;
76 }
77
78 ServiceHandle<ICondSvc> cs("CondSvc",name());
79 for (auto h : outputHandles()) {
80 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
81 // do this inside the loop so we don't create the CondSvc until needed
82 if ( cs.retrieve().isFailure() ) {
83 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
85 }
86 if (cs->regHandle(this,*h).isFailure()) {
88 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
89 << " with CondSvc");
90 }
91 }
92 }
93 return sc;
94}
virtual StatusCode sysInitialize() override
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }

Member Data Documentation

◆ m_detStore

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

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doShape

bool QCDTruthMultiJetFilter::m_doShape
private

Attempt to flatten the pT distribution.

Definition at line 48 of file QCDTruthMultiJetFilter.h.

◆ m_evtStore

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

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects
privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_high

double QCDTruthMultiJetFilter::m_high
private

High-side function level.

Definition at line 46 of file QCDTruthMultiJetFilter.h.

◆ m_keepAll

bool GenFilter::m_keepAll
protectedinherited

Definition at line 66 of file GenFilter.h.

◆ m_MaxEta

double QCDTruthMultiJetFilter::m_MaxEta
private

Max eta for the truth jets.

Definition at line 34 of file QCDTruthMultiJetFilter.h.

◆ m_MaxLeadJetPt

double QCDTruthMultiJetFilter::m_MaxLeadJetPt
private

Max pT for the leading truth jet.

Definition at line 33 of file QCDTruthMultiJetFilter.h.

◆ m_mcEventKey

std::string GenBase::m_mcEventKey {}
protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT).

Definition at line 110 of file GenBase.h.

110{};

◆ m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
privateinherited

Const handle to the MC event collection.

Definition at line 119 of file GenBase.h.

119{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

◆ m_MinLeadJetPt

double QCDTruthMultiJetFilter::m_MinLeadJetPt
private

Min pT for the leading truth jet.

Definition at line 32 of file QCDTruthMultiJetFilter.h.

◆ m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 112 of file GenBase.h.

112{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

◆ m_nFail

int GenFilter::m_nFail
protectedinherited

Definition at line 64 of file GenFilter.h.

◆ m_Njet

int QCDTruthMultiJetFilter::m_Njet
private

Number of truth jets required above m_NjetMinPt.

Definition at line 30 of file QCDTruthMultiJetFilter.h.

◆ m_NjetMinPt

double QCDTruthMultiJetFilter::m_NjetMinPt
private

Min pT for N jets truth jets required.

Definition at line 31 of file QCDTruthMultiJetFilter.h.

◆ m_nJetsFailed

long QCDTruthMultiJetFilter::m_nJetsFailed
private

Number of events failing the nJets cuts.

Definition at line 43 of file QCDTruthMultiJetFilter.h.

◆ m_nNeeded

int GenFilter::m_nNeeded
protectedinherited

Definition at line 65 of file GenFilter.h.

◆ m_norm

double QCDTruthMultiJetFilter::m_norm
private

Normalization for weights.

Definition at line 45 of file QCDTruthMultiJetFilter.h.

◆ m_nPass

int GenFilter::m_nPass
protectedinherited

Definition at line 63 of file GenFilter.h.

◆ m_passed

long QCDTruthMultiJetFilter::m_passed
private

Number of events passing all cuts.

Definition at line 41 of file QCDTruthMultiJetFilter.h.

◆ m_ptfailed

long QCDTruthMultiJetFilter::m_ptfailed
private

Number of events failing the pT cuts.

Definition at line 42 of file QCDTruthMultiJetFilter.h.

◆ m_rndmSvc

ServiceHandle<IAthRNGSvc> QCDTruthMultiJetFilter::m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
private

Random number generator.

Definition at line 38 of file QCDTruthMultiJetFilter.h.

38{this, "RndmSvc", "AthRNGSvc"};

◆ m_total

long QCDTruthMultiJetFilter::m_total
private

Total number of events tested.

Definition at line 40 of file QCDTruthMultiJetFilter.h.

◆ m_TruthJetContainerName

std::string QCDTruthMultiJetFilter::m_TruthJetContainerName
private

Name of the truth jet container.

Definition at line 36 of file QCDTruthMultiJetFilter.h.

◆ m_varHandleArraysDeclared

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

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

Definition at line 398 of file AthCommonDataStore.h.


The documentation for this class was generated from the following files: