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

#include <QCDTruthJetFilter.h>

Inheritance diagram for QCDTruthJetFilter:
Collaboration diagram for QCDTruthJetFilter:

Public Member Functions

 QCDTruthJetFilter (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode filterInitialize ()
StatusCode filterFinalize ()
StatusCode filterEvent (const EventContext &ctx)
virtual StatusCode sysInitialize () override
 Override sysInitialize.
virtual const DataObjIDColl & extraOutputDeps () const override
 Return the list of extra output dependencies.
bool filterPassed (const EventContext &ctx) const
void setFilterPassed (bool state, const EventContext &ctx) const
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).
Particle data accessors
const ServiceHandle< IPartPropSvc > partPropSvc () const
 Access the particle property service.
const HepPDT::ParticleDataTable & particleTable () const
 Get a particle data table.
const HepPDT::ParticleDataTable & pdt () const
 Shorter alias to get a particle data table.
const HepPDT::ParticleData * particleData (int pid) const
 Access an element in the particle data table.
const EventContext & getContext () const
 Deprecated methods (use the ones with EventContext).
bool filterPassed () const
void setFilterPassed (bool state) 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

double m_minPtCut {-1.*Gaudi::Units::GeV}
Gaudi::Property< double > m_MinPt {this, "MinPt", -1.*Gaudi::Units::GeV}
 Min pT for the truth jets.
double m_maxPtCut {7000.*Gaudi::Units::GeV}
Gaudi::Property< double > m_MaxPt {this, "MaxPt", 7000*Gaudi::Units::GeV}
 Max pT for the truth jets.
Gaudi::Property< double > m_MinEta {this, "MinEta", s_startMinEta}
 Min eta for the truth jets.
double m_minEtaCut {s_startMinEta}
Gaudi::Property< double > m_MaxEta {this, "MaxEta", 999.0}
 Max eta for the truth jets.
double m_maxEtaCut {999.0}
Gaudi::Property< double > m_MinPhi {this, "MinPhi", -999.0}
 Min phi for the lead truth jet.
Gaudi::Property< double > m_MaxPhi {this, "MaxPhi", 999.0}
Gaudi::Property< bool > m_SymEta {this, "SymEta", false}
 Use symmetric cut for min eta?
Gaudi::Property< bool > m_doShape {this, "DoShape", false}
 Attempt to flatten the pT distribution.
SG::ReadHandleKey< xAOD::JetContainerm_TruthJetContainerName {this, "TruthJetContainer", "AntiKt4TruthWZJets"}
ServiceHandle< IAthRNGSvcm_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
long m_total {0}
 Total number of events tested.
long m_passed {0}
 Number of events passing all cuts.
long m_ptfailed {0}
 Number of events failing the pT cuts.
double m_norm {1.}
 Normalization for weights.
double m_high {1.}
 High-side function level.
DataObjIDColl m_extendedExtraObjects
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

Static Private Attributes

static constexpr double s_startMinEta {-10}

Properties

ServiceHandle< IPartPropSvc > m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
 Handle on the particle property service.
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 19 of file QCDTruthJetFilter.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

◆ QCDTruthJetFilter()

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

Definition at line 12 of file QCDTruthJetFilter.cxx.

13 : GenFilter(name,pSvcLocator)
14{
15}
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 76 of file GenBase.h.

76 {
77 if (events()->empty())
78 ATH_MSG_ERROR("McEventCollection is empty during first event access");
79 return *(events()->begin());
80 }
#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 83 of file GenBase.h.

83 {
84 const McEventCollection* coll = events_const(ctx);
85 if (coll->empty())
86 ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
87 return *(coll->begin());
88 }
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:97

◆ events_const()

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

Access the current event's McEventCollection (const).

Definition at line 97 of file GenBase.h.

97 {
98 SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
99 if (!ret.isValid())
100 ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
101 return ret.cptr();
102 }
SG::ReadHandleKey< McEventCollection > m_mcevents_const
Const handle to the MC event collection.
Definition GenBase.h:145
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.

Provides access to the EventContext if needed but is non-const as opposed to AthReentrantAlgorithm.

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.
bool filterPassed() 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 & 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}
DataObjIDColl m_extendedExtraObjects

◆ filterEvent()

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

Implements GenFilter.

Definition at line 58 of file QCDTruthJetFilter.cxx.

