BeamBkgMixerModule Class Reference

New beam background mixer; this one doesn't need ROF files. More...

#include <BeamBkgMixerModule.h>

Inheritance diagram for BeamBkgMixerModule:

Classes
struct	BkgFiles
	structure to hold samples of a particular background type More...
struct	BkgHits
	An input event buffer definition for background SimHits. 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
	BeamBkgMixerModule ()
	Constructor.
virtual	~BeamBkgMixerModule ()
	Destructor.
virtual void	initialize () override
	Initialize the Module.
virtual void	beginRun () override
	Called when entering a new run.
virtual void	event () override
	Event processor.
virtual void	endRun () override
	End-of-run action.
virtual void	terminate () override
	Termination action.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
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 Member Functions
template<class SIMHIT >
void	addSimHits (StoreArray< SIMHIT > &simHits, TClonesArray *cloneArray, double timeShift, double minTime, double maxTime)
	functions that add background SimHits to those in the DataStore
template<class HIT >
void	addBeamBackHits (StoreArray< HIT > &hits, TClonesArray *cloneArray, double timeShift, double minTime, double maxTime)
	functions that add BeamBackHits to those in the DataStore
bool	isComponentIncluded (std::vector< std::string > &components, const std::string &component)
	Returns true if a component is found in components or the list is empty.
void	appendSample (BackgroundMetaData::BG_TAG bkgTag, const std::string &bkgType, const std::string &fileName, double realTime, BackgroundMetaData::EFileType fileTyp)
	appends background sample to m_backgrounds
bool	acceptEvent (TClonesArray *cloneArrayECL)
	Checks for deposited energy of ECLHits and returns true if Edep < m_maxEdepECL.
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::vector< std::string >	m_backgroundFiles
	names of beam background files
double	m_overallScaleFactor
	overall scale factor
std::vector< std::tuple< std::string, double > >	m_scaleFactors
	scale factors
double	m_minTime
	minimal time shift of background event
double	m_maxTime
	maximal time shift of background event
std::vector< std::string >	m_components
	detector components
bool	m_wrapAround
	if true wrap around events in the tail after maxTime
double	m_minTimeECL
	minimal time shift of background event for ECL
double	m_maxTimeECL
	maximal time shift of background event for ECL
double	m_minTimePXD
	minimal time shift of background event for PXD
double	m_maxTimePXD
	maximal time shift of background event for PXD
double	m_maxEdepECL
	maximal allowed deposited energy in ECL
int	m_cacheSize
	file cache size in Mbytes
std::vector< BkgFiles >	m_backgrounds
	container for background samples
BkgHits	m_simHits
	input event buffer
bool	m_PXD = false
	true if found in m_components
bool	m_SVD = false
	true if found in m_components
bool	m_CDC = false
	true if found in m_components
bool	m_TOP = false
	true if found in m_components
bool	m_ARICH = false
	true if found in m_components
bool	m_ECL = false
	true if found in m_components
bool	m_KLM = false
	true if found in m_components
bool	m_BeamBackHits = false
	if true add also background hits
background::BeamBGTypes	m_bgTypes
	defined BG types
std::map< std::string, int >	m_rejected
	messages: rejected events
std::map< std::string, int >	m_reused
	messages: rejused events
int	m_rejectedCount = 0
	counter for suppressing "rejected event" messages
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

New beam background mixer; this one doesn't need ROF files.

Definition at line 31 of file BeamBkgMixerModule.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.

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

BeamBkgMixerModule()

BeamBkgMixerModule

(

)

Constructor.

