|
ATLAS Offline Software
|
Select egtruth particles.
More...
#include <egammaTruthAlg.h>
|
| egammaTruthAlg (const std::string &name, ISvcLocator *svcloc) |
| Standard Gaudi algorithm constructor. More...
|
|
virtual StatusCode | initialize () override |
| Standard Gaudi initialize method. More...
|
|
virtual StatusCode | execute (const EventContext &ctx) const override |
| Standard Gaudi execute method. More...
|
|
virtual StatusCode | sysInitialize () override |
| Override sysInitialize. More...
|
|
virtual bool | isClonable () const override |
| Specify if the algorithm is clonable. More...
|
|
virtual unsigned int | cardinality () const override |
| Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
|
|
virtual StatusCode | sysExecute (const EventContext &ctx) override |
| Execute an algorithm. More...
|
|
virtual const DataObjIDColl & | extraOutputDeps () const override |
| Return the list of extra output dependencies. More...
|
|
virtual bool | filterPassed (const EventContext &ctx) const |
|
virtual void | setFilterPassed (bool state, const EventContext &ctx) const |
|
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 | 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 |
|
|
bool | isAccepted (const xAOD::TruthParticle &tp, const xAOD::TruthParticleContainer &cont, float &iso) const |
| Test to see if we accept a particle. More...
|
|
float | computeIso (const xAOD::TruthParticle &tp, const xAOD::TruthParticleContainer &cont) const |
| Compute isolation around a particle. More...
|
|
StatusCode | findImpact (const xAOD::TruthParticle &tp, float &etaCalo, float &phiCalo, float &depthCalo) const |
| Find the impact of a particle in the calorimeter. More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKey> More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &) |
| specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &) |
| specialization for handling Gaudi::Property<SG::VarHandleBase> More...
|
|
Gaudi::Details::PropertyBase & | declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &) |
| specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
|
|
|
std::string | m_auxPrefix |
| Property: Prefix to add to aux data items. More...
|
|
SG::ReadHandleKey< xAOD::TruthParticleContainer > | m_inputKey { this, "InputKey", "", "SG key for the input container." } |
| Property: Name of the input container. More...
|
|
SG::WriteHandleKey< xAOD::TruthParticleContainer > | m_outputKey { this, "OutputKey", "", "SG key for the output container." } |
| Property: Name of the output container. More...
|
|
float | m_electronPtMin |
| Property: Minimum pt for electrons. More...
|
|
float | m_photonPtMin |
| Property: Minimum pt for photons. More...
|
|
float | m_etaMax |
| Property: Maximum eta. More...
|
|
float | m_isoCone |
| Property: Isolation cone width. More...
|
|
float | m_photonEtIsoMax |
| Property: Maximum isolation cone energy allowed to keep a photon. More...
|
|
ToolHandle< Trk::IParticleCaloExtensionTool > | m_exten { this, "ParticleCaloExtensionTool", "", "Extrapolator to calorimeter." } |
| Property: Extrapolation tool to calorimeter. More...
|
|
DataObjIDColl | m_extendedExtraObjects |
| Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
|
|
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 |
|
Select egtruth particles.
Definition at line 34 of file egammaTruthAlg.h.
◆ StoreGateSvc_t
◆ egammaTruthAlg()
D3PD::egammaTruthAlg::egammaTruthAlg |
( |
const std::string & |
name, |
|
|
ISvcLocator * |
svcloc |
|
) |
| |
Standard Gaudi algorithm constructor.
- Parameters
-
name | The algorithm name. |
svcloc | The service locator. |
Definition at line 41 of file egammaTruthAlg.cxx.
46 "Prefix to add to aux data items.");
49 "Minimum pt for electrons.");
51 "Minimum pt for photons.");
55 "Isolation cone width.");
57 "Maximum isolation cone energy allowed to keep a photon.");
◆ cardinality()
unsigned int AthReentrantAlgorithm::cardinality |
( |
| ) |
const |
|
overridevirtualinherited |
Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
Override this to return 0 for reentrant algorithms.
Override this to return 0 for reentrant algorithms.
Definition at line 55 of file AthReentrantAlgorithm.cxx.
◆ computeIso()
Compute isolation around a particle.
- Parameters
-
tp | The particle for which we want isolation. |
cont | The container of particles. |
Definition at line 168 of file egammaTruthAlg.cxx.
◆ 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);
◆ 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.
◆ 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.
◆ 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]
◆ execute()
StatusCode D3PD::egammaTruthAlg::execute |
( |
const EventContext & |
ctx | ) |
const |
|
overridevirtual |
Standard Gaudi execute
method.
Definition at line 78 of file egammaTruthAlg.cxx.
82 auto pout = std::make_unique<xAOD::TruthParticleContainer>();
83 auto pout_aux = std::make_unique<xAOD::TruthParticleAuxContainer>();
84 pout->setStore (pout_aux.get());
86 #define DECOR(TYPE,N) xAOD::TruthParticle::Decorator<TYPE> N (m_auxPrefix + #N)
87 DECOR(
float, etaCalo);
88 DECOR(
float, phiCalo);
89 DECOR(
float, depthCalo);
90 DECOR(
float, Etcone20);
96 pout->push_back (std::make_unique<xAOD::TruthParticle>());
100 etaCalo(*
pout->back()),
101 phiCalo(*
pout->back()),
102 depthCalo(*
pout->back())) );
103 Etcone20(*
pout->back()) = iso;
110 return StatusCode::SUCCESS;
◆ 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
◆ extraOutputDeps()
const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps |
( |
| ) |
const |
|
overridevirtualinherited |
Return the list of extra output dependencies.
This list is extended to include symlinks implied by inheritance relations.
Definition at line 79 of file AthReentrantAlgorithm.cxx.
86 return Algorithm::extraOutputDeps();
◆ filterPassed()
virtual bool AthReentrantAlgorithm::filterPassed |
( |
const EventContext & |
ctx | ) |
const |
|
inlinevirtualinherited |
◆ findImpact()
StatusCode D3PD::egammaTruthAlg::findImpact |
( |
const xAOD::TruthParticle & |
tp, |
|
|
float & |
etaCalo, |
|
|
float & |
phiCalo, |
|
|
float & |
depthCalo |
|
) |
| const |
|
private |
Find the impact of a particle in the calorimeter.
- Parameters
-
p | The particle to analyze. |
etaCalo[out] | Eta of the particle's impact with the calorimeter. |
phiCalo[out] | Phi of the particle's impact with the calorimeter. |
depthCalo[out] | Depth of the particle's impact with the calorimeter (r for barrel and abs(z) for endcap). |
Definition at line 191 of file egammaTruthAlg.cxx.
200 std::unique_ptr<Trk::CaloExtension> extension =
201 m_exten->caloExtension(Gaudi::Hive::currentContext(),
tp);
204 return StatusCode::FAILURE;
209 for (
const auto& [sampling,
entry,
exit] : lvec) {
211 etaCalo =
entry.eta();
212 phiCalo =
entry.phi();
213 depthCalo =
entry.perp();
217 etaCalo =
entry.eta();
218 phiCalo =
entry.phi();
219 depthCalo = std::abs(
entry.z());
223 return StatusCode::SUCCESS;
◆ initialize()
StatusCode D3PD::egammaTruthAlg::initialize |
( |
| ) |
|
|
overridevirtual |
◆ 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.
◆ isAccepted()
Test to see if we accept a particle.
- Parameters
-
tp | The particle to test. |
cont | The container of particles. |
iso[out] | The isolation energy for this particle. |
Definition at line 120 of file egammaTruthAlg.cxx.
130 if (aid != abs(MC::ELECTRON) && !
MC::isPhoton(aid))
return false;
139 if(
tp.hasDecayVtx() ) {
141 size_t sz =
v->nOutgoingParticles();
142 for (
size_t i = 0;
i <
sz;
i++) {
154 if (aid == abs(MC::PHOTON)) {
◆ isClonable()
bool AthReentrantAlgorithm::isClonable |
( |
| ) |
const |
|
overridevirtualinherited |
Specify if the algorithm is clonable.
Reentrant algorithms are clonable.
Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, InDet::SiSPGNNTrackMaker, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, ITkStripCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.
Definition at line 44 of file AthReentrantAlgorithm.cxx.
◆ msg() [1/2]
◆ msg() [2/2]
◆ 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.
◆ renounce()
◆ renounceArray()
◆ setFilterPassed()
virtual void AthReentrantAlgorithm::setFilterPassed |
( |
bool |
state, |
|
|
const EventContext & |
ctx |
|
) |
| const |
|
inlinevirtualinherited |
◆ sysExecute()
StatusCode AthReentrantAlgorithm::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.
Definition at line 67 of file AthReentrantAlgorithm.cxx.
69 return Gaudi::Algorithm::sysExecute (ctx);
◆ sysInitialize()
StatusCode AthReentrantAlgorithm::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 InputMakerBase, and HypoBase.
Definition at line 96 of file AthReentrantAlgorithm.cxx.
107 if ( cs.retrieve().isFailure() ) {
109 return StatusCode::SUCCESS;
111 if (cs->regHandle(
this,*
h).isFailure()) {
112 sc = StatusCode::FAILURE;
113 ATH_MSG_ERROR(
"unable to register WriteCondHandle " <<
h->fullKey()
◆ 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()
◆ m_auxPrefix
std::string D3PD::egammaTruthAlg::m_auxPrefix |
|
private |
◆ m_detStore
◆ m_electronPtMin
float D3PD::egammaTruthAlg::m_electronPtMin |
|
private |
◆ m_etaMax
float D3PD::egammaTruthAlg::m_etaMax |
|
private |
◆ m_evtStore
◆ m_exten
◆ m_extendedExtraObjects
DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects |
|
privateinherited |
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
Empty if no symlinks were found.
Definition at line 153 of file AthReentrantAlgorithm.h.
◆ m_inputKey
◆ m_isoCone
float D3PD::egammaTruthAlg::m_isoCone |
|
private |
◆ m_outputKey
◆ m_photonEtIsoMax
float D3PD::egammaTruthAlg::m_photonEtIsoMax |
|
private |
◆ m_photonPtMin
float D3PD::egammaTruthAlg::m_photonPtMin |
|
private |
◆ m_varHandleArraysDeclared
◆ m_vhka
The documentation for this class was generated from the following files:
def pout(output, newline=True)
bool isSpecialNonInteracting(const T &p)
Identify a special non-interacting particles.
ToolHandle< Trk::IParticleCaloExtensionTool > m_exten
Property: Extrapolation tool to calorimeter.
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
std::string m_auxPrefix
Property: Prefix to add to aux data items.
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)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
bool isAccepted(const xAOD::TruthParticle &tp, const xAOD::TruthParticleContainer &cont, float &iso) const
Test to see if we accept a particle.
float m_etaMax
Property: Maximum eta.
bool is_same_particle(const T1 &p1, const T2 &p2)
Method to establish if two particles in the GenEvent actually represent the same particle.
float m_photonEtIsoMax
Property: Maximum isolation cone energy allowed to keep a photon.
virtual void setOwner(IDataHandleHolder *o)=0
SG::WriteHandleKey< xAOD::TruthParticleContainer > m_outputKey
Property: Name of the output container.
AthReentrantAlgorithm()
Default constructor:
float m_photonPtMin
Property: Minimum pt for photons.
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override
Return this algorithm's output handles.
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...
::StatusCode StatusCode
StatusCode definition for legacy code.
Class describing a truth particle in the MC record.
#define CHECK(...)
Evaluate an expression and check for errors.
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
std::vector< std::tuple< CaloSampling::CaloSample, Amg::Vector3D, Amg::Vector3D > > EntryExitPerLayerVector
DataObjIDColl m_extendedExtraObjects
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Class describing a truth vertex in the MC record.
virtual StatusCode sysInitialize() override
Override sysInitialize.
float m_isoCone
Property: Isolation cone width.
void entryExitPerLayerVector(const Trk::CaloExtension &extension, EntryExitPerLayerVector &result, const LayersToSelect *selection=nullptr)
#define REPORT_MESSAGE(LVL)
Report a message.
bool isStableOrSimDecayed(const T &p)
Identify if particle is satble or decayed in simulation.
bool isStable(const T &p)
Identify if the particle is stable, i.e. has not decayed.
#define ATH_MSG_WARNING(x)
bool isPhoton(const xAOD::Egamma *eg)
is the object a photon
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
SG::ReadHandleKey< xAOD::TruthParticleContainer > m_inputKey
Property: Name of the input container.
bool isZeroEnergyPhoton(const T &p)
Identify a photon with zero energy. Probably a workaround for a generator bug.
int generations(const T &p)
Method to return how many interactions a particle has undergone during simulation (TODO migrate to be...
int pdgId() const
PDG ID code.
float computeIso(const xAOD::TruthParticle &tp, const xAOD::TruthParticleContainer &cont) const
Compute isolation around a particle.
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
float m_electronPtMin
Property: Minimum pt for electrons.
StatusCode findImpact(const xAOD::TruthParticle &tp, float &etaCalo, float &phiCalo, float &depthCalo) const
Find the impact of a particle in the calorimeter.