58 {
59 m_total++; // Bookkeeping
60
61 // Grab random number engine
62 CLHEP::HepRandomEngine* rndm = this->getRandomEngine(name(), ctx);
63 if (!rndm) {
64 ATH_MSG_WARNING("Failed to retrieve random number engine QCDTruthJetFilter");
65 setFilterPassed(false, ctx);
66 return StatusCode::SUCCESS;
67 }
68
69 // Get jet container out
70 // Get jet container out
71 SG::ReadHandle<xAOD::JetContainer> truthjetTES{m_TruthJetContainerName, ctx};
72 if (!truthjetTES.isValid()) {
73 ATH_MSG_ERROR("No xAOD::JetContainer found in StoreGate with key " << m_TruthJetContainerName.key());
74 setFilterPassed(m_minPtCut < 1, ctx);
75 return StatusCode::SUCCESS;
76 }
77
78 // Get pT of leading jet
79 double pt_lead = -1, phi_lead = 0;
80 for (xAOD::JetContainer::const_iterator it_truth = (*truthjetTES).begin(); it_truth != (*truthjetTES).end() ; ++it_truth) {
81 if (!(*it_truth)) continue;
82 if ( ( m_SymEta && !(std::abs((*it_truth)->eta())>=m_minEtaCut && std::abs((*it_truth)->eta())<m_maxEtaCut) )
83 || ( !m_SymEta && !((*it_truth)->eta()>=m_minEtaCut && (*it_truth)->eta()<m_maxEtaCut) )) continue;
84 if (pt_lead < (*it_truth)->pt()) {
85 pt_lead = (*it_truth)->pt();
86 phi_lead = (*it_truth)->phi();
87 }
88 }
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 ((pt_lead<=m_minPtCut || (pt_lead>m_maxPtCut && m_maxPtCut>0)) && !(pt_lead<=m_minPtCut && m_minPtCut<1)) {
94 m_ptfailed++;
95 setFilterPassed(false, ctx);
96 ATH_MSG_DEBUG("Failed filter on jet pT: " << pt_lead << " is not between " << m_minPtCut << " and " << m_maxPtCut);
97 return StatusCode::SUCCESS;
98 }
99
100// If appropriate, check the phi of the lead jet as well
101 if (m_MinPhi > -999.0 || m_MaxPhi < 999.0) {
102 setFilterPassed(false, ctx);
103
104 if (phi_lead < m_MinPhi || phi_lead > m_MaxPhi) {
105 ATH_MSG_DEBUG("Failed filter on jet phi: " << phi_lead << " not between " << m_MinPhi << " and " << m_MaxPhi);
106 return StatusCode::SUCCESS;
107 }
108 else {
109 setFilterPassed(true, ctx);
110 }
111 }
112
113
114 // Unweight the pT spectrum
115 double w = 1.;
116 if (m_doShape) w = fitFn(pt_lead);
117 double rnd = rndm->flat();
118 if (m_high/w < rnd) {
119 setFilterPassed(false, ctx);
120 ATH_MSG_DEBUG("Event failed weighting cut. Weight is " << w << " for pt_lead of " << pt_lead << " high end is " << m_high << " rnd is " << rnd);
121 return StatusCode::SUCCESS;
122 }
123
124 // Made it to the end - success!
125 m_passed++;
126 setFilterPassed(true, ctx);
127
128 // Get MC event collection for setting weight
129 const McEventCollection* mecc = 0;
130 CHECK(evtStore()->retrieve(mecc, m_mcEventKey));
131 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);
132 double orig = 1.;
133 McEventCollection* mec = const_cast<McEventCollection*> (&(*mecc));
134 for (unsigned int i=0;i<mec->size();++i) {
135 if ( !(*mec)[i] ) continue;
136 orig = (*mec)[i]->weights().size()>0?(*mec)[i]->weights()[0]:1.;
137 if ((*mec)[i]->weights().size()>0) (*mec)[i]->weights()[0] = orig*w*m_norm;
138 else (*mec)[i]->weights().push_back( w*m_norm*orig );
139
140 (*mec)[i]->add_attribute(HepMCStr::filterWeight, std::make_shared<HepMC3::DoubleAttribute>(w*m_norm));
141
142 }
143 return StatusCode::SUCCESS;
144}
#define CHECK(...)
Evaluate an expression and check for errors.
static TRandom * rnd
void setFilterPassed(bool state) 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.
static double fitFn(const double x)
long m_ptfailed
Number of events failing the pT cuts.
long m_passed
Number of events passing all cuts.
double m_norm
Normalization for weights.
SG::ReadHandleKey< xAOD::JetContainer > m_TruthJetContainerName
const std::string weights
const std::string filterWeight