Definition at line 54 of file BeamBkgMixerModule.cc.

                                       : Module()
{
  // set module description (e.g. insert text)
  setDescription("Beam background mixer at SimHit level that uses beam background"
                 " simulation output directly (collision files) and not ROF files. "
                 "Each background event is shifted in time randomly within "
                 "a time window specified with minTime and maxTime.");
 
  // Add parameters
  addParam("backgroundFiles", m_backgroundFiles,
           "List of background (collision) files (wildcards not allowed - "
           "use python glob.glob() to expand to list of files)");
  addParam("minTime", m_minTime,
           "Time window lower edge in nano seconds", -1000.0);
  addParam("maxTime", m_maxTime,
           "Time window upper edge in nano seconds", 800.0);
  addParam("overallScaleFactor", m_overallScaleFactor,
           "Overall factor to scale rates of backgrounds", 1.0);
  addParam("scaleFactors", m_scaleFactors,
           "Factors to scale rates of backgrounds. "
           "Possible tag names: " + m_bgTypes.getBGTypes(),
           m_scaleFactors);
  addParam("components", m_components,
           "Detector components to be included, empty list means all components",
           m_components);
  addParam("wrapAround", m_wrapAround,
           "if true wrap around events passing time window upper edge", true);
  addParam("minTimeECL", m_minTimeECL,
           "Time window lower edge for ECL in nano seconds", -17600.0);
  addParam("maxTimeECL", m_maxTimeECL,
           "Time window upper edge for ECL in nano seconds", 8500.0);
  addParam("minTimePXD", m_minTimePXD,
           "Time window lower edge for PXD in nano seconds", -10000.0);
  addParam("maxTimePXD", m_maxTimePXD,
           "Time window upper edge for PXD in nano seconds", 10000.0);
 
  addParam("beambackhits", m_BeamBackHits,
           "If true also add the BeamBackHits collection for the selected "
           "subdetectors to the output file", false);
 
  addParam("maxEdepECL", m_maxEdepECL,
           "maximal deposited energy of ECLHit to accept BG event for mixing"
           "(0 means accept all events)", 1.0);
 
  addParam("cacheSize", m_cacheSize,
           "file cache size in Mbytes. If negative, use root default", 0);
}

~BeamBkgMixerModule()

~BeamBkgMixerModule ( )

virtual

Destructor.

Definition at line 102 of file BeamBkgMixerModule.cc.

{
}

Member Function Documentation

acceptEvent()

bool acceptEvent ( TClonesArray *  cloneArrayECL )

private

Checks for deposited energy of ECLHits and returns true if Edep < m_maxEdepECL.

Parameters

cloneArrayECL

pointer to TClonesArray of ECLHits

Returns

true if all ECLHits have deposited energy below m_maxEdepECL

Definition at line 542 of file BeamBkgMixerModule.cc.

{
  if (!cloneArrayECL) return true;
  if (m_maxEdepECL == 0) return true;
 
  int numEntries = cloneArrayECL->GetEntriesFast();
  for (int i = 0; i < numEntries; i++) {
    ECLHit* simHit = static_cast<ECLHit*>(cloneArrayECL->AddrAt(i));
    if (simHit->getEnergyDep() > m_maxEdepECL) return false;
  }
  return true;
}

addBeamBackHits()

void addBeamBackHits ( StoreArray< HIT > &  hits, TClonesArray *  cloneArray, double  timeShift, double  minTime, double  maxTime  )

inlineprivate

functions that add BeamBackHits to those in the DataStore

Parameters

hits	a reference to DataStore BeamBackHits
cloneArray	a pointer to BeamBackHits read from a file
timeShift	time shift to be applied to BeamBackHits
minTime	time window left edge
maxTime	time window right edge

Definition at line 194 of file BeamBkgMixerModule.h.

    {
      // Match SubDet id from BeamBackHits to whether we keep it or not
      bool keep[] = {false, m_PXD, m_SVD, m_CDC, m_ARICH, m_TOP, m_ECL, m_KLM};
      if (!cloneArray) return;
      if (!hits.isValid()) return;
      // this is basically a copy of addSimHits but we only add the
      // BeamBackHits from the specified sub detectors so we have to check
      // each if it is from one of the enabled subdetectors
      int numEntries = cloneArray->GetEntriesFast();
      for (int i = 0; i < numEntries; i++) {
        HIT* bkgHit =  static_cast<HIT*>(cloneArray->AddrAt(i));
        //Only keep selected
        if (!keep[bkgHit->getSubDet()]) continue;
        HIT* hit = hits.appendNew(*bkgHit);
        hit->shiftInTime(timeShift);
        //TODO: BeamBackHits does not have a setBackgroundTag so we do not
        //check or set it
        if (m_wrapAround) {
          double time = hit->getTime();
          if (time > maxTime) {
            double windowSize = maxTime - minTime;
            double shift = int((time - minTime) / windowSize) * windowSize;
            hit->shiftInTime(-shift);
          }
        }
      }
    }

