RootInputModule Class Reference

Module to read TTree data from file into the data store. More...

#include <RootInputModule.h>

Inheritance diagram for RootInputModule:

Collaboration diagram for RootInputModule:

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.
virtual void	endRun ()
	This method is called if the current run ends.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
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.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
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.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
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.
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).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
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.
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.
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.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

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.
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.
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.
void	setType (const std::string &type)
	Set the module type.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	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.
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.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_inputFileName
	File to read from.
std::vector< std::string >	m_inputFileNames
	Files to read from.
std::vector< std::string >	m_entrySequences
	The number sequences (e.g.
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.
std::vector< std::string >	m_excludeBranchNames [DataStore::c_NDurabilityTypes]
	Array for names of branches that should NOT be written out.
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.
long	m_lastPersistentEntry
	last entry to be in persistent tree.
std::string	m_lastParentFileLFN
	last parent file LFN seen.
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.

Detailed Description

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.

See also

DataStore::EDurability

Definition at line 42 of file RootInputModule.h.

Member Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

StoreEntries

typedef std::vector<DataStore::StoreEntry*> StoreEntries

private

Vector of entries in the data store.

Definition at line 79 of file RootInputModule.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

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.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

RootInputModule()

RootInputModule

(

)

Constructor.

Definition at line 39 of file RootInputModule.cc.

                                 : Module(), m_nextEntry(0), m_lastPersistentEntry(-1), m_tree(nullptr), m_persistent(nullptr)
{
  //Set module properties
  setDescription("Reads objects/arrays from one or more .root files saved by the RootOutput module and makes them available through the DataStore. Files do not necessarily have to be local, http:// and root:// (for files in xrootd) URLs are supported as well.");
  setPropertyFlags(c_Input);
 
  //Parameter definition
  vector<string> emptyvector;
  addParam("inputFileName", m_inputFileName,
           "Input file name. For multiple files, use inputFileNames or wildcards instead. Can be overridden using the -i argument to basf2.",
           string(""));
  addParam("inputFileNames", m_inputFileNames,
           "List of input files. You may use shell-like expansions to specify multiple files, e.g. 'somePrefix_*.root' or 'file_[a,b]_[1-15].root'. Can be overridden using the -i argument to basf2.",
           emptyvector);
  addParam("entrySequences", m_entrySequences,
           "The number sequences (e.g. 23:42,101) defining the entries which are processed for each inputFileName."
           "Must be specified exactly once for each file to be opened."
           "The first event has the entry number 0.", emptyvector);
  addParam("ignoreCommandLineOverride", m_ignoreCommandLineOverride,
           "Ignore override of file name via command line argument -i.", false);
 
  addParam("skipNEvents", m_skipNEvents, "Skip this number of events before starting.", 0u);
  addParam("skipToEvent", m_skipToEvent, "Skip events until the event with "
           "the specified (experiment, run, event number) occurs. This parameter "
           "is useful for debugging to start with a specific event.", m_skipToEvent);
 
  addParam(c_SteerBranchNames[0], m_branchNames[0],
           "Names of event durability branches to be read. Empty means all branches. (EventMetaData is always read)", emptyvector);
  addParam(c_SteerBranchNames[1], m_branchNames[1],
           "Names of persistent durability branches to be read. Empty means all branches. (FileMetaData is always read)", emptyvector);
 
  addParam(c_SteerExcludeBranchNames[0], m_excludeBranchNames[0],
           "Names of event durability branches NOT to be read. Takes precedence over branchNames.", emptyvector);
  vector<string> excludePersistent({"ProcessStatistics"});
  addParam(c_SteerExcludeBranchNames[1], m_excludeBranchNames[1],
           "Names of persistent durability branches NOT to be read. Takes precedence over branchNamesPersistent.", excludePersistent);
 
  addParam("parentLevel", m_parentLevel,
           "Number of generations of parent files (files used as input when creating a file) to be read. This can be useful if a file is missing some information available in its parent. See https://confluence.desy.de/display/BI/Software+ParentFiles for details.",
           0);
 
  addParam("collectStatistics", m_collectStatistics,
           "Collect statistics on amount of data read and print statistics (seperate for input & parent files) after processing. Data is collected from TFile using GetBytesRead(), GetBytesReadExtra(), GetReadCalls()",
           false);
  addParam("cacheSize", m_cacheSize,
           "file cache size in Mbytes. If negative, use root default", 0);
 
  addParam("discardErrorEvents", m_discardErrorEvents,
           "Discard events with an error flag != 0", m_discardErrorEvents);
  addParam("silentErrrorDiscardMask", m_discardErrorMask,
           "Bitmask of error flags to silently discard without raising a WARNING. Should be a combination of the ErrorFlags defined "
           "in the EventMetaData. No Warning will be issued when discarding an event if the error flag consists exclusively of flags "
           "present in this mask", m_discardErrorMask);
 
  addParam("isSecondaryInput", m_isSecondaryInput,
           "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",
           false);
}

Member Function Documentation

addEventListForIndexFile()

void addEventListForIndexFile ( const std::string &  parentLfn )

private

For index files, this creates TEventList/TEntryListArray to enable better cache use.

Definition at line 700 of file RootInputModule.cc.

{
  //is this really an index file? (=only EventMetaData stored)
  if (!(m_parentLevel > 0 and m_storeEntries.size() == 1))
    return;
  //did we handle the current parent file already?
  if (parentLfn == m_lastParentFileLFN)
    return;
  m_lastParentFileLFN = parentLfn;
 
  B2INFO("Index file detected, scanning to generate event list.");
  TTree* tree = m_parentTrees.at(parentLfn);
 
  //both types of list work, TEventList seems to result in slightly less data being read.
  auto* elist = new TEventList("parent_entrylist");
  //TEntryListArray* elist = new TEntryListArray();
 
  TBranch* branch = m_tree->GetBranch("EventMetaData");
  auto* address = branch->GetAddress();
  EventMetaData* eventMetaData = nullptr;
  branch->SetAddress(&eventMetaData);
  long nEntries = m_tree->GetEntries();
  for (long i = m_nextEntry; i < nEntries; i++) {
    branch->GetEntry(i);
    int experiment = eventMetaData->getExperiment();
    int run = eventMetaData->getRun();
    unsigned int event = eventMetaData->getEvent();
    const std::string& newParentLfn = eventMetaData->getParentLfn();
 
    if (parentLfn != newParentLfn) {
      //parent file changed, stopping for now
      break;
    }
    long entry = RootIOUtilities::getEntryNumberWithEvtRunExp(tree, event, run, experiment);
    elist->Enter(entry);
  }
  branch->SetAddress(address);
 
  if (tree) {
    tree->SetEventList(elist);
    //tree->SetEntryList(elist);
  }
}

beginRun()

virtual void beginRun ( )

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 EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, CreateFieldMapModule, ExportGeometryModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, and PyModule.

Definition at line 147 of file Module.h.

{};

clone()

std::shared_ptr< PathElement > clone ( ) const

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.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

connectBranches()

bool connectBranches ( TTree *  tree, DataStore::EDurability  durability, StoreEntries *  storeEntries  )

private

Connect branches of the given tree to the data store.

Parameters

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.

Returns

True if the branches could be connected successfully.

Definition at line 518 of file RootInputModule.cc.

{
  B2DEBUG(30, "File changed, loading persistent data.");
  DataStore::StoreEntryMap& map = DataStore::Instance().getStoreEntryMap(durability);
  //Go over the branchlist and connect the branches with DataStore entries
  const TObjArray* branchesObjArray = tree->GetListOfBranches();
  if (!branchesObjArray) {
    B2FATAL("Tree '" << tree->GetName() << "' doesn't contain any branches!");
  }
  std::vector<TBranch*> branches;
  set<string> branchList;
  for (int jj = 0; jj < branchesObjArray->GetEntriesFast(); jj++) {
    auto* branch = static_cast<TBranch*>(branchesObjArray->At(jj));
    if (!branch) continue;
    branchList.insert(branch->GetName());
    branches.emplace_back(branch);
    // start with all branches disabled and only enable what we read
    setBranchStatus(branch, false);
  }
  //skip branches the user doesn't want
  branchList = filterBranches(branchList, m_branchNames[durability], m_excludeBranchNames[durability], durability, true);
  for (TBranch* branch : branches) {
    const std::string branchName = branch->GetName();
    //skip already connected branches
    if (m_connectedBranches[durability].find(branchName) != m_connectedBranches[durability].end())
      continue;
 
    if ((branchList.count(branchName) == 0) and
        ((branchName != "FileMetaData") || (tree != m_persistent)) and
        ((branchName != "EventMetaData") || (tree != m_tree))) {
      continue;
    }
    auto found = setBranchStatus(branch, true);
    B2DEBUG(32, "Enabling branch" << LogVar("branchName", branchName)
            << LogVar("children found", found));
 
    //Get information about the object in the branch
    TObject* objectPtr = nullptr;
    branch->SetAddress(&objectPtr);
    branch->GetEntry();
    bool array = (string(branch->GetClassName()) == "TClonesArray");
    TClass* objClass = nullptr;
    if (array)
      objClass = (static_cast<TClonesArray*>(objectPtr))->GetClass();
    else
      objClass = objectPtr->IsA();
    delete objectPtr;
 
    //Create a DataStore entry and connect the branch address to it
    if (!DataStore::Instance().registerEntry(branchName, durability, objClass, array, DataStore::c_WriteOut)) {
      B2FATAL("Cannot connect branch to datastore" << LogVar("branchName", branchName));
      continue;
    }
    DataStore::StoreEntry& entry = (map.find(branchName))->second;
    tree->SetBranchAddress(branch->GetName(), &(entry.object));
    if (storeEntries) storeEntries->push_back(&entry);
 
    //Keep track of already connected branches
    m_connectedBranches[durability].insert(branchName);
  }
 
  return true;
}

createParentStoreEntries()

bool createParentStoreEntries ( )

private

Connect the parent trees and fill m_parentStoreEntries.

Definition at line 583 of file RootInputModule.cc.

{
  // get the experiment/run/event number and parentLfn of the first entry
  assert(m_tree);
  TBranch* branch = m_tree->GetBranch("EventMetaData");
  char* address = branch->GetAddress();
  EventMetaData* eventMetaData = nullptr;
  branch->SetAddress(&eventMetaData);
  branch->GetEntry(0);
  int experiment = eventMetaData->getExperiment();
  int run = eventMetaData->getRun();
  unsigned int event = eventMetaData->getEvent();
  std::string parentLfn = eventMetaData->getParentLfn();
  branch->SetAddress(address);
 
  // loop over parents and get their metadata
  for (int level = 0; level < m_parentLevel; level++) {
    // open the parent file
    TDirectory* dir = gDirectory;
    const std::string parentPfn = FileCatalog::Instance().getPhysicalFileName(parentLfn);
    TFile* file = TFile::Open(parentPfn.c_str(), "READ");
    dir->cd();
    if (!file || !file->IsOpen()) {
      B2ERROR("Couldn't open parent file. Maybe you need to create a file catalog using b2file-catalog-add?"
              << LogVar("LFN", parentLfn) << LogVar("PFN", parentPfn));
      return false;
    }
 
    // get the event tree and connect its branches
    auto* tree = dynamic_cast<TTree*>(file->Get(c_treeNames[DataStore::c_Event].c_str()));
    if (!tree) {
      B2ERROR("No tree " << c_treeNames[DataStore::c_Event] << " found in " << parentPfn);
      return false;
    }
    if (int(m_parentStoreEntries.size()) <= level)  m_parentStoreEntries.resize(level + 1);
    connectBranches(tree, DataStore::c_Event, &m_parentStoreEntries[level]);
    m_parentTrees.insert(std::make_pair(parentLfn, tree));
 
    // get the persistent tree and read its branches
    auto* persistent = dynamic_cast<TTree*>(file->Get(c_treeNames[DataStore::c_Persistent].c_str()));
    if (!persistent) {
      B2ERROR("No tree " << c_treeNames[DataStore::c_Persistent] << " found in " << parentPfn);
      return false;
    }
    connectBranches(persistent, DataStore::c_Persistent, nullptr);
 
    // get parent LFN of parent
    EventMetaData* metaData = nullptr;
    tree->SetBranchAddress("EventMetaData", &metaData);
    long entry = RootIOUtilities::getEntryNumberWithEvtRunExp(tree, event, run, experiment);
    tree->GetBranch("EventMetaData")->GetEntry(entry);
    parentLfn = metaData->getParentLfn();
  }
 
  return true;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

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.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

endRun()

virtual void endRun ( )

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 CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, AWESOMEBasicModule, and PyModule.

Definition at line 166 of file Module.h.

{};

entryNotFound()

void entryNotFound ( const std::string &  entryOrigin, const std::string &  name, bool  fileChanged = true  )

private

Check if we warn the user or abort after an entry was missing after changing files.

Definition at line 744 of file RootInputModule.cc.

{
  if (name == "ProcessStatistics" or DataStore::Instance().getDependencyMap().isUsedAs(name, DependencyMap::c_Input)) {
    B2FATAL(entryOrigin << " in " << m_tree->GetFile()->GetName() << " does not contain required object " << name << ", aborting.");
  } else if (fileChanged) {
    B2WARNING(entryOrigin << " in " << m_tree->GetFile()->GetName() << " does not contain object " << name <<
              " that was present in a previous entry.");
  }
}

evalCondition()

bool evalCondition ( ) const

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().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( )

overridevirtual

Running over all events.

Reimplemented from Module.

Definition at line 345 of file RootInputModule.cc.

{
  if (!m_tree)
    return;
 
  while (true) {
    const long nextEntry = InputController::getNextEntry(m_isSecondaryInput);
    if (nextEntry >= 0 && nextEntry < InputController::numEntries(m_isSecondaryInput)) {
      // don't show this message if we are doing event merging, as it will pop up twice for every event
      if (!InputController::getEventMerging()) {
        B2INFO("RootInput: will read entry " << nextEntry << " next.");
      }
      m_nextEntry = nextEntry;
    } else if (InputController::getNextExperiment() >= 0 && InputController::getNextRun() >= 0
               && InputController::getNextEvent() >= 0) {
      const long entry = RootIOUtilities::getEntryNumberWithEvtRunExp(m_tree->GetTree(), InputController::getNextEvent(),
                         InputController::getNextRun(), InputController::getNextExperiment());
      if (entry >= 0) {
        const long chainentry = m_tree->GetChainEntryNumber(entry);
        B2INFO("RootInput: will read entry " << chainentry << " (entry " << entry << " in current file) next.");
        m_nextEntry = chainentry;
      } else {
        B2ERROR("Couldn't find entry (" << InputController::getNextEvent() << ", " << InputController::getNextRun() << ", " <<
                InputController::getNextExperiment() << ") in file! Loading entry " << m_nextEntry << " instead.");
      }
    }
    InputController::eventLoaded(m_nextEntry, m_isSecondaryInput);
 
    readTree();
    m_nextEntry++;
 
    // check for events with errors
    unsigned int errorFlag = 0;
    if (m_discardErrorEvents && (m_nextEntry >= 0)) {
      const StoreObjPtr<EventMetaData> eventMetaData;
      errorFlag = eventMetaData->getErrorFlag();
      if (errorFlag != 0) {
        if (errorFlag & ~m_discardErrorMask) {
          B2WARNING("Discarding corrupted event" << LogVar("errorFlag", errorFlag) << LogVar("experiment", eventMetaData->getExperiment())
                    << LogVar("run", eventMetaData->getRun()) << LogVar("event", eventMetaData->getEvent()));
        }
        // make sure this event is not used if it's the last one in the file
        eventMetaData->setEndOfData();
      }
    }
    if (errorFlag == 0) break;
  }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

virtual std::vector< std::string > getFileNames ( bool  outputFiles = false )

inlineoverridevirtual

Get list of input files, taking -i command line overrides into account.

Reimplemented from Module.

Definition at line 61 of file RootInputModule.h.

    {
      B2ASSERT("RootInput is not an output module", !outputFiles);
      std::vector<std::string> inputFiles = !m_isSecondaryInput ? Environment::Instance().getInputFilesOverride() :
                                            Environment::Instance().getSecondaryInputFilesOverride();
      if (!m_ignoreCommandLineOverride and !inputFiles.empty()) {
        return inputFiles;
      }
      inputFiles = m_inputFileNames;
      if (!m_inputFileName.empty())
        inputFiles.push_back(m_inputFileName);
      return inputFiles;
    }

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

{ return std::list<ModulePtr>(); }

getName()

const std::string & getName ( ) const

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.

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

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.

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

if_false()

void if_false ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

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.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

if_true()

void if_true ( const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

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.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

if_value()

void if_value ( const std::string &  expression, const std::shared_ptr< Path > &  path, EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End  )

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.

Parameters

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'.

Definition at line 79 of file Module.cc.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

initialize()

void initialize ( )

overridevirtual

Initialize the Module.

Reimplemented from Module.

Definition at line 101 of file RootInputModule.cc.

{
  unsigned int skipNEventsOverride = Environment::Instance().getSkipEventsOverride();
  if (skipNEventsOverride != 0)
    m_skipNEvents = skipNEventsOverride;
 
  auto entrySequencesOverride = Environment::Instance().getEntrySequencesOverride();
  if (entrySequencesOverride.size() > 0)
    m_entrySequences = entrySequencesOverride;
 
  m_nextEntry = m_skipNEvents;
  m_lastPersistentEntry = -1;
  m_lastParentFileLFN = "";
 
  const vector<string>& inputFiles = getFileNames();
  if (inputFiles.empty()) {
    B2FATAL("You have to set either the 'inputFileName' or the 'inputFileNames' parameter, or start basf2 with the '-i MyFile.root' option.");
  }
  if (!m_inputFileName.empty() && !m_inputFileNames.empty()) {
    B2FATAL("Cannot use both 'inputFileName' and 'inputFileNames' parameters!");
  }
  m_inputFileNames = expandWordExpansions(inputFiles);
  if (m_inputFileNames.empty()) {
    B2FATAL("No valid files specified!");
  }
 
  if (m_entrySequences.size() > 0 and m_inputFileNames.size() != m_entrySequences.size()) {
    B2FATAL("Number of provided filenames does not match the number of given entrySequences parameters: len(inputFileNames) = "
            << m_inputFileNames.size() << " len(entrySequences) = " << m_entrySequences.size());
  }
 
  m_inputFileName = "";
  // we'll only use m_inputFileNames from now on
 
  // so let's create the chain objects ...
  m_persistent = new TChain(c_treeNames[DataStore::c_Persistent].c_str());
  m_tree = new TChain(c_treeNames[DataStore::c_Event].c_str());
 
  // time for sanity checks. The problem is that this needs to read a few bytes
  // from every input file so for jobs with large amount of input files this
  // will not be efficient.
  // TODO: We might want to create a different input module which will not
  //       check anything and require manual input like the number of events in
  //       each file and the global tags to use.  That would be more efficient
  //       but also less safe
 
  // list of required branches. We keep this empty for now and only fill
  // it after we checked the first file to make sure all other files have the
  // same branches available.
  std::set<std::string> requiredEventBranches;
  std::set<std::string> requiredPersistentBranches;
  // Event metadata from all files, keep it around for sanity checks and globaltag replay
  std::vector<FileMetaData> fileMetaData;
  // and if so, what is the sum
  std::result_of<decltype(&FileMetaData::getMcEvents)(FileMetaData)>::type sumInputMCEvents{0};
 
  // scope for local variables
  {
    // temporarily disable some root warnings
    auto rootWarningGuard = ScopeGuard::guardValue(gErrorIgnoreLevel, kWarning + 1);
    // do all files have a consistent number of MC events? that is all positive or all zero
    bool validInputMCEvents{true};
    for (const string& fileName : m_inputFileNames) {
      // read metadata and create sum of MCEvents and global tags
      try {
        RootIOUtilities::RootFileInfo fileInfo(fileName);
        FileMetaData meta = fileInfo.getFileMetaData();
        if (meta.getNEvents() == 0) {
          B2WARNING("File appears to be empty, skipping" << LogVar("filename", fileName));
          continue;
        }
        realDataWorkaround(meta);
        fileMetaData.push_back(meta);
        // make sure we only look at data or MC. For the first file this is trivially true
        if (fileMetaData.front().isMC() != meta.isMC()) {
          throw std::runtime_error("Mixing real data and simulated data for input files is not supported");
        }
        // accumulate number of inputMCEvents now
        if (validInputMCEvents) {
          // make sure that all files have either a non-zero or zero mcevents.
          if ((sumInputMCEvents > 0 and meta.getMcEvents() == 0)) {
            B2WARNING("inconsistent input files: zero mcEvents, setting total number of MC events to zero" << LogVar("filename", fileName));
            validInputMCEvents = false;
          }
          // So accumulate the number of MCEvents but let's be careful to not have an overflow here
          if (__builtin_add_overflow(sumInputMCEvents, meta.getMcEvents(), &sumInputMCEvents)) {
            B2FATAL("Number of MC events is too large and cannot be represented anymore");
          }
        }
        // for the first file we don't know what branches are required but now we can determine them as we know the file can be opened
        if (requiredEventBranches.empty()) {
          // make sure we have event meta data
          fileInfo.checkMissingBranches({"EventMetaData"}, false);
          requiredEventBranches = fileInfo.getBranchNames(false);
          // filter the branches depending on what the user selected. Note we
          // do the same thing again in connectBranches but we leave it like
          // that because we also want to read branches from parent files
          // selectively and thus we need to filter the branches there anyway.
          // Here we just do it to ensure all files we read directly (which is
          // 99% of the use case) contain all the branches we want.
          requiredEventBranches = RootIOUtilities::filterBranches(requiredEventBranches, m_branchNames[DataStore::c_Event],
                                                                  m_excludeBranchNames[DataStore::c_Event], DataStore::c_Event);
          // but make sure we always have EventMetaData ...
          requiredEventBranches.emplace("EventMetaData");
 
          // Same for persistent data ...
          requiredPersistentBranches = fileInfo.getBranchNames(true);
          // filter the branches depending on what the user selected
          requiredPersistentBranches = RootIOUtilities::filterBranches(requiredPersistentBranches, m_branchNames[DataStore::c_Persistent],
                                       m_excludeBranchNames[DataStore::c_Persistent], DataStore::c_Persistent);
        } else {
          // ok we already have the list ... so let's make sure following files have the same branches
          fileInfo.checkMissingBranches(requiredEventBranches, false);
          fileInfo.checkMissingBranches(requiredPersistentBranches, true);
        }
        // ok, so now we have the file, add it to the chain. We trust the amount of events from metadata here.
        if (m_tree->AddFile(fileName.c_str(), meta.getNEvents()) == 0 || m_persistent->AddFile(fileName.c_str(), 1) == 0) {
          throw std::runtime_error("Could not add file to TChain");
        }
        B2INFO("Added file " + fileName);
      } catch (std::exception& e) {
        B2FATAL("Could not open input file " << std::quoted(fileName) << ": " << e.what());
      }
    }
  }
 
  if (m_tree->GetNtrees() == 0) B2FATAL("No file could be opened, aborting");
  // Set cache size TODO: find out if files are remote and use a bigger default
  // value if at least one file is non-local
  if (m_cacheSize >= 0) m_tree->SetCacheSize(m_cacheSize * 1024 * 1024);
 
  // Check if the files we added to the Chain are unique,
  // if the same file is added multiple times the TEventList used for the eventSequence feature
  // will process each file only once with the union of both given sequences.
  // It is not clear if the user wants this, so we raise a fatal in this situation.
  {
    std::set<std::string> unique_filenames;
 
    // The following lines are directly from the ROOT documentation
    // see TChain::AddFile
    TObjArray* fileElements = m_tree->GetListOfFiles();
    TIter next(fileElements);
    TChainElement* chEl = nullptr;
    while ((chEl = (TChainElement*)next())) {
      if (!unique_filenames.insert(chEl->GetTitle()).second) {
        B2WARNING("The input file '" << chEl->GetTitle() << "' was specified more than once");
        // seems we have duplicate files so we process events more than once. Disable forwarding of MC event number
        m_processingAllEvents = false;
      }
    }
    if ((unsigned int)m_tree->GetNtrees() != unique_filenames.size() && m_entrySequences.size() > 0) {
      B2FATAL("You specified a file multiple times, and specified a sequence of entries which should be used for each file. "
              "Please specify each file only once if you're using the sequence feature!");
    }
  }
 
  if (m_entrySequences.size() > 0) {
    auto* elist = new TEventList("input_event_list");
    for (unsigned int iFile = 0; iFile < m_entrySequences.size(); ++iFile) {
      int64_t offset = m_tree->GetTreeOffset()[iFile];
      int64_t next_offset = m_tree->GetTreeOffset()[iFile + 1];
      // check if Sequence consists only of ':', e.g. the whole file is requested
      if (m_entrySequences[iFile] == ":") {
        for (int64_t global_entry = offset; global_entry < next_offset; ++global_entry)
          elist->Enter(global_entry);
      } else {
        for (const auto& entry : generate_number_sequence(m_entrySequences[iFile])) {
          int64_t global_entry = entry + offset;
          if (global_entry >= next_offset) {
            B2WARNING("Given sequence contains entry numbers which are out of range. "
                      "I won't add any further events to the EventList for the current file.");
            break;
          } else {
            elist->Enter(global_entry);
          }
        }
      }
    }
    m_tree->SetEventList(elist);
  }
 
  B2DEBUG(33, "Opened tree '" + c_treeNames[DataStore::c_Persistent] + "'" << LogVar("entries", m_persistent->GetEntriesFast()));
  B2DEBUG(33, "Opened tree '" + c_treeNames[DataStore::c_Event] + "'" << LogVar("entries", m_tree->GetEntriesFast()));
 
  connectBranches(m_persistent, DataStore::c_Persistent, &m_persistentStoreEntries);
  readPersistentEntry(0);
 
  if (!connectBranches(m_tree, DataStore::c_Event, &m_storeEntries)) {
    delete m_tree;
    m_tree = nullptr; //don't try to read from there
  } else {
    InputController::setCanControlInput(true);
    InputController::setChain(m_tree, m_isSecondaryInput);
  }
 
  if (m_parentLevel > 0) {
    createParentStoreEntries();
  } else if (m_parentLevel < 0) {
    B2ERROR("parentLevel must be >= 0!");
    return;
  }
 
  // Let's check check if we process everything
  //   * all filenames unique (already done above)
  //   * no event skipping either with skipN, entry sequences or skipToEvent
  //   * no -n or process(path, N) with N <= the number of entries in our files
  unsigned int maxEvent = Environment::Instance().getNumberEventsOverride();
  m_processingAllEvents &= m_skipNEvents == 0 && m_entrySequences.size() == 0;
  m_processingAllEvents &= (maxEvent == 0 || maxEvent >= InputController::numEntries(m_isSecondaryInput));
 
  if (!m_skipToEvent.empty()) {
    // Skipping to some specific event is also not processing all events ...
    m_processingAllEvents = false;
    // make sure the number of entries is exactly 3
    if (m_skipToEvent.size() != 3) {
      B2ERROR("skipToEvent must be a list of three values: experiment, run, event number");
      // ignore the value
      m_skipToEvent.clear();
    } else {
      InputController::setNextEntry(m_skipToEvent[0], m_skipToEvent[1], m_skipToEvent[2]);
    }
    if (m_nextEntry > 0) {
      B2ERROR("You cannot supply a number of events to skip (skipNEvents) and an "
              "event to skip to (skipToEvent) at the same time, ignoring skipNEvents");
      //force the number of skipped events to be zero
      m_nextEntry = 0;
    }
  }
 
  // Tell the InputController which event will be processed first
  // (important if we want to do event mixing and skip some events in the input)
  if (m_nextEntry > 0) {
    InputController::setSkippedEntries(m_nextEntry, m_isSecondaryInput);
  }
 
  // Processing everything so forward number of MC events
  if (m_processingAllEvents) {
    Environment::Instance().setNumberOfMCEvents(sumInputMCEvents);
  }
  // And setup global tag replay ...
  Conditions::Configuration::getInstance().setInputMetadata(fileMetaData);
}

readParentTrees()

bool readParentTrees ( )

private

Read data of the current event from the parents.

Definition at line 641 of file RootInputModule.cc.

{
  const StoreObjPtr<EventMetaData> eventMetaData;
  int experiment = eventMetaData->getExperiment();
  int run = eventMetaData->getRun();
  unsigned int event = eventMetaData->getEvent();
 
  std::string parentLfn = eventMetaData->getParentLfn();
  for (int level = 0; level < m_parentLevel; level++) {
    const std::string& parentPfn = FileCatalog::Instance().getPhysicalFileName(parentLfn);
 
    // Open the parent file if we haven't done this already
    TTree* tree = nullptr;
    if (m_parentTrees.find(parentLfn) == m_parentTrees.end()) {
      TDirectory* dir = gDirectory;
      B2DEBUG(30, "Opening parent file" << LogVar("PFN", parentPfn));
      TFile* file = TFile::Open(parentPfn.c_str(), "READ");
      dir->cd();
      if (!file || !file->IsOpen()) {
        B2ERROR("Couldn't open parent file " << parentPfn);
        return false;
      }
      tree = dynamic_cast<TTree*>(file->Get(c_treeNames[DataStore::c_Event].c_str()));
      if (!tree) {
        B2ERROR("No tree " << c_treeNames[DataStore::c_Event] << " found in " << parentPfn);
        return false;
      }
      for (auto entry : m_parentStoreEntries[level]) {
        tree->SetBranchAddress(entry->name.c_str(), &(entry->object));
      }
      m_parentTrees.insert(std::make_pair(parentLfn, tree));
    } else {
      tree = m_parentTrees[parentLfn];
    }
 
    // get entry number in parent tree
    long entryNumber = RootIOUtilities::getEntryNumberWithEvtRunExp(tree, event, run, experiment);
    if (entryNumber < 0) {
      B2ERROR("No event " << experiment << "/" << run << "/" << event << " in parent file " << parentPfn);
      return false;
    }
 
    // read the tree and mark the data read in the data store
    EventMetaData* parentMetaData = nullptr;
    tree->SetBranchAddress("EventMetaData", &parentMetaData);
    tree->GetEntry(entryNumber);
    for (auto entry : m_parentStoreEntries[level]) {
      entry->ptr = entry->object;
    }
 
    // set the parent LFN to the next level
    parentLfn = parentMetaData->getParentLfn();
  }
 
  addEventListForIndexFile(parentLfn);
 
  return true;
}

readPersistentEntry()

void readPersistentEntry ( long  fileEntry )

private

Loads given entry from persistent tree.

Definition at line 754 of file RootInputModule.cc.

{
  m_lastPersistentEntry = fileEntry;
 
  for (auto entry : m_persistentStoreEntries) {
    bool isMergeable = entry->object->InheritsFrom(Mergeable::Class());
    TObject* copyOfPreviousVersion = nullptr;
    if (isMergeable) {
      copyOfPreviousVersion = entry->object->Clone();
    }
    entry->resetForGetEntry();
    //ptr stores old value (or nullptr)
    entry->ptr = copyOfPreviousVersion;
  }
 
  int bytesRead = m_persistent->GetEntry(fileEntry);
  if (bytesRead <= 0) {
    const char* name = m_tree->GetCurrentFile() ? m_tree->GetCurrentFile()->GetName() : "<unknown>";
    B2FATAL("Could not read 'persistent' TTree #" << fileEntry << " in file " << name);
  }
 
  for (auto entry : m_persistentStoreEntries) {
    if (entry->object) {
      bool isMergeable = entry->object->InheritsFrom(Mergeable::Class());
      if (isMergeable) {
        const Mergeable* oldObj = static_cast<Mergeable*>(entry->ptr);
        auto* newObj = static_cast<Mergeable*>(entry->object);
        newObj->merge(oldObj);
 
        delete entry->ptr;
      }
      entry->ptr = entry->object;
    } else {
      entryNotFound("Persistent tree", entry->name);
      entry->recoverFromNullObject();
      entry->ptr = nullptr;
    }
  }
}

readTree()

void readTree ( )

private

Actually performs the reading from the tree.

Definition at line 427 of file RootInputModule.cc.

{
  if (!m_tree)
    return;
 
  //keep snapshot of TFile stats (to use if it changes)
  ReadStats currentEventStats;
  if (m_collectStatistics) {
    currentEventStats.addFromFile(m_tree->GetFile());
  }
 
  // Check if there are still new entries available.
  int  localEntryNumber = m_nextEntry;
  if (m_entrySequences.size() > 0) {
    localEntryNumber = m_tree->GetEntryNumber(localEntryNumber);
  }
  localEntryNumber = m_tree->LoadTree(localEntryNumber);
 
  if (localEntryNumber == -2) {
    m_nextEntry = -2;
    return; //end of file
  } else if (localEntryNumber < 0) {
    B2FATAL("Failed to load tree, corrupt file? Check standard error for additional messages. TChain::LoadTree() returned" <<
            LogVar("error", localEntryNumber));
  }
  B2DEBUG(39, "Reading file entry " << m_nextEntry);
 
  //Make sure transient members of objects are reinitialised
  for (auto entry : m_storeEntries) {
    entry->resetForGetEntry();
  }
  for (const auto& storeEntries : m_parentStoreEntries) {
    for (auto entry : storeEntries) {
      entry->resetForGetEntry();
    }
  }
 
  int bytesRead = m_tree->GetTree()->GetEntry(localEntryNumber);
  if (bytesRead <= 0) {
    B2FATAL("Could not read 'tree' entry " << m_nextEntry << " in file " << m_tree->GetCurrentFile()->GetName());
  }
 
  //In case someone is tempted to change this:
  // TTree::GetCurrentFile() returns a TFile pointer to a fixed location,
  // calling GetName() on the TFile almost works as expected, but starts with the
  // last file in a TChain. (-> we re-read the first persistent tree with TChain,
  // with ill results for Mergeable objects.)
  // GetTreeNumber() also starts at the last entry before we read the first event from m_tree,
  // so we'll save the last persistent tree loaded and only reload on changes.
  StoreObjPtr<FileMetaData> fileMetaData("", DataStore::c_Persistent);
  const long treeNum = m_tree->GetTreeNumber();
  const bool fileChanged = (m_lastPersistentEntry != treeNum);
  if (fileChanged) {
    if (m_collectStatistics) {
      m_readStats.add(currentEventStats);
    }
    // file changed, read the FileMetaData object from the persistent tree and update the parent file metadata
    readPersistentEntry(treeNum);
    B2INFO("Loading new input file"
           << LogVar("filename", m_tree->GetFile()->GetName())
           << LogVar("metadata LFN", fileMetaData->getLfn()));
  }
  realDataWorkaround(*fileMetaData);
 
  for (auto entry : m_storeEntries) {
    if (!entry->object) {
      entryNotFound("Event durability tree (global entry: " + std::to_string(m_nextEntry) + ")", entry->name, fileChanged);
      entry->recoverFromNullObject();
      entry->ptr = nullptr;
    } else {
      entry->ptr = entry->object;
    }
  }
 
  if (m_parentLevel > 0) {
    if (!readParentTrees())
      B2FATAL("Could not read data from parent file!");
  }
 
  // Nooow, if the object didn't exist in the event when we wrote it to File we still have it in the file but it's marked as invalid Object.
  // So go through everything and check for the bit and invalidate as necessary
  for (auto entry : m_storeEntries) {
    if (entry->object->TestBit(kInvalidObject)) entry->invalidate();
  }
  for (const auto& storeEntries : m_parentStoreEntries) {
    for (auto entry : storeEntries) {
      if (entry->object->TestBit(kInvalidObject)) entry->invalidate();
    }
  }
}

realDataWorkaround()

void realDataWorkaround ( FileMetaData &  metaData )

private

Correct isMC flag for raw data recorded before experiment 8 run 2364.

Definition at line 794 of file RootInputModule.cc.

{
  if ((metaData.getSite().find("bfe0") == 0) && (metaData.getDate().compare("2019-06-30") < 0) &&
      (metaData.getExperimentLow() > 0) && (metaData.getExperimentHigh() < 9) && (metaData.getRunLow() > 0)) {
    metaData.declareRealData();
  }
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

void setParamPython ( const std::string &  name, const boost::python::object &  pyObj  )

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.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary )

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.

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

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.

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

terminate()

void terminate ( )

overridevirtual

Is called at the end of your Module.

Reimplemented from Module.

Definition at line 395 of file RootInputModule.cc.

{
  if (m_collectStatistics and m_tree) {
    //add stats for last file
    m_readStats.addFromFile(m_tree->GetFile());
  }
  delete m_tree;
  delete m_persistent;
  ReadStats parentReadStats;
  for (const auto& entry : m_parentTrees) {
    TFile* f = entry.second->GetCurrentFile();
    if (m_collectStatistics)
      parentReadStats.addFromFile(f);
 
    delete f;
  }
 
  if (m_collectStatistics) {
    B2INFO("Statistics for event tree: " << m_readStats.getString());
    B2INFO("Statistics for event tree (parent files): " << parentReadStats.getString());
  }
 
  for (auto& branch : m_connectedBranches) {
    branch.clear();
  }
  m_storeEntries.clear();
  m_persistentStoreEntries.clear();
  m_parentStoreEntries.clear();
  m_parentTrees.clear();
}

Member Data Documentation

m_branchNames

std::vector<std::string> m_branchNames[DataStore::c_NDurabilityTypes]

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.

m_cacheSize

int m_cacheSize {0}

private

Input ROOT File Cache size in MB, <0 means default.

Definition at line 221 of file RootInputModule.h.

m_collectStatistics

bool m_collectStatistics

private

Collect statistics on amount of data read and print statistics (seperate for input & parent files) after processing.

Definition at line 150 of file RootInputModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_connectedBranches

std::set<std::string> m_connectedBranches[DataStore::c_NDurabilityTypes]

private

Already connected branches.

Definition at line 174 of file RootInputModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_discardErrorEvents

bool m_discardErrorEvents {true}

private

Discard events that have an error flag != 0.

Definition at line 224 of file RootInputModule.h.

m_discardErrorMask

unsigned int m_discardErrorMask {EventMetaData::c_HLTDiscard}

private

Don't issue a warning when discarding events if the error flag consists exclusively of flags in this mask.

Definition at line 226 of file RootInputModule.h.

m_entrySequences

std::vector<std::string> m_entrySequences

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.

m_excludeBranchNames

std::vector<std::string> m_excludeBranchNames[DataStore::c_NDurabilityTypes]

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.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_ignoreCommandLineOverride

bool m_ignoreCommandLineOverride

private

Ignore filename override from command line.

Definition at line 125 of file RootInputModule.h.

m_inputFileName

std::string m_inputFileName

private

File to read from.

Cannot be used together with m_inputFileNames.

Definition at line 114 of file RootInputModule.h.

m_inputFileNames

std::vector<std::string> m_inputFileNames

private

Files to read from.

Definition at line 117 of file RootInputModule.h.

m_isSecondaryInput

bool m_isSecondaryInput {false}

private

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.

Definition at line 234 of file RootInputModule.h.

m_lastParentFileLFN

std::string m_lastParentFileLFN

private

last parent file LFN seen.

(used by addEventListForIndexFile())

Definition at line 164 of file RootInputModule.h.

m_lastPersistentEntry

long m_lastPersistentEntry

private

last entry to be in persistent tree.

Definition at line 161 of file RootInputModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

m_nextEntry

long m_nextEntry

private

Next entry to be read in event tree.

Definition at line 158 of file RootInputModule.h.

m_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

m_parentLevel

int m_parentLevel

private

Level of parent files to be read.

Definition at line 147 of file RootInputModule.h.

m_parentStoreEntries

std::vector<StoreEntries> m_parentStoreEntries

private

The parent DataStore entries per level.

Definition at line 182 of file RootInputModule.h.

m_parentTrees

std::map<std::string, TTree*> m_parentTrees

private

Map of file LFNs to trees.

Definition at line 185 of file RootInputModule.h.

m_persistent

TChain* m_persistent

private

TTree for persistent input.

Definition at line 171 of file RootInputModule.h.

m_persistentStoreEntries

StoreEntries m_persistentStoreEntries

private

Vector of DataStore entries of persistent durability that we are supposed to read in.

Definition at line 179 of file RootInputModule.h.

m_processingAllEvents

bool m_processingAllEvents {true}

private

Set to true if we process the input files completely: No skip events or sequences or -n parameters.

Definition at line 229 of file RootInputModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

m_readStats

ReadStats m_readStats

private

some statistics for all files read so far.

Definition at line 218 of file RootInputModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_skipNEvents

unsigned int m_skipNEvents

private

Can be set from steering file to skip the first N events.

Definition at line 144 of file RootInputModule.h.

m_skipToEvent

std::vector<int> m_skipToEvent

private

experiment, run, event number of first event to load

Definition at line 153 of file RootInputModule.h.

m_storeEntries

StoreEntries m_storeEntries

private

Vector of DataStore entries of event durability that we are supposed to read in.

Definition at line 177 of file RootInputModule.h.

m_tree

TChain* m_tree

private

TTree for event input.

Definition at line 168 of file RootInputModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

---

The documentation for this class was generated from the following files:

• framework/modules/rootio/include/RootInputModule.h
• framework/modules/rootio/src/RootInputModule.cc