Belle II Software  light-2212-foldex
KlongDecayReconstructorExpertModule.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 include
10 #include <analysis/modules/KlongDecayReconstructor/KlongDecayReconstructorExpertModule.h>
11 
12 // framework aux
13 #include <framework/logging/Logger.h>
14 
15 // decay descriptor
16 #include <analysis/DecayDescriptor/DecayDescriptorParticle.h>
17 
18 // utilities
19 #include <analysis/DecayDescriptor/ParticleListName.h>
20 
21 #include <Math/Vector4D.h>
22 
23 #include <memory>
24 
25 using namespace std;
26 using namespace Belle2;
27 
28 //-----------------------------------------------------------------
29 // Register module
30 //-----------------------------------------------------------------
31 
32 REG_MODULE(KlongDecayReconstructorExpert);
33 
34 //-----------------------------------------------------------------
35 // Implementation
36 //-----------------------------------------------------------------
37 
38 KlongDecayReconstructorExpertModule::KlongDecayReconstructorExpertModule() :
39  Module(), m_pdgCode(0), m_isSelfConjugatedParticle(false)
40 
41 {
42  // set module description (e.g. insert text)
43  setDescription("This module is used to employ kinematic constraints to determine the momentum of Klongs for two body B decays containing a K_L0 and something else. The module creates a list of K_L0 candidates whose K_L0 momentum is reconstructed by combining the reconstructed direction (from either the ECL or KLM) of the K_L0 and kinematic constraints of the initial state.");
45 
46  // Add parameters
47  addParam("decayString", m_decayString,
48  "Input DecayDescriptor string.");
49  addParam("cut", m_cutParameter, "Selection criteria to be applied", std::string(""));
50  addParam("maximumNumberOfCandidates", m_maximumNumberOfCandidates,
51  "Don't reconstruct channel if more candidates than given are produced.", -1);
52  addParam("decayMode", m_decayModeID, "User-specified decay mode identifier (saved in 'decayModeID' extra-info for each Particle)",
53  0);
54  addParam("writeOut", m_writeOut,
55  "If true, the output ParticleList will be saved by RootOutput. If false, it will be ignored when writing the file.", false);
56  addParam("recoList", m_recoList,
57  "Suffix attached to the original K_L input list to identify the output list of the FindKlongMomentum module; this is the input for this module, if not defined it is set to '_reco' \n",
58  std::string("_reco"));
59 
60 }
61 
63 {
64  m_particles.isRequired();
65 
66  // clear everything, initialize private members
67  m_listName = "";
68  m_generator = nullptr;
69 
70  // obtain the input and output particle lists from the decay string
71  bool valid = m_decaydescriptor.init(m_decayString);
72  if (!valid)
73  B2ERROR("Invalid input DecayString: " << m_decayString);
74 
75  // Mother particle
77 
78  m_pdgCode = mother->getPDGCode();
79  m_listName = mother->getFullName();
80 
83 
84  std::string newDecayString;
85  std::string kListName;
86  newDecayString = m_listName + " -> ";
87 
88  // Daughters
89  bool k_check = false;
90  int nProducts = m_decaydescriptor.getNDaughters();
91  for (int i = 0; i < nProducts; ++i) {
93  if (daughter->getPDGCode() == Const::Klong.getPDGCode()) {
94  if (k_check)
95  B2FATAL("More than one K_L is detected! This module accepts only one K_L in the final state.");
96 
97  StoreObjPtr<ParticleList>().isRequired(daughter->getFullName() + m_recoList);
98  kListName = daughter->getFullName() + m_recoList;
99  k_check = true;
100  } else {
101  StoreObjPtr<ParticleList>().isRequired(daughter->getFullName());
102  newDecayString = newDecayString + daughter->getFullName() + " ";
103  }
104  }
105 
106  if (!k_check)
107  B2FATAL("This module is meant to reconstruct decays with a K_L0 in the final state. There is no K_L0 in this decay!");
108 
109  newDecayString = newDecayString + kListName;
110 
111  m_generator = std::make_unique<ParticleGenerator>(newDecayString, m_cutParameter);
112 
114  m_outputList.registerInDataStore(m_listName, flags);
116  m_outputAntiList.registerInDataStore(m_antiListName, flags);
117  }
118 
120 
121 }
122 
124 {
125  m_outputList.create();
126  m_outputList->initialize(m_pdgCode, m_listName);
127 
129  m_outputAntiList.create();
130  m_outputAntiList->initialize(-1 * m_pdgCode, m_antiListName);
131 
132  m_outputList->bindAntiParticleList(*(m_outputAntiList));
133  }
134 
135  m_generator->init();
136 
137  int numberOfCandidates = 0;
138  while (m_generator->loadNext()) {
139 
140  Particle particle = m_generator->getCurrentParticle();
141 
142  bool is_physical = true;
143 
144  const std::vector<Particle*> daughters = particle.getDaughters();
145 
146  if (daughters.size() < 2)
147  B2FATAL("Reconstructing particle as a daughter of a decay with less than 2 daughters!");
148 
149  if (daughters.size() > 3)
150  B2FATAL("Higher multiplicity (>2) missing momentum decays not implemented yet!");
151 
152  int e_check = 0;
153  ROOT::Math::PxPyPzEVector pDaughters;
154  for (auto daughter : daughters) {
155  if (daughter->getPDGCode() != Const::Klong.getPDGCode()) {
156  pDaughters += daughter->get4Vector();
157  e_check = daughter->getArrayIndex() + e_check * 100;
158  }
159  }
160 
161 
162  ROOT::Math::PxPyPzEVector klDaughters;
163  for (auto daughter : daughters) {
164  if (daughter->getPDGCode() == Const::Klong.getPDGCode()) {
165  klDaughters += daughter->get4Vector();
166  if (e_check != daughter->getExtraInfo("permID")) {
167  is_physical = false;
168  }
169  }
170  }
171  double m_b = particle.getPDGMass();
172 
173  ROOT::Math::PxPyPzEVector mom = pDaughters + klDaughters;
174  mom.SetE(TMath::Sqrt(mom.P2() + m_b * m_b));
175  if ((!isnan(mom.P())) && is_physical)
176  particle.set4Vector(mom);
177  if (isnan(mom.P()))
178  is_physical = false;
179 
180  if (!m_cut->check(&particle))
181  continue;
182 
183  if (!is_physical)
184  continue;
185 
186  numberOfCandidates++;
187 
188  if (m_maximumNumberOfCandidates > 0 and numberOfCandidates > m_maximumNumberOfCandidates) {
189  m_outputList->clear();
190  break;
191  }
192 
193  Particle* newParticle = m_particles.appendNew(particle);
194 
195  m_outputList->addParticle(newParticle);
196  newParticle->addExtraInfo("decayModeID", m_decayModeID);
197 
198  } //while
199 
200 } //event
int getPDGCode() const
PDG code.
Definition: Const.h:464
static const ParticleType Klong
K^0_L particle.
Definition: Const.h:668
EStoreFlags
Flags describing behaviours of objects etc.
Definition: DataStore.h:69
@ c_WriteOut
Object/array should be saved by output modules.
Definition: DataStore.h:70
@ c_DontWriteOut
Object/array should be NOT saved by output modules.
Definition: DataStore.h:71
Represents a particle in the DecayDescriptor.
int getPDGCode() const
Return PDG code.
std::string getFullName() const
returns the full name of the particle full_name = name:label
bool init(const std::string &str)
Initialise the DecayDescriptor from given string.
const DecayDescriptorParticle * getMother() const
return mother.
int getNDaughters() const
return number of direct daughters.
const DecayDescriptor * getDaughter(int i) const
return i-th daughter (0 based index).
static std::unique_ptr< GeneralCut > compile(const std::string &cut)
Creates an instance of a cut and returns a unique_ptr to it, if you need a copy-able object instead y...
Definition: GeneralCut.h:84
bool m_isSelfConjugatedParticle
flag that indicates whether an anti-particle mother does not exist and should not be reconstructed as...
int m_maximumNumberOfCandidates
drop all candidates if more candidates than this parameter are produced
std::string m_antiListName
output anti-particle list name
virtual void initialize() override
Initialize the Module.
std::string m_decayString
Input DecayString specifying the decay being reconstructed.
StoreObjPtr< ParticleList > m_outputAntiList
output anti-particle list
StoreArray< Particle > m_particles
StoreArray of Particles.
std::string m_recoList
suffix for input K_L0 list name
StoreObjPtr< ParticleList > m_outputList
output particle list
std::unique_ptr< ParticleGenerator > m_generator
Generates the combinations.
std::unique_ptr< Variable::Cut > m_cut
cut object which performs the cuts
DecayDescriptor m_decaydescriptor
Decay descriptor of the decay being reconstructed.
int m_pdgCode
PDG code of the combined mother particle.
Base class for Modules.
Definition: Module.h:72
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
Class to store reconstructed particles.
Definition: Particle.h:74
std::vector< Belle2::Particle * > getDaughters() const
Returns a vector of pointers to daughter particles.
Definition: Particle.cc:669
double getPDGMass(void) const
Returns uncertainty on the invariant mass (requires valid momentum error matrix)
Definition: Particle.cc:636
void addExtraInfo(const std::string &name, double value)
Sets the user-defined data of given name to the given value.
Definition: Particle.cc:1363
void set4Vector(const ROOT::Math::PxPyPzEVector &p4)
Sets Lorentz vector.
Definition: Particle.h:286
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
Type-safe access to single objects in the data store.
Definition: StoreObjPtr.h:95
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560
#define REG_MODULE(moduleName)
Register the given module (without 'Module' suffix) with the framework.
Definition: Module.h:650
std::string antiParticleListName(const std::string &listName)
Returns name of anti-particle-list corresponding to listName.
Abstract base class for different kinds of events.
Definition: ClusterUtils.h:23