addSimHits()

void addSimHits ( StoreArray< SIMHIT > &  simHits, TClonesArray *  cloneArray, double  timeShift, double  minTime, double  maxTime  )

inlineprivate

functions that add background SimHits to those in the DataStore

Parameters

simHits	a reference to DataStore SimHits
cloneArray	a pointer to background SimHits read from a file
timeShift	time shift to be applied to background SimHits
minTime	time window left edge
maxTime	time window right edge

Definition at line 157 of file BeamBkgMixerModule.h.

    {
      if (!cloneArray) return;
      if (!simHits.isValid()) return;
 
      int numEntries = cloneArray->GetEntriesFast();
      for (int i = 0; i < numEntries; i++) {
        SIMHIT* bkgSimHit = static_cast<SIMHIT*>(cloneArray->AddrAt(i));
        SIMHIT* simHit = simHits.appendNew(*bkgSimHit);
        simHit->shiftInTime(timeShift);
        if (simHit->getBackgroundTag() == 0) // should be properly set at bkg simulation
          simHit->setBackgroundTag(BackgroundMetaData::bg_other);
        if (m_wrapAround) {
          double time = simHit->getGlobalTime();
          if (time > maxTime) {
            double windowSize = maxTime - minTime;
            double shift = int((time - minTime) / windowSize) * windowSize;
            simHit->shiftInTime(-shift);
          }
        }
      }
 
    }

appendSample()

void appendSample ( BackgroundMetaData::BG_TAG  bkgTag, const std::string &  bkgType, const std::string &  fileName, double  realTime, BackgroundMetaData::EFileType  fileTyp  )

private

appends background sample to m_backgrounds

Parameters

bkgTag	background tag
bkgType	background type
fileName	file name
realTime	real time that corresponds to background sample
fileTyp	file type

Definition at line 520 of file BeamBkgMixerModule.cc.

{
  for (auto& bkg : m_backgrounds) {
    if (tag == bkg.tag and fileType == bkg.fileType) {
      bkg.fileNames.push_back(fileName);
      bkg.realTime += realTime;
      return;
    }
  }
  std::string ftype = type;
  if (fileType == BackgroundMetaData::c_ECL) ftype += "(ECL)";
  if (fileType == BackgroundMetaData::c_PXD) ftype += "(PXD)";
  unsigned index = m_backgrounds.size();
  m_backgrounds.push_back(BkgFiles(tag, ftype, fileName, realTime,
                                   m_overallScaleFactor, fileType, index));
}

beginRun()

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Set run dependent things like run header parameters, alignment, etc.

Reimplemented from Module.

Definition at line 337 of file BeamBkgMixerModule.cc.

{
}

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;
}

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 425 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 438 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 431 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 419 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 444 of file Module.h.

{ terminate(); }

endRun()

void endRun ( void  )

overridevirtual

End-of-run action.

Save run-related stuff, such as statistics.

Reimplemented from Module.

Definition at line 484 of file BeamBkgMixerModule.cc.

{
}

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

overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 341 of file BeamBkgMixerModule.cc.