◆ filterFinalize()

StatusCode QCDTruthJetFilter::filterFinalize ( )
virtual

Reimplemented from GenFilter.

Definition at line 52 of file QCDTruthJetFilter.cxx.

52 {
53 ATH_MSG_INFO("Total efficiency: " << 100.*double(m_passed)/double(m_total) << "% (" << 100.*double(m_ptfailed)/double(m_total) << "% failed pT cuts)");
54 return StatusCode::SUCCESS;
55}
#define ATH_MSG_INFO(x)

◆ filterInitialize()

StatusCode QCDTruthJetFilter::filterInitialize ( )
virtual

Reimplemented from GenFilter.

Definition at line 18 of file QCDTruthJetFilter.cxx.

18 {
19
20 CHECK(m_TruthJetContainerName.initialize());
21 CHECK(m_rndmSvc.retrieve());
22 m_minPtCut = m_MinPt.value() / Gaudi::Units::GeV;
23 m_maxPtCut = m_MaxPt.value() / Gaudi::Units::GeV;
24 // Set actual Eta cut values based on configurable properties
25 m_maxEtaCut = m_MaxEta.value();
26 if (m_MinEta.value() == s_startMinEta && m_maxEtaCut>0) m_minEtaCut = -1.*m_maxEtaCut;
27 if (m_SymEta) {
28 ATH_MSG_INFO("Configured with " << m_minPtCut << "<p_T<" << m_maxPtCut << " GeV and " << m_minEtaCut << "<abs(eta)<" << m_maxEtaCut << " for jets in " << m_TruthJetContainerName);
29 } else {
30 ATH_MSG_INFO("Configured with " << m_minPtCut << "<p_T<" << m_maxPtCut << " GeV and " << m_minEtaCut << "<eta<" << m_maxEtaCut << " for jets in " << m_TruthJetContainerName);
31 }
32
33 // 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
34 if (m_minPtCut < 1999. && m_maxPtCut > 21. && m_doShape) {
35 // Use the fit in all its glory
36 m_high = fitFn(m_maxPtCut);
37 m_norm = 1./(m_high==0?1.:m_high); //(m_maxPtCut-m_minPtCut) / (m_norm!=0?m_norm:1.);
38 ATH_MSG_INFO("Initialized and set high to " << m_high << " and norm to " << m_norm);
39 } else if (m_doShape) {
40 ATH_MSG_INFO("Requested shaping with bounds of " << m_minPtCut << " , " << m_maxPtCut << " which cannot be done. Turning off shaping (sorry).");
41 m_doShape=false; // FIXME Do not alter the values of configurable properties in initialize
42 }
43
44if (m_MinPhi > -998.0 || m_MaxPhi < 998.0) {
45 ATH_MSG_INFO("Configured phi as well with min = " << m_MinPhi << " and max = " << m_MaxPhi);
46 }
47
48 return StatusCode::SUCCESS;
49}
Gaudi::Property< bool > m_doShape
Attempt to flatten the pT distribution.
static constexpr double s_startMinEta
double m_high
High-side function level.

◆ filterPassed() [1/2]

bool AthAlgorithm::filterPassed ( ) const
inherited

Definition at line 94 of file AthAlgorithm.cxx.

94 {
95 return filterPassed( Gaudi::Hive::currentContext() );
96}

◆ filterPassed() [2/2]

bool AthAlgorithm::filterPassed ( const EventContext & ctx) const
inherited

Definition at line 98 of file AthAlgorithm.cxx.

98 {
99 return execState( ctx ).filterPassed();
100}

◆ 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 QCDTruthJetFilter::fitFn ( const double x)
inlinestatic
Todo
Move to an inline in the cc

Definition at line 68 of file QCDTruthJetFilter.h.

68 {
69 static const double p[7] = //{100000,-5,0.0004,0.0000001,1./3600.,23,0.8};
70 { 1000000, -5.5, 0.0001, 0.00000012, 1./4150., 23, 0.4 };
71 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]);
72 }
#define x

◆ fitFnR()

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

Definition at line 61 of file QCDTruthJetFilter.h.

61 {
62 static const double p[7] = //{100000,-5,0.0004,0.0000001,1./3600.,23,0.8};
63 { 1000000, -5.5, 0.0001, 0.00000012, 1./4150., 23, 0.4 };
64 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]);
65 }

◆ getContext()

const EventContext & AthAlgorithm::getContext ( ) const
inherited

