9 #include <analysis/modules/VariablesToNtuple/VariablesToNtupleModule.h>
12 #include <analysis/dataobjects/ParticleList.h>
13 #include <analysis/VariableManager/Manager.h>
14 #include <analysis/VariableManager/Utility.h>
15 #include <analysis/dataobjects/StringWrapper.h>
18 #include <framework/logging/Logger.h>
19 #include <framework/pcore/ProcHandler.h>
20 #include <framework/core/ModuleParam.templateDetails.h>
23 #include <framework/utilities/MakeROOTCompatible.h>
24 #include <framework/utilities/RootFileCreationManager.h>
35 VariablesToNtupleModule::VariablesToNtupleModule() :
39 setDescription(
"Calculate variables specified by the user for a given ParticleList and save them into a TNtuple. The TNtuple is candidate-based, meaning that the variables of each candidate are saved into separate rows.");
42 vector<string> emptylist;
44 "Name of particle list with reconstructed particles. If no list is provided the variables are saved once per event (only possible for event-type variables)",
47 "List of variables (or collections) to save. Variables are taken from Variable::Manager, and are identical to those available to e.g. ParticleSelector.",
50 addParam(
"fileName",
m_fileName,
"Name of ROOT file for output.",
string(
"VariablesToNtuple.root"));
51 addParam(
"treeName",
m_treeName,
"Name of the NTuple in the saved file.",
string(
"ntuple"));
54 std::tuple<std::string, std::map<int, unsigned int>> default_sampling{
"", {}};
56 "Tuple of variable name and a map of integer values and inverse sampling rate. E.g. (signal, {1: 0, 0:10}) selects all signal candidates and every 10th background candidate.",
60 "Name of signal-side particle list to store the index of the signal-side particle when one calls the module in a for_each loop over the RestOfEvent",
73 B2FATAL(
"Output root file name is not set. Please set a valid root output file name (\"fileName\" module parameter).");
79 B2ERROR(
"Could not create file \"" <<
m_fileName <<
80 "\". Please set a valid root output file name (\"fileName\" module parameter).");
84 TDirectory::TContext directoryGuard(
m_file.get());
89 <<
"\" already exists in the file \"" <<
m_fileName <<
"\"\n"
90 <<
"\nYou probably want to either set the output fileName or the treeName to something else:\n\n"
91 <<
" from modularAnalysis import variablesToNtuple\n"
92 <<
" variablesToNtuple('pi+:all', ['p'], treename='pions', filename='variablesToNtuple.root')\n"
93 <<
" variablesToNtuple('gamma:all', ['p'], treename='photons', filename='variablesToNtuple.root') # two trees, same file\n"
95 <<
" from modularAnalysis import variablesToNtuple\n"
96 <<
" variablesToNtuple('pi+:all', ['p'], filename='pions.root')\n"
97 <<
" variablesToNtuple('gamma:all', ['p'], filename='photons.root') # two files\n"
105 m_tree->get().SetCacheSize(100000);
109 m_tree->get().Branch(
"__run__", &
m_run,
"__run__/I");
121 if (not
m_roe.isOptional(
"RestOfEvent")) {
122 B2WARNING(
"The signalSideParticleList is set outside of a for_each loop over the RestOfEvent. "
123 <<
"__signalSideCandidates__ and __nSignalSideCandidate__ will be always -1 and 0, respectively.");
131 if (Variable::isCounterVariable(variable)) {
132 B2WARNING(
"The counter '" << variable
133 <<
"' is handled automatically by VariablesToNtuple, you don't need to add it.");
139 unordered_set<string> seen;
141 if (seen.find(varStr) != std::end(seen)) return true;
150 size_t enumerate = 1;
160 B2ERROR(
"Variable '" << varStr <<
"' is not available in Variable::Manager!");
162 if (
m_particleList.empty() && var->description.find(
"[Eventbased]") == string::npos) {
163 B2ERROR(
"Variable '" << varStr <<
"' is not an event-based variable, "
164 "but you are using VariablesToNtuple without a decay string, i.e. in the event-wise mode.\n"
165 "If you have created an event-based alias you can wrap your alias with `eventCached` to "
166 "declare it as event based, which avoids this error.\n\n"
167 "vm.addAlias('myAliasName', 'eventCached(myAlias)')");
170 if (var->variabletype == Variable::Manager::VariableDataType::c_double) {
172 }
else if (var->variabletype == Variable::Manager::VariableDataType::c_int) {
174 }
else if (var->variabletype == Variable::Manager::VariableDataType::c_bool) {
177 m_functions.push_back(std::make_pair(var->function, var->variabletype));
189 B2FATAL(
"Couldn't find sample variable " <<
m_sampling_name <<
" via the Variable::Manager. Check the name!");
237 if (
m_roe.isValid()) {
251 for (
unsigned int iVar = 0; iVar <
m_variables.size(); iVar++) {
252 auto var_result = std::get<0>(
m_functions[iVar])(
nullptr);
254 if (std::holds_alternative<double>(var_result)) {
255 if (var_type != Variable::Manager::VariableDataType::c_double)
256 B2WARNING(
"Wrong registered data type for variable '" +
m_variables[iVar] +
257 "'. Expected Variable::Manager::VariableDataType::c_double. Exported data for this variable might be incorrect.");
259 }
else if (std::holds_alternative<int>(var_result)) {
260 if (var_type != Variable::Manager::VariableDataType::c_int)
261 B2WARNING(
"Wrong registered data type for variable '" +
m_variables[iVar] +
262 "'. Expected Variable::Manager::VariableDataType::c_int. Exported data for this variable might be incorrect.");
264 }
else if (std::holds_alternative<bool>(var_result)) {
265 if (var_type != Variable::Manager::VariableDataType::c_bool)
266 B2WARNING(
"Wrong registered data type for variable '" +
m_variables[iVar] +
267 "'. Expected Variable::Manager::VariableDataType::c_bool. Exported data for this variable might be incorrect.");
277 for (
unsigned int iPart = 0; iPart <
m_ncandidates; iPart++) {
279 const Particle* particle = particlelist->getParticle(iPart);
282 for (
unsigned int iVar = 0; iVar <
m_variables.size(); iVar++) {
283 auto var_result = std::get<0>(
m_functions[iVar])(particle);
285 if (std::holds_alternative<double>(var_result)) {
286 if (var_type != Variable::Manager::VariableDataType::c_double)
287 B2WARNING(
"Wrong registered data type for variable '" +
m_variables[iVar] +
288 "'. Expected Variable::Manager::VariableDataType::c_double. Exported data for this variable might be incorrect.");
290 }
else if (std::holds_alternative<int>(var_result)) {
291 if (var_type != Variable::Manager::VariableDataType::c_int)
292 B2WARNING(
"Wrong registered data type for variable '" +
m_variables[iVar] +
293 "'. Expected Variable::Manager::VariableDataType::c_int. Exported data for this variable might be incorrect.");
295 }
else if (std::holds_alternative<bool>(var_result)) {
296 if (var_type != Variable::Manager::VariableDataType::c_bool)
297 B2WARNING(
"Wrong registered data type for variable '" +
m_variables[iVar] +
298 "'. Expected Variable::Manager::VariableDataType::c_bool. Exported data for this variable might be incorrect.");
312 TDirectory::TContext directoryGuard(
m_file.get());
315 const bool writeError =
m_file->TestBit(TFile::kWriteError);
318 B2FATAL(
"A write error occurred while saving '" <<
m_fileName <<
"', please check if enough disk space is available.");
In the store you can park objects that have to be accessed by various modules.
@ c_DontWriteOut
Object/array should be NOT saved by output modules.
static std::string makeROOTCompatible(std::string str)
Remove special characters that ROOT dislikes in branch names, e.g.
void setDescription(const std::string &description)
Sets the description of the module.
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Class to store reconstructed particles.
static bool isOutputProcess()
Return true if the process is an output process.
static bool parallelProcessingUsed()
Returns true if multiple processes have been spawned, false in single-core mode.
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
Type-safe access to single objects in the data store.
std::vector< std::string > resolveCollections(const std::vector< std::string > &variables)
Resolve Collection Returns variable names corresponding to the given collection or if it is not a col...
const Var * getVariable(std::string name)
Get the variable belonging to the given key.
static Manager & Instance()
get singleton instance.
void checkDeprecatedVariable(const std::string &name)
Check if a variable is deprecated.
StoreObjPtr< RestOfEvent > m_roe
ROE object.
std::vector< std::string > m_variables
List of variables to save.
virtual void initialize() override
Initialises the module.
std::map< int, unsigned int > m_sampling_rates
Inverse sampling rates.
virtual void event() override
Method called for each event.
unsigned int m_ncandidates
total n candidates
virtual void terminate() override
Write TTree to file, and close file if necessary.
StoreObjPtr< EventMetaData > m_eventMetaData
the event information
std::map< int, unsigned long int > m_sampling_counts
Current number of samples with this value.
std::string m_fileName
Name of ROOT file for output.
std::vector< std::pair< Variable::Manager::FunctionPtr, Variable::Manager::VariableDataType > > m_functions
List of pairs of function pointers and respective data type corresponding to given variables.
std::tuple< std::string, std::map< int, unsigned int > > m_sampling
Tuple of variable name and a map of integer values and inverse sampling rate.
std::vector< int > m_branchAddressesInt
Branch addresses of variables of type int (or bool)
int m_basketsize
Size of TBaskets in the output ROOT file in bytes.
int m_production
production ID (to distinguish MC samples)
unsigned int m_nSignalSideCandidates
total n signal-side candidates
StoreObjPtr< StringWrapper > m_stringWrapper
string wrapper storing the MCDecayString
int m_experiment
experiment number
std::string m_particleList
Name of particle list with reconstructed particles.
StoreObjPtr< RootMergeable< TTree > > m_tree
The ROOT TNtuple for output.
std::shared_ptr< TFile > m_file
ROOT file for output.
std::vector< double > m_branchAddressesDouble
Branch addresses of variables of type double.
std::string m_sampling_name
Variable name of sampling variable.
float getInverseSamplingRateWeight(const Particle *particle)
Calculate inverse sampling rate weight.
std::string m_treeName
Name of the TTree.
std::string m_signalSideParticleList
Name of signal-side particle list
const Variable::Manager::Var * m_sampling_variable
Variable Pointer to target variable.
int m_signalSideCandidate
signal-side candidate counter
int m_candidate
candidate counter
std::string m_MCDecayString
MC decay string to be filled.
void addParam(const std::string &name, T ¶mVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
std::shared_ptr< TFile > getFile(std::string, bool ignoreErrors=false)
Get a file with a specific name, if is does not exist it will be created.
static RootFileCreationManager & getInstance()
Interface for the FileManager.
#define REG_MODULE(moduleName)
Register the given module (without 'Module' suffix) with the framework.
Abstract base class for different kinds of events.
VariableDataType variabletype
data type of variable
A variable returning a floating-point value for a given Particle.
FunctionPtr function
Pointer to function.