{
  StoreArray<PXDSimHit> pxdSimHits;
  StoreArray<SVDSimHit> svdSimHits;
  StoreArray<CDCSimHit> cdcSimHits;
  StoreArray<TOPSimHit> topSimHits;
  StoreArray<ARICHSimHit> arichSimHits;
  StoreArray<ECLHit> eclHits;
  StoreArray<KLMSimHit> klmSimHits;
  StoreArray<BeamBackHit> beamBackHits;
  StoreObjPtr<BackgroundInfo> bkgInfo("", DataStore::c_Persistent);
 
  for (auto& bkg : m_backgrounds) {
 
    if (bkg.fileType != BackgroundMetaData::c_Usual) continue;
 
    double mean = bkg.rate * (m_maxTime - m_minTime);
    int nev = gRandom->Poisson(mean);
 
    for (int iev = 0; iev < nev; iev++) {
      double timeShift = gRandom->Rndm() * (m_maxTime - m_minTime) + m_minTime;
      bkg.tree->GetEntry(bkg.eventCount);
 
      if (acceptEvent(m_simHits.ECL)) {
        addSimHits(pxdSimHits, m_simHits.PXD, timeShift, m_minTime, m_maxTime);
        addSimHits(svdSimHits, m_simHits.SVD, timeShift, m_minTime, m_maxTime);
        addSimHits(cdcSimHits, m_simHits.CDC, timeShift, m_minTime, m_maxTime);
        addSimHits(topSimHits, m_simHits.TOP, timeShift, m_minTime, m_maxTime);
        addSimHits(arichSimHits, m_simHits.ARICH, timeShift, m_minTime, m_maxTime);
        addSimHits(eclHits, m_simHits.ECL, timeShift, m_minTime, m_maxTime);
        addSimHits(klmSimHits, m_simHits.KLM, timeShift, m_minTime, m_maxTime);
        addBeamBackHits(beamBackHits, m_simHits.BeamBackHits, timeShift,
                        m_minTime, m_maxTime);
      } else {
        iev--;
        std::string message = "BeamBkgMixer: event " + to_string(bkg.eventCount)
                              + " of " + bkg.type + " rejected due to large energy deposit in ECL";
        m_rejected[message] += 1;
        m_rejectedCount++;
        if (m_rejectedCount < 10) {
          B2INFO("BeamBkgMixer: event rejected due to large energy deposit in ECL");
        } else if (m_rejectedCount == 10) {
          B2INFO("BeamBkgMixer: event rejected due to large energy deposit in ECL "
                 << "(message will be suppressed now)");
        }
      }
 
      bkg.eventCount++;
      if (bkg.eventCount >= bkg.numEvents) {
        bkg.eventCount = 0;
        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be reused";
        m_reused[message] += 1;
        if (m_reused[message] == 1) B2INFO(message);
        bkgInfo->incrementReusedCounter(bkg.index);
      }
    }
  }
 
 
  for (auto& bkg : m_backgrounds) {
 
    if (bkg.fileType != BackgroundMetaData::c_ECL) continue;
 
    double mean = bkg.rate * (m_maxTimeECL - m_minTimeECL);
    int nev = gRandom->Poisson(mean);
 
    for (int iev = 0; iev < nev; iev++) {
      double timeShift = gRandom->Rndm() * (m_maxTimeECL - m_minTimeECL) + m_minTimeECL;
      if (timeShift > m_minTime and timeShift < m_maxTime) continue;
      bkg.tree->GetEntry(bkg.eventCount);
 
      if (acceptEvent(m_simHits.ECL)) {
        double minTime = m_minTimeECL;
        double maxTime = m_maxTimeECL;
        if (timeShift <= m_minTime) {
          maxTime = m_minTime;
        } else {
          minTime = m_maxTime;
        }
        addSimHits(eclHits, m_simHits.ECL, timeShift, minTime, maxTime);
      } else {
        iev--;
        std::string message = "BeamBkgMixer: event " + to_string(bkg.eventCount)
                              + " of " + bkg.type + " rejected due to large energy deposit in ECL";
        m_rejected[message] += 1;
        m_rejectedCount++;
        if (m_rejectedCount < 10) {
          B2INFO("BeamBkgMixer: event rejected due to large energy deposit in ECL");
        } else if (m_rejectedCount == 10) {
          B2INFO("BeamBkgMixer: event rejected due to large energy deposit in ECL "
                 << "(message will be suppressed now)");
        }
      }
 
      bkg.eventCount++;
      if (bkg.eventCount >= bkg.numEvents) {
        bkg.eventCount = 0;
        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be reused";
        m_reused[message] += 1;
        if (m_reused[message] == 1) B2INFO(message);
        bkgInfo->incrementReusedCounter(bkg.index);
      }
    }
 
  }
 
 
  for (auto& bkg : m_backgrounds) {
 
    if (bkg.fileType != BackgroundMetaData::c_PXD) continue;
 
    double mean = bkg.rate * (m_maxTimePXD - m_minTimePXD);
    int nev = gRandom->Poisson(mean);
 
    for (int iev = 0; iev < nev; iev++) {
      double timeShift = gRandom->Rndm() * (m_maxTimePXD - m_minTimePXD) + m_minTimePXD;
      if (timeShift > m_minTime and timeShift < m_maxTime) continue;
      bkg.tree->GetEntry(bkg.eventCount);
 
      double minTime = m_minTimePXD;
      double maxTime = m_maxTimePXD;
      if (timeShift <= m_minTime) {
        maxTime = m_minTime;
      } else {
        minTime = m_maxTime;
      }
      addSimHits(pxdSimHits, m_simHits.PXD, timeShift, minTime, maxTime);
 
      bkg.eventCount++;
      if (bkg.eventCount >= bkg.numEvents) {
        bkg.eventCount = 0;
        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be reused";
        m_reused[message] += 1;
        if (m_reused[message] == 1) B2INFO(message);
        bkgInfo->incrementReusedCounter(bkg.index);
      }
    }
 
  }
 
}

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 paths */
  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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  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 323 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 313 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 201 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 133 of file Module.h.

    {
      return std::vector<std::string>();
    }

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 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 186 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 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 362 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 380 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 310 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 377 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://xwiki.desy.de/xwiki/rest/p/a94f2 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 ( void  )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 106 of file BeamBkgMixerModule.cc.