Deprecated methods (use the ones with EventContext).

Definition at line 90 of file AthAlgorithm.cxx.

90 {
91 return Gaudi::Hive::currentContext();
92}

◆ getRandomEngine()

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

Definition at line 147 of file QCDTruthJetFilter.cxx.

149{
150 ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
151 std::string rngName = name()+streamName;
152 rngWrapper->setSeed( rngName, ctx );
153 return rngWrapper->getEngine(ctx);
154}
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.

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const
inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 111 of file AthAlgorithm.h.

111{ 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.

◆ particleData()

const HepPDT::ParticleData * GenBase::particleData ( int pid) const
inlineinherited

Access an element in the particle data table.

Definition at line 124 of file GenBase.h.

124 {
125 return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
126 }
const HepPDT::ParticleDataTable & pdt() const
Shorter alias to get a particle data table.
Definition GenBase.h:121

◆ particleTable()

const HepPDT::ParticleDataTable & GenBase::particleTable ( ) const
inlineinherited

Get a particle data table.

Definition at line 116 of file GenBase.h.

116 {
117 return *(m_ppSvc->PDT());
118 }
ServiceHandle< IPartPropSvc > m_ppSvc
Handle on the particle property service.
Definition GenBase.h:142

◆ partPropSvc()

const ServiceHandle< IPartPropSvc > GenBase::partPropSvc ( ) const
inlineinherited

Access the particle property service.

Definition at line 111 of file GenBase.h.

111 {
112 return m_ppSvc;
113 }

◆ pdt()

const HepPDT::ParticleDataTable & GenBase::pdt ( ) const
inlineinherited

Shorter alias to get a particle data table.

Definition at line 121 of file GenBase.h.

121{ return particleTable(); }
const HepPDT::ParticleDataTable & particleTable() const
Get a particle data table.
Definition GenBase.h:116

◆ 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() [1/2]

void AthAlgorithm::setFilterPassed ( bool state) const
inherited

Definition at line 102 of file AthAlgorithm.cxx.

102 {
103 setFilterPassed( state, Gaudi::Hive::currentContext() );
104}

◆ setFilterPassed() [2/2]

void AthAlgorithm::setFilterPassed ( bool state,
const EventContext & ctx ) const
inherited

Definition at line 106 of file AthAlgorithm.cxx.

106 {
107 execState( ctx ).setFilterPassed(state);
108}

◆ sysInitialize()

StatusCode AthAlgorithm::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, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

66 {
68
69 if (sc.isFailure()) {
70 return sc;
71 }
72 ServiceHandle<ICondSvc> cs("CondSvc",name());
73 for (auto h : outputHandles()) {
74 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
75 // do this inside the loop so we don't create the CondSvc until needed
76 if ( cs.retrieve().isFailure() ) {
77 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
78 return StatusCode::SUCCESS;
79 }
80 if (cs->regHandle(this,*h).isFailure()) {
81 sc = StatusCode::FAILURE;
82 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
83 << " with CondSvc");
84 }
85 }
86 }
87 return sc;
88}
virtual StatusCode sysInitialize() override
Override sysInitialize.
AthCommonDataStore(const std::string &name, T... args)
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

Gaudi::Property<bool> QCDTruthJetFilter::m_doShape {this, "DoShape", false}
private

Attempt to flatten the pT distribution.

Definition at line 44 of file QCDTruthJetFilter.h.

44{this, "DoShape", false};

◆ 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 AthAlgorithm::m_extendedExtraObjects
privateinherited

Definition at line 114 of file AthAlgorithm.h.

◆ m_high

double QCDTruthJetFilter::m_high {1.}
private

High-side function level.

Definition at line 55 of file QCDTruthJetFilter.h.

55{1.};

◆ m_keepAll

bool GenFilter::m_keepAll
protectedinherited

Definition at line 66 of file GenFilter.h.

◆ m_MaxEta

Gaudi::Property<double> QCDTruthJetFilter::m_MaxEta {this, "MaxEta", 999.0}
private

Max eta for the truth jets.

Definition at line 39 of file QCDTruthJetFilter.h.

39{this, "MaxEta", 999.0};

◆ m_maxEtaCut

double QCDTruthJetFilter::m_maxEtaCut {999.0}
private

Definition at line 40 of file QCDTruthJetFilter.h.

40{999.0};

◆ m_MaxPhi

Gaudi::Property<double> QCDTruthJetFilter::m_MaxPhi {this, "MaxPhi", 999.0}
private

