|
ATLAS Offline Software
|
#include <TrackTruthSelectionTool.h>
|
| TrackTruthSelectionTool (const std::string &name) |
|
virtual | ~TrackTruthSelectionTool () |
|
virtual StatusCode | initialize () override |
| Dummy implementation of the initialisation function. More...
|
|
virtual StatusCode | finalize () override |
|
virtual const asg::AcceptInfo & | getAcceptInfo () const override |
| Declare the interface ID for this pure-virtual interface class to the Athena framework. More...
|
|
virtual asg::AcceptData | accept (const xAOD::IParticle *p) const override |
| The main accept method: the actual cuts are applied here. More...
|
|
virtual asg::AcceptData | accept (const xAOD::TruthParticle *p) 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 |
|
|
asg::AcceptInfo | m_accept {"TrackTruthSelection"} |
|
std::vector< std::pair< std::string, std::string > > | m_cuts |
|
std::atomic< ULong64_t > | m_numTruthProcessed {0} |
|
std::atomic< ULong64_t > | m_numTruthPassed {0} |
|
std::vector< ULong64_t > m_numTruthPassedCuts | ATLAS_THREAD_SAFE |
|
std::mutex | m_mutex |
|
FloatProperty | m_maxEta {this, "maxEta", 2.5} |
|
FloatProperty | m_maxPt {this, "maxPt", -1.} |
|
FloatProperty | m_minPt {this, "minPt", 400.} |
|
BooleanProperty | m_requireOnlyPrimary {this, "requireOnlyPrimary", true} |
|
BooleanProperty | m_requireCharged {this, "requireCharged", true} |
|
BooleanProperty | m_requireStable {this, "requireStable", true} |
|
FloatProperty | m_maxProdVertRadius {this, "maxProdVertRadius", 110.} |
|
IntegerProperty | m_pdgId {this, "pdgId", -1} |
|
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 |
|
Definition at line 16 of file TrackTruthSelectionTool.h.
◆ StoreGateSvc_t
◆ TrackTruthSelectionTool()
TrackTruthSelectionTool::TrackTruthSelectionTool |
( |
const std::string & |
name | ) |
|
◆ ~TrackTruthSelectionTool()
TrackTruthSelectionTool::~TrackTruthSelectionTool |
( |
| ) |
|
|
virtualdefault |
◆ accept() [1/2]
◆ accept() [2/2]
Definition at line 96 of file TrackTruthSelectionTool.cxx.
101 acceptData.setCutResult(
"eta", (
p->pt() > 1
e-7 ? (std::fabs(
p->eta()) <
m_maxEta) :
false));
104 acceptData.setCutResult(
"min_pt", (
p->pt() >
m_minPt));
107 acceptData.setCutResult(
"max_pt", (
p->pt() <
m_maxPt));
114 acceptData.setCutResult(
"charged", (not (
p->isNeutral())));
120 acceptData.setCutResult(
"decay_before_pixel", (!
p->hasProdVtx() ||
p->prodVtx()->perp() <
m_maxProdVertRadius));
123 acceptData.setCutResult(
"pdgId", (std::fabs(
p->pdgId()) ==
m_pdgId));
125 std::lock_guard<std::mutex> lock{
m_mutex};
128 unsigned int pos = acceptData.getCutPosition(
cut.first);
129 if (acceptData.getCutResult(
pos)) {
130 m_numTruthPassedCuts[
pos]++;
◆ ASG_TOOL_CLASS1()
◆ declareGaudiProperty() [1/4]
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
175 hndl.documentation());
◆ declareGaudiProperty() [2/4]
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
161 hndl.documentation());
◆ declareGaudiProperty() [3/4]
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
189 hndl.documentation());
◆ declareGaudiProperty() [4/4]
◆ declareProperty() [1/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation 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.
250 this->declare(hndl.
vhKey());
251 hndl.
vhKey().setOwner(
this);
253 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [2/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation 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.
229 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [3/6]
◆ declareProperty() [4/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation 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.
338 return PBASE::declareProperty(
name, property,
doc);
◆ declareProperty() [5/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation 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.
◆ declareProperty() [6/6]
◆ detStore()
◆ evtStore() [1/2]
◆ evtStore() [2/2]
◆ extraDeps_update_handler()
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 TrackTruthSelectionTool::finalize |
( |
| ) |
|
|
overridevirtual |
◆ getAcceptInfo()
◆ getKey()
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
-
ptr | The 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.
121 #ifdef XAOD_STANDALONE
127 return (
proxy ==
nullptr ? 0 :
proxy->sgkey() );
128 #endif // XAOD_STANDALONE
◆ 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
-
ptr | The 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.
108 #ifdef XAOD_STANDALONE
114 static const std::string
dummy =
"";
116 #endif // XAOD_STANDALONE
◆ getProperty()
template<class T >
const T* asg::AsgTool::getProperty |
( |
const std::string & |
name | ) |
const |
|
inherited |
Get one of the tool's properties.
◆ initialize()
StatusCode TrackTruthSelectionTool::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 20 of file TrackTruthSelectionTool.cxx.
22 return StatusCode::FAILURE;
29 m_cuts.emplace_back(
"eta",
"Cut on (absolute) particle eta");
32 m_cuts.emplace_back(
"min_pt",
"Cut on minimum particle pT");
35 m_cuts.emplace_back(
"max_pt",
"Cut on maximum particle pT");
39 m_cuts.emplace_back(
"OnlyPrimary",
"Cut on origin");
43 m_cuts.emplace_back(
"charged",
"Require charged particle");
46 m_cuts.emplace_back(
"stable",
"Particle stable");
50 m_cuts.emplace_back(
"decay_before_pixel",
"Decays before first pixel layer");
54 m_cuts.emplace_back(
"pdgId",
"Pdg Id cut");
59 ATH_MSG_ERROR(
"Failed to add cut " <<
cut.first <<
" because the AcceptInfo object is full.");
60 return StatusCode::FAILURE;
67 return StatusCode::SUCCESS;
◆ inputHandles()
Return this algorithm's input handles.
We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.
◆ msg() [1/2]
◆ msg() [2/2]
◆ 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.
◆ msgLvl()
◆ outputHandles()
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 the state of the tool.
Implements asg::IAsgTool.
Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
Definition at line 131 of file AsgTool.cxx.
◆ print() [2/2]
virtual void asg::IAsgTool::print |
( |
| ) |
const |
|
pure virtualinherited |
Print the state of the tool.
Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
◆ renounce()
◆ renounceArray()
◆ sysInitialize()
◆ sysStart()
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
◆ updateVHKA()
◆ ATLAS_THREAD_SAFE
std::vector<ULong64_t> m_numTruthPassedCuts TrackTruthSelectionTool::ATLAS_THREAD_SAFE |
|
mutableprivate |
◆ m_accept
◆ m_cuts
std::vector<std::pair<std::string, std::string> > TrackTruthSelectionTool::m_cuts |
|
private |
◆ m_detStore
◆ m_evtStore
◆ m_maxEta
FloatProperty TrackTruthSelectionTool::m_maxEta {this, "maxEta", 2.5} |
|
private |
◆ m_maxProdVertRadius
FloatProperty TrackTruthSelectionTool::m_maxProdVertRadius {this, "maxProdVertRadius", 110.} |
|
private |
◆ m_maxPt
FloatProperty TrackTruthSelectionTool::m_maxPt {this, "maxPt", -1.} |
|
private |
◆ m_minPt
FloatProperty TrackTruthSelectionTool::m_minPt {this, "minPt", 400.} |
|
private |
◆ m_mutex
std::mutex TrackTruthSelectionTool::m_mutex |
|
mutableprivate |
◆ m_numTruthPassed
std::atomic<ULong64_t> TrackTruthSelectionTool::m_numTruthPassed {0} |
|
mutableprivate |
◆ m_numTruthProcessed
std::atomic<ULong64_t> TrackTruthSelectionTool::m_numTruthProcessed {0} |
|
mutableprivate |
◆ m_pdgId
IntegerProperty TrackTruthSelectionTool::m_pdgId {this, "pdgId", -1} |
|
private |
◆ m_requireCharged
BooleanProperty TrackTruthSelectionTool::m_requireCharged {this, "requireCharged", true} |
|
private |
◆ m_requireOnlyPrimary
BooleanProperty TrackTruthSelectionTool::m_requireOnlyPrimary {this, "requireOnlyPrimary", true} |
|
private |
◆ m_requireStable
BooleanProperty TrackTruthSelectionTool::m_requireStable {this, "requireStable", true} |
|
private |
◆ m_varHandleArraysDeclared
◆ m_vhka
The documentation for this class was generated from the following files:
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
unsigned int getCutPosition(const std::string &cutName) const
Get the bit position of a cut.
virtual void setOwner(IDataHandleHolder *o)=0
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
bool is_simulation_particle(const T &p)
Method to establish if a particle (or barcode) was created during the simulation (TODO update to be s...
unsigned int getNCuts() const
Get the number of cuts defined.
Class describing a truth particle in the MC record.
TruthParticle_v1 TruthParticle
Typedef to implementation.
cut
This script demonstrates how to call a C++ class from Python Also how to use PyROOT is shown.
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
bool isStable(const T &p)
Identify if the particle is stable, i.e. has not decayed.
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
int addCut(const std::string &cutName, const std::string &cutDescription)
Add a cut; returning the cut position.