Belle II Software development
MetaVariables.cc
1/**************************************************************************
2 * basf2 (Belle II Analysis Software Framework) *
3 * Author: The Belle II Collaboration *
4 * *
5 * See git log for contributors and copyright holders. *
6 * This file is licensed under LGPL-3.0, see LICENSE.md. *
7 **************************************************************************/
8
9// Own header.
10#include <analysis/variables/MetaVariables.h>
11#include <analysis/variables/MCTruthVariables.h>
12
13#include <analysis/VariableManager/Utility.h>
14#include <analysis/dataobjects/Particle.h>
15#include <analysis/dataobjects/ParticleList.h>
16#include <analysis/dataobjects/EventKinematics.h>
17#include <analysis/utility/PCmsLabTransform.h>
18#include <analysis/utility/ReferenceFrame.h>
19#include <analysis/utility/EvtPDLUtil.h>
20#include <analysis/utility/ParticleCopy.h>
21#include <analysis/utility/ValueIndexPairSorting.h>
22#include <analysis/ClusterUtility/ClusterUtils.h>
23#include <analysis/variables/VariableFormulaConstructor.h>
24
25#include <framework/logging/Logger.h>
26#include <framework/datastore/StoreArray.h>
27#include <framework/datastore/StoreObjPtr.h>
28#include <framework/dataobjects/EventExtraInfo.h>
29#include <framework/utilities/Conversion.h>
30#include <framework/utilities/MakeROOTCompatible.h>
31#include <framework/gearbox/Const.h>
32
33#include <mdst/dataobjects/Track.h>
34#include <mdst/dataobjects/MCParticle.h>
35#include <mdst/dataobjects/ECLCluster.h>
36#include <mdst/dataobjects/TrackFitResult.h>
37
38#include <boost/algorithm/string.hpp>
39#include <limits>
40
41#include <cmath>
42#include <stdexcept>
43#include <regex>
44
45#include <TDatabasePDG.h>
46#include <Math/Vector4D.h>
47#include <Math/VectorUtil.h>
48
49namespace Belle2 {
54 namespace Variable {
55 double requireDoubleForFrameVariable(const Variable::Manager::Var* var,
57 const std::string& frameFunction)
58 {
59 if (std::holds_alternative<double>(value)) {
60 return std::get<double>(value);
61 }
62
63 const char* returnedType = std::holds_alternative<int>(value) ? "int" : "bool";
64 B2ERROR("Meta function " << frameFunction << " expects a double variable, but '" << var->name
65 << "' returned " << returnedType << ". Returning NaN.");
66 return Const::doubleNaN;
67 }
68
69 Manager::FunctionPtr useRestFrame(const std::vector<std::string>& arguments)
70 {
71 if (arguments.size() == 1) {
72 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
73 auto func = [var](const Particle * particle) -> double {
74 UseReferenceFrame<RestFrame> frame(particle);
75 return requireDoubleForFrameVariable(var, var->function(particle), "useRestFrame");
76 };
77 return func;
78 } else {
79 B2FATAL("Wrong number of arguments for meta function useRestFrame");
80 }
81 }
82
83 Manager::FunctionPtr useCMSFrame(const std::vector<std::string>& arguments)
84 {
85 if (arguments.size() == 1) {
86 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
87 auto func = [var](const Particle * particle) -> double {
88 UseReferenceFrame<CMSFrame> frame;
89 return requireDoubleForFrameVariable(var, var->function(particle), "useCMSFrame");
90 };
91 return func;
92 } else {
93 B2FATAL("Wrong number of arguments for meta function useCMSFrame");
94 }
95 }
96
97 Manager::FunctionPtr useLabFrame(const std::vector<std::string>& arguments)
98 {
99 if (arguments.size() == 1) {
100 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
101 auto func = [var](const Particle * particle) -> double {
102 UseReferenceFrame<LabFrame> frame;
103 return requireDoubleForFrameVariable(var, var->function(particle), "useLabFrame");
104 };
105 return func;
106 } else {
107 B2FATAL("Wrong number of arguments for meta function useLabFrame");
108 }
109 }
110
111 Manager::FunctionPtr useTagSideRecoilRestFrame(const std::vector<std::string>& arguments)
112 {
113 if (arguments.size() == 2) {
114 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
115 auto daughterFunction = convertToDaughterIndex({arguments[1]});
116 auto func = [var, daughterFunction](const Particle * particle) -> double {
117 int daughterIndexTagB = std::get<int>(daughterFunction(particle));
118 if (daughterIndexTagB < 0)
119 return Const::doubleNaN;
120
121 if (particle->getPDGCode() != 300553)
122 {
123 B2ERROR("Variable should only be used on a Upsilon(4S) Particle List!");
124 return Const::doubleNaN;
125 }
126
127 PCmsLabTransform T;
128 ROOT::Math::PxPyPzEVector pSigB = T.getBeamFourMomentum() - particle->getDaughter(daughterIndexTagB)->get4Vector();
129 Particle tmp(pSigB, -particle->getDaughter(daughterIndexTagB)->getPDGCode());
130
131 UseReferenceFrame<RestFrame> frame(&tmp);
132 return requireDoubleForFrameVariable(var, var->function(particle), "useTagSideRecoilRestFrame");
133 };
134
135 return func;
136 } else {
137 B2FATAL("Wrong number of arguments for meta function useTagSideRecoilRestFrame");
138 }
139 }
140
141 Manager::FunctionPtr useParticleRestFrame(const std::vector<std::string>& arguments)
142 {
143 if (arguments.size() == 2) {
144 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
145 std::string listName = arguments[1];
146 auto func = [var, listName](const Particle * particle) -> double {
147 StoreObjPtr<ParticleList> list(listName);
148 unsigned listSize = list->getListSize();
149 if (listSize == 0)
150 return Const::doubleNaN;
151 if (listSize > 1)
152 B2WARNING("The selected ParticleList contains more than 1 Particles in this event. The variable useParticleRestFrame will use only the first candidate, and the result may not be the expected one."
153 << LogVar("ParticleList", listName)
154 << LogVar("Number of candidates in the list", listSize));
155 const Particle* p = list->getParticle(0);
156 UseReferenceFrame<RestFrame> frame(p);
157 return requireDoubleForFrameVariable(var, var->function(particle), "useParticleRestFrame");
158 };
159 return func;
160 } else {
161 B2FATAL("Wrong number of arguments for meta function useParticleRestFrame.");
162 }
163 }
164
165 Manager::FunctionPtr useRecoilParticleRestFrame(const std::vector<std::string>& arguments)
166 {
167 if (arguments.size() == 2) {
168 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
169 std::string listName = arguments[1];
170 auto func = [var, listName](const Particle * particle) -> double {
171 StoreObjPtr<ParticleList> list(listName);
172 unsigned listSize = list->getListSize();
173 if (listSize == 0)
174 return Const::doubleNaN;
175 if (listSize > 1)
176 B2WARNING("The selected ParticleList contains more than 1 Particles in this event. The variable useParticleRestFrame will use only the first candidate, and the result may not be the expected one."
177 << LogVar("ParticleList", listName)
178 << LogVar("Number of candidates in the list", listSize));
179 const Particle* p = list->getParticle(0);
180 PCmsLabTransform T;
181 ROOT::Math::PxPyPzEVector recoil = T.getBeamFourMomentum() - p->get4Vector();
182 /* Let's use 0 as PDG code to avoid wrong assumptions. */
183 Particle pRecoil(recoil, 0);
184 pRecoil.setVertex(particle->getVertex());
185 UseReferenceFrame<RestFrame> frame(&pRecoil);
186 return requireDoubleForFrameVariable(var, var->function(particle), "useRecoilParticleRestFrame");
187 };
188 return func;
189 } else {
190 B2FATAL("Wrong number of arguments for meta function useParticleRestFrame.");
191 }
192 }
193
194 Manager::FunctionPtr useDaughterRestFrame(const std::vector<std::string>& arguments)
195 {
196 if (arguments.size() >= 2) {
197 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
198 auto func = [var, arguments](const Particle * particle) -> double {
199
200 // Sum of the 4-momenta of all the selected daughters
201 ROOT::Math::PxPyPzEVector pSum(0, 0, 0, 0);
202
203 for (unsigned int i = 1; i < arguments.size(); i++)
204 {
205 auto generalizedIndex = arguments[i];
206 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
207 if (dauPart)
208 pSum += dauPart->get4Vector();
209 else
210 return Const::doubleNaN;
211 }
212 Particle tmp(pSum, 0);
213 UseReferenceFrame<RestFrame> frame(&tmp);
214 return requireDoubleForFrameVariable(var, var->function(particle), "useDaughterRestFrame");
215 };
216 return func;
217 } else {
218 B2FATAL("Wrong number of arguments for meta function useDaughterRestFrame.");
219 }
220 }
221
222 Manager::FunctionPtr useDaughterRecoilRestFrame(const std::vector<std::string>& arguments)
223 {
224 if (arguments.size() >= 2) {
225 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
226 auto func = [var, arguments](const Particle * particle) -> double {
227
228 // Sum of the 4-momenta of all the selected daughters
229 ROOT::Math::PxPyPzEVector pSum(0, 0, 0, 0);
230
231 for (unsigned int i = 1; i < arguments.size(); i++)
232 {
233 auto generalizedIndex = arguments[i];
234 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
235 if (dauPart)
236 pSum += dauPart->get4Vector();
237 else
238 return Const::doubleNaN;
239 }
240 PCmsLabTransform T;
241 ROOT::Math::PxPyPzEVector recoil = T.getBeamFourMomentum() - pSum;
242 /* Let's use 0 as PDG code to avoid wrong assumptions. */
243 Particle pRecoil(recoil, 0);
244 UseReferenceFrame<RestFrame> frame(&pRecoil);
245 return requireDoubleForFrameVariable(var, var->function(particle), "useDaughterRecoilRestFrame");
246 };
247 return func;
248 } else {
249 B2FATAL("Wrong number of arguments for meta function useDaughterRecoilRestFrame.");
250 }
251 }
252
253 Manager::FunctionPtr useMCancestorBRestFrame(const std::vector<std::string>& arguments)
254 {
255 if (arguments.size() == 1) {
256 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
257 auto func = [var](const Particle * particle) -> double {
258 int index = ancestorBIndex(particle);
259 if (index < 0) return Const::doubleNaN;
260 StoreArray<MCParticle> mcparticles;
261 Particle temp(mcparticles[index]);
262 UseReferenceFrame<RestFrame> frame(&temp);
263 return requireDoubleForFrameVariable(var, var->function(particle), "useMCancestorBRestFrame");
264 };
265 return func;
266 } else {
267 B2FATAL("Wrong number of arguments for meta function useMCancestorBRestFrame.");
268 }
269 }
270
271 Manager::FunctionPtr extraInfo(const std::vector<std::string>& arguments)
272 {
273 if (arguments.size() == 1) {
274 auto extraInfoName = arguments[0];
275 auto func = [extraInfoName](const Particle * particle) -> double {
276 if (particle == nullptr)
277 {
278 B2WARNING("Returns NaN because the particle is nullptr! If you want EventExtraInfo variables, please use eventExtraInfo() instead");
279 return Const::doubleNaN;
280 }
281 if (particle->hasExtraInfo(extraInfoName))
282 {
283 return particle->getExtraInfo(extraInfoName);
284 } else
285 {
286 return Const::doubleNaN;
287 }
288 };
289 return func;
290 } else {
291 B2FATAL("Wrong number of arguments for meta function extraInfo");
292 }
293 }
294
295 Manager::FunctionPtr eventExtraInfo(const std::vector<std::string>& arguments)
296 {
297 if (arguments.size() == 1) {
298 auto extraInfoName = arguments[0];
299 auto func = [extraInfoName](const Particle*) -> double {
300 StoreObjPtr<EventExtraInfo> eventExtraInfo;
301 if (not eventExtraInfo.isValid())
302 return Const::doubleNaN;
303 if (eventExtraInfo->hasExtraInfo(extraInfoName))
304 {
305 return eventExtraInfo->getExtraInfo(extraInfoName);
306 } else
307 {
308 return Const::doubleNaN;
309 }
310 };
311 return func;
312 } else {
313 B2FATAL("Wrong number of arguments for meta function extraInfo");
314 }
315 }
316
317 Manager::FunctionPtr eventCached(const std::vector<std::string>& arguments)
318 {
319 if (arguments.size() == 1) {
320 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
321 std::string key = std::string("__") + MakeROOTCompatible::makeROOTCompatible(var->name);
322 auto func = [var, key](const Particle*) -> double {
323
324 StoreObjPtr<EventExtraInfo> eventExtraInfo;
325 if (not eventExtraInfo.isValid())
326 eventExtraInfo.create();
327 if (eventExtraInfo->hasExtraInfo(key))
328 {
329 return eventExtraInfo->getExtraInfo(key);
330 } else
331 {
332 double value = Const::doubleNaN;
333 auto var_result = var->function(nullptr);
334 if (std::holds_alternative<double>(var_result)) {
335 value = std::get<double>(var_result);
336 } else if (std::holds_alternative<int>(var_result)) {
337 return std::get<int>(var_result);
338 } else if (std::holds_alternative<bool>(var_result)) {
339 return std::get<bool>(var_result);
340 }
341 eventExtraInfo->addExtraInfo(key, value);
342 return value;
343 }
344 };
345 return func;
346 } else {
347 B2FATAL("Wrong number of arguments for meta function eventCached");
348 }
349 }
350
351 Manager::FunctionPtr particleCached(const std::vector<std::string>& arguments)
352 {
353 if (arguments.size() == 1) {
354 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
355 std::string key = std::string("__") + MakeROOTCompatible::makeROOTCompatible(var->name);
356 auto func = [var, key](const Particle * particle) -> double {
357
358 if (particle->hasExtraInfo(key))
359 {
360 return particle->getExtraInfo(key);
361 } else
362 {
363 double value = std::get<double>(var->function(particle));
364 // Remove constness from Particle pointer.
365 // The extra-info is used as a cache in our case,
366 // indicated by the double-underscore in front of the key.
367 // One could implement the cache as a separate property of the particle object
368 // and mark it as mutable, however, this would only lead to code duplication
369 // and an increased size of the particle object.
370 // Thus, we decided to use the extra-info field and cast away the const in this case.
371 const_cast<Particle*>(particle)->addExtraInfo(key, value);
372 return value;
373 }
374 };
375 return func;
376 } else {
377 B2FATAL("Wrong number of arguments for meta function particleCached");
378 }
379 }
380
381 // Formula of other variables, going to require a space between all operators and operations.
382 // Later can add some check for : (colon) trailing + or - to distinguish between particle lists
383 // and operations, but for now cbf.
384 Manager::FunctionPtr formula(const std::vector<std::string>& arguments)
385 {
386 if (arguments.size() != 1) B2FATAL("Wrong number of arguments for meta function formula");
387 FormulaParser<VariableFormulaConstructor> parser;
388 try {
389 return parser.parse(arguments[0]);
390 } catch (std::runtime_error& e) {
391 B2FATAL(e.what());
392 }
393 }
394
395 Manager::FunctionPtr nCleanedTracks(const std::vector<std::string>& arguments)
396 {
397 if (arguments.size() <= 1) {
398
399 std::string cutString;
400 if (arguments.size() == 1)
401 cutString = arguments[0];
402 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
403 auto func = [cut](const Particle*) -> int {
404
405 int number_of_tracks = 0;
406 StoreArray<Track> tracks;
407 for (const auto& track : tracks)
408 {
409 const TrackFitResult* trackFit = track.getTrackFitResultWithClosestMass(Const::pion);
410 if (!trackFit) continue;
411 if (trackFit->getChargeSign() == 0) {
412 // Ignore track
413 } else {
414 Particle particle(&track, Const::pion);
415 if (cut->check(&particle))
416 number_of_tracks++;
417 }
418 }
419
420 return number_of_tracks;
421
422 };
423 return func;
424 } else {
425 B2FATAL("Wrong number of arguments for meta function nCleanedTracks");
426 }
427 }
428
429 Manager::FunctionPtr nCleanedECLClusters(const std::vector<std::string>& arguments)
430 {
431 if (arguments.size() <= 1) {
432
433 std::string cutString;
434 if (arguments.size() == 1)
435 cutString = arguments[0];
436 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
437 auto func = [cut](const Particle*) -> int {
438
439 int number_of_clusters = 0;
440 StoreArray<ECLCluster> clusters;
441 for (const auto& cluster : clusters)
442 {
443 // look only at momentum of N1 (n photons) ECLClusters
444 if (!cluster.hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons))
445 continue;
446
447 Particle particle(&cluster);
448 if (cut->check(&particle))
449 number_of_clusters++;
450 }
451
452 return number_of_clusters;
453
454 };
455 return func;
456 } else {
457 B2FATAL("Wrong number of arguments for meta function nCleanedECLClusters");
458 }
459 }
460
461 Manager::FunctionPtr passesCut(const std::vector<std::string>& arguments)
462 {
463 if (arguments.size() == 1) {
464 std::string cutString = arguments[0];
465 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
466 auto func = [cut](const Particle * particle) -> bool {
467 if (cut->check(particle))
468 return 1;
469 else
470 return 0;
471 };
472 return func;
473 } else {
474 B2FATAL("Wrong number of arguments for meta function passesCut");
475 }
476 }
477
478 Manager::FunctionPtr passesEventCut(const std::vector<std::string>& arguments)
479 {
480 if (arguments.size() == 1) {
481 std::string cutString = arguments[0];
482 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
483 auto func = [cut](const Particle*) -> bool {
484 if (cut->check(nullptr))
485 return 1;
486 else
487 return 0;
488 };
489 return func;
490 } else {
491 B2FATAL("Wrong number of arguments for meta function passesEventCut");
492 }
493 }
494
495 Manager::FunctionPtr varFor(const std::vector<std::string>& arguments)
496 {
497 if (arguments.size() == 2) {
498 int pdgCode = 0;
499 try {
500 pdgCode = convertString<int>(arguments[0]);
501 } catch (std::invalid_argument&) {
502 B2FATAL("The first argument of varFor meta function must be a positive integer!");
503 }
504 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
505 auto func = [pdgCode, var](const Particle * particle) -> double {
506 if (std::abs(particle->getPDGCode()) == std::abs(pdgCode))
507 {
508 auto var_result = var->function(particle);
509 if (std::holds_alternative<double>(var_result)) {
510 return std::get<double>(var_result);
511 } else if (std::holds_alternative<int>(var_result)) {
512 return std::get<int>(var_result);
513 } else if (std::holds_alternative<bool>(var_result)) {
514 return std::get<bool>(var_result);
515 } else return Const::doubleNaN;
516 } else return Const::doubleNaN;
517 };
518 return func;
519 } else {
520 B2FATAL("Wrong number of arguments for meta function varFor");
521 }
522 }
523
524 Manager::FunctionPtr varForMCGen(const std::vector<std::string>& arguments)
525 {
526 if (arguments.size() == 1) {
527 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
528 auto func = [var](const Particle * particle) -> double {
529 if (particle->getMCParticle())
530 {
531 if (particle->getMCParticle()->getStatus(MCParticle::c_PrimaryParticle)
532 && (! particle->getMCParticle()->getStatus(MCParticle::c_IsVirtual))
533 && (! particle->getMCParticle()->getStatus(MCParticle::c_Initial))) {
534 auto var_result = var->function(particle);
535 if (std::holds_alternative<double>(var_result)) {
536 return std::get<double>(var_result);
537 } else if (std::holds_alternative<int>(var_result)) {
538 return std::get<int>(var_result);
539 } else if (std::holds_alternative<bool>(var_result)) {
540 return std::get<bool>(var_result);
541 } else return Const::doubleNaN;
542 } else return Const::doubleNaN;
543 } else return Const::doubleNaN;
544 };
545 return func;
546 } else {
547 B2FATAL("Wrong number of arguments for meta function varForMCGen");
548 }
549 }
550
551 Manager::FunctionPtr nParticlesInList(const std::vector<std::string>& arguments)
552 {
553 if (arguments.size() == 1) {
554 std::string listName = arguments[0];
555 auto func = [listName](const Particle * particle) -> int {
556
557 (void) particle;
558 StoreObjPtr<ParticleList> listOfParticles(listName);
559
560 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to nParticlesInList");
561
562 return listOfParticles->getListSize();
563
564 };
565 return func;
566 } else {
567 B2FATAL("Wrong number of arguments for meta function nParticlesInList");
568 }
569 }
570
571 Manager::FunctionPtr isInList(const std::vector<std::string>& arguments)
572 {
573 // unpack arguments, there should be only one: the name of the list we're checking
574 if (arguments.size() != 1) {
575 B2FATAL("Wrong number of arguments for isInList");
576 }
577 auto listName = arguments[0];
578
579 auto func = [listName](const Particle * particle) -> bool {
580
581 // check the list exists
582 StoreObjPtr<ParticleList> list(listName);
583 if (!(list.isValid()))
584 {
585 B2FATAL("Invalid Listname " << listName << " given to isInList");
586 }
587
588 // is the particle in the list?
589 return list->contains(particle);
590
591 };
592 return func;
593 }
594
595 Manager::FunctionPtr sourceObjectIsInList(const std::vector<std::string>& arguments)
596 {
597 // unpack arguments, there should be only one: the name of the list we're checking
598 if (arguments.size() != 1) {
599 B2FATAL("Wrong number of arguments for sourceObjectIsInList");
600 }
601 auto listName = arguments[0];
602
603 auto func = [listName](const Particle * particle) -> int {
604
605 // check the list exists
606 StoreObjPtr<ParticleList> list(listName);
607 if (!(list.isValid()))
608 {
609 B2FATAL("Invalid Listname " << listName << " given to sourceObjectIsInList");
610 }
611
612 // this only makes sense for particles that are *not* composite and come
613 // from some mdst object (tracks, clusters..)
614 Particle::EParticleSourceObject particlesource = particle->getParticleSource();
615 if (particlesource == Particle::EParticleSourceObject::c_Composite
616 or particlesource == Particle::EParticleSourceObject::c_Undefined)
617 return -1;
618
619 // it *is* possible to have a particle list from different sources (like
620 // hadrons from the ECL and KLM) so we have to check each particle in
621 // the list individually
622 for (unsigned i = 0; i < list->getListSize(); ++i)
623 {
624 Particle* iparticle = list->getParticle(i);
625 if (particle->getMdstSource() == iparticle->getMdstSource())
626 return 1;
627 }
628 return 0;
629
630 };
631 return func;
632 }
633
634 Manager::FunctionPtr mcParticleIsInMCList(const std::vector<std::string>& arguments)
635 {
636 // unpack arguments, there should be only one: the name of the list we're checking
637 if (arguments.size() != 1) {
638 B2FATAL("Wrong number of arguments for mcParticleIsInMCList");
639 }
640 auto listName = arguments[0];
641
642 auto func = [listName](const Particle * particle) -> bool {
643
644 // check the list exists
645 StoreObjPtr<ParticleList> list(listName);
646 if (!(list.isValid()))
647 B2FATAL("Invalid Listname " << listName << " given to mcParticleIsInMCList");
648
649 // this can only be true for mc-matched particles or particles are created from MCParticles
650 const MCParticle* mcp = particle->getMCParticle();
651 if (mcp == nullptr) return false;
652
653 // check every particle in the input list is not matched to (or created from) the same MCParticle
654 for (unsigned i = 0; i < list->getListSize(); ++i)
655 {
656 const MCParticle* imcp = list->getParticle(i)->getMCParticle();
657 if ((imcp != nullptr) and (mcp->getArrayIndex() == imcp->getArrayIndex()))
658 return true;
659 }
660 return false;
661 };
662 return func;
663 }
664
665 Manager::FunctionPtr isDaughterOfList(const std::vector<std::string>& arguments)
666 {
667 B2WARNING("isDaughterOfList is outdated and replaced by isDescendantOfList.");
668 std::vector<std::string> new_arguments = arguments;
669 new_arguments.push_back(std::string("1"));
670 return isDescendantOfList(new_arguments);
671 }
672
673 Manager::FunctionPtr isGrandDaughterOfList(const std::vector<std::string>& arguments)
674 {
675 B2WARNING("isGrandDaughterOfList is outdated and replaced by isDescendantOfList.");
676 std::vector<std::string> new_arguments = arguments;
677 new_arguments.push_back(std::string("2"));
678 return isDescendantOfList(new_arguments);
679 }
680
681 Manager::FunctionPtr isDescendantOfList(const std::vector<std::string>& arguments)
682 {
683 if (arguments.size() > 0) {
684 auto listNames = arguments;
685 auto func = [listNames](const Particle * particle) -> bool {
686 bool output = false;
687 int generation_flag = -1;
688 try
689 {
690 generation_flag = convertString<int>(listNames.back());
691 } catch (std::exception& e) {}
692
693 for (auto& iListName : listNames)
694 {
695 try {
696 convertString<int>(iListName);
697 continue;
698 } catch (std::exception& e) {}
699
700 // Creating recursive lambda
701 auto list_comparison = [](auto&& self, const Particle * m, const Particle * p, int flag)-> bool {
702 bool result = false;
703 for (unsigned i = 0; i < m->getNDaughters(); ++i)
704 {
705 const Particle* daughter = m->getDaughter(i);
706 if ((flag == 1.) or (flag < 0)) {
707 if (p->isCopyOf(daughter)) {
708 return true;
709 }
710 }
711
712 if (flag != 1.) {
713 if (daughter->getNDaughters() > 0) {
714 result = self(self, daughter, p, flag - 1);
715 if (result == 1) {
716 return true;
717 }
718 }
719 }
720 }
721 return result;
722 };
723
724 StoreObjPtr<ParticleList> listOfParticles(iListName);
725
726 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << iListName << " given to isDescendantOfList");
727
728 for (unsigned i = 0; i < listOfParticles->getListSize(); ++i) {
729 Particle* iParticle = listOfParticles->getParticle(i);
730 output = list_comparison(list_comparison, iParticle, particle, generation_flag);
731 if (output) {
732 return output;
733 }
734 }
735 }
736 return output;
737 };
738 return func;
739 } else {
740 B2FATAL("Wrong number of arguments for meta function isDescendantOfList");
741 }
742 }
743
744 Manager::FunctionPtr isMCDescendantOfList(const std::vector<std::string>& arguments)
745 {
746 if (arguments.size() > 0) {
747 auto listNames = arguments;
748 auto func = [listNames](const Particle * particle) -> bool {
749 bool output = false;
750 int generation_flag = -1;
751 try
752 {
753 generation_flag = convertString<int>(listNames.back());
754 } catch (std::exception& e) {}
755
756 if (particle->getMCParticle() == nullptr)
757 {
758 return false;
759 }
760
761 for (auto& iListName : listNames)
762 {
763 try {
764 std::stod(iListName);
765 continue;
766 } catch (std::exception& e) {}
767 // Creating recursive lambda
768 auto list_comparison = [](auto&& self, const Particle * m, const Particle * p, int flag)-> bool {
769 bool result = false;
770 for (unsigned i = 0; i < m->getNDaughters(); ++i)
771 {
772 const Particle* daughter = m->getDaughter(i);
773 if ((flag == 1.) or (flag < 0)) {
774 if (daughter->getMCParticle() != nullptr) {
775 if (p->getMCParticle()->getArrayIndex() == daughter->getMCParticle()->getArrayIndex()) {
776 return true;
777 }
778 }
779 }
780 if (flag != 1.) {
781 if (daughter->getNDaughters() > 0) {
782 result = self(self, daughter, p, flag - 1);
783 if (result) {
784 return true;
785 }
786 }
787 }
788 }
789 return result;
790 };
791
792 StoreObjPtr<ParticleList> listOfParticles(iListName);
793
794 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << iListName << " given to isMCDescendantOfList");
795
796 for (unsigned i = 0; i < listOfParticles->getListSize(); ++i) {
797 Particle* iParticle = listOfParticles->getParticle(i);
798 output = list_comparison(list_comparison, iParticle, particle, generation_flag);
799 if (output) {
800 return output;
801 }
802 }
803 }
804 return output;
805 };
806 return func;
807 } else {
808 B2FATAL("Wrong number of arguments for meta function isMCDescendantOfList");
809 }
810 }
811
812 Manager::FunctionPtr daughterProductOf(const std::vector<std::string>& arguments)
813 {
814 if (arguments.size() == 1) {
815 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
816 auto func = [var](const Particle * particle) -> double {
817 double product = 1.0;
818 if (particle->getNDaughters() == 0)
819 {
820 return Const::doubleNaN;
821 }
822 if (std::holds_alternative<double>(var->function(particle->getDaughter(0))))
823 {
824 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
825 product *= std::get<double>(var->function(particle->getDaughter(j)));
826 }
827 } else if (std::holds_alternative<int>(var->function(particle->getDaughter(0))))
828 {
829 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
830 product *= std::get<int>(var->function(particle->getDaughter(j)));
831 }
832 } else return Const::doubleNaN;
833 return product;
834 };
835 return func;
836 } else {
837 B2FATAL("Wrong number of arguments for meta function daughterProductOf");
838 }
839 }
840
841 Manager::FunctionPtr daughterSumOf(const std::vector<std::string>& arguments)
842 {
843 if (arguments.size() == 1) {
844 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
845 auto func = [var](const Particle * particle) -> double {
846 double sum = 0.0;
847 if (particle->getNDaughters() == 0)
848 {
849 return Const::doubleNaN;
850 }
851 if (std::holds_alternative<double>(var->function(particle->getDaughter(0))))
852 {
853 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
854 sum += std::get<double>(var->function(particle->getDaughter(j)));
855 }
856 } else if (std::holds_alternative<int>(var->function(particle->getDaughter(0))))
857 {
858 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
859 sum += std::get<int>(var->function(particle->getDaughter(j)));
860 }
861 } else return Const::doubleNaN;
862 return sum;
863 };
864 return func;
865 } else {
866 B2FATAL("Wrong number of arguments for meta function daughterSumOf");
867 }
868 }
869
870 Manager::FunctionPtr daughterLowest(const std::vector<std::string>& arguments)
871 {
872 if (arguments.size() == 1) {
873 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
874 auto func = [var](const Particle * particle) -> double {
875 double min = Const::doubleNaN;
876 if (particle->getNDaughters() == 0)
877 {
878 return Const::doubleNaN;
879 }
880 if (std::holds_alternative<double>(var->function(particle->getDaughter(0))))
881 {
882 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
883 double iValue = std::get<double>(var->function(particle->getDaughter(j)));
884 if (std::isnan(iValue)) continue;
885 if (std::isnan(min)) min = iValue;
886 if (iValue < min) min = iValue;
887 }
888 } else if (std::holds_alternative<int>(var->function(particle->getDaughter(0))))
889 {
890 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
891 int iValue = std::get<int>(var->function(particle->getDaughter(j)));
892 if (std::isnan(min)) min = iValue;
893 if (iValue < min) min = iValue;
894 }
895 }
896 return min;
897 };
898 return func;
899 } else {
900 B2FATAL("Wrong number of arguments for meta function daughterLowest");
901 }
902 }
903
904 Manager::FunctionPtr daughterHighest(const std::vector<std::string>& arguments)
905 {
906 if (arguments.size() == 1) {
907 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
908 auto func = [var](const Particle * particle) -> double {
909 double max = Const::doubleNaN;
910 if (particle->getNDaughters() == 0)
911 {
912 return Const::doubleNaN;
913 }
914 if (std::holds_alternative<double>(var->function(particle->getDaughter(0))))
915 {
916 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
917 double iValue = std::get<double>(var->function(particle->getDaughter(j)));
918 if (std::isnan(iValue)) continue;
919 if (std::isnan(max)) max = iValue;
920 if (iValue > max) max = iValue;
921 }
922 } else if (std::holds_alternative<int>(var->function(particle->getDaughter(0))))
923 {
924 for (unsigned j = 0; j < particle->getNDaughters(); ++j) {
925 int iValue = std::get<int>(var->function(particle->getDaughter(j)));
926 if (std::isnan(max)) max = iValue;
927 if (iValue > max) max = iValue;
928 }
929 }
930 return max;
931 };
932 return func;
933 } else {
934 B2FATAL("Wrong number of arguments for meta function daughterHighest");
935 }
936 }
937
938 Manager::FunctionPtr daughterDiffOf(const std::vector<std::string>& arguments)
939 {
940 if (arguments.size() == 3) {
941 auto func = [arguments](const Particle * particle) -> double {
942 if (particle == nullptr)
943 return Const::doubleNaN;
944 const Particle* dau_i = particle->getParticleFromGeneralizedIndexString(arguments[0]);
945 const Particle* dau_j = particle->getParticleFromGeneralizedIndexString(arguments[1]);
946 auto variablename = arguments[2];
947 if (dau_i == nullptr || dau_j == nullptr)
948 {
949 B2ERROR("One of the first two arguments doesn't specify a valid (grand-)daughter!");
950 return Const::doubleNaN;
951 }
952 const Variable::Manager::Var* var = Manager::Instance().getVariable(variablename);
953 auto result_j = var->function(dau_j);
954 auto result_i = var->function(dau_i);
955 double diff = Const::doubleNaN;
956 if (std::holds_alternative<double>(result_j) && std::holds_alternative<double>(result_i))
957 {
958 diff = std::get<double>(result_j) - std::get<double>(result_i);
959 } else if (std::holds_alternative<int>(result_j) && std::holds_alternative<int>(result_i))
960 {
961 diff = std::get<int>(result_j) - std::get<int>(result_i);
962 } else
963 {
964 throw std::runtime_error("Bad variant access");
965 }
966 if (variablename == "phi" or variablename == "clusterPhi" or std::regex_match(variablename, std::regex("use.*Frame\\(phi\\)"))
967 or std::regex_match(variablename, std::regex("use.*Frame\\(clusterPhi\\)")))
968 {
969 if (fabs(diff) > M_PI) {
970 if (diff > M_PI) {
971 diff = diff - 2 * M_PI;
972 } else {
973 diff = 2 * M_PI + diff;
974 }
975 }
976 }
977 return diff;
978 };
979 return func;
980 } else {
981 B2FATAL("Wrong number of arguments for meta function daughterDiffOf");
982 }
983 }
984
985 Manager::FunctionPtr mcDaughterDiffOf(const std::vector<std::string>& arguments)
986 {
987 if (arguments.size() == 3) {
988 auto func = [arguments](const Particle * particle) -> double {
989 if (particle == nullptr)
990 return Const::doubleNaN;
991 const Particle* dau_i = particle->getParticleFromGeneralizedIndexString(arguments[0]);
992 const Particle* dau_j = particle->getParticleFromGeneralizedIndexString(arguments[1]);
993 auto variablename = arguments[2];
994 if (dau_i == nullptr || dau_j == nullptr)
995 {
996 B2ERROR("One of the first two arguments doesn't specify a valid (grand-)daughter!");
997 return Const::doubleNaN;
998 }
999 const MCParticle* iMcDaughter = dau_i->getMCParticle();
1000 const MCParticle* jMcDaughter = dau_j->getMCParticle();
1001 if (iMcDaughter == nullptr || jMcDaughter == nullptr)
1002 return Const::doubleNaN;
1003 Particle iTmpPart(iMcDaughter);
1004 Particle jTmpPart(jMcDaughter);
1005 const Variable::Manager::Var* var = Manager::Instance().getVariable(variablename);
1006 auto result_j = var->function(&jTmpPart);
1007 auto result_i = var->function(&iTmpPart);
1008 double diff = Const::doubleNaN;
1009 if (std::holds_alternative<double>(result_j) && std::holds_alternative<double>(result_i))
1010 {
1011 diff = std::get<double>(result_j) - std::get<double>(result_i);
1012 } else if (std::holds_alternative<int>(result_j) && std::holds_alternative<int>(result_i))
1013 {
1014 diff = std::get<int>(result_j) - std::get<int>(result_i);
1015 } else
1016 {
1017 throw std::runtime_error("Bad variant access");
1018 }
1019 if (variablename == "phi" or std::regex_match(variablename, std::regex("use.*Frame\\(phi\\)")))
1020 {
1021 if (fabs(diff) > M_PI) {
1022 if (diff > M_PI) {
1023 diff = diff - 2 * M_PI;
1024 } else {
1025 diff = 2 * M_PI + diff;
1026 }
1027 }
1028 }
1029 return diff;
1030 };
1031 return func;
1032 } else {
1033 B2FATAL("Wrong number of arguments for meta function mcDaughterDiffOf");
1034 }
1035 }
1036
1037 Manager::FunctionPtr grandDaughterDiffOf(const std::vector<std::string>& arguments)
1038 {
1039 if (arguments.size() == 5) {
1040 try {
1041 convertString<int>(arguments[0]);
1042 convertString<int>(arguments[1]);
1043 convertString<int>(arguments[2]);
1044 convertString<int>(arguments[3]);
1045 } catch (std::invalid_argument&) {
1046 B2FATAL("First four arguments of grandDaughterDiffOf meta function must be integers!");
1047 }
1048 std::vector<std::string> new_arguments;
1049 new_arguments.push_back(std::string(arguments[0] + ":" + arguments[2]));
1050 new_arguments.push_back(std::string(arguments[1] + ":" + arguments[3]));
1051 new_arguments.push_back(arguments[4]);
1052 return daughterDiffOf(new_arguments);
1053 } else {
1054 B2FATAL("Wrong number of arguments for meta function grandDaughterDiffOf");
1055 }
1056 }
1057
1058 Manager::FunctionPtr daughterNormDiffOf(const std::vector<std::string>& arguments)
1059 {
1060 if (arguments.size() == 3) {
1061 auto func = [arguments](const Particle * particle) -> double {
1062 if (particle == nullptr)
1063 return Const::doubleNaN;
1064 const Particle* dau_i = particle->getParticleFromGeneralizedIndexString(arguments[0]);
1065 const Particle* dau_j = particle->getParticleFromGeneralizedIndexString(arguments[1]);
1066 if (!(dau_i && dau_j))
1067 {
1068 B2ERROR("One of the first two arguments doesn't specify a valid (grand-)daughter!");
1069 return Const::doubleNaN;
1070 }
1071 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[2]);
1072 double iValue, jValue;
1073 if (std::holds_alternative<double>(var->function(dau_j)))
1074 {
1075 iValue = std::get<double>(var->function(dau_i));
1076 jValue = std::get<double>(var->function(dau_j));
1077 } else if (std::holds_alternative<int>(var->function(dau_j)))
1078 {
1079 iValue = std::get<int>(var->function(dau_i));
1080 jValue = std::get<int>(var->function(dau_j));
1081 } else return Const::doubleNaN;
1082 return (jValue - iValue) / (jValue + iValue);
1083 };
1084 return func;
1085 } else {
1086 B2FATAL("Wrong number of arguments for meta function daughterNormDiffOf");
1087 }
1088 }
1089
1090 Manager::FunctionPtr daughterMotherDiffOf(const std::vector<std::string>& arguments)
1091 {
1092 if (arguments.size() == 2) {
1093 auto daughterFunction = convertToDaughterIndex({arguments[0]});
1094 std::string variableName = arguments[1];
1095 auto func = [daughterFunction, variableName](const Particle * particle) -> double {
1096 if (particle == nullptr)
1097 return Const::doubleNaN;
1098 int daughterNumber = std::get<int>(daughterFunction(particle));
1099 if (daughterNumber >= int(particle->getNDaughters()) or daughterNumber < 0)
1100 return Const::doubleNaN;
1101 const Variable::Manager::Var* var = Manager::Instance().getVariable(variableName);
1102 auto result_mother = var->function(particle);
1103 auto result_daughter = var->function(particle->getDaughter(daughterNumber));
1104 double diff = Const::doubleNaN;
1105 if (std::holds_alternative<double>(result_mother) && std::holds_alternative<double>(result_daughter))
1106 {
1107 diff = std::get<double>(result_mother) - std::get<double>(result_daughter);
1108 } else if (std::holds_alternative<int>(result_mother) && std::holds_alternative<int>(result_daughter))
1109 {
1110 diff = std::get<int>(result_mother) - std::get<int>(result_daughter);
1111 } else
1112 {
1113 throw std::runtime_error("Bad variant access");
1114 }
1115
1116 if (variableName == "phi" or variableName == "useCMSFrame(phi)")
1117 {
1118 if (fabs(diff) > M_PI) {
1119 if (diff > M_PI) {
1120 diff = diff - 2 * M_PI;
1121 } else {
1122 diff = 2 * M_PI + diff;
1123 }
1124 }
1125 }
1126 return diff;
1127 };
1128 return func;
1129 } else {
1130 B2FATAL("Wrong number of arguments for meta function daughterMotherDiffOf");
1131 }
1132 }
1133
1134 Manager::FunctionPtr daughterMotherNormDiffOf(const std::vector<std::string>& arguments)
1135 {
1136 if (arguments.size() == 2) {
1137 auto daughterFunction = convertToDaughterIndex({arguments[0]});
1138 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
1139 auto func = [var, daughterFunction](const Particle * particle) -> double {
1140 if (particle == nullptr)
1141 return Const::doubleNaN;
1142 int daughterNumber = std::get<int>(daughterFunction(particle));
1143 if (daughterNumber >= int(particle->getNDaughters()) or daughterNumber < 0)
1144 return Const::doubleNaN;
1145 double daughterValue = 0.0, motherValue = 0.0;
1146 if (std::holds_alternative<double>(var->function(particle)))
1147 {
1148 daughterValue = std::get<double>(var->function(particle->getDaughter(daughterNumber)));
1149 motherValue = std::get<double>(var->function(particle));
1150 } else if (std::holds_alternative<int>(var->function(particle)))
1151 {
1152 daughterValue = std::get<int>(var->function(particle->getDaughter(daughterNumber)));
1153 motherValue = std::get<int>(var->function(particle));
1154 }
1155 return (motherValue - daughterValue) / (motherValue + daughterValue);
1156 };
1157 return func;
1158 } else {
1159 B2FATAL("Wrong number of arguments for meta function daughterMotherNormDiffOf");
1160 }
1161 }
1162
1163 Manager::FunctionPtr angleBetweenDaughterAndRecoil(const std::vector<std::string>& arguments)
1164 {
1165 if (arguments.size() >= 1) {
1166
1167 auto func = [arguments](const Particle * particle) -> double {
1168 if (particle == nullptr)
1169 return Const::doubleNaN;
1170
1171 const auto& frame = ReferenceFrame::GetCurrent();
1172
1173 ROOT::Math::PxPyPzEVector pSum(0, 0, 0, 0);
1174 for (auto& generalizedIndex : arguments)
1175 {
1176 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
1177 if (dauPart) pSum += frame.getMomentum(dauPart);
1178 else {
1179 B2WARNING("Trying to access a daughter that does not exist. Index = " << generalizedIndex);
1180 return Const::doubleNaN;
1181 }
1182 }
1183
1184 PCmsLabTransform T;
1185 ROOT::Math::PxPyPzEVector pIN = T.getBeamFourMomentum(); // Initial state (e+e- momentum in LAB)
1186 ROOT::Math::PxPyPzEVector pRecoil = frame.getMomentum(pIN - particle->get4Vector());
1187
1188 return ROOT::Math::VectorUtil::Angle(pRecoil, pSum);
1189 };
1190 return func;
1191 } else {
1192 B2FATAL("Wrong number of arguments for meta function angleBetweenDaughterAndRecoil");
1193 }
1194 }
1195
1196 Manager::FunctionPtr angleBetweenDaughterAndMissingMomentum(const std::vector<std::string>& arguments)
1197 {
1198 if (arguments.size() >= 1) {
1199 auto func = [arguments](const Particle * particle) -> double {
1200 if (particle == nullptr)
1201 return Const::doubleNaN;
1202
1203 StoreObjPtr<EventKinematics> evtShape;
1204 if (!evtShape)
1205 {
1206 B2WARNING("Cannot find missing momentum information, did you forget to run EventKinematicsModule?");
1207 return Const::doubleNaN;
1208 }
1209 ROOT::Math::XYZVector missingMomentumCMS = evtShape->getMissingMomentumCMS();
1210 ROOT::Math::PxPyPzEVector missingTotalMomentumCMS(missingMomentumCMS.X(),
1211 missingMomentumCMS.Y(),
1212 missingMomentumCMS.Z(),
1213 evtShape->getMissingEnergyCMS());
1214 PCmsLabTransform T;
1215 ROOT::Math::PxPyPzEVector missingTotalMomentumLab = T.rotateCmsToLab() * missingTotalMomentumCMS;
1216
1217 const auto& frame = ReferenceFrame::GetCurrent();
1218 ROOT::Math::PxPyPzEVector pMiss = frame.getMomentum(missingTotalMomentumLab); // transform from lab to reference frame
1219
1220 ROOT::Math::PxPyPzEVector pSum(0, 0, 0, 0);
1221 for (auto& generalizedIndex : arguments)
1222 {
1223 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
1224 if (dauPart) pSum += frame.getMomentum(dauPart);
1225 else {
1226 B2WARNING("Trying to access a daughter that does not exist. Index = " << generalizedIndex);
1227 return Const::doubleNaN;
1228 }
1229 }
1230
1231 return ROOT::Math::VectorUtil::Angle(pMiss, pSum);
1232 };
1233 return func;
1234 } else {
1235 B2FATAL("Wrong number of arguments for meta function angleBetweenDaughterAndMissingMomentum");
1236 }
1237 }
1238
1239 Manager::FunctionPtr daughterAngle(const std::vector<std::string>& arguments)
1240 {
1241 if (arguments.size() == 2 || arguments.size() == 3) {
1242
1243 auto func = [arguments](const Particle * particle) -> double {
1244 if (particle == nullptr)
1245 return Const::doubleNaN;
1246
1247 std::vector<ROOT::Math::PxPyPzEVector> pDaus;
1248 const auto& frame = ReferenceFrame::GetCurrent();
1249
1250 // Parses the generalized indexes and fetches the 4-momenta of the particles of interest
1251 for (auto& generalizedIndex : arguments)
1252 {
1253 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
1254 if (dauPart)
1255 pDaus.push_back(frame.getMomentum(dauPart));
1256 else {
1257 B2WARNING("Trying to access a daughter that does not exist. Index = " << generalizedIndex);
1258 return Const::doubleNaN;
1259 }
1260 }
1261
1262 // Calculates the angle between the selected particles
1263 if (pDaus.size() == 2)
1264 return ROOT::Math::VectorUtil::Angle(pDaus[0], pDaus[1]);
1265 else
1266 return ROOT::Math::VectorUtil::Angle(pDaus[2], pDaus[0] + pDaus[1]);
1267 };
1268 return func;
1269 } else {
1270 B2FATAL("Wrong number of arguments for meta function daughterAngle");
1271 }
1272 }
1273
1274 double grandDaughterDecayAngle(const Particle* particle, const std::vector<double>& arguments)
1275 {
1276 if (arguments.size() == 2) {
1277
1278 if (!particle)
1279 return Const::doubleNaN;
1280
1281 int daughterIndex = std::lround(arguments[0]);
1282 if (daughterIndex >= int(particle->getNDaughters()))
1283 return Const::doubleNaN;
1284 const Particle* dau = particle->getDaughter(daughterIndex);
1285
1286 int grandDaughterIndex = std::lround(arguments[1]);
1287 if (grandDaughterIndex >= int(dau->getNDaughters()))
1288 return Const::doubleNaN;
1289
1290 ROOT::Math::XYZVector boost = dau->get4Vector().BoostToCM();
1291
1292 ROOT::Math::PxPyPzEVector motherMomentum = - particle->get4Vector();
1293 motherMomentum = ROOT::Math::Boost(boost) * motherMomentum;
1294
1295 ROOT::Math::PxPyPzEVector grandDaughterMomentum = dau->getDaughter(grandDaughterIndex)->get4Vector();
1296 grandDaughterMomentum = ROOT::Math::Boost(boost) * grandDaughterMomentum;
1297
1298 return ROOT::Math::VectorUtil::Angle(motherMomentum, grandDaughterMomentum);
1299
1300 } else {
1301 B2FATAL("The variable grandDaughterDecayAngle needs exactly two integers as arguments!");
1302 }
1303 }
1304
1305 Manager::FunctionPtr mcDaughterAngle(const std::vector<std::string>& arguments)
1306 {
1307 if (arguments.size() == 2 || arguments.size() == 3) {
1308
1309 auto func = [arguments](const Particle * particle) -> double {
1310 if (particle == nullptr)
1311 return Const::doubleNaN;
1312
1313 std::vector<ROOT::Math::PxPyPzEVector> pDaus;
1314 const auto& frame = ReferenceFrame::GetCurrent();
1315
1316 // Parses the generalized indexes and fetches the 4-momenta of the particles of interest
1317 if (particle->getParticleSource() == Particle::EParticleSourceObject::c_MCParticle) // Check if MCParticle
1318 {
1319 for (auto& generalizedIndex : arguments) {
1320 const MCParticle* mcPart = particle->getMCParticle();
1321 if (mcPart == nullptr)
1322 return Const::doubleNaN;
1323 const MCParticle* dauMcPart = mcPart->getParticleFromGeneralizedIndexString(generalizedIndex);
1324 if (dauMcPart == nullptr)
1325 return Const::doubleNaN;
1326
1327 pDaus.push_back(frame.getMomentum(dauMcPart->get4Vector()));
1328 }
1329 } else
1330 {
1331 for (auto& generalizedIndex : arguments) {
1332 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
1333 if (dauPart == nullptr)
1334 return Const::doubleNaN;
1335
1336 const MCParticle* dauMcPart = dauPart->getMCParticle();
1337 if (dauMcPart == nullptr)
1338 return Const::doubleNaN;
1339
1340 pDaus.push_back(frame.getMomentum(dauMcPart->get4Vector()));
1341 }
1342 }
1343
1344 // Calculates the angle between the selected particles
1345 if (pDaus.size() == 2)
1346 return ROOT::Math::VectorUtil::Angle(pDaus[0], pDaus[1]);
1347 else
1348 return ROOT::Math::VectorUtil::Angle(pDaus[2], pDaus[0] + pDaus[1]);
1349 };
1350 return func;
1351 } else {
1352 B2FATAL("Wrong number of arguments for meta function mcDaughterAngle");
1353 }
1354 }
1355
1356 double daughterClusterAngleInBetween(const Particle* particle, const std::vector<double>& daughterIndices)
1357 {
1358 if (daughterIndices.size() == 2) {
1359 int daughterIndexi = std::lround(daughterIndices[0]);
1360 int daughterIndexj = std::lround(daughterIndices[1]);
1361 if (std::max(daughterIndexi, daughterIndexj) >= int(particle->getNDaughters())) {
1362 return Const::doubleNaN;
1363 } else {
1364 const ECLCluster* clusteri = particle->getDaughter(daughterIndexi)->getECLCluster();
1365 const ECLCluster* clusterj = particle->getDaughter(daughterIndexj)->getECLCluster();
1366 if (clusteri and clusterj) {
1367 const auto& frame = ReferenceFrame::GetCurrent();
1368 const ECLCluster::EHypothesisBit clusteriBit = (particle->getDaughter(daughterIndexi))->getECLClusterEHypothesisBit();
1369 const ECLCluster::EHypothesisBit clusterjBit = (particle->getDaughter(daughterIndexj))->getECLClusterEHypothesisBit();
1370 ClusterUtils clusutils;
1371 ROOT::Math::PxPyPzEVector pi = frame.getMomentum(clusutils.Get4MomentumFromCluster(clusteri, clusteriBit));
1372 ROOT::Math::PxPyPzEVector pj = frame.getMomentum(clusutils.Get4MomentumFromCluster(clusterj, clusterjBit));
1373 return ROOT::Math::VectorUtil::Angle(pi, pj);
1374 }
1375 return Const::doubleNaN;
1376 }
1377 } else if (daughterIndices.size() == 3) {
1378 int daughterIndexi = std::lround(daughterIndices[0]);
1379 int daughterIndexj = std::lround(daughterIndices[1]);
1380 int daughterIndexk = std::lround(daughterIndices[2]);
1381 if (std::max(std::max(daughterIndexi, daughterIndexj), daughterIndexk) >= int(particle->getNDaughters())) {
1382 return Const::doubleNaN;
1383 } else {
1384 const ECLCluster* clusteri = (particle->getDaughter(daughterIndices[0]))->getECLCluster();
1385 const ECLCluster* clusterj = (particle->getDaughter(daughterIndices[1]))->getECLCluster();
1386 const ECLCluster* clusterk = (particle->getDaughter(daughterIndices[2]))->getECLCluster();
1387 if (clusteri and clusterj and clusterk) {
1388 const auto& frame = ReferenceFrame::GetCurrent();
1389 const ECLCluster::EHypothesisBit clusteriBit = (particle->getDaughter(daughterIndices[0]))->getECLClusterEHypothesisBit();
1390 const ECLCluster::EHypothesisBit clusterjBit = (particle->getDaughter(daughterIndices[1]))->getECLClusterEHypothesisBit();
1391 const ECLCluster::EHypothesisBit clusterkBit = (particle->getDaughter(daughterIndices[2]))->getECLClusterEHypothesisBit();
1392 ClusterUtils clusutils;
1393 ROOT::Math::PxPyPzEVector pi = frame.getMomentum(clusutils.Get4MomentumFromCluster(clusteri, clusteriBit));
1394 ROOT::Math::PxPyPzEVector pj = frame.getMomentum(clusutils.Get4MomentumFromCluster(clusterj, clusterjBit));
1395 ROOT::Math::PxPyPzEVector pk = frame.getMomentum(clusutils.Get4MomentumFromCluster(clusterk, clusterkBit));
1396 return ROOT::Math::VectorUtil::Angle(pk, pi + pj);
1397 }
1398 return Const::doubleNaN;
1399 }
1400 } else {
1401 B2FATAL("Wrong number of arguments for daughterClusterAngleInBetween!");
1402 }
1403 }
1404
1405 Manager::FunctionPtr daughterInvM(const std::vector<std::string>& arguments)
1406 {
1407 if (arguments.size() > 1) {
1408 auto func = [arguments](const Particle * particle) -> double {
1409 const auto& frame = ReferenceFrame::GetCurrent();
1410 ROOT::Math::PxPyPzEVector pSum;
1411
1412 for (auto& generalizedIndex : arguments)
1413 {
1414 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
1415 if (dauPart)
1416 pSum += frame.getMomentum(dauPart);
1417 else {
1418 return Const::doubleNaN;
1419 }
1420 }
1421 return pSum.M();
1422 };
1423 return func;
1424 } else {
1425 B2FATAL("Wrong number of arguments for meta function daughterInvM. At least two integers are needed.");
1426 }
1427 }
1428
1429 Manager::FunctionPtr modulo(const std::vector<std::string>& arguments)
1430 {
1431 if (arguments.size() == 2) {
1432 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1433 int divideBy = 1;
1434 try {
1435 divideBy = convertString<int>(arguments[1]);
1436 } catch (std::invalid_argument&) {
1437 B2FATAL("Second argument of modulo meta function must be integer!");
1438 }
1439 auto func = [var, divideBy](const Particle * particle) -> int {
1440 auto var_result = var->function(particle);
1441 if (std::holds_alternative<double>(var_result))
1442 {
1443 return int(std::get<double>(var_result)) % divideBy;
1444 } else if (std::holds_alternative<int>(var_result))
1445 {
1446 return std::get<int>(var_result) % divideBy;
1447 } else if (std::holds_alternative<bool>(var_result))
1448 {
1449 return int(std::get<bool>(var_result)) % divideBy;
1450 } else return 0;
1451 };
1452 return func;
1453 } else {
1454 B2FATAL("Wrong number of arguments for meta function modulo");
1455 }
1456 }
1457
1458 Manager::FunctionPtr isNAN(const std::vector<std::string>& arguments)
1459 {
1460 if (arguments.size() == 1) {
1461 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1462
1463 auto func = [var](const Particle * particle) -> bool { return std::isnan(std::get<double>(var->function(particle))); };
1464 return func;
1465 } else {
1466 B2FATAL("Wrong number of arguments for meta function isNAN");
1467 }
1468 }
1469
1470 Manager::FunctionPtr ifNANgiveX(const std::vector<std::string>& arguments)
1471 {
1472 if (arguments.size() == 2) {
1473 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1474 double defaultOutput;
1475 try {
1476 defaultOutput = convertString<double>(arguments[1]);
1477 } catch (std::invalid_argument&) {
1478 B2FATAL("The second argument of ifNANgiveX meta function must be a number!");
1479 }
1480 auto func = [var, defaultOutput](const Particle * particle) -> double {
1481 double output = std::get<double>(var->function(particle));
1482 if (std::isnan(output)) return defaultOutput;
1483 else return output;
1484 };
1485 return func;
1486 } else {
1487 B2FATAL("Wrong number of arguments for meta function ifNANgiveX");
1488 }
1489 }
1490
1491 Manager::FunctionPtr isInfinity(const std::vector<std::string>& arguments)
1492 {
1493 if (arguments.size() == 1) {
1494 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1495
1496 auto func = [var](const Particle * particle) -> bool { return std::isinf(std::get<double>(var->function(particle))); };
1497 return func;
1498 } else {
1499 B2FATAL("Wrong number of arguments for meta function isInfinity");
1500 }
1501 }
1502
1503 Manager::FunctionPtr unmask(const std::vector<std::string>& arguments)
1504 {
1505 if (arguments.size() >= 2) {
1506 // get the function pointer of variable to be unmasked
1507 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1508
1509 // get the final mask which summarize all the input masks
1510 int finalMask = 0;
1511 for (size_t i = 1; i < arguments.size(); ++i) {
1512 try {
1513 finalMask |= convertString<int>(arguments[i]);
1514 } catch (std::invalid_argument&) {
1515 B2FATAL("The input flags to meta function unmask() should be integer!");
1516 return nullptr;
1517 }
1518 }
1519
1520 // unmask the variable
1521 auto func = [var, finalMask](const Particle * particle) -> double {
1522 int value = 0;
1523 auto var_result = var->function(particle);
1524 if (std::holds_alternative<double>(var_result))
1525 {
1526 // judge if the value is nan before unmasking
1527 if (std::isnan(std::get<double>(var_result))) {
1528 return Const::doubleNaN;
1529 }
1530 value = int(std::get<double>(var_result));
1531 } else if (std::holds_alternative<int>(var_result))
1532 {
1533 value = std::get<int>(var_result);
1534 }
1535
1536 // apply the final mask
1537 value &= (~finalMask);
1538
1539 return value;
1540 };
1541 return func;
1542
1543 } else {
1544 B2FATAL("Meta function unmask needs at least two arguments!");
1545 }
1546 }
1547
1548 Manager::FunctionPtr conditionalVariableSelector(const std::vector<std::string>& arguments)
1549 {
1550 if (arguments.size() == 3) {
1551
1552 std::string cutString = arguments[0];
1553 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
1554
1555 const Variable::Manager::Var* variableIfTrue = Manager::Instance().getVariable(arguments[1]);
1556 const Variable::Manager::Var* variableIfFalse = Manager::Instance().getVariable(arguments[2]);
1557
1558 auto func = [cut, variableIfTrue, variableIfFalse](const Particle * particle) -> double {
1559 if (particle == nullptr)
1560 return Const::doubleNaN;
1561 if (cut->check(particle))
1562 {
1563 auto var_result = variableIfTrue->function(particle);
1564 if (std::holds_alternative<double>(var_result)) {
1565 return std::get<double>(var_result);
1566 } else if (std::holds_alternative<int>(var_result)) {
1567 return std::get<int>(var_result);
1568 } else if (std::holds_alternative<bool>(var_result)) {
1569 return std::get<bool>(var_result);
1570 } else return Const::doubleNaN;
1571 } else
1572 {
1573 auto var_result = variableIfFalse->function(particle);
1574 if (std::holds_alternative<double>(var_result)) {
1575 return std::get<double>(var_result);
1576 } else if (std::holds_alternative<int>(var_result)) {
1577 return std::get<int>(var_result);
1578 } else if (std::holds_alternative<bool>(var_result)) {
1579 return std::get<bool>(var_result);
1580 } else return Const::doubleNaN;
1581 }
1582 };
1583 return func;
1584
1585 } else {
1586 B2FATAL("Wrong number of arguments for meta function conditionalVariableSelector");
1587 }
1588 }
1589
1590 Manager::FunctionPtr pValueCombination(const std::vector<std::string>& arguments)
1591 {
1592 if (arguments.size() > 0) {
1593 std::vector<const Variable::Manager::Var*> variables;
1594 for (auto& argument : arguments)
1595 variables.push_back(Manager::Instance().getVariable(argument));
1596
1597 auto func = [variables, arguments](const Particle * particle) -> double {
1598 double pValueProduct = 1.;
1599 for (auto variable : variables)
1600 {
1601 double pValue = std::get<double>(variable->function(particle));
1602 if (pValue < 0)
1603 return -1;
1604 else
1605 pValueProduct *= pValue;
1606 }
1607 double pValueSum = 1.;
1608 double factorial = 1.;
1609 for (unsigned int i = 1; i < arguments.size(); ++i)
1610 {
1611 factorial *= i;
1612 pValueSum += pow(-std::log(pValueProduct), i) / factorial;
1613 }
1614 return pValueProduct * pValueSum;
1615 };
1616 return func;
1617 } else {
1618 B2FATAL("Wrong number of arguments for meta function pValueCombination");
1619 }
1620 }
1621
1622 Manager::FunctionPtr pValueCombinationOfDaughters(const std::vector<std::string>& arguments)
1623 {
1624 if (arguments.size() == 1) {
1625 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1626 auto func = [var](const Particle * particle) -> double {
1627 double pValueProduct = 1.;
1628 if (particle->getNDaughters() == 0)
1629 {
1630 return Const::doubleNaN;
1631 }
1632
1633 for (unsigned j = 0; j < particle->getNDaughters(); ++j)
1634 {
1635 double pValue = std::get<double>(var->function(particle->getDaughter(j)));
1636 if (pValue < 0) return -1;
1637 else pValueProduct *= pValue;
1638 }
1639
1640 double pValueSum = 1.;
1641 double factorial = 1.;
1642 for (unsigned int i = 1; i < particle->getNDaughters(); ++i)
1643 {
1644 factorial *= i;
1645 pValueSum += pow(-std::log(pValueProduct), i) / factorial;
1646 }
1647 return pValueProduct * pValueSum;
1648 };
1649 return func;
1650 } else {
1651 B2FATAL("Wrong number of arguments for meta function pValueCombinationOfDaughters");
1652 }
1653 }
1654
1655 Manager::FunctionPtr abs(const std::vector<std::string>& arguments)
1656 {
1657 if (arguments.size() == 1) {
1658 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1659 auto func = [var](const Particle * particle) -> double {
1660 auto var_result = var->function(particle);
1661 if (std::holds_alternative<double>(var_result))
1662 {
1663 return std::abs(std::get<double>(var_result));
1664 } else if (std::holds_alternative<int>(var_result))
1665 {
1666 return std::abs(std::get<int>(var_result));
1667 } else return Const::doubleNaN;
1668 };
1669 return func;
1670 } else {
1671 B2FATAL("Wrong number of arguments for meta function abs");
1672 }
1673 }
1674
1675 Manager::FunctionPtr max(const std::vector<std::string>& arguments)
1676 {
1677 if (arguments.size() == 2) {
1678 const Variable::Manager::Var* var1 = Manager::Instance().getVariable(arguments[0]);
1679 const Variable::Manager::Var* var2 = Manager::Instance().getVariable(arguments[1]);
1680
1681 if (!var1 or !var2)
1682 B2FATAL("One or both of the used variables doesn't exist!");
1683
1684 auto func = [var1, var2](const Particle * particle) -> double {
1685 double val1, val2;
1686 auto var_result1 = var1->function(particle);
1687 auto var_result2 = var2->function(particle);
1688 if (std::holds_alternative<double>(var_result1))
1689 {
1690 val1 = std::get<double>(var_result1);
1691 } else if (std::holds_alternative<int>(var_result1))
1692 {
1693 val1 = std::get<int>(var_result1);
1694 } else if (std::holds_alternative<bool>(var_result1))
1695 {
1696 val1 = std::get<bool>(var_result1);
1697 } else
1698 {
1699 B2FATAL("A variable in meta function max holds no double, int or bool values");
1700 }
1701 if (std::holds_alternative<double>(var_result2))
1702 {
1703 val2 = std::get<double>(var_result2);
1704 } else if (std::holds_alternative<int>(var_result2))
1705 {
1706 val2 = std::get<int>(var_result2);
1707 } else if (std::holds_alternative<bool>(var_result2))
1708 {
1709 val2 = std::get<bool>(var_result2);
1710 } else
1711 {
1712 B2FATAL("A variable in meta function max holds no double, int or bool values");
1713 }
1714 return std::max(val1, val2);
1715 };
1716 return func;
1717 } else {
1718 B2FATAL("Wrong number of arguments for meta function max");
1719 }
1720 }
1721
1722 Manager::FunctionPtr min(const std::vector<std::string>& arguments)
1723 {
1724 if (arguments.size() == 2) {
1725 const Variable::Manager::Var* var1 = Manager::Instance().getVariable(arguments[0]);
1726 const Variable::Manager::Var* var2 = Manager::Instance().getVariable(arguments[1]);
1727
1728 if (!var1 or !var2)
1729 B2FATAL("One or both of the used variables doesn't exist!");
1730
1731 auto func = [var1, var2](const Particle * particle) -> double {
1732 double val1, val2;
1733 auto var_result1 = var1->function(particle);
1734 auto var_result2 = var2->function(particle);
1735 if (std::holds_alternative<double>(var_result1))
1736 {
1737 val1 = std::get<double>(var_result1);
1738 } else if (std::holds_alternative<int>(var_result1))
1739 {
1740 val1 = std::get<int>(var_result1);
1741 } else if (std::holds_alternative<bool>(var_result1))
1742 {
1743 val1 = std::get<bool>(var_result1);
1744 } else
1745 {
1746 B2FATAL("A variable in meta function min holds no double, int or bool values");
1747 }
1748 if (std::holds_alternative<double>(var_result2))
1749 {
1750 val2 = std::get<double>(var_result2);
1751 } else if (std::holds_alternative<int>(var_result2))
1752 {
1753 val2 = std::get<int>(var_result2);
1754 } else if (std::holds_alternative<bool>(var_result2))
1755 {
1756 val2 = std::get<bool>(var_result2);
1757 } else
1758 {
1759 B2FATAL("A variable in meta function min holds no double, int or bool values");
1760 }
1761 return std::min(val1, val2);
1762 };
1763 return func;
1764 } else {
1765 B2FATAL("Wrong number of arguments for meta function min");
1766 }
1767 }
1768
1769 Manager::FunctionPtr sin(const std::vector<std::string>& arguments)
1770 {
1771 if (arguments.size() == 1) {
1772 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1773 auto func = [var](const Particle * particle) -> double {
1774 auto var_result = var->function(particle);
1775 if (std::holds_alternative<double>(var_result))
1776 return std::sin(std::get<double>(var_result));
1777 else if (std::holds_alternative<int>(var_result))
1778 return std::sin(std::get<int>(var_result));
1779 else return Const::doubleNaN;
1780 };
1781 return func;
1782 } else {
1783 B2FATAL("Wrong number of arguments for meta function sin");
1784 }
1785 }
1786
1787 Manager::FunctionPtr asin(const std::vector<std::string>& arguments)
1788 {
1789 if (arguments.size() == 1) {
1790 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1791 auto func = [var](const Particle * particle) -> double {
1792 auto var_result = var->function(particle);
1793 if (std::holds_alternative<double>(var_result))
1794 return std::asin(std::get<double>(var_result));
1795 else if (std::holds_alternative<int>(var_result))
1796 return std::asin(std::get<int>(var_result));
1797 else return Const::doubleNaN;
1798 };
1799 return func;
1800 } else {
1801 B2FATAL("Wrong number of arguments for meta function asin");
1802 }
1803 }
1804
1805 Manager::FunctionPtr cos(const std::vector<std::string>& arguments)
1806 {
1807 if (arguments.size() == 1) {
1808 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1809 auto func = [var](const Particle * particle) -> double {
1810 auto var_result = var->function(particle);
1811 if (std::holds_alternative<double>(var_result))
1812 return std::cos(std::get<double>(var_result));
1813 else if (std::holds_alternative<int>(var_result))
1814 return std::cos(std::get<int>(var_result));
1815 else return Const::doubleNaN;
1816 };
1817 return func;
1818 } else {
1819 B2FATAL("Wrong number of arguments for meta function cos");
1820 }
1821 }
1822
1823 Manager::FunctionPtr acos(const std::vector<std::string>& arguments)
1824 {
1825 if (arguments.size() == 1) {
1826 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1827 auto func = [var](const Particle * particle) -> double {
1828 auto var_result = var->function(particle);
1829 if (std::holds_alternative<double>(var_result))
1830 return std::acos(std::get<double>(var_result));
1831 else if (std::holds_alternative<int>(var_result))
1832 return std::acos(std::get<int>(var_result));
1833 else return Const::doubleNaN;
1834 };
1835 return func;
1836 } else {
1837 B2FATAL("Wrong number of arguments for meta function acos");
1838 }
1839 }
1840
1841 Manager::FunctionPtr tan(const std::vector<std::string>& arguments)
1842 {
1843 if (arguments.size() == 1) {
1844 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1845 auto func = [var](const Particle * particle) -> double { return std::tan(std::get<double>(var->function(particle))); };
1846 return func;
1847 } else {
1848 B2FATAL("Wrong number of arguments for meta function tan");
1849 }
1850 }
1851
1852 Manager::FunctionPtr atan(const std::vector<std::string>& arguments)
1853 {
1854 if (arguments.size() == 1) {
1855 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1856 auto func = [var](const Particle * particle) -> double { return std::atan(std::get<double>(var->function(particle))); };
1857 return func;
1858 } else {
1859 B2FATAL("Wrong number of arguments for meta function atan");
1860 }
1861 }
1862
1863 Manager::FunctionPtr exp(const std::vector<std::string>& arguments)
1864 {
1865 if (arguments.size() == 1) {
1866 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1867 auto func = [var](const Particle * particle) -> double {
1868 auto var_result = var->function(particle);
1869 if (std::holds_alternative<double>(var_result))
1870 return std::exp(std::get<double>(var_result));
1871 else if (std::holds_alternative<int>(var_result))
1872 return std::exp(std::get<int>(var_result));
1873 else return Const::doubleNaN;
1874 };
1875 return func;
1876 } else {
1877 B2FATAL("Wrong number of arguments for meta function exp");
1878 }
1879 }
1880
1881 Manager::FunctionPtr log(const std::vector<std::string>& arguments)
1882 {
1883 if (arguments.size() == 1) {
1884 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1885 auto func = [var](const Particle * particle) -> double {
1886 auto var_result = var->function(particle);
1887 if (std::holds_alternative<double>(var_result))
1888 return std::log(std::get<double>(var_result));
1889 else if (std::holds_alternative<int>(var_result))
1890 return std::log(std::get<int>(var_result));
1891 else return Const::doubleNaN;
1892 };
1893 return func;
1894 } else {
1895 B2FATAL("Wrong number of arguments for meta function log");
1896 }
1897 }
1898
1899 Manager::FunctionPtr log10(const std::vector<std::string>& arguments)
1900 {
1901 if (arguments.size() == 1) {
1902 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1903 auto func = [var](const Particle * particle) -> double {
1904 auto var_result = var->function(particle);
1905 if (std::holds_alternative<double>(var_result))
1906 return std::log10(std::get<double>(var_result));
1907 else if (std::holds_alternative<int>(var_result))
1908 return std::log10(std::get<int>(var_result));
1909 else return Const::doubleNaN;
1910 };
1911 return func;
1912 } else {
1913 B2FATAL("Wrong number of arguments for meta function log10");
1914 }
1915 }
1916
1917 Manager::FunctionPtr originalParticle(const std::vector<std::string>& arguments)
1918 {
1919 if (arguments.size() == 1) {
1920 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
1921 auto func = [var](const Particle * particle) -> double {
1922 if (particle == nullptr)
1923 return Const::doubleNaN;
1924
1925 StoreArray<Particle> particles;
1926 if (!particle->hasExtraInfo("original_index"))
1927 return Const::doubleNaN;
1928
1929 auto originalParticle = particles[particle->getExtraInfo("original_index")];
1930 if (!originalParticle)
1931 return Const::doubleNaN;
1932 auto var_result = var->function(originalParticle);
1933 if (std::holds_alternative<double>(var_result))
1934 {
1935 return std::get<double>(var_result);
1936 } else if (std::holds_alternative<int>(var_result))
1937 {
1938 return std::get<int>(var_result);
1939 } else if (std::holds_alternative<bool>(var_result))
1940 {
1941 return std::get<bool>(var_result);
1942 } else return Const::doubleNaN;
1943 };
1944 return func;
1945 } else {
1946 B2FATAL("Wrong number of arguments for meta function originalParticle");
1947 }
1948 }
1949
1950 Manager::FunctionPtr daughter(const std::vector<std::string>& arguments)
1951 {
1952 if (arguments.size() == 2) {
1953 auto daughterFunction = convertToDaughterIndex({arguments[0]});
1954 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
1955 auto func = [var, daughterFunction](const Particle * particle) -> double {
1956 if (particle == nullptr)
1957 return Const::doubleNaN;
1958 int daughterNumber = std::get<int>(daughterFunction(particle));
1959 if (daughterNumber >= int(particle->getNDaughters()) or daughterNumber < 0)
1960 return Const::doubleNaN;
1961 auto var_result = var->function(particle->getDaughter(daughterNumber));
1962 if (std::holds_alternative<double>(var_result))
1963 {
1964 return std::get<double>(var_result);
1965 } else if (std::holds_alternative<int>(var_result))
1966 {
1967 return std::get<int>(var_result);
1968 } else if (std::holds_alternative<bool>(var_result))
1969 {
1970 return std::get<bool>(var_result);
1971 } else return Const::doubleNaN;
1972 };
1973 return func;
1974 } else {
1975 B2FATAL("Wrong number of arguments for meta function daughter");
1976 }
1977 }
1978
1979 Manager::FunctionPtr originalDaughter(const std::vector<std::string>& arguments)
1980 {
1981 if (arguments.size() == 2) {
1982 auto daughterFunction = convertToDaughterIndex({arguments[0]});
1983 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
1984 auto func = [var, daughterFunction](const Particle * particle) -> double {
1985 if (particle == nullptr)
1986 return Const::doubleNaN;
1987 int daughterNumber = std::get<int>(daughterFunction(particle));
1988 if (daughterNumber >= int(particle->getNDaughters()) or daughterNumber < 0)
1989 return Const::doubleNaN;
1990 else
1991 {
1992 StoreArray<Particle> particles;
1993 if (!particle->getDaughter(daughterNumber)->hasExtraInfo("original_index"))
1994 return Const::doubleNaN;
1995 auto originalDaughter = particles[particle->getDaughter(daughterNumber)->getExtraInfo("original_index")];
1996 if (!originalDaughter)
1997 return Const::doubleNaN;
1998
1999 auto var_result = var->function(originalDaughter);
2000 if (std::holds_alternative<double>(var_result)) {
2001 return std::get<double>(var_result);
2002 } else if (std::holds_alternative<int>(var_result)) {
2003 return std::get<int>(var_result);
2004 } else if (std::holds_alternative<bool>(var_result)) {
2005 return std::get<bool>(var_result);
2006 } else return Const::doubleNaN;
2007 }
2008 };
2009 return func;
2010 } else {
2011 B2FATAL("Wrong number of arguments for meta function daughter");
2012 }
2013 }
2014
2015 Manager::FunctionPtr convertToDaughterIndex(const std::vector<std::string>& arguments)
2016 {
2017 if (arguments.size() == 1) {
2018 std::string daughterString = arguments[0];
2019 auto func = [daughterString](const Particle * particle) -> int {
2020 if (particle == nullptr)
2021 return -1;
2022 int daughterNumber = 0;
2023 try
2024 {
2025 daughterNumber = convertString<int>(daughterString);
2026 } catch (std::invalid_argument&)
2027 {
2028 auto daughterFunction = convertToInt({daughterString, "-1"});
2029 auto daughterVarResult = daughterFunction(particle);
2030 daughterNumber = std::get<int>(daughterVarResult);
2031 }
2032 return daughterNumber;
2033 };
2034 return func;
2035 } else {
2036 B2FATAL("Wrong number of arguments for meta function convertToDaughterIndex");
2037 }
2038 }
2039
2040 Manager::FunctionPtr mcDaughter(const std::vector<std::string>& arguments)
2041 {
2042 if (arguments.size() == 2) {
2043 auto daughterFunction = convertToDaughterIndex({arguments[0]});
2044 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
2045 auto func = [var, daughterFunction](const Particle * particle) -> double {
2046 if (particle == nullptr)
2047 return Const::doubleNaN;
2048 if (particle->getMCParticle()) // has MC match or is MCParticle
2049 {
2050 int daughterNumber = std::get<int>(daughterFunction(particle));
2051 if (daughterNumber >= int(particle->getMCParticle()->getNDaughters()) or daughterNumber < 0)
2052 return Const::doubleNaN;
2053 Particle tempParticle = Particle(particle->getMCParticle()->getDaughters().at(daughterNumber));
2054 auto var_result = var->function(&tempParticle);
2055 if (std::holds_alternative<double>(var_result)) {
2056 return std::get<double>(var_result);
2057 } else if (std::holds_alternative<int>(var_result)) {
2058 return std::get<int>(var_result);
2059 } else if (std::holds_alternative<bool>(var_result)) {
2060 return std::get<bool>(var_result);
2061 } else {
2062 return Const::doubleNaN;
2063 }
2064 } else
2065 {
2066 return Const::doubleNaN;
2067 }
2068 };
2069 return func;
2070 } else {
2071 B2FATAL("Wrong number of arguments for meta function mcDaughter");
2072 }
2073 }
2074
2075 Manager::FunctionPtr mcMother(const std::vector<std::string>& arguments)
2076 {
2077 if (arguments.size() == 1) {
2078 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
2079 auto func = [var](const Particle * particle) -> double {
2080 if (particle == nullptr)
2081 return Const::doubleNaN;
2082 if (particle->getMCParticle()) // has MC match or is MCParticle
2083 {
2084 if (particle->getMCParticle()->getMother() == nullptr) {
2085 return Const::doubleNaN;
2086 }
2087 Particle tempParticle = Particle(particle->getMCParticle()->getMother());
2088 auto var_result = var->function(&tempParticle);
2089 if (std::holds_alternative<double>(var_result)) {
2090 return std::get<double>(var_result);
2091 } else if (std::holds_alternative<int>(var_result)) {
2092 return std::get<int>(var_result);
2093 } else if (std::holds_alternative<bool>(var_result)) {
2094 return std::get<bool>(var_result);
2095 } else return Const::doubleNaN;
2096 } else
2097 {
2098 return Const::doubleNaN;
2099 }
2100 };
2101 return func;
2102 } else {
2103 B2FATAL("Wrong number of arguments for meta function mcMother");
2104 }
2105 }
2106
2107 Manager::FunctionPtr genParticle(const std::vector<std::string>& arguments)
2108 {
2109 if (arguments.size() == 2) {
2110 std::string indexString = arguments[0];
2111 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
2112
2113 auto func = [var, indexString](const Particle * particle) -> double {
2114 // First get the partcile index. If not int, evaluate the variable
2115 int particleNumber = 0;
2116 try
2117 {
2118 particleNumber = convertString<int>(indexString);
2119 } catch (std::invalid_argument&)
2120 {
2121 auto indexFunction = convertToInt({indexString, "-1"});
2122 auto indexVarResult = indexFunction(particle);
2123 particleNumber = std::get<int>(indexVarResult);
2124 }
2125
2126 StoreArray<MCParticle> mcParticles("MCParticles");
2127 if (particleNumber >= mcParticles.getEntries())
2128 {
2129 return Const::doubleNaN;
2130 }
2131
2132 MCParticle* mcParticle = mcParticles[particleNumber];
2133 Particle part = Particle(mcParticle);
2134 auto var_result = var->function(&part);
2135 if (std::holds_alternative<double>(var_result))
2136 {
2137 return std::get<double>(var_result);
2138 } else if (std::holds_alternative<int>(var_result))
2139 {
2140 return std::get<int>(var_result);
2141 } else if (std::holds_alternative<bool>(var_result))
2142 {
2143 return std::get<bool>(var_result);
2144 } else return Const::doubleNaN;
2145 };
2146 return func;
2147 } else {
2148 B2FATAL("Wrong number of arguments for meta function genParticle");
2149 }
2150 }
2151
2152 Manager::FunctionPtr genUpsilon4S(const std::vector<std::string>& arguments)
2153 {
2154 if (arguments.size() == 1) {
2155 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
2156
2157 auto func = [var](const Particle*) -> double {
2158 StoreArray<MCParticle> mcParticles("MCParticles");
2159 if (mcParticles.getEntries() == 0)
2160 {
2161 return Const::doubleNaN;
2162 }
2163
2164 MCParticle* mcUpsilon4S = mcParticles[0];
2165 if (mcUpsilon4S->isInitial()) mcUpsilon4S = mcParticles[2];
2166 if (mcUpsilon4S->getPDG() != 300553)
2167 {
2168 return Const::doubleNaN;
2169 }
2170
2171 Particle upsilon4S = Particle(mcUpsilon4S);
2172 auto var_result = var->function(&upsilon4S);
2173 if (std::holds_alternative<double>(var_result))
2174 {
2175 return std::get<double>(var_result);
2176 } else if (std::holds_alternative<int>(var_result))
2177 {
2178 return std::get<int>(var_result);
2179 } else if (std::holds_alternative<bool>(var_result))
2180 {
2181 return std::get<bool>(var_result);
2182 } else return Const::doubleNaN;
2183 };
2184 return func;
2185 } else {
2186 B2FATAL("Wrong number of arguments for meta function genUpsilon4S");
2187 }
2188 }
2189
2190 Manager::FunctionPtr getVariableByRank(const std::vector<std::string>& arguments)
2191 {
2192 if (arguments.size() == 4) {
2193 std::string listName = arguments[0];
2194 std::string rankedVariableName = arguments[1];
2195 std::string returnVariableName = arguments[2];
2196 std::string extraInfoName = rankedVariableName + "_rank";
2197 int rank = 1;
2198 try {
2199 rank = convertString<int>(arguments[3]);
2200 } catch (std::invalid_argument&) {
2201 B2ERROR("3rd argument of getVariableByRank meta function (Rank) must be an integer!");
2202 return nullptr;
2203 }
2204
2205 const Variable::Manager::Var* var = Manager::Instance().getVariable(returnVariableName);
2206 auto func = [var, rank, extraInfoName, listName](const Particle*)-> double {
2207 StoreObjPtr<ParticleList> list(listName);
2208
2209 const unsigned int numParticles = list->getListSize();
2210 for (unsigned int i = 0; i < numParticles; i++)
2211 {
2212 const Particle* p = list->getParticle(i);
2213 if (p->getExtraInfo(extraInfoName) == rank) {
2214 auto var_result = var->function(p);
2215 if (std::holds_alternative<double>(var_result)) {
2216 return std::get<double>(var_result);
2217 } else if (std::holds_alternative<int>(var_result)) {
2218 return std::get<int>(var_result);
2219 } else if (std::holds_alternative<bool>(var_result)) {
2220 return std::get<bool>(var_result);
2221 } else return Const::doubleNaN;
2222 }
2223 }
2224 // return 0;
2225 return std::numeric_limits<double>::signaling_NaN();
2226 };
2227 return func;
2228 } else {
2229 B2FATAL("Wrong number of arguments for meta function getVariableByRank");
2230 }
2231 }
2232
2233 Manager::FunctionPtr countInList(const std::vector<std::string>& arguments)
2234 {
2235 if (arguments.size() == 1 or arguments.size() == 2) {
2236
2237 std::string listName = arguments[0];
2238 std::string cutString = "";
2239
2240 if (arguments.size() == 2) {
2241 cutString = arguments[1];
2242 }
2243
2244 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
2245
2246 auto func = [listName, cut](const Particle*) -> int {
2247
2248 StoreObjPtr<ParticleList> list(listName);
2249 int sum = 0;
2250 for (unsigned int i = 0; i < list->getListSize(); i++)
2251 {
2252 const Particle* particle = list->getParticle(i);
2253 if (cut->check(particle)) {
2254 sum++;
2255 }
2256 }
2257 return sum;
2258 };
2259 return func;
2260 } else {
2261 B2FATAL("Wrong number of arguments for meta function countInList");
2262 }
2263 }
2264
2265 Manager::FunctionPtr veto(const std::vector<std::string>& arguments)
2266 {
2267 if (arguments.size() == 2 or arguments.size() == 3) {
2268
2269 std::string roeListName = arguments[0];
2270 std::string cutString = arguments[1];
2271 int pdgCode = Const::electron.getPDGCode();
2272 if (arguments.size() == 2) {
2273 B2INFO("Use pdgCode of electron as default in meta variable veto, other arguments: " << roeListName << ", " << cutString);
2274 } else {
2275 try {
2276 pdgCode = convertString<int>(arguments[2]);;
2277 } catch (std::invalid_argument&) {
2278 B2FATAL("Third argument of veto meta function must be integer!");
2279 }
2280 }
2281
2282 auto flavourType = (EvtPDLUtil::hasAntiParticle(pdgCode)) ? Particle::c_Flavored : Particle::c_Unflavored;
2283 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
2284
2285 auto func = [roeListName, cut, pdgCode, flavourType](const Particle * particle) -> bool {
2286 StoreObjPtr<ParticleList> roeList(roeListName);
2287 ROOT::Math::PxPyPzEVector vec = particle->get4Vector();
2288 for (unsigned int i = 0; i < roeList->getListSize(); i++)
2289 {
2290 const Particle* roeParticle = roeList->getParticle(i);
2291 if (not particle->overlapsWith(roeParticle)) {
2292 ROOT::Math::PxPyPzEVector tempCombination = roeParticle->get4Vector() + vec;
2293 std::vector<int> indices = { particle->getArrayIndex(), roeParticle->getArrayIndex() };
2294 Particle tempParticle = Particle(tempCombination, pdgCode, flavourType, indices, particle->getArrayPointer());
2295 if (cut->check(&tempParticle)) {
2296 return 1;
2297 }
2298 }
2299 }
2300 return 0;
2301 };
2302 return func;
2303 } else {
2304 B2FATAL("Wrong number of arguments for meta function veto");
2305 }
2306 }
2307
2308 Manager::FunctionPtr countDaughters(const std::vector<std::string>& arguments)
2309 {
2310 if (arguments.size() == 1) {
2311 std::string cutString = arguments[0];
2312 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
2313 auto func = [cut](const Particle * particle) -> int {
2314 int n = 0;
2315 for (auto& daughter : particle->getDaughters())
2316 {
2317 if (cut->check(daughter))
2318 ++n;
2319 }
2320 return n;
2321 };
2322 return func;
2323 } else {
2324 B2FATAL("Wrong number of arguments for meta function countDaughters");
2325 }
2326 }
2327
2328 Manager::FunctionPtr countFSPDaughters(const std::vector<std::string>& arguments)
2329 {
2330 if (arguments.size() == 1) {
2331 std::string cutString = arguments[0];
2332 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
2333 auto func = [cut](const Particle * particle) -> int {
2334
2335 std::vector<const Particle*> fspDaughters;
2336 particle->fillFSPDaughters(fspDaughters);
2337
2338 int n = 0;
2339 for (auto& daughter : fspDaughters)
2340 {
2341 if (cut->check(daughter))
2342 ++n;
2343 }
2344 return n;
2345 };
2346 return func;
2347 } else {
2348 B2FATAL("Wrong number of arguments for meta function countFSPDaughters");
2349 }
2350 }
2351
2352 Manager::FunctionPtr countDescendants(const std::vector<std::string>& arguments)
2353 {
2354 if (arguments.size() == 1) {
2355 std::string cutString = arguments[0];
2356 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
2357 auto func = [cut](const Particle * particle) -> int {
2358
2359 std::vector<const Particle*> allDaughters;
2360 particle->fillAllDaughters(allDaughters);
2361
2362 int n = 0;
2363 for (auto& daughter : allDaughters)
2364 {
2365 if (cut->check(daughter))
2366 ++n;
2367 }
2368 return n;
2369 };
2370 return func;
2371 } else {
2372 B2FATAL("Wrong number of arguments for meta function countDescendants");
2373 }
2374 }
2375
2376 Manager::FunctionPtr numberOfNonOverlappingParticles(const std::vector<std::string>& arguments)
2377 {
2378
2379 auto func = [arguments](const Particle * particle) -> int {
2380
2381 int _numberOfNonOverlappingParticles = 0;
2382 for (const auto& listName : arguments)
2383 {
2384 StoreObjPtr<ParticleList> list(listName);
2385 if (not list.isValid()) {
2386 B2FATAL("Invalid list named " << listName << " encountered in numberOfNonOverlappingParticles.");
2387 }
2388 for (unsigned int i = 0; i < list->getListSize(); i++) {
2389 const Particle* p = list->getParticle(i);
2390 if (not particle->overlapsWith(p)) {
2391 _numberOfNonOverlappingParticles++;
2392 }
2393 }
2394 }
2395 return _numberOfNonOverlappingParticles;
2396 };
2397
2398 return func;
2399
2400 }
2401
2402 void appendDaughtersRecursive(Particle* mother, StoreArray<Particle>& container)
2403 {
2404
2405 auto* mcmother = mother->getRelated<MCParticle>();
2406
2407 if (!mcmother)
2408 return;
2409
2410 for (auto* mcdaughter : mcmother->getDaughters()) {
2411 if (!mcdaughter->hasStatus(MCParticle::c_PrimaryParticle)) continue;
2412 Particle tmp_daughter(mcdaughter);
2413 Particle* new_daughter = container.appendNew(tmp_daughter);
2414 new_daughter->addRelationTo(mcdaughter);
2415 mother->appendDaughter(new_daughter, false);
2416
2417 if (mcdaughter->getNDaughters() > 0)
2418 appendDaughtersRecursive(new_daughter, container);
2419 }
2420 }
2421
2422 Manager::FunctionPtr matchedMC(const std::vector<std::string>& arguments)
2423 {
2424 if (arguments.size() == 1) {
2425 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
2426 auto func = [var](const Particle * particle) -> double {
2427 const MCParticle* mcp = particle->getMCParticle();
2428 if (!mcp) // Has no MC match and is no MCParticle
2429 {
2430 return Const::doubleNaN;
2431 }
2432 StoreArray<Particle> tempParticles("tempParticles");
2433 tempParticles.clear();
2434 Particle tmpPart(mcp);
2435 Particle* newPart = tempParticles.appendNew(tmpPart);
2436 newPart->addRelationTo(mcp);
2437
2438 appendDaughtersRecursive(newPart, tempParticles);
2439
2440 auto var_result = var->function(newPart);
2441 if (std::holds_alternative<double>(var_result))
2442 {
2443 return std::get<double>(var_result);
2444 } else if (std::holds_alternative<int>(var_result))
2445 {
2446 return std::get<int>(var_result);
2447 } else if (std::holds_alternative<bool>(var_result))
2448 {
2449 return std::get<bool>(var_result);
2450 } else return Const::doubleNaN;
2451 };
2452 return func;
2453 } else {
2454 B2FATAL("Wrong number of arguments for meta function matchedMC");
2455 }
2456 }
2457
2458 Manager::FunctionPtr clusterBestMatchedMCParticle(const std::vector<std::string>& arguments)
2459 {
2460 if (arguments.size() == 1) {
2461 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
2462
2463 auto func = [var](const Particle * particle) -> double {
2464
2465 const ECLCluster* cluster = particle->getECLCluster();
2466 if (!cluster) return Const::doubleNaN;
2467
2468 auto mcps = cluster->getRelationsTo<MCParticle>();
2469 if (mcps.size() == 0) return Const::doubleNaN;
2470
2471 std::vector<std::pair<double, int>> weightsAndIndices;
2472 for (unsigned int i = 0; i < mcps.size(); ++i)
2473 weightsAndIndices.emplace_back(mcps.weight(i), i);
2474
2475 // sort descending by weight
2476 std::sort(weightsAndIndices.begin(), weightsAndIndices.end(),
2477 ValueIndexPairSorting::higherPair<decltype(weightsAndIndices)::value_type>);
2478
2479 // cppcheck-suppress containerOutOfBounds
2480 const MCParticle* mcp = mcps.object(weightsAndIndices[0].second);
2481
2482 StoreArray<Particle> tempParticles("tempParticles");
2483 tempParticles.clear();
2484 Particle tmpPart(mcp);
2485 Particle* newPart = tempParticles.appendNew(tmpPart);
2486 newPart->addRelationTo(mcp);
2487
2488 appendDaughtersRecursive(newPart, tempParticles);
2489
2490 auto var_result = var->function(newPart);
2491 if (std::holds_alternative<double>(var_result))
2492 {
2493 return std::get<double>(var_result);
2494 } else if (std::holds_alternative<int>(var_result))
2495 {
2496 return std::get<int>(var_result);
2497 } else if (std::holds_alternative<bool>(var_result))
2498 {
2499 return std::get<bool>(var_result);
2500 } else
2501 {
2502 return Const::doubleNaN;
2503 }
2504 };
2505
2506 return func;
2507 } else {
2508 B2FATAL("Wrong number of arguments for meta function clusterBestMatchedMCParticle");
2509 }
2510 }
2511
2512 Manager::FunctionPtr clusterBestMatchedMCKlong(const std::vector<std::string>& arguments)
2513 {
2514 if (arguments.size() == 1) {
2515 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
2516
2517 auto func = [var](const Particle * particle) -> double {
2518
2519 const ECLCluster* cluster = particle->getECLCluster();
2520 if (!cluster) return Const::doubleNaN;
2521
2522 auto mcps = cluster->getRelationsTo<MCParticle>();
2523 if (mcps.size() == 0) return Const::doubleNaN;
2524
2525 std::map<int, double> mapMCParticleIndxAndWeight;
2526 getKlongWeightMap(particle, mapMCParticleIndxAndWeight);
2527
2528 // Klong is not found
2529 if (mapMCParticleIndxAndWeight.size() == 0)
2530 return Const::doubleNaN;
2531
2532 // find max totalWeight
2533 auto maxMap = std::max_element(mapMCParticleIndxAndWeight.begin(), mapMCParticleIndxAndWeight.end(),
2534 [](const auto & x, const auto & y) { return x.second < y.second; }
2535 );
2536
2537 StoreArray<MCParticle> mcparticles;
2538 const MCParticle* mcKlong = mcparticles[maxMap->first];
2539
2540 Particle tmpPart(mcKlong);
2541 auto var_result = var->function(&tmpPart);
2542 if (std::holds_alternative<double>(var_result))
2543 {
2544 return std::get<double>(var_result);
2545 } else if (std::holds_alternative<int>(var_result))
2546 {
2547 return std::get<int>(var_result);
2548 } else if (std::holds_alternative<bool>(var_result))
2549 {
2550 return std::get<bool>(var_result);
2551 } else
2552 {
2553 return Const::doubleNaN;
2554 }
2555 };
2556
2557 return func;
2558 } else {
2559 B2FATAL("Wrong number of arguments for meta function clusterBestMatchedMCKlong");
2560 }
2561 }
2562
2563 double matchedMCHasPDG(const Particle* particle, const std::vector<double>& pdgCode)
2564 {
2565 if (pdgCode.size() != 1) {
2566 B2FATAL("Too many arguments provided to matchedMCHasPDG!");
2567 }
2568 int inputPDG = std::lround(pdgCode[0]);
2569
2570 const MCParticle* mcp = particle->getMCParticle();
2571 if (!mcp)
2572 return Const::doubleNaN;
2573
2574 return std::abs(mcp->getPDG()) == inputPDG;
2575 }
2576
2577 Manager::FunctionPtr totalEnergyOfParticlesInList(const std::vector<std::string>& arguments)
2578 {
2579 if (arguments.size() == 1) {
2580 std::string listName = arguments[0];
2581 auto func = [listName](const Particle * particle) -> double {
2582
2583 (void) particle;
2584 StoreObjPtr<ParticleList> listOfParticles(listName);
2585
2586 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to totalEnergyOfParticlesInList");
2587 double totalEnergy = 0;
2588 int nParticles = listOfParticles->getListSize();
2589 for (int i = 0; i < nParticles; i++)
2590 {
2591 const Particle* part = listOfParticles->getParticle(i);
2592 const auto& frame = ReferenceFrame::GetCurrent();
2593 totalEnergy += frame.getMomentum(part).E();
2594 }
2595 return totalEnergy;
2596
2597 };
2598 return func;
2599 } else {
2600 B2FATAL("Wrong number of arguments for meta function totalEnergyOfParticlesInList");
2601 }
2602 }
2603
2604 Manager::FunctionPtr totalPxOfParticlesInList(const std::vector<std::string>& arguments)
2605 {
2606 if (arguments.size() == 1) {
2607 std::string listName = arguments[0];
2608 auto func = [listName](const Particle*) -> double {
2609 StoreObjPtr<ParticleList> listOfParticles(listName);
2610
2611 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to totalPxOfParticlesInList");
2612 double totalPx = 0;
2613 int nParticles = listOfParticles->getListSize();
2614 const auto& frame = ReferenceFrame::GetCurrent();
2615 for (int i = 0; i < nParticles; i++)
2616 {
2617 const Particle* part = listOfParticles->getParticle(i);
2618 totalPx += frame.getMomentum(part).Px();
2619 }
2620 return totalPx;
2621 };
2622 return func;
2623 } else {
2624 B2FATAL("Wrong number of arguments for meta function totalPxOfParticlesInList");
2625 }
2626 }
2627
2628 Manager::FunctionPtr totalPyOfParticlesInList(const std::vector<std::string>& arguments)
2629 {
2630 if (arguments.size() == 1) {
2631 std::string listName = arguments[0];
2632 auto func = [listName](const Particle*) -> double {
2633 StoreObjPtr<ParticleList> listOfParticles(listName);
2634
2635 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to totalPyOfParticlesInList");
2636 double totalPy = 0;
2637 int nParticles = listOfParticles->getListSize();
2638 const auto& frame = ReferenceFrame::GetCurrent();
2639 for (int i = 0; i < nParticles; i++)
2640 {
2641 const Particle* part = listOfParticles->getParticle(i);
2642 totalPy += frame.getMomentum(part).Py();
2643 }
2644 return totalPy;
2645 };
2646 return func;
2647 } else {
2648 B2FATAL("Wrong number of arguments for meta function totalPyOfParticlesInList");
2649 }
2650 }
2651
2652 Manager::FunctionPtr totalPzOfParticlesInList(const std::vector<std::string>& arguments)
2653 {
2654 if (arguments.size() == 1) {
2655 std::string listName = arguments[0];
2656 auto func = [listName](const Particle*) -> double {
2657 StoreObjPtr<ParticleList> listOfParticles(listName);
2658
2659 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to totalPzOfParticlesInList");
2660 double totalPz = 0;
2661 int nParticles = listOfParticles->getListSize();
2662 const auto& frame = ReferenceFrame::GetCurrent();
2663 for (int i = 0; i < nParticles; i++)
2664 {
2665 const Particle* part = listOfParticles->getParticle(i);
2666 totalPz += frame.getMomentum(part).Pz();
2667 }
2668 return totalPz;
2669 };
2670 return func;
2671 } else {
2672 B2FATAL("Wrong number of arguments for meta function totalPzOfParticlesInList");
2673 }
2674 }
2675
2676 Manager::FunctionPtr invMassInLists(const std::vector<std::string>& arguments)
2677 {
2678 if (arguments.size() > 0) {
2679
2680 auto func = [arguments](const Particle * particle) -> double {
2681
2682 ROOT::Math::PxPyPzEVector total4Vector;
2683 // To make sure particles in particlesList don't overlap.
2684 std::vector<Particle*> particlePool;
2685
2686 (void) particle;
2687 for (const auto& argument : arguments)
2688 {
2689 StoreObjPtr <ParticleList> listOfParticles(argument);
2690
2691 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << argument << " given to invMassInLists");
2692 int nParticles = listOfParticles->getListSize();
2693 for (int i = 0; i < nParticles; i++) {
2694 bool overlaps = false;
2695 Particle* part = listOfParticles->getParticle(i);
2696 for (auto poolPart : particlePool) {
2697 if (part->overlapsWith(poolPart)) {
2698 overlaps = true;
2699 break;
2700 }
2701 }
2702 if (!overlaps) {
2703 total4Vector += part->get4Vector();
2704 particlePool.push_back(part);
2705 }
2706 }
2707 }
2708 double invariantMass = total4Vector.M();
2709 return invariantMass;
2710
2711 };
2712 return func;
2713 } else {
2714 B2FATAL("Wrong number of arguments for meta function invMassInLists");
2715 }
2716 }
2717
2718 Manager::FunctionPtr totalECLEnergyOfParticlesInList(const std::vector<std::string>& arguments)
2719 {
2720 if (arguments.size() == 1) {
2721 std::string listName = arguments[0];
2722 auto func = [listName](const Particle * particle) -> double {
2723
2724 (void) particle;
2725 StoreObjPtr<ParticleList> listOfParticles(listName);
2726
2727 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to totalEnergyOfParticlesInList");
2728 double totalEnergy = 0;
2729 int nParticles = listOfParticles->getListSize();
2730 for (int i = 0; i < nParticles; i++)
2731 {
2732 const Particle* part = listOfParticles->getParticle(i);
2733 const ECLCluster* cluster = part->getECLCluster();
2734 const ECLCluster::EHypothesisBit clusterHypothesis = part->getECLClusterEHypothesisBit();
2735 if (cluster != nullptr) {
2736 totalEnergy += cluster->getEnergy(clusterHypothesis);
2737 }
2738 }
2739 return totalEnergy;
2740
2741 };
2742 return func;
2743 } else {
2744 B2FATAL("Wrong number of arguments for meta function totalECLEnergyOfParticlesInList");
2745 }
2746 }
2747
2748 Manager::FunctionPtr maxPtInList(const std::vector<std::string>& arguments)
2749 {
2750 if (arguments.size() == 1) {
2751 std::string listName = arguments[0];
2752 auto func = [listName](const Particle*) -> double {
2753 StoreObjPtr<ParticleList> listOfParticles(listName);
2754
2755 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to maxPtInList");
2756 int nParticles = listOfParticles->getListSize();
2757 const auto& frame = ReferenceFrame::GetCurrent();
2758 double maxPt = 0;
2759 for (int i = 0; i < nParticles; i++)
2760 {
2761 const Particle* part = listOfParticles->getParticle(i);
2762 const double Pt = frame.getMomentum(part).Pt();
2763 if (Pt > maxPt) maxPt = Pt;
2764 }
2765 return maxPt;
2766 };
2767 return func;
2768 } else {
2769 B2FATAL("Wrong number of arguments for meta function maxPtInList");
2770 }
2771 }
2772
2773 Manager::FunctionPtr eclClusterTrackMatchedWithCondition(const std::vector<std::string>& arguments)
2774 {
2775 if (arguments.size() <= 1) {
2776
2777 std::string cutString;
2778 if (arguments.size() == 1)
2779 cutString = arguments[0];
2780 std::shared_ptr<Variable::Cut> cut = std::shared_ptr<Variable::Cut>(Variable::Cut::compile(cutString));
2781 auto func = [cut](const Particle * particle) -> double {
2782
2783 if (particle == nullptr)
2784 return Const::doubleNaN;
2785
2786 const ECLCluster* cluster = particle->getECLCluster();
2787
2788 if (cluster)
2789 {
2790 auto tracks = cluster->getRelationsFrom<Track>();
2791
2792 for (const auto& track : tracks) {
2793 Particle trackParticle(&track, Const::pion);
2794
2795 if (cut->check(&trackParticle))
2796 return 1;
2797 }
2798 return 0;
2799 }
2800 return Const::doubleNaN;
2801 };
2802 return func;
2803 } else {
2804 B2FATAL("Wrong number of arguments for meta function eclClusterSpecialTrackMatched");
2805 }
2806 }
2807
2808 Manager::FunctionPtr averageValueInList(const std::vector<std::string>& arguments)
2809 {
2810 if (arguments.size() == 2) {
2811 std::string listName = arguments[0];
2812 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
2813
2814 auto func = [listName, var](const Particle*) -> double {
2815 StoreObjPtr<ParticleList> listOfParticles(listName);
2816
2817 if (!(listOfParticles.isValid())) B2FATAL("Invalid list name " << listName << " given to averageValueInList");
2818 int nParticles = listOfParticles->getListSize();
2819 if (nParticles == 0)
2820 {
2821 return Const::doubleNaN;
2822 }
2823 double average = 0;
2824 if (std::holds_alternative<double>(var->function(listOfParticles->getParticle(0))))
2825 {
2826 for (int i = 0; i < nParticles; i++) {
2827 average += std::get<double>(var->function(listOfParticles->getParticle(i))) / nParticles;
2828 }
2829 } else if (std::holds_alternative<int>(var->function(listOfParticles->getParticle(0))))
2830 {
2831 for (int i = 0; i < nParticles; i++) {
2832 average += std::get<int>(var->function(listOfParticles->getParticle(i))) / nParticles;
2833 }
2834 } else return Const::doubleNaN;
2835 return average;
2836 };
2837 return func;
2838 } else {
2839 B2FATAL("Wrong number of arguments for meta function averageValueInList");
2840 }
2841 }
2842
2843 Manager::FunctionPtr medianValueInList(const std::vector<std::string>& arguments)
2844 {
2845 if (arguments.size() == 2) {
2846 std::string listName = arguments[0];
2847 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
2848
2849 auto func = [listName, var](const Particle*) -> double {
2850 StoreObjPtr<ParticleList> listOfParticles(listName);
2851
2852 if (!(listOfParticles.isValid())) B2FATAL("Invalid list name " << listName << " given to medianValueInList");
2853 int nParticles = listOfParticles->getListSize();
2854 if (nParticles == 0)
2855 {
2856 return Const::doubleNaN;
2857 }
2858 std::vector<double> valuesInList;
2859 if (std::holds_alternative<double>(var->function(listOfParticles->getParticle(0))))
2860 {
2861 for (int i = 0; i < nParticles; i++) {
2862 valuesInList.push_back(std::get<double>(var->function(listOfParticles->getParticle(i))));
2863 }
2864 } else if (std::holds_alternative<int>(var->function(listOfParticles->getParticle(0))))
2865 {
2866 for (int i = 0; i < nParticles; i++) {
2867 valuesInList.push_back(std::get<int>(var->function(listOfParticles->getParticle(i))));
2868 }
2869 } else return Const::doubleNaN;
2870 std::sort(valuesInList.begin(), valuesInList.end());
2871 if (nParticles % 2 != 0)
2872 {
2873 return valuesInList[nParticles / 2];
2874 } else
2875 {
2876 return 0.5 * (valuesInList[nParticles / 2] + valuesInList[nParticles / 2 - 1]);
2877 }
2878 };
2879 return func;
2880 } else {
2881 B2FATAL("Wrong number of arguments for meta function medianValueInList");
2882 }
2883 }
2884
2885 Manager::FunctionPtr sumValueInList(const std::vector<std::string>& arguments)
2886 {
2887 if (arguments.size() == 2) {
2888 std::string listName = arguments[0];
2889 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
2890
2891 auto func = [listName, var](const Particle*) -> double {
2892 StoreObjPtr<ParticleList> listOfParticles(listName);
2893
2894 if (!(listOfParticles.isValid())) B2FATAL("Invalid list name " << listName << " given to sumValueInList");
2895 int nParticles = listOfParticles->getListSize();
2896 if (nParticles == 0)
2897 {
2898 return Const::doubleNaN;
2899 }
2900 double sum = 0;
2901 if (std::holds_alternative<double>(var->function(listOfParticles->getParticle(0))))
2902 {
2903 for (int i = 0; i < nParticles; i++) {
2904 sum += std::get<double>(var->function(listOfParticles->getParticle(i)));
2905 }
2906 } else if (std::holds_alternative<int>(var->function(listOfParticles->getParticle(0))))
2907 {
2908 for (int i = 0; i < nParticles; i++) {
2909 sum += std::get<int>(var->function(listOfParticles->getParticle(i)));
2910 }
2911 } else return Const::doubleNaN;
2912 return sum;
2913 };
2914 return func;
2915 } else {
2916 B2FATAL("Wrong number of arguments for meta function sumValueInList");
2917 }
2918 }
2919
2920 Manager::FunctionPtr productValueInList(const std::vector<std::string>& arguments)
2921 {
2922 if (arguments.size() == 2) {
2923 std::string listName = arguments[0];
2924 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
2925
2926 auto func = [listName, var](const Particle*) -> double {
2927 StoreObjPtr<ParticleList> listOfParticles(listName);
2928
2929 if (!(listOfParticles.isValid())) B2FATAL("Invalid list name " << listName << " given to productValueInList");
2930 int nParticles = listOfParticles->getListSize();
2931 if (nParticles == 0)
2932 {
2933 return Const::doubleNaN;
2934 }
2935 double product = 1;
2936 if (std::holds_alternative<double>(var->function(listOfParticles->getParticle(0))))
2937 {
2938 for (int i = 0; i < nParticles; i++) {
2939 product *= std::get<double>(var->function(listOfParticles->getParticle(i)));
2940 }
2941 } else if (std::holds_alternative<int>(var->function(listOfParticles->getParticle(0))))
2942 {
2943 for (int i = 0; i < nParticles; i++) {
2944 product *= std::get<int>(var->function(listOfParticles->getParticle(i)));
2945 }
2946 } else return Const::doubleNaN;
2947 return product;
2948 };
2949 return func;
2950 } else {
2951 B2FATAL("Wrong number of arguments for meta function productValueInList");
2952 }
2953 }
2954
2955 Manager::FunctionPtr angleToClosestInList(const std::vector<std::string>& arguments)
2956 {
2957 // expecting the list name
2958 if (arguments.size() != 1)
2959 B2FATAL("Wrong number of arguments for meta function angleToClosestInList");
2960
2961 std::string listname = arguments[0];
2962
2963 auto func = [listname](const Particle * particle) -> double {
2964 // get the list and check it's valid
2965 StoreObjPtr<ParticleList> list(listname);
2966 if (not list.isValid())
2967 B2FATAL("Invalid particle list name " << listname << " given to angleToClosestInList");
2968
2969 // check the list isn't empty
2970 if (list->getListSize() == 0)
2971 return Const::doubleNaN;
2972
2973 // respect the current frame and get the momentum of our input
2974 const auto& frame = ReferenceFrame::GetCurrent();
2975 const auto p_this = frame.getMomentum(particle);
2976
2977 // find the particle index with the smallest opening angle
2978 double minAngle = 2 * M_PI;
2979 for (unsigned int i = 0; i < list->getListSize(); ++i)
2980 {
2981 const Particle* compareme = list->getParticle(i);
2982 const auto p_compare = frame.getMomentum(compareme);
2983 double angle = ROOT::Math::VectorUtil::Angle(p_compare, p_this);
2984 if (minAngle > angle) minAngle = angle;
2985 }
2986 return minAngle;
2987 };
2988 return func;
2989 }
2990
2991 Manager::FunctionPtr closestInList(const std::vector<std::string>& arguments)
2992 {
2993 // expecting the list name and a variable name
2994 if (arguments.size() != 2)
2995 B2FATAL("Wrong number of arguments for meta function closestInList");
2996
2997 std::string listname = arguments[0];
2998
2999 // the requested variable and check it exists
3000 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
3001
3002 auto func = [listname, var](const Particle * particle) -> double {
3003 // get the list and check it's valid
3004 StoreObjPtr<ParticleList> list(listname);
3005 if (not list.isValid())
3006 B2FATAL("Invalid particle list name " << listname << " given to closestInList");
3007
3008 // respect the current frame and get the momentum of our input
3009 const auto& frame = ReferenceFrame::GetCurrent();
3010 const auto p_this = frame.getMomentum(particle);
3011
3012 // find the particle index with the smallest opening angle
3013 double minAngle = 2 * M_PI;
3014 int iClosest = -1;
3015 for (unsigned int i = 0; i < list->getListSize(); ++i)
3016 {
3017 const Particle* compareme = list->getParticle(i);
3018 const auto p_compare = frame.getMomentum(compareme);
3019 double angle = ROOT::Math::VectorUtil::Angle(p_compare, p_this);
3020 if (minAngle > angle) {
3021 minAngle = angle;
3022 iClosest = i;
3023 }
3024 }
3025
3026 // final check that the list wasn't empty (or some other problem)
3027 if (iClosest == -1) return Const::doubleNaN;
3028 auto var_result = var->function(list->getParticle(iClosest));
3029 if (std::holds_alternative<double>(var_result))
3030 {
3031 return std::get<double>(var_result);
3032 } else if (std::holds_alternative<int>(var_result))
3033 {
3034 return std::get<int>(var_result);
3035 } else if (std::holds_alternative<bool>(var_result))
3036 {
3037 return std::get<bool>(var_result);
3038 } else return Const::doubleNaN;
3039 };
3040 return func;
3041 }
3042
3043 Manager::FunctionPtr angleToMostB2BInList(const std::vector<std::string>& arguments)
3044 {
3045 // expecting the list name
3046 if (arguments.size() != 1)
3047 B2FATAL("Wrong number of arguments for meta function angleToMostB2BInList");
3048
3049 std::string listname = arguments[0];
3050
3051 auto func = [listname](const Particle * particle) -> double {
3052 // get the list and check it's valid
3053 StoreObjPtr<ParticleList> list(listname);
3054 if (not list.isValid())
3055 B2FATAL("Invalid particle list name " << listname << " given to angleToMostB2BInList");
3056
3057 // check the list isn't empty
3058 if (list->getListSize() == 0)
3059 return Const::doubleNaN;
3060
3061 // respect the current frame and get the momentum of our input
3062 const auto& frame = ReferenceFrame::GetCurrent();
3063 const auto p_this = frame.getMomentum(particle);
3064
3065 // find the most back-to-back (the largest opening angle before they
3066 // start getting smaller again!)
3067 double maxAngle = 0;
3068 for (unsigned int i = 0; i < list->getListSize(); ++i)
3069 {
3070 const Particle* compareme = list->getParticle(i);
3071 const auto p_compare = frame.getMomentum(compareme);
3072 double angle = ROOT::Math::VectorUtil::Angle(p_compare, p_this);
3073 if (maxAngle < angle) maxAngle = angle;
3074 }
3075 return maxAngle;
3076 };
3077 return func;
3078 }
3079
3080 Manager::FunctionPtr deltaPhiToMostB2BPhiInList(const std::vector<std::string>& arguments)
3081 {
3082 // expecting the list name
3083 if (arguments.size() != 1)
3084 B2FATAL("Wrong number of arguments for meta function deltaPhiToMostB2BPhiInList");
3085
3086 std::string listname = arguments[0];
3087
3088 auto func = [listname](const Particle * particle) -> double {
3089 // get the list and check it's valid
3090 StoreObjPtr<ParticleList> list(listname);
3091 if (not list.isValid())
3092 B2FATAL("Invalid particle list name " << listname << " given to deltaPhiToMostB2BPhiInList");
3093
3094 // check the list isn't empty
3095 if (list->getListSize() == 0)
3096 return Const::doubleNaN;
3097
3098 // respect the current frame and get the momentum of our input
3099 const auto& frame = ReferenceFrame::GetCurrent();
3100 const auto phi_this = frame.getMomentum(particle).Phi();
3101
3102 // find the most back-to-back in phi (largest absolute value of delta phi)
3103 double maxAngle = 0;
3104 for (unsigned int i = 0; i < list->getListSize(); ++i)
3105 {
3106 const Particle* compareme = list->getParticle(i);
3107 const auto phi_compare = frame.getMomentum(compareme).Phi();
3108 double angle = std::abs(phi_compare - phi_this);
3109 if (angle > M_PI) {angle = 2 * M_PI - angle;}
3110 if (maxAngle < angle) maxAngle = angle;
3111 }
3112 return maxAngle;
3113 };
3114 return func;
3115 }
3116
3117 Manager::FunctionPtr mostB2BInList(const std::vector<std::string>& arguments)
3118 {
3119 // expecting the list name and a variable name
3120 if (arguments.size() != 2)
3121 B2FATAL("Wrong number of arguments for meta function mostB2BInList");
3122
3123 std::string listname = arguments[0];
3124
3125 // the requested variable and check it exists
3126 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
3127
3128 auto func = [listname, var](const Particle * particle) -> double {
3129 // get the list and check it's valid
3130 StoreObjPtr<ParticleList> list(listname);
3131 if (not list.isValid())
3132 B2FATAL("Invalid particle list name " << listname << " given to mostB2BInList");
3133
3134 // respect the current frame and get the momentum of our input
3135 const auto& frame = ReferenceFrame::GetCurrent();
3136 const auto p_this = frame.getMomentum(particle);
3137
3138 // find the most back-to-back (the largest opening angle before they
3139 // start getting smaller again!)
3140 double maxAngle = -1.0;
3141 int iMostB2B = -1;
3142 for (unsigned int i = 0; i < list->getListSize(); ++i)
3143 {
3144 const Particle* compareme = list->getParticle(i);
3145 const auto p_compare = frame.getMomentum(compareme);
3146 double angle = ROOT::Math::VectorUtil::Angle(p_compare, p_this);
3147 if (maxAngle < angle) {
3148 maxAngle = angle;
3149 iMostB2B = i;
3150 }
3151 }
3152
3153 // final check that the list wasn't empty (or some other problem)
3154 if (iMostB2B == -1) return Const::doubleNaN;
3155 auto var_result = var->function(list->getParticle(iMostB2B));
3156 if (std::holds_alternative<double>(var_result))
3157 {
3158 return std::get<double>(var_result);
3159 } else if (std::holds_alternative<int>(var_result))
3160 {
3161 return std::get<int>(var_result);
3162 } else if (std::holds_alternative<bool>(var_result))
3163 {
3164 return std::get<bool>(var_result);
3165 } else return Const::doubleNaN;
3166 };
3167 return func;
3168 }
3169
3170 Manager::FunctionPtr maxOpeningAngleInList(const std::vector<std::string>& arguments)
3171 {
3172 if (arguments.size() == 1) {
3173 std::string listName = arguments[0];
3174 auto func = [listName](const Particle*) -> double {
3175 StoreObjPtr<ParticleList> listOfParticles(listName);
3176
3177 if (!(listOfParticles.isValid())) B2FATAL("Invalid Listname " << listName << " given to maxOpeningAngleInList");
3178 int nParticles = listOfParticles->getListSize();
3179 // return NaN if number of particles is less than 2
3180 if (nParticles < 2) return Const::doubleNaN;
3181
3182 const auto& frame = ReferenceFrame::GetCurrent();
3183 double maxOpeningAngle = -1;
3184 for (int i = 0; i < nParticles; i++)
3185 {
3186 ROOT::Math::PxPyPzEVector v1 = frame.getMomentum(listOfParticles->getParticle(i));
3187 for (int j = i + 1; j < nParticles; j++) {
3188 ROOT::Math::PxPyPzEVector v2 = frame.getMomentum(listOfParticles->getParticle(j));
3189 const double angle = ROOT::Math::VectorUtil::Angle(v1, v2);
3190 if (angle > maxOpeningAngle) maxOpeningAngle = angle;
3191 }
3192 }
3193 return maxOpeningAngle;
3194 };
3195 return func;
3196 } else {
3197 B2FATAL("Wrong number of arguments for meta function maxOpeningAngleInList");
3198 }
3199 }
3200
3201 Manager::FunctionPtr daughterCombination(const std::vector<std::string>& arguments)
3202 {
3203 // Expect 2 or more arguments.
3204 if (arguments.size() >= 2) {
3205 // First argument is the variable name
3206 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
3207
3208 // Core function: calculates a variable combining an arbitrary number of particles
3209 auto func = [var, arguments](const Particle * particle) -> double {
3210 if (particle == nullptr)
3211 {
3212 B2WARNING("Trying to access a daughter that does not exist. Skipping");
3213 return Const::doubleNaN;
3214 }
3215 const auto& frame = ReferenceFrame::GetCurrent();
3216
3217 // Sum of the 4-momenta of all the selected daughters
3218 ROOT::Math::PxPyPzEVector pSum(0, 0, 0, 0);
3219
3220 // Loop over the arguments. Each one of them is a generalizedIndex,
3221 // pointing to a particle in the decay tree.
3222 for (unsigned int iCoord = 1; iCoord < arguments.size(); iCoord++)
3223 {
3224 auto generalizedIndex = arguments[iCoord];
3225 const Particle* dauPart = particle->getParticleFromGeneralizedIndexString(generalizedIndex);
3226 if (dauPart)
3227 pSum += frame.getMomentum(dauPart);
3228 else {
3229 B2WARNING("Trying to access a daughter that does not exist. Index = " << generalizedIndex);
3230 return Const::doubleNaN;
3231 }
3232 }
3233
3234 // Make a dummy particle out of the sum of the 4-momenta of the selected daughters
3235 Particle sumOfDaughters(pSum, 100); // 100 is one of the special numbers
3236
3237 auto var_result = var->function(&sumOfDaughters);
3238 // Calculate the variable on the dummy particle
3239 if (std::holds_alternative<double>(var_result))
3240 {
3241 return std::get<double>(var_result);
3242 } else if (std::holds_alternative<int>(var_result))
3243 {
3244 return std::get<int>(var_result);
3245 } else if (std::holds_alternative<bool>(var_result))
3246 {
3247 return std::get<bool>(var_result);
3248 } else return Const::doubleNaN;
3249 };
3250 return func;
3251 } else
3252 B2FATAL("Wrong number of arguments for meta function daughterCombination");
3253 }
3254
3255 Manager::FunctionPtr useAlternativeDaughterHypothesis(const std::vector<std::string>& arguments)
3256 {
3257 /*
3258 `arguments` contains the variable to calculate and a list of colon-separated index-particle pairs.
3259 Overall, it looks like {"M", "0:K+", "1:p+", "3:e-"}.
3260 The code is thus divided in two parts:
3261 1) Parsing. A loop over the elements of `arguments` that first separates the variable from the rest, and then splits all the index:particle
3262 pairs, filling a std::vector with the indexes and another one with the new mass values.
3263 2) Replacing: A loop over the particle's daughters. We take the 4-momentum of each of them, recalculating it with a new mass if needed, and then we calculate
3264 the variable value using the sum of all the 4-momenta, both updated and non-updated ones.
3265 */
3266
3267 // Expect 2 or more arguments.
3268 if (arguments.size() >= 2) {
3269
3270 //----
3271 // 1) parsing
3272 //----
3273
3274 // First argument is the variable name
3275 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
3276
3277 // Parses the other arguments, which are in the form of index:particleName pairs,
3278 // and stores indexes and pdgs in std::unordered_map
3279 std::unordered_map<unsigned int, int> mapOfReplacedDaughters;
3280
3281 // Loop over the arguments to parse them
3282 for (unsigned int iCoord = 1; iCoord < arguments.size(); iCoord++) {
3283 auto replacedDauString = arguments[iCoord];
3284 // Split the string in index and new mass
3285 std::vector<std::string> indexAndMass;
3286 boost::split(indexAndMass, replacedDauString, boost::is_any_of(":"));
3287
3288 // Checks that the index:particleName pair is properly formatted.
3289 if (indexAndMass.size() > 2) {
3290 B2WARNING("The string indicating which daughter's mass should be replaced contains more than two elements separated by a colon. Perhaps you tried to pass a generalized index, which is not supported yet for this variable. The offending string is "
3291 << replacedDauString << ", while a correct syntax looks like 0:K+.");
3292 return nullptr;
3293 }
3294
3295 if (indexAndMass.size() < 2) {
3296 B2WARNING("The string indicating which daughter's mass should be replaced contains only one colon-separated element instead of two. The offending string is "
3297 << replacedDauString << ", while a correct syntax looks like 0:K+.");
3298 return nullptr;
3299 }
3300
3301 // indexAndMass[0] is the daughter index as string. Try to convert it
3302 int dauIndex = 0;
3303 try {
3304 dauIndex = convertString<int>(indexAndMass[0]);
3305 } catch (std::invalid_argument&) {
3306 B2FATAL("Found the string " << indexAndMass[0] << "instead of a daughter index.");
3307 }
3308
3309 // Determine PDG code corresponding to indexAndMass[1] using the particle names defined in evt.pdl
3310 TParticlePDG* particlePDG = TDatabasePDG::Instance()->GetParticle(indexAndMass[1].c_str());
3311 if (!particlePDG) {
3312 B2WARNING("Particle not in evt.pdl file! " << indexAndMass[1]);
3313 return nullptr;
3314 }
3315
3316 // Stores the indexes and the pdgs in the map that will be passed to the lambda function
3317 int pdgCode = particlePDG->PdgCode();
3318 mapOfReplacedDaughters[dauIndex] = pdgCode;
3319 } // End of parsing
3320
3321 // Check the size of mapOfReplacedDaughters
3322 if (mapOfReplacedDaughters.size() != arguments.size() - 1)
3323 B2FATAL("Overlapped daughter's index is detected in the meta-variable useAlternativeDaughterHypothesis");
3324
3325 //----
3326 // 2) replacing
3327 //----
3328
3329 // Core function: creates a new particle from the original one changing
3330 // some of the daughters' masses
3331 auto func = [var, mapOfReplacedDaughters](const Particle * particle) -> double {
3332 if (particle == nullptr)
3333 {
3334 B2WARNING("Trying to access a particle that does not exist. Skipping");
3335 return Const::doubleNaN;
3336 }
3337
3338 const auto& frame = ReferenceFrame::GetCurrent();
3339
3340 // Create a dummy particle from the given particle to overwrite its kinematics
3341 Particle* dummy = ParticleCopy::copyParticle(particle);
3342
3343 // Sum of the 4-momenta of all the daughters with the new mass assumptions
3344 ROOT::Math::PxPyPzMVector pSum(0, 0, 0, 0);
3345
3346 for (unsigned int iDau = 0; iDau < particle->getNDaughters(); iDau++)
3347 {
3348 const Particle* dauPart = particle->getDaughter(iDau);
3349 if (not dauPart) {
3350 B2WARNING("Trying to access a daughter that does not exist. Index = " << iDau);
3351 return Const::doubleNaN;
3352 }
3353
3354 ROOT::Math::PxPyPzMVector dauMom = ROOT::Math::PxPyPzMVector(frame.getMomentum(dauPart));
3355
3356 int pdgCode;
3357 try {
3358 pdgCode = mapOfReplacedDaughters.at(iDau);
3359 } catch (std::out_of_range&) {
3360 // iDau is not in mapOfReplacedDaughters
3361 pSum += dauMom;
3362 continue;
3363 }
3364
3365 // overwrite the daughter's kinematics
3366 double p_x = dauMom.Px();
3367 double p_y = dauMom.Py();
3368 double p_z = dauMom.Pz();
3369 dauMom.SetCoordinates(p_x, p_y, p_z, TDatabasePDG::Instance()->GetParticle(pdgCode)->Mass());
3370 const_cast<Particle*>(dummy->getDaughter(iDau))->set4VectorDividingByMomentumScaling(ROOT::Math::PxPyPzEVector(dauMom));
3371
3372 // overwrite the daughter's pdg
3373 const int charge = dummy->getDaughter(iDau)->getCharge();
3374 if (TDatabasePDG::Instance()->GetParticle(pdgCode)->Charge() / 3.0 == charge)
3375 const_cast<Particle*>(dummy->getDaughter(iDau))->setPDGCode(pdgCode);
3376 else
3377 const_cast<Particle*>(dummy->getDaughter(iDau))->setPDGCode(-1 * pdgCode);
3378
3379 pSum += dauMom;
3380 } // End of loop over number of daughter
3381
3382 // overwrite the particle's kinematics
3383 dummy->set4Vector(ROOT::Math::PxPyPzEVector(pSum));
3384
3385 auto var_result = var->function(dummy);
3386
3387 // Calculate the variable on the dummy particle
3388 if (std::holds_alternative<double>(var_result))
3389 {
3390 return std::get<double>(var_result);
3391 } else if (std::holds_alternative<int>(var_result))
3392 {
3393 return std::get<int>(var_result);
3394 } else if (std::holds_alternative<bool>(var_result))
3395 {
3396 return std::get<bool>(var_result);
3397 } else return Const::doubleNaN;
3398 }; // end of lambda function
3399 return func;
3400 }// end of check on number of arguments
3401 else
3402 B2FATAL("Wrong number of arguments for meta function useAlternativeDaughterHypothesis");
3403 }
3404
3405 Manager::FunctionPtr varForFirstMCAncestorOfType(const std::vector<std::string>& arguments)
3406 {
3407 if (arguments.size() == 2) {
3408 int pdg_code = -1;
3409 std::string arg = arguments[0];
3410 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[1]);
3411 TParticlePDG* part = TDatabasePDG::Instance()->GetParticle(arg.c_str());
3412
3413 if (part != nullptr) {
3414 pdg_code = std::abs(part->PdgCode());
3415 } else {
3416 try {
3417 pdg_code = convertString<int>(arg);
3418 } catch (std::exception& e) {}
3419 }
3420
3421 if (pdg_code == -1) {
3422 B2FATAL("Ancestor " + arg + " is not recognised. Please provide valid PDG code or particle name.");
3423 }
3424
3425 auto func = [pdg_code, var](const Particle * particle) -> double {
3426 const Particle* p = particle;
3427
3428 int ancestor_level = std::get<double>(Manager::Instance().getVariable("hasAncestor(" + std::to_string(pdg_code) + ", 0)")->function(p));
3429 if ((ancestor_level <= 0) or (std::isnan(ancestor_level)))
3430 {
3431 return Const::doubleNaN;
3432 }
3433
3434 const MCParticle* i_p = p->getMCParticle();
3435
3436 for (int a = 0; a < ancestor_level ; a = a + 1)
3437 {
3438 i_p = i_p->getMother();
3439 }
3440
3441 StoreArray<Particle> tempParticles("tempParticles");
3442 tempParticles.clear();
3443 Particle m_p(i_p);
3444 Particle* newPart = tempParticles.appendNew(m_p);
3445 newPart->addRelationTo(i_p);
3446
3447 appendDaughtersRecursive(newPart, tempParticles);
3448
3449 auto var_result = var->function(newPart);
3450 if (std::holds_alternative<double>(var_result))
3451 {
3452 return std::get<double>(var_result);
3453 } else if (std::holds_alternative<int>(var_result))
3454 {
3455 return std::get<int>(var_result);
3456 } else if (std::holds_alternative<bool>(var_result))
3457 {
3458 return std::get<bool>(var_result);
3459 } else return Const::doubleNaN;
3460 };
3461 return func;
3462 } else {
3463 B2FATAL("Wrong number of arguments for meta function varForFirstMCAncestorOfType (expected 2: type and variable of interest)");
3464 }
3465 }
3466
3467 Manager::FunctionPtr nTrackFitResults(const std::vector<std::string>& arguments)
3468 {
3469 if (arguments.size() != 1) {
3470 B2FATAL("Number of arguments for nTrackFitResults must be 1, particleType or PDGcode");
3471 }
3472
3473 std::string arg = arguments[0];
3474 TDatabasePDG* pdgDatabase = TDatabasePDG::Instance();
3475 TParticlePDG* part = pdgDatabase->GetParticle(arg.c_str());
3476 int absPdg = 0;
3477 if (part != nullptr) {
3478 absPdg = std::abs(part->PdgCode());
3479 } else {
3480 try {
3481 absPdg = std::abs(convertString<int>(arg));
3482 } catch (const std::exception&) {
3483 absPdg = 0;
3484 }
3485
3486 if (absPdg == 0 || pdgDatabase->GetParticle(absPdg) == nullptr) {
3487 B2FATAL("nTrackFitResults: argument '" << arg << "' is neither a valid particle name nor a PDG code");
3488 }
3489 }
3490
3491 auto func = [absPdg](const Particle*) -> int {
3492
3493 Const::ChargedStable type(absPdg);
3494 StoreArray<Track> tracks;
3495
3496 int nTrackFitResults = 0;
3497
3498 for (const auto& track : tracks)
3499 {
3500 const TrackFitResult* trackFit = track.getTrackFitResultWithClosestMass(type);
3501
3502 if (!trackFit) continue;
3503 if (trackFit->getChargeSign() == 0) continue;
3504
3505 nTrackFitResults++;
3506 }
3507
3508 return nTrackFitResults;
3509
3510 };
3511 return func;
3512 }
3513
3514
3515 Manager::FunctionPtr convertToInt(const std::vector<std::string>& arguments)
3516 {
3517 if (arguments.size() == 2) {
3518 const Variable::Manager::Var* var = Manager::Instance().getVariable(arguments[0]);
3519 int default_val = convertString<int>(arguments[1]);
3520 auto func = [var, default_val](const Particle * particle) -> int {
3521 auto var_result = var->function(particle);
3522 if (std::holds_alternative<double>(var_result))
3523 {
3524 double value = std::get<double>(var_result);
3525 if (value > std::numeric_limits<int>::max())
3526 value = std::numeric_limits<int>::max();
3527 if (value < std::numeric_limits<int>::min())
3528 value = std::numeric_limits<int>::min();
3529 if (std::isnan(value))
3530 value = default_val;
3531 return static_cast<int>(value);
3532 } else if (std::holds_alternative<int>(var_result))
3533 return std::get<int>(var_result);
3534 else if (std::holds_alternative<bool>(var_result))
3535 return static_cast<int>(std::get<bool>(var_result));
3536 else return default_val;
3537 };
3538 return func;
3539 } else {
3540 B2FATAL("Wrong number of arguments for meta function int, please provide variable name and replacement value for NaN!");
3541 }
3542 }
3543
3544 VARIABLE_GROUP("MetaFunctions");
3545 REGISTER_METAVARIABLE("nCleanedECLClusters(cut)", nCleanedECLClusters,
3546 "[Eventbased] Returns the number of clean Clusters in the event\n"
3547 "Clean clusters are defined by the clusters which pass the given cut assuming a photon hypothesis.",
3548 Manager::VariableDataType::c_int);
3549 REGISTER_METAVARIABLE("nCleanedTracks(cut)", nCleanedTracks,
3550 "[Eventbased] Returns the number of clean Tracks in the event\n"
3551 "Clean tracks are defined by the tracks which pass the given cut assuming a pion hypothesis.", Manager::VariableDataType::c_int);
3552 REGISTER_METAVARIABLE("formula(v1 + v2 * [v3 - v4] / v5^v6)", formula, R"DOCSTRING(
3553Returns the result of the given formula, where v1 to vN are variables or floating
3554point numbers. Currently the only supported operations are addition (``+``),
3555subtraction (``-``), multiplication (``*``), division (``/``) and power (``^``
3556or ``**``). Parenthesis can be in the form of square brackets ``[v1 * v2]``
3557or normal brackets ``(v1 * v2)``. It will work also with variables taking
3558arguments. Operator precedence is taken into account. For example ::
3559
3560 (daughter(0, E) + daughter(1, E))**2 - p**2 + 0.138
3561
3562.. versionchanged:: release-03-00-00
3563 now both, ``[]`` and ``()`` can be used for grouping operations, ``**`` can
3564 be used for exponent and float literals are possible directly in the
3565 formula.
3566)DOCSTRING", Manager::VariableDataType::c_double);
3567 REGISTER_METAVARIABLE("useRestFrame(variable)", useRestFrame,
3568 "Returns the value of the variable using the rest frame of the given particle as current reference frame.\n"
3569 "E.g. ``useRestFrame(daughter(0, p))`` returns the total momentum of the first daughter in its mother's rest-frame", Manager::VariableDataType::c_double);
3570 REGISTER_METAVARIABLE("useCMSFrame(variable)", useCMSFrame,
3571 "Returns the value of the variable using the CMS frame as current reference frame.\n"
3572 "E.g. ``useCMSFrame(E)`` returns the energy of a particle in the CMS frame.", Manager::VariableDataType::c_double);
3573 REGISTER_METAVARIABLE("useLabFrame(variable)", useLabFrame, R"DOC(
3574Returns the value of ``variable`` in the *lab* frame.
3575
3576.. tip::
3577 The lab frame is the default reference frame, usually you don't need to use this meta-variable.
3578 E.g. ``useLabFrame(E)`` returns the energy of a particle in the Lab frame, same as just ``E``.
3579
3580Specifying the lab frame is useful in some corner-cases. For example:
3581``useRestFrame(daughter(0, formula(E - useLabFrame(E))))`` which is the difference of the first daughter's energy in the rest frame of the mother (current particle) with the same daughter's lab-frame energy.
3582)DOC", Manager::VariableDataType::c_double);
3583 REGISTER_METAVARIABLE("useTagSideRecoilRestFrame(variable, daughterIndexTagB)", useTagSideRecoilRestFrame,
3584 "Returns the value of the variable in the rest frame of the recoiling particle to the tag side B meson.\n"
3585 "The variable should only be applied to an Upsilon(4S) list.\n"
3586 "E.g. ``useTagSideRecoilRestFrame(daughter(1, daughter(1, p)), 0)`` applied on a Upsilon(4S) list (``Upsilon(4S)->B+:tag B-:sig``) returns the momentum of the second daughter of the signal B meson in the signal B meson rest frame.", Manager::VariableDataType::c_double);
3587 REGISTER_METAVARIABLE("useParticleRestFrame(variable, particleList)", useParticleRestFrame,
3588 "Returns the value of the variable in the rest frame of the first Particle contained in the given ParticleList.\n"
3589 "It is strongly recommended to pass a ParticleList that contains at most only one Particle in each event. "
3590 "When more than one Particle is present in the ParticleList, only the first Particle in the list is used for "
3591 "computing the rest frame and a warning is thrown. If the given ParticleList is empty in an event, it returns NaN.", Manager::VariableDataType::c_double);
3592 REGISTER_METAVARIABLE("useRecoilParticleRestFrame(variable, particleList)", useRecoilParticleRestFrame,
3593 "Returns the value of the variable in the rest frame of recoil system against the first Particle contained in the given ParticleList.\n"
3594 "It is strongly recommended to pass a ParticleList that contains at most only one Particle in each event. "
3595 "When more than one Particle is present in the ParticleList, only the first Particle in the list is used for "
3596 "computing the rest frame and a warning is thrown. If the given ParticleList is empty in an event, it returns NaN.", Manager::VariableDataType::c_double);
3597 REGISTER_METAVARIABLE("useDaughterRestFrame(variable, daughterIndex_1, [daughterIndex_2, ... daughterIndex_3])", useDaughterRestFrame,
3598 "Returns the value of the variable in the rest frame of the selected daughter particle.\n"
3599 "The daughter is identified via generalized daughter index, e.g. ``0:1`` identifies the second daughter (1) "
3600 "of the first daughter (0). If the daughter index is invalid, it returns NaN.\n"
3601 "If two or more indices are given, the rest frame of the sum of the daughters is used.",
3602 Manager::VariableDataType::c_double);
3603 REGISTER_METAVARIABLE("useDaughterRecoilRestFrame(variable, daughterIndex_1, [daughterIndex_2, ... daughterIndex_3])", useDaughterRecoilRestFrame,
3604 "Returns the value of the variable in the rest frame of the recoil of the selected daughter particle.\n"
3605 "The daughter is identified via generalized daughter index, e.g. ``0:1`` identifies the second daughter (1) "
3606 "of the first daughter (0). If the daughter index is invalid, it returns NaN.\n"
3607 "If two or more indices are given, the rest frame of the sum of the daughters is used.",
3608 Manager::VariableDataType::c_double);
3609 REGISTER_METAVARIABLE("useMCancestorBRestFrame(variable)", useMCancestorBRestFrame,
3610 "Returns the value of the variable in the rest frame of the ancestor B MC particle.\n"
3611 "If no B or no MC-matching is found, it returns NaN.", Manager::VariableDataType::c_double);
3612 REGISTER_METAVARIABLE("passesCut(cut)", passesCut,
3613 "Returns 1 if particle passes the cut otherwise 0.\n"
3614 "Useful if you want to write out if a particle would have passed a cut or not.", Manager::VariableDataType::c_bool);
3615 REGISTER_METAVARIABLE("passesEventCut(cut)", passesEventCut,
3616 "[Eventbased] Returns 1 if event passes the cut otherwise 0.\n"
3617 "Useful if you want to select events passing a cut without looping into particles, such as for skimming.\n", Manager::VariableDataType::c_bool);
3618 REGISTER_METAVARIABLE("countDaughters(cut)", countDaughters,
3619 "Returns number of direct daughters which satisfy the cut.\n"
3620 "Used by the skimming package (for what exactly?)", Manager::VariableDataType::c_int);
3621 REGISTER_METAVARIABLE("countFSPDaughters(cut)", countDescendants,
3622 "Returns number of final-state daughters which satisfy the cut.",
3623 Manager::VariableDataType::c_int);
3624 REGISTER_METAVARIABLE("countDescendants(cut)", countDescendants,
3625 "Returns number of descendants for all generations which satisfy the cut.",
3626 Manager::VariableDataType::c_int);
3627 REGISTER_METAVARIABLE("varFor(pdgCode, variable)", varFor,
3628 "Returns the value of the variable for the given particle if its abs(pdgCode) agrees with the given one.\n"
3629 "E.g. ``varFor(11, p)`` returns the momentum if the particle is an electron or a positron.", Manager::VariableDataType::c_double);
3630 REGISTER_METAVARIABLE("varForMCGen(variable)", varForMCGen,
3631 "Returns the value of the variable for the given particle if the MC particle related to it is primary, not virtual, and not initial.\n"
3632 "If no MC particle is related to the given particle, or the MC particle is not primary, virtual, or initial, NaN will be returned.\n"
3633 "E.g. ``varForMCGen(PDG)`` returns the PDG code of the MC particle related to the given particle if it is primary, not virtual, and not initial.", Manager::VariableDataType::c_double);
3634 REGISTER_METAVARIABLE("nParticlesInList(particleListName)", nParticlesInList,
3635 "[Eventbased] Returns number of particles in the given particle List.", Manager::VariableDataType::c_int);
3636 REGISTER_METAVARIABLE("isInList(particleListName)", isInList,
3637 "Returns 1 if the particle is in the list provided, 0 if not. Note that this only checks the particle given. For daughters of composite particles, please see :b2:var:`isDaughterOfList`.", Manager::VariableDataType::c_bool);
3638 REGISTER_METAVARIABLE("isDaughterOfList(particleListNames)", isDaughterOfList,
3639 "Returns 1 if the given particle is a daughter of at least one of the particles in the given particle Lists.", Manager::VariableDataType::c_bool);
3640 REGISTER_METAVARIABLE("isDescendantOfList(particleListName[, anotherParticleListName][, generationFlag = -1])", isDescendantOfList, R"DOC(
3641 Returns 1 if the given particle appears in the decay chain of the particles in the given ParticleLists.
3642
3643 Passing an integer as the last argument, allows to check if the particle belongs to the specific generation:
3644
3645 * ``isDescendantOfList(<particle_list>,1)`` returns 1 if particle is a daughter of the list,
3646 * ``isDescendantOfList(<particle_list>,2)`` returns 1 if particle is a granddaughter of the list,
3647 * ``isDescendantOfList(<particle_list>,3)`` returns 1 if particle is a great-granddaughter of the list, etc.
3648 * Default value is ``-1`` that is inclusive for all generations.
3649 )DOC", Manager::VariableDataType::c_bool);
3650 REGISTER_METAVARIABLE("isMCDescendantOfList(particleListName[, anotherParticleListName][, generationFlag = -1])", isMCDescendantOfList, R"DOC(
3651 Returns 1 if the given particle is linked to the same MC particle as any reconstructed daughter of the decay lists.
3652
3653 Passing an integer as the last argument, allows to check if the particle belongs to the specific generation:
3654
3655 * ``isMCDescendantOfList(<particle_list>,1)`` returns 1 if particle is matched to the same particle as any daughter of the list,
3656 * ``isMCDescendantOfList(<particle_list>,2)`` returns 1 if particle is matched to the same particle as any granddaughter of the list,
3657 * ``isMCDescendantOfList(<particle_list>,3)`` returns 1 if particle is matched to the same particle as any great-granddaughter of the list, etc.
3658 * Default value is ``-1`` that is inclusive for all generations.
3659
3660 It makes only sense for lists created with `fillParticleListFromMC` function with ``addDaughters=True`` argument.
3661 )DOC", Manager::VariableDataType::c_bool);
3662
3663 REGISTER_METAVARIABLE("sourceObjectIsInList(particleListName)", sourceObjectIsInList, R"DOC(
3664Returns 1 if the underlying mdst object (e.g. track, or cluster) was used to create a particle in ``particleListName``, 0 if not.
3665
3666.. note::
3667 This only makes sense for particles that are not composite. Returns -1 for composite particles.
3668)DOC", Manager::VariableDataType::c_int);
3669
3670 REGISTER_METAVARIABLE("mcParticleIsInMCList(particleListName)", mcParticleIsInMCList, R"DOC(
3671Returns 1 if the particle's matched MC particle is also matched to a particle in ``particleListName``
3672(or if either of the lists were filled from generator level `modularAnalysis.fillParticleListFromMC`.)
3673
3674.. seealso:: :b2:var:`isMCDescendantOfList` to check daughters.
3675)DOC", Manager::VariableDataType::c_bool);
3676
3677 REGISTER_METAVARIABLE("isGrandDaughterOfList(particleListNames)", isGrandDaughterOfList,
3678 "Returns 1 if the given particle is a grand daughter of at least one of the particles in the given particle Lists.", Manager::VariableDataType::c_bool);
3679 REGISTER_METAVARIABLE("originalParticle(variable)", originalParticle, R"DOC(
3680 Returns value of variable for the original particle from which the given particle is copied.
3681
3682 The copy of particle is created, for example, when the vertex fit updates the daughters and `modularAnalysis.copyParticles` is called.
3683 Returns NaN if the given particle is not copied and so there is no original particle.
3684 )DOC", Manager::VariableDataType::c_double);
3685 REGISTER_METAVARIABLE("daughter(i, variable)", daughter, R"DOC(
3686 Returns value of variable for the i-th daughter. E.g.
3687
3688 * ``daughter(0, p)`` returns the total momentum of the first daughter.
3689 * ``daughter(0, daughter(1, p)`` returns the total momentum of the second daughter of the first daughter.
3690
3691 Returns NaN if particle is nullptr or if the given daughter-index is out of bound (>= amount of daughters).
3692 )DOC", Manager::VariableDataType::c_double);
3693 REGISTER_METAVARIABLE("originalDaughter(i, variable)", originalDaughter, R"DOC(
3694 Returns value of variable for the original particle from which the i-th daughter is copied.
3695
3696 The copy of particle is created, for example, when the vertex fit updates the daughters and `modularAnalysis.copyParticles` is called.
3697 Returns NaN if the daughter is not copied and so there is no original daughter.
3698
3699 Returns NaN if particle is nullptr or if the given daughter-index is out of bound (>= amount of daughters).
3700 )DOC", Manager::VariableDataType::c_double);
3701 REGISTER_METAVARIABLE("mcDaughter(i, variable)", mcDaughter, R"DOC(
3702 Returns the value of the requested variable for the i-th Monte Carlo daughter of the particle.
3703
3704 Returns NaN if the particle is nullptr, if the particle is not matched to an MC particle,
3705 or if the i-th MC daughter does not exist.
3706
3707 E.g. ``mcDaughter(0, PDG)`` will return the PDG code of the first MC daughter of the matched MC
3708 particle of the reconstructed particle the function is applied to.
3709
3710 The meta variable can also be nested: ``mcDaughter(0, mcDaughter(1, PDG))``.
3711 )DOC", Manager::VariableDataType::c_double);
3712 REGISTER_METAVARIABLE("mcMother(variable)", mcMother, R"DOC(
3713 Returns the value of the requested variable for the Monte Carlo mother of the particle.
3714
3715 Returns NaN if the particle is nullptr, if the particle is not matched to an MC particle,
3716 or if the MC mother does not exist.
3717
3718 E.g. ``mcMother(PDG)`` will return the PDG code of the MC mother of the matched MC
3719 particle of the reconstructed particle the function is applied to.
3720
3721 The meta variable can also be nested: ``mcMother(mcMother(PDG))``.
3722 )DOC", Manager::VariableDataType::c_double);
3723 REGISTER_METAVARIABLE("genParticle(index, variable)", genParticle, R"DOC(
3724[Eventbased] Returns the ``variable`` for the ith generator particle.
3725The arguments of the function must be the ``index`` of the particle in the MCParticle Array,
3726and ``variable``, the name of the function or variable for that generator particle.
3727If ``index`` goes beyond the length of the MCParticles array, NaN will be returned.
3728
3729E.g. ``genParticle(0, p)`` returns the total momentum of the first MCParticle, which in a generic decay up to MC15 is
3730the Upsilon(4S) and for MC16 and beyond the initial electron.
3731)DOC", Manager::VariableDataType::c_double);
3732 REGISTER_METAVARIABLE("genUpsilon4S(variable)", genUpsilon4S, R"DOC(
3733[Eventbased] Returns the ``variable`` evaluated for the generator-level :math:`\Upsilon(4S)`.
3734If no generator level :math:`\Upsilon(4S)` exists for the event, NaN will be returned.
3735
3736E.g. ``genUpsilon4S(p)`` returns the total momentum of the :math:`\Upsilon(4S)` in a generic decay.
3737``genUpsilon4S(mcDaughter(1, p))`` returns the total momentum of the second daughter of the
3738generator-level :math:`\Upsilon(4S)` (i.e. the momentum of the second B meson in a generic decay).
3739)DOC", Manager::VariableDataType::c_double);
3740 REGISTER_METAVARIABLE("daughterProductOf(variable)", daughterProductOf,
3741 "Returns product of a variable over all daughters.\n"
3742 "E.g. ``daughterProductOf(extraInfo(SignalProbability))`` returns the product of the SignalProbabilitys of all daughters.", Manager::VariableDataType::c_double);
3743 REGISTER_METAVARIABLE("daughterSumOf(variable)", daughterSumOf,
3744 "Returns sum of a variable over all daughters.\n"
3745 "E.g. ``daughterSumOf(nDaughters)`` returns the number of grand-daughters.", Manager::VariableDataType::c_double);
3746 REGISTER_METAVARIABLE("daughterLowest(variable)", daughterLowest,
3747 "Returns the lowest value of the given variable among all daughters.\n"
3748 "E.g. ``useCMSFrame(daughterLowest(p))`` returns the lowest momentum in CMS frame.", Manager::VariableDataType::c_double);
3749 REGISTER_METAVARIABLE("daughterHighest(variable)", daughterHighest,
3750 "Returns the highest value of the given variable among all daughters.\n"
3751 "E.g. ``useCMSFrame(daughterHighest(p))`` returns the highest momentum in CMS frame.", Manager::VariableDataType::c_double);
3752 REGISTER_METAVARIABLE("daughterDiffOf(daughterIndex_i, daughterIndex_j, variable)", daughterDiffOf, R"DOC(
3753 Returns the difference of a variable between the two given daughters.
3754 E.g. ``useRestFrame(daughterDiffOf(0, 1, p))`` returns the momentum difference between first and second daughter in the rest frame of the given particle.
3755 (That means that it returns :math:`p_j - p_i`)
3756
3757 The daughters can be provided as generalized daughter indexes, which are simply colon-separated
3758 lists of daughter indexes, ordered starting from the root particle. For example, ``0:1``
3759 identifies the second daughter (1) of the first daughter (0) of the mother particle.
3760
3761 )DOC", Manager::VariableDataType::c_double);
3762 REGISTER_METAVARIABLE("mcDaughterDiffOf(i, j, variable)", mcDaughterDiffOf,
3763 "MC matched version of the `daughterDiffOf` function.", Manager::VariableDataType::c_double);
3764 REGISTER_METAVARIABLE("grandDaughterDiffOf(i, j, variable)", grandDaughterDiffOf,
3765 "Returns the difference of a variable between the first daughters of the two given daughters.\n"
3766 "E.g. ``useRestFrame(grandDaughterDiffOf(0, 1, p))`` returns the momentum difference between the first daughters of the first and second daughter in the rest frame of the given particle.\n"
3767 "(That means that it returns :math:`p_j - p_i`)", Manager::VariableDataType::c_double);
3768 MAKE_DEPRECATED("grandDaughterDiffOf", false, "light-2402-ocicat", R"DOC(
3769 The difference between any combination of (grand-)daughters can be calculated with the more general variable :b2:var:`daughterDiffOf`
3770 by using generalized daughter indexes.)DOC");
3771 REGISTER_METAVARIABLE("daughterNormDiffOf(i, j, variable)", daughterNormDiffOf,
3772 "Returns the normalized difference of a variable between the two given daughters.\n"
3773 "E.g. ``daughterNormDiffOf(0, 1, p)`` returns the normalized momentum difference between first and second daughter in the lab frame.", Manager::VariableDataType::c_double);
3774 REGISTER_METAVARIABLE("daughterMotherDiffOf(i, variable)", daughterMotherDiffOf,
3775 "Returns the difference of a variable between the given daughter and the mother particle itself.\n"
3776 "E.g. ``useRestFrame(daughterMotherDiffOf(0, p))`` returns the momentum difference between the given particle and its first daughter in the rest frame of the mother.", Manager::VariableDataType::c_double);
3777 REGISTER_METAVARIABLE("daughterMotherNormDiffOf(i, variable)", daughterMotherNormDiffOf,
3778 "Returns the normalized difference of a variable between the given daughter and the mother particle itself.\n"
3779 "E.g. ``daughterMotherNormDiffOf(1, p)`` returns the normalized momentum difference between the given particle and its second daughter in the lab frame.", Manager::VariableDataType::c_double);
3780 REGISTER_METAVARIABLE("angleBetweenDaughterAndRecoil(daughterIndex_1, daughterIndex_2, ... )", angleBetweenDaughterAndRecoil, R"DOC(
3781 Returns the angle between the momentum recoiling against the particle and the sum of the momenta of the given daughters.
3782 The unit of the angle is ``rad``.
3783
3784 The particles are identified via generalized daughter indexes, which are simply colon-separated lists of
3785 daughter indexes, ordered starting from the root particle. For example, ``0:1:3`` identifies the fourth
3786 daughter (3) of the second daughter (1) of the first daughter (0) of the mother particle. ``1`` simply
3787 identifies the second daughter of the root particle.
3788
3789 At least one generalized index has to be given to ``angleBetweenDaughterAndRecoil``.
3790
3791 .. tip::
3792 ``angleBetweenDaughterAndRecoil(0)`` will return the angle between pRecoil and the momentum of the first daughter.
3793
3794 ``angleBetweenDaughterAndRecoil(0, 1)`` will return the angle between pRecoil and the sum of the momenta of the first and second daughter.
3795
3796 ``angleBetweenDaughterAndRecoil(0:0, 3:0)`` will return the angle between pRecoil and the sum of the momenta of the: first daughter of the first daughter, and
3797 the first daughter of the fourth daughter.)DOC", Manager::VariableDataType::c_double);
3798 REGISTER_METAVARIABLE("angleBetweenDaughterAndMissingMomentum(daughterIndex_1, daughterIndex_2, ... )", angleBetweenDaughterAndMissingMomentum, R"DOC(
3799 Returns the angle between the missing momentum in the event and the sum of the momenta of the given daughters.
3800 The unit of the angle is ``rad``. EventKinematics module has to be called to use this.
3801
3802 The particles are identified via generalized daughter indexes, which are simply colon-separated lists of
3803 daughter indexes, ordered starting from the root particle. For example, ``0:1:3`` identifies the fourth
3804 daughter (3) of the second daughter (1) of the first daughter (0) of the mother particle. ``1`` simply
3805 identifies the second daughter of the root particle.
3806
3807 At least one generalized index has to be given to ``angleBetweenDaughterAndMissingMomentum``.
3808
3809 .. tip::
3810 ``angleBetweenDaughterAndMissingMomentum(0)`` will return the angle between missMom and the momentum of the first daughter.
3811
3812 ``angleBetweenDaughterAndMissingMomentum(0, 1)`` will return the angle between missMom and the sum of the momenta of the first and second daughter.
3813
3814 ``angleBetweenDaughterAndMissingMomentum(0:0, 3:0)`` will return the angle between missMom and the sum of the momenta of the: first daughter of the first daughter, and
3815 the first daughter of the fourth daughter.)DOC", Manager::VariableDataType::c_double);
3816 REGISTER_METAVARIABLE("daughterAngle(daughterIndex_1, daughterIndex_2[, daughterIndex_3])", daughterAngle, R"DOC(
3817 Returns the angle in between any pair of particles belonging to the same decay tree.
3818 The unit of the angle is ``rad``.
3819
3820 The particles are identified via generalized daughter indexes, which are simply colon-separated lists of
3821 daughter indexes, ordered starting from the root particle. For example, ``0:1:3`` identifies the fourth
3822 daughter (3) of the second daughter (1) of the first daughter (0) of the mother particle. ``1`` simply
3823 identifies the second daughter of the root particle.
3824
3825 Both two and three generalized indexes can be given to ``daughterAngle``. If two indices are given, the
3826 variable returns the angle between the momenta of the two given particles. If three indices are given, the
3827 variable returns the angle between the momentum of the third particle and a vector which is the sum of the
3828 first two daughter momenta.
3829
3830 .. tip::
3831 ``daughterAngle(0, 3)`` will return the angle between the first and fourth daughter.
3832 ``daughterAngle(0, 1, 3)`` will return the angle between the fourth daughter and the sum of the first and
3833 second daughter.
3834 ``daughterAngle(0:0, 3:0)`` will return the angle between the first daughter of the first daughter, and
3835 the first daughter of the fourth daughter.
3836
3837 )DOC", Manager::VariableDataType::c_double);
3838 REGISTER_METAVARIABLE("mcDaughterAngle(daughterIndex_1, daughterIndex_2, [daughterIndex_3])", mcDaughterAngle,
3839 "MC matched version of the `daughterAngle` function. Also works if applied directly to MC particles. The unit of the angle is ``rad``", Manager::VariableDataType::c_double);
3840 REGISTER_VARIABLE("grandDaughterDecayAngle(i, j)", grandDaughterDecayAngle,
3841 "Returns the decay angle of the granddaughter in the daughter particle's rest frame.\n"
3842 "It is calculated with respect to the reverted momentum vector of the particle.\n"
3843 "Two arguments representing the daughter and granddaughter indices have to be provided as arguments.\n\n", "rad");
3844 REGISTER_VARIABLE("daughterClusterAngleInBetween(i, j)", daughterClusterAngleInBetween,
3845 "Returns the angle between clusters associated to the two daughters."
3846 "If two indices given: returns the angle between the momenta of the clusters associated to the two given daughters."
3847 "If three indices given: returns the angle between the momentum of the third particle's cluster and a vector "
3848 "which is the sum of the first two daughter's cluster momenta."
3849 "Returns nan if any of the daughters specified don't have an associated cluster."
3850 "The arguments in the argument vector must be integers corresponding to the ith and jth (and kth) daughters.\n\n", "rad");
3851 REGISTER_METAVARIABLE("daughterInvM(i[, j, ...])", daughterInvM, R"DOC(
3852 Returns the invariant mass adding the Lorentz vectors of the given daughters. The unit of the invariant mass is GeV/:math:`\text{c}^2`
3853 E.g. ``daughterInvM(0, 1, 2)`` returns the invariant Mass :math:`m = \sqrt{(p_0 + p_1 + p_2)^2}` of the first, second and third daughter.
3854
3855 Daughters from different generations of the decay tree can be combined using generalized daughter indexes,
3856 which are simply colon-separated daughter indexes for each generation, starting from the root particle. For
3857 example, ``0:1:3`` identifies the fourth daughter (3) of the second daughter (1) of the first daughter(0) of
3858 the mother particle.
3859
3860 Returns NaN if the given daughter-index is out of bound (>= number of daughters))DOC", Manager::VariableDataType::c_double);
3861 REGISTER_METAVARIABLE("extraInfo(name)", extraInfo,
3862 "Returns extra info stored under the given name.\n"
3863 "The extraInfo has to be set by a module first.\n"
3864 "E.g. ``extraInfo(SignalProbability)`` returns the SignalProbability calculated by the ``MVAExpert`` module.\n"
3865 "If nothing is set under the given name or if the particle is a nullptr, NaN is returned.\n"
3866 "In the latter case please use `eventExtraInfo` if you want to access an EventExtraInfo variable.", Manager::VariableDataType::c_double);
3867 REGISTER_METAVARIABLE("eventExtraInfo(name)", eventExtraInfo,
3868 "[Eventbased] Returns extra info stored under the given name in the event extra info.\n"
3869 "The extraInfo has to be set first by another module like MVAExpert in event mode.\n"
3870 "If nothing is set under this name, NaN is returned.", Manager::VariableDataType::c_double);
3871 REGISTER_METAVARIABLE("eventCached(variable)", eventCached,
3872 "[Eventbased] Returns value of event-based variable and caches this value in the EventExtraInfo.\n"
3873 "The result of second call to this variable in the same event will be provided from the cache.\n"
3874 "It is recommended to use this variable in order to declare custom aliases as event-based. This is "
3875 "necessary if using the eventwise mode of variablesToNtuple).", Manager::VariableDataType::c_double);
3876 REGISTER_METAVARIABLE("particleCached(variable)", particleCached,
3877 "Returns value of given variable and caches this value in the ParticleExtraInfo of the provided particle.\n"
3878 "The result of second call to this variable on the same particle will be provided from the cache.", Manager::VariableDataType::c_double);
3879 REGISTER_METAVARIABLE("modulo(variable, n)", modulo,
3880 "Returns rest of division of variable by n.", Manager::VariableDataType::c_int);
3881 REGISTER_METAVARIABLE("abs(variable)", abs,
3882 "Returns absolute value of the given variable.\n"
3883 "E.g. abs(mcPDG) returns the absolute value of the mcPDG, which is often useful for cuts.", Manager::VariableDataType::c_double);
3884 REGISTER_METAVARIABLE("max(var1,var2)", max, "Returns max value of two variables.\n", Manager::VariableDataType::c_double);
3885 REGISTER_METAVARIABLE("min(var1,var2)", min, "Returns min value of two variables.\n", Manager::VariableDataType::c_double);
3886 REGISTER_METAVARIABLE("sin(variable)", sin, "Returns sine value of the given variable.", Manager::VariableDataType::c_double);
3887 REGISTER_METAVARIABLE("asin(variable)", asin, "Returns arcsine of the given variable. The unit of the asin() is ``rad``", Manager::VariableDataType::c_double);
3888 REGISTER_METAVARIABLE("cos(variable)", cos, "Returns cosine value of the given variable.", Manager::VariableDataType::c_double);
3889 REGISTER_METAVARIABLE("acos(variable)", acos, "Returns arccosine value of the given variable. The unit of the acos() is ``rad``", Manager::VariableDataType::c_double);
3890 REGISTER_METAVARIABLE("tan(variable)", tan, "Returns tangent value of the given variable.", Manager::VariableDataType::c_double);
3891 REGISTER_METAVARIABLE("atan(variable)", atan, "Returns arctangent value of the given variable. The unit of the atan() is ``rad``", Manager::VariableDataType::c_double);
3892 REGISTER_METAVARIABLE("exp(variable)", exp, "Returns exponential evaluated for the given variable.", Manager::VariableDataType::c_double);
3893 REGISTER_METAVARIABLE("log(variable)", log, "Returns natural logarithm evaluated for the given variable.", Manager::VariableDataType::c_double);
3894 REGISTER_METAVARIABLE("log10(variable)", log10, "Returns base-10 logarithm evaluated for the given variable.", Manager::VariableDataType::c_double);
3895 REGISTER_METAVARIABLE("int(variable, nan_replacement)", convertToInt, R"DOC(
3896 Casts the output of the variable to an integer value.
3897
3898 .. note::
3899 Overflow and underflow are clipped at maximum and minimum values, respectively. NaN values are replaced with the value of the 2nd argument.
3900
3901 )DOC", Manager::VariableDataType::c_int);
3902 REGISTER_METAVARIABLE("isNAN(variable)", isNAN,
3903 "Returns true if variable value evaluates to nan (determined via std::isnan(double)).\n"
3904 "Useful for debugging.", Manager::VariableDataType::c_bool);
3905 REGISTER_METAVARIABLE("ifNANgiveX(variable, x)", ifNANgiveX,
3906 "Returns x (has to be a number) if variable value is nan (determined via std::isnan(double)).\n"
3907 "Useful for technical purposes while training MVAs.", Manager::VariableDataType::c_double);
3908 REGISTER_METAVARIABLE("isInfinity(variable)", isInfinity,
3909 "Returns true if variable value evaluates to infinity (determined via std::isinf(double)).\n"
3910 "Useful for debugging.", Manager::VariableDataType::c_bool);
3911 REGISTER_METAVARIABLE("unmask(variable, flag1, flag2, ...)", unmask,
3912 "unmask(variable, flag1, flag2, ...) or unmask(variable, mask) sets certain bits in the variable to zero.\n"
3913 "For example, if you want to set the second, fourth and fifth bits to zero, you could call \n"
3914 "``unmask(variable, 2, 8, 16)`` or ``unmask(variable, 26)``.\n"
3915 "", Manager::VariableDataType::c_double);
3916 REGISTER_METAVARIABLE("conditionalVariableSelector(cut, variableIfTrue, variableIfFalse)", conditionalVariableSelector,
3917 "Returns one of the two supplied variables, depending on whether the particle passes the supplied cut.\n"
3918 "The first variable is returned if the particle passes the cut, and the second variable is returned otherwise.", Manager::VariableDataType::c_double);
3919 REGISTER_METAVARIABLE("pValueCombination(p1, p2, ...)", pValueCombination,
3920 "Returns the combined p-value of the provided p-values according to the formula given in `Nucl. Instr. and Meth. A 411 (1998) 449 <https://doi.org/10.1016/S0168-9002(98)00293-9>`_ .\n"
3921 "If any of the p-values is invalid, i.e. smaller than zero, -1 is returned.", Manager::VariableDataType::c_double);
3922 REGISTER_METAVARIABLE("pValueCombinationOfDaughters(variable)", pValueCombinationOfDaughters,
3923 "Returns the combined p-value of the daughter p-values according to the formula given in `Nucl. Instr. and Meth. A 411 (1998) 449 <https://doi.org/10.1016/S0168-9002(98)00293-9>`_ .\n"
3924 "If any of the p-values is invalid, i.e. smaller than zero, -1 is returned.", Manager::VariableDataType::c_double);
3925 REGISTER_METAVARIABLE("veto(particleList, cut, pdgCode = 11)", veto,
3926 "Combines current particle with particles from the given particle list and returns 1 if the combination passes the provided cut. \n"
3927 "For instance one can apply this function on a signal Photon and provide a list of all photons in the rest of event and a cut \n"
3928 "around the neutral Pion mass (e.g. ``0.130 < M < 0.140``). \n"
3929 "If a combination of the signal Photon with a ROE photon fits this criteria, hence looks like a neutral pion, the veto-Metavariable will return 1", Manager::VariableDataType::c_bool);
3930 REGISTER_METAVARIABLE("matchedMC(variable)", matchedMC,
3931 "Returns variable output for the matched MCParticle by constructing a temporary Particle from it.\n"
3932 "This may not work too well if your variable requires accessing daughters of the particle.\n"
3933 "E.g. ``matchedMC(p)`` returns the total momentum of the related MCParticle.\n"
3934 "Returns NaN if no matched MCParticle exists.", Manager::VariableDataType::c_double);
3935 REGISTER_METAVARIABLE("clusterBestMatchedMCParticle(variable)", clusterBestMatchedMCParticle,
3936 "Returns variable output for the MCParticle that is best-matched with the ECLCluster of the given Particle.\n"
3937 "E.g. To get the energy of the MCParticle that matches best with an ECLCluster, one could use ``clusterBestMatchedMCParticle(E)``\n"
3938 "When the variable is called for ``gamma`` and if the ``gamma`` is matched with MCParticle, it works same as `matchedMC`.\n"
3939 "If the variable is called for ``gamma`` that fails to match with an MCParticle, it provides the mdst-level MCMatching information abouth the ECLCluster.\n"
3940 "Returns NaN if the particle is not matched to an ECLCluster, or if the ECLCluster has no matching MCParticles", Manager::VariableDataType::c_double);
3941 REGISTER_METAVARIABLE("varForBestMatchedMCKlong(variable)", clusterBestMatchedMCKlong,
3942 "Returns variable output for the Klong MCParticle which has the best match with the ECLCluster of the given Particle.\n"
3943 "Returns NaN if the particle is not matched to an ECLCluster, or if the ECLCluster has no matching Klong MCParticle", Manager::VariableDataType::c_double);
3944
3945 REGISTER_METAVARIABLE("countInList(particleList, cut='')", countInList, "[Eventbased] "
3946 "Returns number of particle which pass given in cut in the specified particle list.\n"
3947 "Useful for creating statistics about the number of particles in a list.\n"
3948 "E.g. ``countInList(e+, isSignal == 1)`` returns the number of correctly reconstructed electrons in the event.\n"
3949 "The variable is event-based and does not need a valid particle pointer as input.", Manager::VariableDataType::c_int);
3950 REGISTER_METAVARIABLE("getVariableByRank(particleList, rankedVariableName, variableName, rank)", getVariableByRank, R"DOC(
3951 [Eventbased] Returns the value of ``variableName`` for the candidate in the ``particleList`` with the requested ``rank``.
3952
3953 .. note::
3954 The `BestCandidateSelection` module available via `rankByHighest` / `rankByLowest` has to be used before.
3955
3956 .. warning::
3957 The first candidate matching the given rank is used.
3958 Thus, it is not recommended to use this variable in conjunction with ``allowMultiRank`` in the `BestCandidateSelection` module.
3959
3960 The suffix ``_rank`` is automatically added to the argument ``rankedVariableName``,
3961 which either has to be the name of the variable used to order the candidates or the selected outputVariable name without the ending ``_rank``.
3962 This means that your selected name for the rank variable has to end with ``_rank``.
3963
3964 An example of this variable's usage is given in the tutorial `B2A602-BestCandidateSelection <https://gitlab.desy.de/belle2/software/basf2/-/tree/main/analysis/examples/tutorials/B2A602-BestCandidateSelection.py>`_
3965 )DOC", Manager::VariableDataType::c_double);
3966 REGISTER_VARIABLE("matchedMCHasPDG(PDGCode)", matchedMCHasPDG,
3967 "Returns if the absolute value of the PDGCode of the MCParticle related to the Particle matches a given PDGCode."
3968 "Returns 0/NAN/1 if PDGCode does not match/is not available/ matches");
3969 REGISTER_METAVARIABLE("numberOfNonOverlappingParticles(pList1, pList2, ...)", numberOfNonOverlappingParticles,
3970 "Returns the number of non-overlapping particles in the given particle lists"
3971 "Useful to check if there is additional physics going on in the detector if one reconstructed the Y4S", Manager::VariableDataType::c_int);
3972 REGISTER_METAVARIABLE("totalEnergyOfParticlesInList(particleListName)", totalEnergyOfParticlesInList,
3973 "[Eventbased] Returns the total energy of particles in the given particle List. The unit of the energy is ``GeV``", Manager::VariableDataType::c_double);
3974 REGISTER_METAVARIABLE("totalPxOfParticlesInList(particleListName)", totalPxOfParticlesInList,
3975 "[Eventbased] Returns the total momentum Px of particles in the given particle List. The unit of the momentum is ``GeV/c``", Manager::VariableDataType::c_double);
3976 REGISTER_METAVARIABLE("totalPyOfParticlesInList(particleListName)", totalPyOfParticlesInList,
3977 "[Eventbased] Returns the total momentum Py of particles in the given particle List. The unit of the momentum is ``GeV/c``", Manager::VariableDataType::c_double);
3978 REGISTER_METAVARIABLE("totalPzOfParticlesInList(particleListName)", totalPzOfParticlesInList,
3979 "[Eventbased] Returns the total momentum Pz of particles in the given particle List. The unit of the momentum is ``GeV/c``", Manager::VariableDataType::c_double);
3980 REGISTER_METAVARIABLE("invMassInLists(pList1, pList2, ...)", invMassInLists,
3981 "[Eventbased] Returns the invariant mass of the combination of particles in the given particle lists. The unit of the invariant mass is GeV/:math:`\\text{c}^2` ", Manager::VariableDataType::c_double);
3982 REGISTER_METAVARIABLE("totalECLEnergyOfParticlesInList(particleListName)", totalECLEnergyOfParticlesInList,
3983 "[Eventbased] Returns the total ECL energy of particles in the given particle List. The unit of the energy is ``GeV``", Manager::VariableDataType::c_double);
3984 REGISTER_METAVARIABLE("maxPtInList(particleListName)", maxPtInList,
3985 "[Eventbased] Returns maximum transverse momentum Pt in the given particle List. The unit of the transverse momentum is ``GeV/c``", Manager::VariableDataType::c_double);
3986 REGISTER_METAVARIABLE("eclClusterSpecialTrackMatched(cut)", eclClusterTrackMatchedWithCondition,
3987 "Returns if at least one Track that satisfies the given condition is related to the ECLCluster of the Particle.", Manager::VariableDataType::c_double);
3988 REGISTER_METAVARIABLE("averageValueInList(particleListName, variable)", averageValueInList,
3989 "[Eventbased] Returns the arithmetic mean of the given variable of the particles in the given particle list.", Manager::VariableDataType::c_double);
3990 REGISTER_METAVARIABLE("medianValueInList(particleListName, variable)", medianValueInList,
3991 "[Eventbased] Returns the median value of the given variable of the particles in the given particle list.", Manager::VariableDataType::c_double);
3992 REGISTER_METAVARIABLE("sumValueInList(particleListName, variable)", sumValueInList,
3993 "[Eventbased] Returns the sum of the given variable of the particles in the given particle list.", Manager::VariableDataType::c_double);
3994 REGISTER_METAVARIABLE("productValueInList(particleListName, variable)", productValueInList,
3995 "[Eventbased] Returns the product of the given variable of the particles in the given particle list.", Manager::VariableDataType::c_double);
3996 REGISTER_METAVARIABLE("angleToClosestInList(particleListName)", angleToClosestInList,
3997 "Returns the angle between this particle and the closest particle (smallest opening angle) in the list provided. The unit of the angle is ``rad`` ", Manager::VariableDataType::c_double);
3998 REGISTER_METAVARIABLE("closestInList(particleListName, variable)", closestInList,
3999 "Returns `variable` for the closest particle (smallest opening angle) in the list provided.", Manager::VariableDataType::c_double);
4000 REGISTER_METAVARIABLE("angleToMostB2BInList(particleListName)", angleToMostB2BInList,
4001 "Returns the angle between this particle and the most back-to-back particle (closest opening angle to 180) in the list provided. The unit of the angle is ``rad`` ", Manager::VariableDataType::c_double);
4002 REGISTER_METAVARIABLE("deltaPhiToMostB2BPhiInList(particleListName)", deltaPhiToMostB2BPhiInList,
4003 "Returns the abs(delta phi) between this particle and the most back-to-back particle in phi (closest opening angle to 180) in the list provided. The unit of the angle is ``rad`` ", Manager::VariableDataType::c_double);
4004 REGISTER_METAVARIABLE("mostB2BInList(particleListName, variable)", mostB2BInList,
4005 "Returns `variable` for the most back-to-back particle (closest opening angle to 180) in the list provided.", Manager::VariableDataType::c_double);
4006 REGISTER_METAVARIABLE("maxOpeningAngleInList(particleListName)", maxOpeningAngleInList,
4007 "[Eventbased] Returns maximum opening angle in the given particle List. The unit of the angle is ``rad`` ", Manager::VariableDataType::c_double);
4008 REGISTER_METAVARIABLE("daughterCombination(variable, daughterIndex_1, daughterIndex_2 ... daughterIndex_n)", daughterCombination,R"DOC(
4009Returns a ``variable`` function only of the 4-momentum calculated on an arbitrary set of (grand)daughters.
4010
4011.. warning::
4012 ``variable`` can only be a function of the daughters' 4-momenta.
4013
4014Daughters from different generations of the decay tree can be combined using generalized daughter indexes, which are simply colon-separated
4015the list of daughter indexes, starting from the root particle: for example, ``0:1:3`` identifies the fourth
4016daughter (3) of the second daughter (1) of the first daughter (0) of the mother particle.
4017
4018.. tip::
4019 ``daughterCombination(M, 0, 3, 4)`` will return the invariant mass of the system made of the first, fourth and fifth daughter of particle.
4020 ``daughterCombination(M, 0:0, 3:0)`` will return the invariant mass of the system made of the first daughter of the first daughter and the first daughter of the fourth daughter.
4021
4022)DOC", Manager::VariableDataType::c_double);
4023 REGISTER_METAVARIABLE("useAlternativeDaughterHypothesis(variable, daughterIndex_1:newMassHyp_1, ..., daughterIndex_n:newMassHyp_n)", useAlternativeDaughterHypothesis,R"DOC(
4024Returns a ``variable`` calculated using new mass hypotheses for (some of) the particle's daughters.
4025
4026.. warning::
4027 ``variable`` can only be a function of the particle 4-momentum, which is re-calculated as the sum of the daughters' 4-momenta, and the daughters' 4-momentum.
4028 This means that if you made a kinematic fit without updating the daughters' momenta, the result of this variable will not reflect the effect of the kinematic fit.
4029 Also, the track fit is not performed again: the variable only re-calculates the 4-vectors using different mass assumptions.
4030 In the variable, a copy of the given particle is created with daughters' alternative mass assumption (i.e. the original particle and daughters are not changed).
4031
4032.. warning::
4033 Generalized daughter indexes are not supported (yet!): this variable can be used only on first-generation daughters.
4034
4035.. tip::
4036 ``useAlternativeDaughterHypothesis(M, 0:K+, 2:pi-)`` will return the invariant mass of the particle assuming that the first daughter is a kaon and the third is a pion, instead of whatever was used in reconstructing the decay.
4037 ``useAlternativeDaughterHypothesis(mRecoil, 1:p+)`` will return the recoil mass of the particle assuming that the second daughter is a proton instead of whatever was used in reconstructing the decay.
4038
4039)DOC", Manager::VariableDataType::c_double);
4040 REGISTER_METAVARIABLE("varForFirstMCAncestorOfType(type, variable)",varForFirstMCAncestorOfType,R"DOC(Returns requested variable of the first ancestor of the given type.
4041Ancestor type can be set up by PDG code or by particle name (check evt.pdl for valid particle names))DOC", Manager::VariableDataType::c_double);
4042
4043 REGISTER_METAVARIABLE("nTrackFitResults(particleType)", nTrackFitResults,
4044 "[Eventbased] Returns the total number of TrackFitResults for a given particleType. The argument can be the name of particle (e.g. pi+) or PDG code (e.g. 211).",
4045 Manager::VariableDataType::c_int);
4046
4047 REGISTER_METAVARIABLE("convertToDaughterIndex(variable)", convertToDaughterIndex, R"DOC(Converts the variable of the given particle into integer and returns it if it is a valid daughter index, else returns -1.)DOC", Manager::VariableDataType::c_int);
4048
4049 }
4051}
int getPDGCode() const
PDG code.
Definition Const.h:473
static const ChargedStable pion
charged pion particle
Definition Const.h:661
static const double doubleNaN
quiet_NaN
Definition Const.h:703
static const ChargedStable electron
electron particle
Definition Const.h:659
EHypothesisBit
The hypothesis bits for this ECLCluster (Connected region (CR) is split using this hypothesis.
Definition ECLCluster.h:31
@ c_nPhotons
CR is split into n photons (N1)
Definition ECLCluster.h:41
static std::unique_ptr< GeneralCut > compile(const std::string &cut)
Definition GeneralCut.h:84
@ c_Initial
bit 5: Particle is initial such as e+ or e- and not going to Geant4
Definition MCParticle.h:57
@ c_PrimaryParticle
bit 0: Particle is primary particle.
Definition MCParticle.h:47
@ c_IsVirtual
bit 4: Particle is virtual and not going to Geant4.
Definition MCParticle.h:55
static std::string makeROOTCompatible(std::string str)
Remove special characters that ROOT dislikes in branch names, e.g.
EParticleSourceObject
particle source enumerators
Definition Particle.h:83
@ c_Flavored
Is either particle or antiparticle.
Definition Particle.h:98
static const ReferenceFrame & GetCurrent()
Get current rest frame.
std::function< VarVariant(const Particle *)> FunctionPtr
functions stored take a const Particle* and return VarVariant.
Definition Manager.h:112
const Var * getVariable(std::string name)
Get the variable belonging to the given key.
Definition Manager.cc:58
std::variant< double, int, bool > VarVariant
NOTE: the python interface is documented manually in analysis/doc/Variables.rst (because we use ROOT ...
Definition Manager.h:110
static Manager & Instance()
get singleton instance.
Definition Manager.cc:26
#define MAKE_DEPRECATED(name, make_fatal, version, description)
Registers a variable as deprecated.
Definition Manager.h:456
T convertString(const std::string &str)
Converts a string to type T (one of float, double, long double, int, long int, unsigned long int).
bool hasAntiParticle(int pdgCode)
Checks if the particle with given pdg code has an anti-particle or not.
Definition EvtPDLUtil.cc:12
Particle * copyParticle(const Particle *original)
Function takes argument Particle and creates a copy of it and copies of all its (grand-)^n-daughters.
Abstract base class for different kinds of events.