{
 
  // included components
 
  std::vector<std::string> components = m_components;
  m_PXD = isComponentIncluded(components, "PXD");
  m_SVD = isComponentIncluded(components, "SVD");
  m_CDC = isComponentIncluded(components, "CDC");
  m_TOP = isComponentIncluded(components, "TOP");
  m_ARICH = isComponentIncluded(components, "ARICH");
  m_ECL = isComponentIncluded(components, "ECL");
  m_KLM = isComponentIncluded(components, "KLM");
 
  // ignore these ones
 
  isComponentIncluded(components, "MagneticField2d");
  isComponentIncluded(components, "MagneticField3d");
  isComponentIncluded(components, "MagneticField");
  isComponentIncluded(components, "MagneticFieldConstant4LimitedRCDC");
  isComponentIncluded(components, "MagneticFieldConstant4LimitedRSVD");
  isComponentIncluded(components, "BeamPipe");
  isComponentIncluded(components, "Cryostat");
  isComponentIncluded(components, "FarBeamLine");
  isComponentIncluded(components, "HeavyMetalShield");
  isComponentIncluded(components, "COIL");
  isComponentIncluded(components, "STR");
  isComponentIncluded(components, "VXDService");
 
  if (!components.empty()) {
    std::string str;
    for (unsigned i = 0; i < components.size(); ++i) str = str + " " + components[i];
    B2WARNING("Unknown components:" << str);
  }
 
  // check files and append them to sample container
 
  for (auto file : m_backgroundFiles) {
 
    // wildcarding is not allowed anymore
    if (TString(file.c_str()).Contains("*")) {
      B2ERROR(file << ": wildcards are not allowed");
      continue;
    }
 
    // check the file existence
    TFile* f = TFile::Open(file.c_str(), "READ");
    if (!f) {
      B2ERROR(file << ": file not found");
      continue;
    }
    if (!f->IsOpen()) {
      B2ERROR(file << ": can't open file");
      continue;
    }
    f->Close();
 
    TChain persistent("persistent");
    int nFiles = persistent.Add(file.c_str());
    if (nFiles == 0) {
      B2ERROR(file << ": no such files");
      continue;
    }
    if (persistent.GetEntries() == 0) {
      B2ERROR(file << ": tree 'persistent' has no entries");
      continue;
    }
 
    TObject* bkgMetaData = 0; // Note: allocation left to root
    TBranch* branchBMD = persistent.GetBranch("BackgroundMetaData");
    if (!branchBMD) {
      B2ERROR(file << ": branch 'BackgroundMetaData' not found");
      continue;
    }
    branchBMD->SetAddress(&bkgMetaData);
 
    std::vector<BackgroundMetaData::BG_TAG> tags;
    std::vector<std::string> types;
    std::vector<BackgroundMetaData::EFileType> fileTypes;
    double realTime = 0;
    for (unsigned k = 0; k < persistent.GetEntries(); k++) {
      persistent.GetEntry(k);
      BackgroundMetaData* bgMD = static_cast<BackgroundMetaData*>(bkgMetaData);
      tags.push_back(bgMD->getBackgroundTag());
      types.push_back(bgMD->getBackgroundType());
      fileTypes.push_back(bgMD->getFileType());
      realTime += bgMD->getRealTime();
    }
    if (realTime <= 0) {
      B2ERROR(file << ": invalid realTime: " << realTime);
      continue;
    }
    for (unsigned i = 1; i < tags.size(); ++i) {
      if (tags[i] != tags[0]) {
        B2ERROR(file << ": files with mixed background types not supported");
        continue;
      }
    }
    for (unsigned i = 1; i < fileTypes.size(); ++i) {
      if (fileTypes[i] != fileTypes[0]) {
        B2ERROR(file << ": files with mixed file types not supported");
        continue;
      }
    }
 
    appendSample(tags[0], types[0], file, realTime, fileTypes[0]);
 
  }
 
 
  // set scale factors
 
  for (auto scaleFactor : m_scaleFactors) {
    std::string type = std::get<0>(scaleFactor);
    if (m_bgTypes.getTag(type) == 0)
      B2ERROR("Unknown beam background type found in 'scaleFactors': " << type << "\n"
              "Possible are: " + m_bgTypes.getBGTypes());
    for (auto& bkg : m_backgrounds) {
      if (bkg.tag == m_bgTypes.getTag(type))
        bkg.scaleFactor *= std::get<1>(scaleFactor);
    }
  }
 
  // open files for reading SimHits
 
  for (auto& bkg : m_backgrounds) {
 
    // define TChain for reading SimHits
    bkg.tree.reset(new TChain("tree"));
    for (unsigned i = 0; i < bkg.fileNames.size(); ++i) {
      bkg.numFiles += bkg.tree->Add(bkg.fileNames[i].c_str());
    }
 
    bkg.numEvents = bkg.tree->GetEntries();
    bkg.rate =  bkg.numEvents / bkg.realTime * bkg.scaleFactor;
 
    if (m_cacheSize >= 0) bkg.tree->SetCacheSize(m_cacheSize * 1024 * 1024);
 
    if (m_PXD and bkg.tree->GetBranch("PXDSimHits"))
      bkg.tree->SetBranchAddress("PXDSimHits", &m_simHits.PXD);
    if (m_SVD and bkg.tree->GetBranch("SVDSimHits"))
      bkg.tree->SetBranchAddress("SVDSimHits", &m_simHits.SVD);
    if (m_CDC and bkg.tree->GetBranch("CDCSimHits"))
      bkg.tree->SetBranchAddress("CDCSimHits", &m_simHits.CDC);
    if (m_TOP and bkg.tree->GetBranch("TOPSimHits"))
      bkg.tree->SetBranchAddress("TOPSimHits", &m_simHits.TOP);
    if (m_ARICH and bkg.tree->GetBranch("ARICHSimHits"))
      bkg.tree->SetBranchAddress("ARICHSimHits", &m_simHits.ARICH);
    if (m_ECL and bkg.tree->GetBranch("ECLHits"))
      bkg.tree->SetBranchAddress("ECLHits", &m_simHits.ECL);
    if (m_KLM and bkg.tree->GetBranch("KLMSimHits"))
      bkg.tree->SetBranchAddress("KLMSimHits", &m_simHits.KLM);
 
    if (m_BeamBackHits and bkg.tree->GetBranch("BeamBackHits"))
      bkg.tree->SetBranchAddress("BeamBackHits", &m_simHits.BeamBackHits);
 
    // print INFO
    std::string unit(" ns");
    double realTime = bkg.realTime;
    if (realTime >= 1000.0) {realTime /= 1000.0; unit = " us";}
    if (realTime >= 1000.0) {realTime /= 1000.0; unit = " ms";}
    if (realTime >= 1000.0) {realTime /= 1000.0; unit = " s";}
 
    B2INFO("BeamBkgMixer: " << bkg.type <<
           " tag=" << bkg.tag <<
           " files=" << bkg.numFiles <<
           " events=" << bkg.numEvents <<
           " realTime=" << realTime << unit <<
           " scaleFactor=" << bkg.scaleFactor <<
           " rate=" << bkg.rate * 1000 << " MHz");
  }
 
 
  // SimHits registration
 
  StoreArray<PXDSimHit> pxdSimHits;
  if (m_PXD) pxdSimHits.registerInDataStore();
 
  StoreArray<SVDSimHit> svdSimHits;
  if (m_SVD) svdSimHits.registerInDataStore();
 
  StoreArray<CDCSimHit> cdcSimHits;
  if (m_CDC) cdcSimHits.registerInDataStore();
 
  StoreArray<TOPSimHit> topSimHits;
  if (m_TOP) topSimHits.registerInDataStore();
 
  StoreArray<ARICHSimHit> arichSimHits;
  if (m_ARICH) arichSimHits.registerInDataStore();
 
  StoreArray<ECLHit> eclHits;
  if (m_ECL) eclHits.registerInDataStore();
 
  StoreArray<KLMSimHit> klmSimHits;
  if (m_KLM) klmSimHits.registerInDataStore();
 
  StoreArray<BeamBackHit> beamBackHits;
  if (m_BeamBackHits) beamBackHits.registerInDataStore();
 
 
  // add BackgroundInfo to persistent tree
 
  StoreObjPtr<BackgroundInfo> bkgInfo("", DataStore::c_Persistent);
  bkgInfo.registerInDataStore();
  bkgInfo.create();
  bkgInfo->setMethod(BackgroundInfo::c_Mixing);
  bkgInfo->setComponents(m_components);
  bkgInfo->setMinTime(m_minTime);
  bkgInfo->setMaxTime(m_maxTime);
  bkgInfo->setMinTimeECL(m_minTimeECL);
  bkgInfo->setMaxTimeECL(m_maxTimeECL);
  bkgInfo->setMinTimePXD(m_minTimePXD);
  bkgInfo->setMaxTimePXD(m_maxTimePXD);
  bkgInfo->setWrapAround(m_wrapAround);
  bkgInfo->setMaxEdepECL(m_maxEdepECL);
  for (auto& bkg : m_backgrounds) {
    BackgroundInfo::BackgroundDescr descr;
    descr.tag = bkg.tag;
    descr.type = bkg.type;
    descr.fileType = bkg.fileType;
    descr.fileNames = bkg.fileNames;
    descr.realTime = bkg.realTime;
    descr.numEvents = bkg.numEvents;
    descr.scaleFactor = bkg.scaleFactor;
    descr.rate = bkg.rate;
    descr.reused = 0;
    bkgInfo->appendBackgroundDescr(descr);
  }
 
}

