From fd87782b409896d6f72456d22e1c205b8ac2cef4 Mon Sep 17 00:00:00 2001 From: tmadlener Date: Tue, 23 Apr 2024 10:41:14 +0200 Subject: [PATCH] Add section about how (not) to use the PIDHandler --- doc/PIDHandler.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/PIDHandler.md b/doc/PIDHandler.md index 165a9206f..b2a6ae506 100644 --- a/doc/PIDHandler.md +++ b/doc/PIDHandler.md @@ -13,6 +13,23 @@ features are allows one to, e.g. get all `ParticleID`s that point to a specific `ReconstructedParticle`. +### When (not) to use the PIDHandler +NOTE: Depending on how you use the `PIDHandler` it might incur an unnecessary +performance overhead. The main purpose is to use it in cases, where the relation +between `ParticleID`s and `ReconstructedParticle`s is not trivial, e.g. +- When the two collections do **not** run in parallel +- When not all `ReconstructedParticle`s have a `ParticleID` attached +- When you want to have access to several `ParticleID`s for a given + `ReonstructedParticle` and there is no trivial relation between them. + +In case your collections run in parallel it will be much quicker to just loop +over them in parallel. + +In case you just want look at one `ParticleID` collection, but need to look at +some properties of the `ReconstructedParticle`, simply use the existing relation +to do that. + + ## ParticleIDMeta basics `ParticleIDMeta` is a simple struct that bundles all ParticleID meta information for one collection together. Whenever metadata is involved for ParticleIDs this