![]() |
Belle II Software
light-2403-persian
|
Module to read TTree data from file into the data store. More...
#include <RootInputModule.h>
Classes | |
struct | ReadStats |
for collecting statistics over multiple files. More... | |
Public Types | |
enum | EModulePropFlags { c_Input = 1 , c_Output = 2 , c_ParallelProcessingCertified = 4 , c_HistogramManager = 8 , c_InternalSerializer = 16 , c_TerminateInAllProcesses = 32 , c_DontCollectStatistics = 64 } |
Each module can be tagged with property flags, which indicate certain features of the module. More... | |
typedef ModuleCondition::EAfterConditionPath | EAfterConditionPath |
Forward the EAfterConditionPath definition from the ModuleCondition. | |
Public Member Functions | |
RootInputModule () | |
Constructor. | |
virtual | ~RootInputModule () |
Destructor. | |
virtual void | initialize () override |
Initialize the Module. | |
virtual void | event () override |
Running over all events. | |
virtual void | terminate () override |
Is called at the end of your Module. | |
virtual std::vector< std::string > | getFileNames (bool outputFiles=false) override |
Get list of input files, taking -i command line overrides into account. | |
virtual void | beginRun () |
Called when entering a new run. More... | |
virtual void | endRun () |
This method is called if the current run ends. More... | |
const std::string & | getName () const |
Returns the name of the module. More... | |
const std::string & | getType () const |
Returns the type of the module (i.e. More... | |
const std::string & | getPackage () const |
Returns the package this module is in. | |
const std::string & | getDescription () const |
Returns the description of the module. | |
void | setName (const std::string &name) |
Set the name of the module. More... | |
void | setPropertyFlags (unsigned int propertyFlags) |
Sets the flags for the module properties. More... | |
LogConfig & | getLogConfig () |
Returns the log system configuration. | |
void | setLogConfig (const LogConfig &logConfig) |
Set the log system configuration. | |
void | setLogLevel (int logLevel) |
Configure the log level. | |
void | setDebugLevel (int debugLevel) |
Configure the debug messaging level. | |
void | setAbortLevel (int abortLevel) |
Configure the abort log level. | |
void | setLogInfo (int logLevel, unsigned int logInfo) |
Configure the printed log information for the given level. More... | |
void | if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End) |
Add a condition to the module. More... | |
void | if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End) |
A simplified version to add a condition to the module. More... | |
void | if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End) |
A simplified version to set the condition of the module. More... | |
bool | hasCondition () const |
Returns true if at least one condition was set for the module. | |
const ModuleCondition * | getCondition () const |
Return a pointer to the first condition (or nullptr, if none was set) | |
const std::vector< ModuleCondition > & | getAllConditions () const |
Return all set conditions for this module. | |
bool | evalCondition () const |
If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More... | |
std::shared_ptr< Path > | getConditionPath () const |
Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More... | |
Module::EAfterConditionPath | getAfterConditionPath () const |
What to do after the conditional path is finished. More... | |
std::vector< std::shared_ptr< Path > > | getAllConditionPaths () const |
Return all condition paths currently set (no matter if the condition is true or not). | |
bool | hasProperties (unsigned int propertyFlags) const |
Returns true if all specified property flags are available in this module. More... | |
bool | hasUnsetForcedParams () const |
Returns true and prints error message if the module has unset parameters which the user has to set in the steering file. | |
const ModuleParamList & | getParamList () const |
Return module param list. | |
template<typename T > | |
ModuleParam< T > & | getParam (const std::string &name) const |
Returns a reference to a parameter. More... | |
bool | hasReturnValue () const |
Return true if this module has a valid return value set. | |
int | getReturnValue () const |
Return the return value set by this module. More... | |
std::shared_ptr< PathElement > | clone () const override |
Create an independent copy of this module. More... | |
std::shared_ptr< boost::python::list > | getParamInfoListPython () const |
Returns a python list of all parameters. More... | |
Static Public Member Functions | |
static void | exposePythonAPI () |
Exposes methods of the Module class to Python. | |
Protected Member Functions | |
virtual void | def_initialize () |
Wrappers to make the methods without "def_" prefix callable from Python. More... | |
virtual void | def_beginRun () |
Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python. | |
virtual void | def_event () |
Wrapper method for the virtual function event() that has the implementation to be used in a call from Python. | |
virtual void | def_endRun () |
This method can receive that the current run ends as a call from the Python side. More... | |
virtual void | def_terminate () |
Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python. | |
void | setDescription (const std::string &description) |
Sets the description of the module. More... | |
void | setType (const std::string &type) |
Set the module type. More... | |
template<typename T > | |
void | addParam (const std::string &name, T ¶mVariable, const std::string &description, const T &defaultValue) |
Adds a new parameter to the module. More... | |
template<typename T > | |
void | addParam (const std::string &name, T ¶mVariable, const std::string &description) |
Adds a new enforced parameter to the module. More... | |
void | setReturnValue (int value) |
Sets the return value for this module as integer. More... | |
void | setReturnValue (bool value) |
Sets the return value for this module as bool. More... | |
void | setParamList (const ModuleParamList ¶ms) |
Replace existing parameter list. | |
Private Types | |
typedef std::vector< DataStore::StoreEntry * > | StoreEntries |
Vector of entries in the data store. | |
Private Member Functions | |
void | readTree () |
Actually performs the reading from the tree. | |
bool | connectBranches (TTree *tree, DataStore::EDurability durability, StoreEntries *storeEntries) |
Connect branches of the given tree to the data store. More... | |
bool | createParentStoreEntries () |
Connect the parent trees and fill m_parentStoreEntries. | |
bool | readParentTrees () |
Read data of the current event from the parents. | |
void | readPersistentEntry (long fileEntry) |
Loads given entry from persistent tree. | |
void | entryNotFound (const std::string &entryOrigin, const std::string &name, bool fileChanged=true) |
Check if we warn the user or abort after an entry was missing after changing files. | |
void | addEventListForIndexFile (const std::string &parentLfn) |
For index files, this creates TEventList/TEntryListArray to enable better cache use. | |
void | realDataWorkaround (FileMetaData &metaData) |
Correct isMC flag for raw data recorded before experiment 8 run 2364. | |
std::list< ModulePtr > | getModules () const override |
no submodules, return empty list | |
std::string | getPathString () const override |
return the module name. | |
void | setParamPython (const std::string &name, const boost::python::object &pyObj) |
Implements a method for setting boost::python objects. More... | |
void | setParamPythonDict (const boost::python::dict &dictionary) |
Implements a method for reading the parameter values from a boost::python dictionary. More... | |
Private Attributes | |
std::string | m_inputFileName |
File to read from. More... | |
std::vector< std::string > | m_inputFileNames |
Files to read from. | |
std::vector< std::string > | m_entrySequences |
The number sequences (e.g. More... | |
bool | m_ignoreCommandLineOverride |
Ignore filename override from command line. | |
std::vector< std::string > | m_branchNames [DataStore::c_NDurabilityTypes] |
Array for names of branches, that shall be written out. More... | |
std::vector< std::string > | m_excludeBranchNames [DataStore::c_NDurabilityTypes] |
Array for names of branches that should NOT be written out. More... | |
unsigned int | m_skipNEvents |
Can be set from steering file to skip the first N events. | |
int | m_parentLevel |
Level of parent files to be read. | |
bool | m_collectStatistics |
Collect statistics on amount of data read and print statistics (seperate for input & parent files) after processing. | |
std::vector< int > | m_skipToEvent |
experiment, run, event number of first event to load | |
long | m_nextEntry |
Next entry to be read in event tree. More... | |
long | m_lastPersistentEntry |
last entry to be in persistent tree. More... | |
std::string | m_lastParentFileLFN |
last parent file LFN seen. More... | |
TChain * | m_tree |
TTree for event input. | |
TChain * | m_persistent |
TTree for persistent input. | |
std::set< std::string > | m_connectedBranches [DataStore::c_NDurabilityTypes] |
Already connected branches. | |
StoreEntries | m_storeEntries |
Vector of DataStore entries of event durability that we are supposed to read in. | |
StoreEntries | m_persistentStoreEntries |
Vector of DataStore entries of persistent durability that we are supposed to read in. | |
std::vector< StoreEntries > | m_parentStoreEntries |
The parent DataStore entries per level. | |
std::map< std::string, TTree * > | m_parentTrees |
Map of file LFNs to trees. | |
ReadStats | m_readStats |
some statistics for all files read so far. | |
int | m_cacheSize {0} |
Input ROOT File Cache size in MB, <0 means default. | |
bool | m_discardErrorEvents {true} |
Discard events that have an error flag != 0. | |
unsigned int | m_discardErrorMask {EventMetaData::c_HLTDiscard} |
Don't issue a warning when discarding events if the error flag consists exclusively of flags in this mask. | |
bool | m_processingAllEvents {true} |
Set to true if we process the input files completely: No skip events or sequences or -n parameters. | |
bool | m_isSecondaryInput {false} |
When using a second RootInputModule in an independent path [usually if you are using add_independent_merge_path(...)] this has to be set to true. | |
std::string | m_name |
The name of the module, saved as a string (user-modifiable) | |
std::string | m_type |
The type of the module, saved as a string. | |
std::string | m_package |
Package this module is found in (may be empty). | |
std::string | m_description |
The description of the module. | |
unsigned int | m_propertyFlags |
The properties of the module as bitwise or (with |) of EModulePropFlags. | |
LogConfig | m_logConfig |
The log system configuration of the module. | |
ModuleParamList | m_moduleParamList |
List storing and managing all parameter of the module. | |
bool | m_hasReturnValue |
True, if the return value is set. | |
int | m_returnValue |
The return value. | |
std::vector< ModuleCondition > | m_conditions |
Module condition, only non-null if set. | |
Module to read TTree data from file into the data store.
For more information consult the basf2 Software Portal confluence page. You can specify different TTrees for different durabilities, and specify if only specific branches should be read (branchNames), or if some should be excluded (excludeBranchNames).
The module supports reading from multiple files using TChain, entries will be read in the order the files are specified.
Definition at line 42 of file RootInputModule.h.
|
inherited |
Each module can be tagged with property flags, which indicate certain features of the module.
Enumerator | |
---|---|
c_Input | This module is an input module (reads data). |
c_Output | This module is an output module (writes data). |
c_ParallelProcessingCertified | This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.) |
c_HistogramManager | This module is used to manage histograms accumulated by other modules. |
c_InternalSerializer | This module is an internal serializer/deserializer for parallel processing. |
c_TerminateInAllProcesses | When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process. |
c_DontCollectStatistics | No statistics is collected for this module. |
|
inlinevirtualinherited |
Called when entering a new run.
Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.
This method can be implemented by subclasses.
Reimplemented in PyModule, AWESOMEBasicModule, MVAPrototypeModule, MVAMultipleExpertsModule, MVAExpertModule, ExportGeometryModule, CreateFieldMapModule, TxModule, RxModule, SeqRootOutputModule, SeqRootInputModule, StatisticsSummaryModule, HistoManagerModule, GearboxModule, RandomBarrierModule, ProgressModule, IoVDependentConditionModule, EventLimiterModule, EventInfoPrinterModule, SwitchDataStoreModule, SubEventModule, HistoModule, BelleMCOutputModule, B2BIIMdstInputModule, B2BIIFixMdstModule, B2BIIConvertMdstModule, B2BIIConvertBeamParamsModule, B2BIIMCParticlesMonitorModule, TreeFitterModule, TagVertexModule, PhotonEfficiencySystematicsModule, ParticleVertexFitterModule, LowEnergyPi0VetoExpertModule, LowEnergyPi0IdentificationExpertModule, CurlTaggerModule, ChargedPidMVAMulticlassModule, ChargedPidMVAModule, and EnergyBiasCorrectionModule.
|
overridevirtualinherited |
Create an independent copy of this module.
Note that parameters are shared, so changing them on a cloned module will also affect the original module.
Implements PathElement.
|
private |
Connect branches of the given tree to the data store.
tree | The tree to be connected. |
durability | The data store durability level. |
storeEntries | The store entries to which the branches are connected will be added to this vector. |
Definition at line 518 of file RootInputModule.cc.
|
inlineprotectedvirtualinherited |
|
inlineprotectedvirtualinherited |
Wrappers to make the methods without "def_" prefix callable from Python.
Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.
Reimplemented in PyModule.
|
inlinevirtualinherited |
This method is called if the current run ends.
Use this method to store information, which should be aggregated over one run.
This method can be implemented by subclasses.
Reimplemented in PyModule, AWESOMEBasicModule, ZMQTxWorkerModule, ZMQTxInputModule, TxModule, RxModule, SeqRootOutputModule, SeqRootInputModule, StatisticsSummaryModule, HistoManagerModule, RandomBarrierModule, EventInfoPrinterModule, SwitchDataStoreModule, SubEventModule, HistoModule, BelleMCOutputModule, B2BIIMdstInputModule, B2BIIConvertMdstModule, B2BIIMCParticlesMonitorModule, LowEnergyPi0VetoExpertModule, LowEnergyPi0IdentificationExpertModule, and CurlTaggerModule.
|
inherited |
If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().
|
inherited |
|
inherited |
|
inlineinherited |
Returns the name of the module.
This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.
For identifying the type of a module, using getType() (or type() in Python) is recommended.
|
inherited |
Returns a python list of all parameters.
Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.
|
inlineinherited |
Return the return value set by this module.
This value is only meaningful if hasReturnValue() is true
|
inherited |
|
inherited |
|
inherited |
A simplified version to add a condition to the module.
Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.
Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.
It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.
path | Shared pointer to the Path which will be executed if the return value is false. |
afterConditionPath | What to do after executing 'path'. |
|
inherited |
A simplified version to set the condition of the module.
Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.
Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.
It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.
path | Shared pointer to the Path which will be executed if the return value is true. |
afterConditionPath | What to do after executing 'path'. |
|
inherited |
Add a condition to the module.
Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.
See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.
Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.
expression | The expression of the condition. |
path | Shared pointer to the Path which will be executed if the condition is evaluated to true. |
afterConditionPath | What to do after executing 'path'. |
|
protectedinherited |
|
inherited |
Configure the printed log information for the given level.
logLevel | The log level (one of LogConfig::ELogLevel) |
logInfo | What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags. |
|
inlineinherited |
|
privateinherited |
Implements a method for setting boost::python objects.
The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.
name | The unique name of the parameter. |
pyObj | The object which should be converted and stored as the parameter value. |
|
privateinherited |
Implements a method for reading the parameter values from a boost::python dictionary.
The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.
dictionary | The python dictionary from which the parameter values are read. |
|
inherited |
|
protectedinherited |
Sets the return value for this module as bool.
The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.
value | The value of the return value. |
|
protectedinherited |
|
protectedinherited |
|
private |
Array for names of branches, that shall be written out.
Empty vector results in all branches being read. These vectors can be configured in the steering file.
Definition at line 133 of file RootInputModule.h.
|
private |
The number sequences (e.g.
23:42,101) defining the entries which are processed for each inputFileName.
Definition at line 122 of file RootInputModule.h.
|
private |
Array for names of branches that should NOT be written out.
This takes precedence over m_branchNames, so if a branch is in both m_branchNames[d] and m_excludeBranchNames[d], it is not saved.
Definition at line 140 of file RootInputModule.h.
|
private |
File to read from.
Cannot be used together with m_inputFileNames.
Definition at line 114 of file RootInputModule.h.
|
private |
last parent file LFN seen.
(used by addEventListForIndexFile())
Definition at line 164 of file RootInputModule.h.
|
private |
|
private |