isComponentIncluded()

bool isComponentIncluded ( std::vector< std::string > &  components, const std::string &  component  )

private

Returns true if a component is found in components or the list is empty.

If found a component is erased from components.

Parameters

components	list of components to be included
component	the name of detector component to check

Returns

true if component found in components

Definition at line 507 of file BeamBkgMixerModule.cc.

{
  if (m_components.empty()) return true;
  auto iterator = std::find(components.begin(), components.end(), component);
  if (iterator != components.end()) {
    components.erase(iterator);
    return true;
  }
  return false;
}

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 229 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 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 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 ( void  )

overridevirtual

Termination action.

Clean-up, close files, summarize statistics, etc.

Reimplemented from Module.

Definition at line 488 of file BeamBkgMixerModule.cc.

{
 
  B2INFO("BeamBkgMixer - reused samples:");
  for (const auto& message : m_reused) {
    B2INFO(message.first << "(occurred " << message.second << " times)");
  }
  B2INFO("BeamBkgMixer - rejected events:");
  for (const auto& message : m_rejected) {
    B2INFO(message.first << "(occurred " << message.second << " times)");
  }
 
  for (auto& bkg : m_backgrounds) {
    bkg.tree.reset();
  }
 
}

Member Data Documentation

m_ARICH

bool m_ARICH = false