Definition at line 42 of file QCDTruthJetFilter.h.

42{this, "MaxPhi", 999.0};

◆ m_MaxPt

Gaudi::Property<double> QCDTruthJetFilter::m_MaxPt {this, "MaxPt", 7000*Gaudi::Units::GeV}
private

Max pT for the truth jets.

Definition at line 35 of file QCDTruthJetFilter.h.

35{this, "MaxPt", 7000*Gaudi::Units::GeV};

◆ m_maxPtCut

double QCDTruthJetFilter::m_maxPtCut {7000.*Gaudi::Units::GeV}
private

Definition at line 34 of file QCDTruthJetFilter.h.

34{7000.*Gaudi::Units::GeV};

◆ m_mcEventKey

std::string GenBase::m_mcEventKey {}
protectedinherited

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

Definition at line 134 of file GenBase.h.

134{};

◆ 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 145 of file GenBase.h.

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

◆ m_MinEta

Gaudi::Property<double> QCDTruthJetFilter::m_MinEta {this, "MinEta", s_startMinEta}
private

Min eta for the truth jets.

Definition at line 37 of file QCDTruthJetFilter.h.

37{this, "MinEta", s_startMinEta};

◆ m_minEtaCut

double QCDTruthJetFilter::m_minEtaCut {s_startMinEta}
private

Definition at line 38 of file QCDTruthJetFilter.h.

◆ m_MinPhi

Gaudi::Property<double> QCDTruthJetFilter::m_MinPhi {this, "MinPhi", -999.0}
private

Min phi for the lead truth jet.

Definition at line 41 of file QCDTruthJetFilter.h.

41{this, "MinPhi", -999.0};

◆ m_MinPt

Gaudi::Property<double> QCDTruthJetFilter::m_MinPt {this, "MinPt", -1.*Gaudi::Units::GeV}
private

Min pT for the truth jets.

Definition at line 33 of file QCDTruthJetFilter.h.

33{this, "MinPt", -1.*Gaudi::Units::GeV};

◆ m_minPtCut

double QCDTruthJetFilter::m_minPtCut {-1.*Gaudi::Units::GeV}
private

Definition at line 32 of file QCDTruthJetFilter.h.

32{-1.*Gaudi::Units::GeV};

◆ 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 136 of file GenBase.h.

136{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_nNeeded

int GenFilter::m_nNeeded
protectedinherited

Definition at line 65 of file GenFilter.h.

◆ m_norm

double QCDTruthJetFilter::m_norm {1.}
private

Normalization for weights.

Definition at line 54 of file QCDTruthJetFilter.h.

54{1.};

◆ m_nPass

int GenFilter::m_nPass
protectedinherited

Definition at line 63 of file GenFilter.h.

◆ m_passed

long QCDTruthJetFilter::m_passed {0}
private

Number of events passing all cuts.

Definition at line 51 of file QCDTruthJetFilter.h.

51{0};

◆ m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
privateinherited

Handle on the particle property service.

Definition at line 142 of file GenBase.h.

142{this, "PartPropSvc", "PartPropSvc"};

◆ m_ptfailed

long QCDTruthJetFilter::m_ptfailed {0}
private

Number of events failing the pT cuts.

Definition at line 52 of file QCDTruthJetFilter.h.

52{0};

◆ m_rndmSvc

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

Definition at line 48 of file QCDTruthJetFilter.h.

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

◆ m_SymEta

Gaudi::Property<bool> QCDTruthJetFilter::m_SymEta {this, "SymEta", false}
private

Use symmetric cut for min eta?

(Default false for p-Pb run filters)

Definition at line 43 of file QCDTruthJetFilter.h.

43{this, "SymEta", false};

◆ m_total

long QCDTruthJetFilter::m_total {0}
private

Total number of events tested.

Definition at line 50 of file QCDTruthJetFilter.h.

50{0};

◆ m_TruthJetContainerName

SG::ReadHandleKey<xAOD::JetContainer> QCDTruthJetFilter::m_TruthJetContainerName {this, "TruthJetContainer", "AntiKt4TruthWZJets"}
private

Definition at line 46 of file QCDTruthJetFilter.h.

46{this, "TruthJetContainer", "AntiKt4TruthWZJets"}; // Name of the truth jet container

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

◆ s_startMinEta

double QCDTruthJetFilter::s_startMinEta {-10}
staticconstexprprivate

Definition at line 36 of file QCDTruthJetFilter.h.

36{-10};

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