Belle II Software development
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 header.
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#include <TMath.h>
23
24#include <cmath>
25#include <memory>
26
27using namespace std;
28using namespace Belle2;
29
30//-----------------------------------------------------------------
31// Register module
32//-----------------------------------------------------------------
33
34REG_MODULE(KlongDecayReconstructorExpert);
35
36//-----------------------------------------------------------------
37// Implementation
38//-----------------------------------------------------------------
39
41 Module(), m_pdgCode(0), m_isSelfConjugatedParticle(false)
42
43{
44 // set module description (e.g. insert text)
45 setDescription(R"DOC(
46This module is used to employ kinematic constraints to determine the momentum
47of Klongs for two body B decays containing a K_L0 and something else. The
48module creates a list of K_L0 candidates whose K_L0 momentum is reconstructed
49by combining the reconstructed direction (from either the ECL or KLM) of the
50K_L0 and kinematic constraints of the initial state.
51 )DOC");
53
54 // Add parameters
55 addParam("decayString", m_decayString,
56 "Input DecayDescriptor string.");
57 addParam("cut", m_cutParameter, "Selection criteria to be applied", std::string(""));
58 addParam("maximumNumberOfCandidates", m_maximumNumberOfCandidates,
59 "Don't reconstruct channel if more candidates than given are produced.", 10000);
60 addParam("decayMode", m_decayModeID, "User-specified decay mode identifier (saved in 'decayModeID' extra-info for each Particle)",
61 0);
62 addParam("writeOut", m_writeOut,
63 "If true, the output ParticleList will be saved by RootOutput. If false, it will be ignored when writing the file.", false);
64 addParam("recoList", m_recoList,
65 "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",
66 std::string("_reco"));
67
68}
69
71{
73
74 // clear everything, initialize private members
75 m_listName = "";
76 m_generator = nullptr;
77
78 // obtain the input and output particle lists from the decay string
80 if (!valid)
81 B2ERROR("Invalid input DecayString: " << m_decayString);
82
83 // Mother particle
85
86 m_pdgCode = mother->getPDGCode();
87 m_listName = mother->getFullName();
88
91
92 std::string newDecayString;
93 std::string kListName;
94 newDecayString = m_listName + " -> ";
95
96 // Daughters
97 bool k_check = false;
98 int nProducts = m_decaydescriptor.getNDaughters();
99 for (int i = 0; i < nProducts; ++i) {
101 if (daughter->getPDGCode() == Const::Klong.getPDGCode()) {
102 if (k_check)
103 B2FATAL("More than one K_L is detected! This module accepts only one K_L in the final state.");
104
105 StoreObjPtr<ParticleList>().isRequired(daughter->getFullName() + m_recoList);
106 kListName = daughter->getFullName() + m_recoList;
107 k_check = true;
108 } else {
109 StoreObjPtr<ParticleList>().isRequired(daughter->getFullName());
110 newDecayString = newDecayString + daughter->getFullName() + " ";
111 }
112 }
113
114 if (!k_check)
115 B2FATAL("This module is meant to reconstruct decays with a K_L0 in the final state. There is no K_L0 in this decay!");
116
117 newDecayString = newDecayString + kListName;
118
119 m_generator = std::make_unique<ParticleGenerator>(newDecayString, m_cutParameter);
120
122 m_outputList.registerInDataStore(m_listName, flags);
124 m_outputAntiList.registerInDataStore(m_antiListName, flags);
125 }
126
128
129}
130
132{
133 m_outputList.create();
134 m_outputList->initialize(m_pdgCode, m_listName);
135
137 m_outputAntiList.create();
138 m_outputAntiList->initialize(-1 * m_pdgCode, m_antiListName);
139
140 m_outputList->bindAntiParticleList(*(m_outputAntiList));
141 }
142
143 m_generator->init();
144
145 int numberOfCandidates = 0;
146 while (m_generator->loadNext()) {
147
148 Particle particle = m_generator->getCurrentParticle();
149
150 bool is_physical = true;
151
152 const std::vector<Particle*> daughters = particle.getDaughters();
153
154 if (daughters.size() < 2)
155 B2FATAL("Reconstructing particle as a daughter of a decay with less than 2 daughters!");
156
157 if (daughters.size() > 3)
158 B2FATAL("Higher multiplicity (>2) missing momentum decays not implemented yet!");
159
160 int e_check = 0;
161 ROOT::Math::PxPyPzEVector pDaughters;
162 for (auto daughter : daughters) {
163 if (daughter->getPDGCode() != Const::Klong.getPDGCode()) {
164 pDaughters += daughter->get4Vector();
165 e_check = daughter->getArrayIndex() + e_check * 100;
166 }
167 }
168
169
170 ROOT::Math::PxPyPzEVector klDaughters;
171 for (auto daughter : daughters) {
172 if (daughter->getPDGCode() == Const::Klong.getPDGCode()) {
173 klDaughters += daughter->get4Vector();
174 if (e_check != daughter->getExtraInfo("permID")) {
175 is_physical = false;
176 }
177 }
178 }
179 double m_b = particle.getPDGMass();
180
181 ROOT::Math::PxPyPzEVector mom = pDaughters + klDaughters;
182 mom.SetE(TMath::Sqrt(mom.P2() + m_b * m_b));
183 if ((!std::isnan(mom.P())) && is_physical)
184 particle.set4Vector(mom);
185 if (std::isnan(mom.P()))
186 is_physical = false;
187
188 if (!m_cut->check(&particle))
189 continue;
190
191 if (!is_physical)
192 continue;
193
194 numberOfCandidates++;
195
196 if (m_maximumNumberOfCandidates > 0 and numberOfCandidates > m_maximumNumberOfCandidates) {
197 m_outputList->clear();
198 break;
199 }
200
201 Particle* newParticle = m_particles.appendNew(particle);
202
203 m_outputList->addParticle(newParticle);
204 newParticle->addExtraInfo("decayModeID", m_decayModeID);
205
206 } //while
207
208} //event
int getPDGCode() const
PDG code.
Definition: Const.h:473
static const ParticleType Klong
K^0_L particle.
Definition: Const.h:678
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 DecayDescriptor * getDaughter(int i) const
return i-th daughter (0 based index).
int getNDaughters() const
return number of direct daughters.
const DecayDescriptorParticle * getMother() const
return mother.
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:76
void addExtraInfo(const std::string &name, double value)
Sets the user-defined data of given name to the given value.
Definition: Particle.cc:1421
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
T * appendNew()
Construct a new T object at the end of the array.
Definition: StoreArray.h:246
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:559
#define REG_MODULE(moduleName)
Register the given module (without 'Module' suffix) with the framework.
Definition: Module.h:649
std::string antiParticleListName(const std::string &listName)
Returns name of anti-particle-list corresponding to listName.
Abstract base class for different kinds of events.
STL namespace.