private

true if found in m_components

Definition at line 277 of file BeamBkgMixerModule.h.

m_backgroundFiles

std::vector<std::string> m_backgroundFiles

private

names of beam background files

Definition at line 256 of file BeamBkgMixerModule.h.

m_backgrounds

std::vector<BkgFiles> m_backgrounds

private

container for background samples

Definition at line 270 of file BeamBkgMixerModule.h.

m_BeamBackHits

bool m_BeamBackHits = false

private

if true add also background hits

Definition at line 280 of file BeamBkgMixerModule.h.

m_bgTypes

background::BeamBGTypes m_bgTypes

private

defined BG types

Definition at line 282 of file BeamBkgMixerModule.h.

m_cacheSize

int m_cacheSize

private

file cache size in Mbytes

Definition at line 268 of file BeamBkgMixerModule.h.

m_CDC

bool m_CDC = false

private

true if found in m_components

Definition at line 275 of file BeamBkgMixerModule.h.

m_components

std::vector<std::string> m_components

private

detector components

Definition at line 261 of file BeamBkgMixerModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_ECL

bool m_ECL = false

private

true if found in m_components

Definition at line 278 of file BeamBkgMixerModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

m_KLM

bool m_KLM = false

private

true if found in m_components

Definition at line 279 of file BeamBkgMixerModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

m_maxEdepECL

double m_maxEdepECL

private

maximal allowed deposited energy in ECL

Definition at line 267 of file BeamBkgMixerModule.h.

m_maxTime

double m_maxTime

private

maximal time shift of background event

Definition at line 260 of file BeamBkgMixerModule.h.

m_maxTimeECL

double m_maxTimeECL

private

maximal time shift of background event for ECL

Definition at line 264 of file BeamBkgMixerModule.h.

m_maxTimePXD

double m_maxTimePXD

private

maximal time shift of background event for PXD

Definition at line 266 of file BeamBkgMixerModule.h.

m_minTime

double m_minTime

private

minimal time shift of background event

Definition at line 259 of file BeamBkgMixerModule.h.

m_minTimeECL

double m_minTimeECL

private

minimal time shift of background event for ECL

Definition at line 263 of file BeamBkgMixerModule.h.

m_minTimePXD

double m_minTimePXD

private

minimal time shift of background event for PXD

Definition at line 265 of file BeamBkgMixerModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 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 507 of file Module.h.

m_overallScaleFactor

double m_overallScaleFactor

private

overall scale factor

Definition at line 257 of file BeamBkgMixerModule.h.

m_package

std::string m_package

privateinherited

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

Definition at line 509 of file Module.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 511 of file Module.h.

m_PXD

bool m_PXD = false

private

true if found in m_components

Definition at line 273 of file BeamBkgMixerModule.h.

m_rejected

std::map<std::string, int> m_rejected

private

messages: rejected events

Definition at line 284 of file BeamBkgMixerModule.h.

m_rejectedCount

int m_rejectedCount = 0

private

counter for suppressing "rejected event" messages

Definition at line 286 of file BeamBkgMixerModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

m_reused

std::map<std::string, int> m_reused

private

messages: rejused events

Definition at line 285 of file BeamBkgMixerModule.h.

m_scaleFactors

std::vector<std::tuple<std::string, double> > m_scaleFactors

private

scale factors

Definition at line 258 of file BeamBkgMixerModule.h.

m_simHits

BkgHits m_simHits

private

input event buffer

Definition at line 271 of file BeamBkgMixerModule.h.

m_SVD

bool m_SVD = false

private

true if found in m_components

Definition at line 274 of file BeamBkgMixerModule.h.

m_TOP

bool m_TOP = false

private

true if found in m_components

Definition at line 276 of file BeamBkgMixerModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

m_wrapAround

bool m_wrapAround

private

if true wrap around events in the tail after maxTime

Definition at line 262 of file BeamBkgMixerModule.h.

---

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

• background/modules/BeamBkgMixer/include/BeamBkgMixerModule.h
• background/modules/BeamBkgMixer/src/BeamBkgMixerModule.cc