eclBhabhaTimeCalibrationValidationCollectorModule Class Reference

This module generates 'TimevsCrys' histogram to later (in eclBhabhaTAlgorithm) find time offset from bhabha events. More...

#include <eclBhabhaTimeCalibrationValidationCollectorModule.h>

Inheritance diagram for eclBhabhaTimeCalibrationValidationCollectorModule:

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
	eclBhabhaTimeCalibrationValidationCollectorModule ()
	Module constructor.
virtual	~eclBhabhaTimeCalibrationValidationCollectorModule ()
	Module destructor.
void	inDefineHisto () override
	Replacement for defineHisto() in CalibrationCollector modules.
void	prepare () override
	Define histograms and read payloads from DB.
void	collect () override
	Select events and crystals and accumulate histograms.
void	initialize () final
	Set up a default RunRange object in datastore and call prepare()
void	event () final
	Check current experiment and run and update if needed, fill into RunRange and collect()
void	beginRun () final
	Reset the m_runCollectOnRun flag, if necessary, to begin collection again.
void	endRun () final
	Write the current collector objects to a file and clear their memory.
void	terminate () final
	Write the final objects to the file.
void	defineHisto () final
	Runs due to HistoManager, allows us to discover the correct file.
template<class T >
void	registerObject (std::string name, T *obj)
	Register object with a name, takes ownership, do not access the pointer beyond prepare()
template<class T >
T *	getObjectPtr (std::string name)
	Calls the CalibObjManager to get the requested stored collector data.
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	startRun ()
	Replacement for beginRun(). Do anything you would normally do in beginRun here.
virtual void	closeRun ()
	Replacement for endRun(). Do anything you would normally do in endRun here.
virtual void	finish ()
	Replacement for terminate(). Do anything you would normally do in terminate here.
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.

Protected Attributes
TDirectory *	m_dir
	The top TDirectory that collector objects for this collector will be stored beneath.
CalibObjManager	m_manager
	Controls the creation, collection and access to calibration objects.
RunRange *	m_runRange
	Overall list of runs processed.
Calibration::ExpRun	m_expRun
	Current ExpRun for object retrieval (becomes -1,-1 for granularity=all)
StoreObjPtr< EventMetaData >	m_emd
	Current EventMetaData.

Private Member Functions
bool	getPreScaleChoice ()
	I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values.
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
bool	m_saveTree
	If true, save TTree with more detailed event info.
StoreArray< Track >	tracks
	Required input array of tracks.
StoreArray< ECLCluster >	m_eclClusterArray
	Required input array of ECLClusters.
StoreArray< ECLCalDigit >	m_eclCalDigitArray
	Required input array of ECLCalDigits.
std::unique_ptr< Belle2::ECL::ECLChannelMapper >	m_crystalMapper
	ECL object for keeping track of mapping between crystals and crates etc.
StoreObjPtr< EventMetaData >	m_EventMetaData
	Event metadata.
StoreObjPtr< SoftwareTriggerResult >	m_TrgResult
	Store array for Trigger selection.
StoreObjPtr< EventT0 >	m_eventT0
	StoreObjPtr for T0.
TTree *	m_dbg_tree_electronClusters
	debug output tree for per electron cluster
TTree *	m_dbg_tree_event
	debug output tree for per event
TTree *	m_dbg_tree_run
	debug output tree for per run
int	m_tree_evt_num = -1
	Event number for debug TTree output.
int	m_tree_run = -1
	Run number for debug TTree output.
int	m_tree_cid = -1
	ECL Cell ID (1..ECLElementNumbers::c_NCrystals) for debug TTree output.
double	m_tree_dt99 = -1
	dt99 for cluster
double	m_tree_time = -1
	Calibrated time.
double	m_tree_time_fromE0 = -1
	Calibrated time - highest E cluster.
double	m_tree_time_fromE1 = -1
	Calibrated time - second highest E cluster.
double	m_tree_E0 = -1
	Highest E cluster energy.
double	m_tree_E1 = -1
	second highest E cluster energy
double	m_tree_t0 = -1
	EventT0 (not from ECL) for debug TTree output.
double	m_tree_t0_unc = -1
	EventT0 uncertainty for debug TTree output.
int	m_NtightTracks = -1
	Number of tight tracks.
DBObjPtr< ECLCrystalCalib >	m_CrateTimeDB
	database object
std::vector< float >	m_CrateTime
	vector obtained from DB object
std::vector< float >	m_CrateTimeUnc
	uncertainty vector obtained from DB object
DBObjPtr< Belle2::ECLChannelMap >	m_channelMapDB
	Mapper of ecl channels to various other objects, like crates.
int	m_tree_crateid = -1
	Crate ID for debug TTree output.
double	m_tree_tcrate = -1
	Crate time for debug TTree output.
double	m_tree_tcrate_unc = -1
	Crate time uncertainty for debug TTree output.
int	m_tree_PreviousRun = -1
	Run number for the previous run for debug TTree output.
std::vector< float >	m_EperCrys
	ECL Cal digit energy for each crystal.
double	m_E_electron_clust = -1
	Electron cluster energy.
short	m_timeAbsMax
	Events with abs(time) > m_timeAbsMax are excluded, mostly for histogram x-range purposes.
double	m_looseTrkZ0
	Loose track z0 minimum cut.
double	m_tightTrkZ0
	Tight track z0 minimum cut.
double	m_looseTrkD0
	Loose track d0 minimum cut.
double	m_tightTrkD0
	Tight track d0 minimum cut.
bool	skipTrgSel
	flag to skip the trigger skim selection in the module
std::string	m_granularity
	Granularity of data collection = run|all(= no granularity, exp,run=-1,-1)
int	m_maxEventsPerRun
	Maximum number of events to be collected at the start of each run (-1 = no maximum)
float	m_preScale
	Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].
StoreObjPtr< EventMetaData >	m_evtMetaData
	Required input for EventMetaData.
bool	m_runCollectOnRun = true
	Whether or not we will run the collect() at all this run, basically skips the event() function if false.
std::map< Calibration::ExpRun, int >	m_expRunEvents
	How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.
int *	m_eventsCollectedInRun
	Will point at correct value in m_expRunEvents.
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

This module generates 'TimevsCrys' histogram to later (in eclBhabhaTAlgorithm) find time offset from bhabha events.

Definition at line 41 of file eclBhabhaTimeCalibrationValidationCollectorModule.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

eclBhabhaTimeCalibrationValidationCollectorModule()

eclBhabhaTimeCalibrationValidationCollectorModule

(

)

Module constructor.

Definition at line 59 of file eclBhabhaTimeCalibrationValidationCollectorModule.cc.

                                                                                                     :
  CalibrationCollectorModule(),
  m_dbg_tree_electronClusters(0),
  m_dbg_tree_event(0),
  m_dbg_tree_run(0),
  m_CrateTimeDB("ECLCrateTimeOffset"),
  m_channelMapDB("ECLChannelMap")//,
{
  setDescription("This module validates the ECL cluster times");
 
  addParam("timeAbsMax", m_timeAbsMax, // (Time in ns)
           "Events with fabs(getTimeFit) > m_timeAbsMax "
           "are excluded", (short)80);
 
  addParam("saveTree", m_saveTree,
           "If true, TTree 'tree' with more detailed event info is saved in "
           "the output file specified by HistoManager",
           false);
 
  addParam("looseTrkZ0", m_looseTrkZ0, "max Z0 for loose tracks (cm)", 10.);
  addParam("tightTrkZ0", m_tightTrkZ0, "max Z0 for tight tracks (cm)", 2.);
  addParam("looseTrkD0", m_looseTrkD0, "max D0 for loose tracks (cm)", 2.);
  addParam("tightTrkD0", m_tightTrkD0, "max D0 for tight tracks (cm)", 0.5);  // beam pipe radius = 1cm in 2019
  addParam("skipTrgSel", skipTrgSel, "boolean to skip the trigger skim selection", false);
 
 
  // specify this flag if you need parallel processing
  setPropertyFlags(c_ParallelProcessingCertified);
}

~eclBhabhaTimeCalibrationValidationCollectorModule()

~eclBhabhaTimeCalibrationValidationCollectorModule ( )

virtual

Module destructor.

Definition at line 89 of file eclBhabhaTimeCalibrationValidationCollectorModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

finalvirtualinherited

Reset the m_runCollectOnRun flag, if necessary, to begin collection again.

It seems that the beginRun() function is called in each basf2 subprocess when the run changes in each process. This is nice because it allows us to write the new (exp,run) object creation in the beginRun function as though the other processes don't exist.

Reimplemented from HistoModule.

Definition at line 77 of file CalibrationCollectorModule.cc.

{
  // Current (Exp,Run)
  ExpRun expRun = make_pair(m_emd->getExperiment(), m_emd->getRun());
  m_runRange->add(expRun.first, expRun.second);
 
  // Do we care about the number of events collected in each (input data) ExpRun?
  // If so, we want to create values for the events collected map
  if (m_maxEventsPerRun > -1) {
    // Do we have a count for this ExpRun yet? If not create one
    auto i_eventsInExpRun = m_expRunEvents.find(expRun);
    if (i_eventsInExpRun == m_expRunEvents.end()) {
      m_expRunEvents[expRun] = 0;
    }
 
    // Set our pointer to the correct location for this ExpRun
    m_eventsCollectedInRun = &m_expRunEvents[expRun];
    // Want to reset our flag to start collection if necessary
    if ((*m_eventsCollectedInRun) < m_maxEventsPerRun) {
      B2INFO("New run has had less events than the maximum collected so far ("
             << (*m_eventsCollectedInRun)
             << " < "
             << m_maxEventsPerRun
             << "). Turning on collection.");
      m_runCollectOnRun = true;
    } else {
      B2INFO("New run has had more events than the maximum collected so far ("
             << (*m_eventsCollectedInRun)
             << " >= "
             << m_maxEventsPerRun
             << "). Turning off collection.");
      m_runCollectOnRun = false;
    }
  }
  // Granularity=all removes data spliting by runs by setting
  // always the same exp, run for calibration data objects
  if (m_granularity == "all") {
    m_expRun = { -1, -1};
  } else {
    m_expRun = expRun;
  }
  m_manager.createExpRunDirectories(m_expRun);
  // Run the user's startRun() implementation if there is one
  startRun();
}

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

closeRun()

virtual void closeRun ( )

inlineprotectedvirtualinherited

Replacement for endRun(). Do anything you would normally do in endRun here.

Reimplemented in TOPValidationCollectorModule, MillepedeCollectorModule, CaTestModule, CDCCrudeT0CollectorModule, eclAutocovarianceCalibrationC1CollectorModule, eclAutocovarianceCalibrationC3CollectorModule, eclAutocovarianceCalibrationC4CollectorModule, eclWaveformTemplateCalibrationC1CollectorModule, KLMChannelStatusCollectorModule, KLMStripEfficiencyCollectorModule, SVDCrossTalkCalibrationsCollectorModule, and SVDOccupancyCalibrationsCollectorModule.

Definition at line 77 of file CalibrationCollectorModule.h.

{}

collect()

void collect ( )

overridevirtual

Select events and crystals and accumulate histograms.

< vector derived from DB object

< vector derived from DB object

< number of loose tracks

< number of tight tracks

Reimplemented from CalibrationCollectorModule.

Definition at line 208 of file eclBhabhaTimeCalibrationValidationCollectorModule.cc.

{
  int cutIndexPassed = 0;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: no cuts: index = " << cutIndexPassed);
 
 
  // --- Check the trigger skim is the type that has two tracks
 
  /* If we skip the trigger skim selection then still fill the cutflow histogram
     just so that the positions don't change. */
  if (!skipTrgSel) {
    if (!m_TrgResult.isValid()) {
      B2WARNING("SoftwareTriggerResult required to select bhabha event is not found");
      return;
    }
 
    /* Release05: bhabha_all is grand skim = bhabha+bhabhaecl+radee.  We only want
       to look at the 2 track bhabha events. */
    const std::map<std::string, int>& fresults = m_TrgResult->getResults();
    if (fresults.find("software_trigger_cut&skim&accept_bhabha") == fresults.end()) {
      B2WARNING("Can't find required bhabha trigger identifier");
      return;
    }
 
    const bool eBhabha = (m_TrgResult->getResult("software_trigger_cut&skim&accept_bhabha") ==
                          SoftwareTriggerCutResult::c_accept);
    B2DEBUG(22, "eBhabha (trigger passed) = " << eBhabha);
 
    if (!eBhabha) {
      return;
    }
  }
 
  /*  Fill the histgram showing that the trigger skim cut passed OR that we
      are skipping this selection. */
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: Trigger cut passed: index = " << cutIndexPassed);
 
 
 
 
 
  /* Use ECLChannelMapper to get other detector indices for the crystals
     For conversion from CellID to crate, shaper, and channel ids.
     The initialization function automatically checks to see if the
     object has been initialized and ifthe payload has changed and
     thus needs updating. */
  bool ECLchannelMapHasChanged = m_channelMapDB.hasChanged();
  if (ECLchannelMapHasChanged) {
    B2INFO("eclBhabhaTimeCalibrationValidationCollectorModule::collect() " << LogVar("ECLchannelMapHasChanged",
           ECLchannelMapHasChanged));
    if (!m_crystalMapper->initFromDB()) {
      B2FATAL("eclBhabhaTimeCalibrationValidationCollectorModule::collect() : Can't initialize eclChannelMapper!");
    }
  }
 
 
 
 
 
  B2DEBUG(29, "Finished checking if previous crystal time payload has changed");
 
  if (m_CrateTimeDB.hasChanged()) {
    m_CrateTime = m_CrateTimeDB->getCalibVector();
    m_CrateTimeUnc = m_CrateTimeDB->getCalibUncVector();
  }
 
  B2DEBUG(25, "eclBhabhaTimeCalibrationValidationCollector:: loaded ECLCrateTimeOffset from the database"
          << LogVar("IoV", m_CrateTimeDB.getIoV())
          << LogVar("Checksum", m_CrateTimeDB.getChecksum()));
 
  // Conversion coefficient from ADC ticks to nanoseconds
  // TICKS_TO_NS ~ 0.4931 ns/clock tick
  // 1/(4fRF) = 0.4913 ns/clock tick, where fRF is the accelerator RF frequency
  const double TICKS_TO_NS = 1.0 / (4.0 * EclConfiguration::getRF()) * 1e3;
 
 
  vector<float> Crate_time_ns(52, 0.0); 
  vector<float> Crate_time_unc_ns(52, 0.0); 
  // Make a crate time offset vector with an entry per crate (instead of per crystal) and convert from ADC counts to ns.
  for (int crysID = 1; crysID <= ECLElementNumbers::c_NCrystals; crysID++) {
    int crateID_temp = m_crystalMapper->getCrateID(crysID);
    Crate_time_ns[crateID_temp - 1] = m_CrateTime[crysID] * TICKS_TO_NS;
    Crate_time_unc_ns[crateID_temp - 1] = m_CrateTimeUnc[crysID] * TICKS_TO_NS;
  }
 
 
 
  // Storage crystal energies
  m_EperCrys.resize(ECLElementNumbers::c_NCrystals);
  for (auto& eclCalDigit : m_eclCalDigitArray) {
    int tempCrysID = eclCalDigit.getCellId() - 1;
    m_EperCrys[tempCrysID] = eclCalDigit.getEnergy();
  }
 
 
  // Getting the event t0 using the full event t0 rather than from the CDC specifically
 
  double evt_t0 = -1000 ;
  double evt_t0_unc = -1000 ;
 
  // Determine if there is an event t0 to use and then extract the information about it
  if (m_eventT0.isOptional()) {
    if (!m_eventT0.isValid()) {
      return;
    }
    if (!m_eventT0->hasEventT0()) {
      return;
    } else {
      // Overall event t0 (combination of multiple event t0s from different detectors)
      evt_t0 = m_eventT0->getEventT0() ;
      evt_t0_unc = m_eventT0->getEventT0Uncertainty() ;
    }
    B2DEBUG(26, "Found event t0") ;
  }
 
 
  //---------------------------------------------------------------------
  //..Some utilities
  PCmsLabTransform boostrotate;
 
  //---------------------------------------------------------------------
  //..Track properties. Use pion (211) mass hypothesis,
  //     which is the only particle hypothesis currently available???
  double maxp[2] = {0., 0.};
  int maxiTrk[2] = { -1, -1};
  int nTrkAll = tracks.getEntries() ;
 
  int nTrkLoose = 0 ; 
  int nTrkTight = 0 ; 
  /* Loop over all the tracks to define the tight and loose selection tracks
     We will select events with only 2 tight tracks and no additional loose tracks.
     Tight tracks are a subset of looses tracks. */
  for (int iTrk = 0 ; iTrk < nTrkAll ; iTrk++) {
    // Get track biasing towards the particle being a pion based on what particle types
    // are used for reconstruction at this stage.
    const TrackFitResult* tempTrackFit = tracks[iTrk]->getTrackFitResultWithClosestMass(Const::pion);
    if (not tempTrackFit) {continue ;}
 
    // Collect track info to be used for categorizing
    short charge = tempTrackFit->getChargeSign() ;
    double z0 = tempTrackFit->getZ0() ;
    double d0 = tempTrackFit->getD0() ;
    int nCDChits = tempTrackFit->getHitPatternCDC().getNHits() ;
    double p = tempTrackFit->getMomentum().R() ;
 
    /* Test if loose track  */
 
    // d0 and z0 cuts
    if (fabs(d0) > m_looseTrkD0) {
      continue;
    }
    if (fabs(z0) > m_looseTrkZ0) {
      continue;
    }
    // Number of hits in the CDC
    if (nCDChits < 1) {
      continue;
    }
    nTrkLoose++;
 
 
 
    /* Test if the loose track is also a tight track */
 
    // Number of hits in the CDC
    if (nCDChits < 20) {
      continue;
    }
    // d0 and z0 cuts
    if (fabs(d0) > m_tightTrkD0) {
      continue;
    }
    if (fabs(z0) > m_tightTrkZ0) {
      continue;
    }
    nTrkTight++;
 
    // Sorting of tight tracks.  Not really required as we only want two tight tracks (at the moment) but okay.
    //..Find the maximum p negative [0] and positive [1] tracks
    int icharge = 0;
    if (charge > 0) {icharge = 1;}
    if (p > maxp[icharge]) {
      maxp[icharge] = p;
      maxiTrk[icharge] = iTrk;
    }
 
  }
  /* After that last section the numbers of loose and tight tracks are known as well as the
     index of the loose tracks that have the highest p negatively charged and highest p positively
     charged tracks as measured in the centre of mass frame */
 
 
  if (nTrkTight != 2) {
    return;
  }
  // There are exactly two tight tracks
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: Two tight tracks: index = " << cutIndexPassed);
 
 
  if (nTrkLoose != 2) {
    return;
  }
  // There are exactly two loose tracks as well, i.e. no additional loose tracks
  cutIndexPassed++ ;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed) ;
  B2DEBUG(22, "Cutflow: No additional loose tracks: index = " << cutIndexPassed) ;
  /* Determine if the two tracks have the opposite electric charge.
     We know this because the track indices stores the max pt track in [0] for negatively charged track
     and [1] fo the positively charged track.  If both are filled then both a negatively charged
     and positively charged track were found.   */
  bool oppositelyChargedTracksPassed = maxiTrk[0] != -1  &&  maxiTrk[1] != -1;
  if (!oppositelyChargedTracksPassed) {
    return;
  }
  // The two tracks have the opposite electric charges.
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: Oppositely charged tracks: index = " << cutIndexPassed);
 
 
 
  //---------------------------------------------------------------------
  /* Determine associated energy clusters to each of the two tracks.  Sum the energies of the
     multiple clusters to each track and find the crystal with the maximum energy within all
     the sets of clusters associated to the tracks.  Extract the good cluster times.*/
  double trkEClustLab[2] = {0., 0.};
  double trkEClustCOM[2] = {0., 0.};
  double trkpLab[2];
  double trkpCOM[2];
  ROOT::Math::PxPyPzEVector trkp4Lab[2];
  ROOT::Math::PxPyPzEVector trkp4COM[2];
 
  // Index of the cluster and the crystal that has the highest energy crystal for the two tracks
  int numClustersPerTrack[2] = { 0, 0 };
  double E_DIV_p[2];
 
  vector<double> goodClustTimes ;
  vector<double> goodClust_dt99 ;
  vector<double> goodClustE ;
  vector<int> goodClustMaxEcrys_cid ;
 
  for (int icharge = 0; icharge < 2; icharge++) {
    if (maxiTrk[icharge] > -1) {
      B2DEBUG(22, "looping over the 2 max pt tracks");
 
      const TrackFitResult* tempTrackFit = tracks[maxiTrk[icharge]]->getTrackFitResultWithClosestMass(Const::pion);
      if (not tempTrackFit) {continue ;}
 
      trkp4Lab[icharge] = tempTrackFit->get4Momentum();
      trkp4COM[icharge] = boostrotate.rotateLabToCms() * trkp4Lab[icharge];
      trkpLab[icharge] = trkp4Lab[icharge].P();
      trkpCOM[icharge] = trkp4COM[icharge].P();
 
 
      /* For each cluster associated to the current track, sum up the energies to get the total
         energy of all clusters associated to the track and find which crystal has the highest
         energy from all those clusters*/
      auto eclClusterRelationsFromTracks = tracks[maxiTrk[icharge]]->getRelationsTo<ECLCluster>();
      for (unsigned int clusterIdx = 0; clusterIdx < eclClusterRelationsFromTracks.size(); clusterIdx++) {
 
        B2DEBUG(22, "Looking at clusters.  index = " << clusterIdx);
        auto cluster = eclClusterRelationsFromTracks[clusterIdx];
 
        if (cluster->hasHypothesis(Belle2::ECLCluster::EHypothesisBit::c_nPhotons)) {
          numClustersPerTrack[icharge]++;
          double eClust = cluster->getEnergy(Belle2::ECLCluster::EHypothesisBit::c_nPhotons);
          double electronTime = cluster->getTime();
          bool badElectronTime = cluster->hasFailedFitTime();
          bool badElectronTimeResolution = cluster->hasFailedTimeResolution();
          if ((fabs(electronTime) < m_timeAbsMax)   &&
              (!badElectronTime)                    &&
              (!badElectronTimeResolution)) {
            trkEClustLab[icharge] += eClust ;
            short cid = cluster->getMaxECellId() ;
            goodClustMaxEcrys_cid.push_back(cid) ;
            goodClustTimes.push_back(electronTime) ;
            goodClust_dt99.push_back(cluster->getDeltaTime99()) ;
            goodClustE.push_back(eClust);
          }
        }
      }
      trkEClustCOM[icharge] = trkEClustLab[icharge] * trkpCOM[icharge] / trkpLab[icharge];
 
      // Check both electrons to see if their cluster energy / track momentum is good.
      // The Belle II physics book shows that this is the main way of separating electrons from other particles
      // Done in the centre of mass reference frame although I believe E/p is invariant under a boost.
      E_DIV_p[icharge] = trkEClustCOM[icharge] / trkpCOM[icharge];
 
    }
  }
  /* At the end of this section the 3-momenta magnitudes and the cluster energies are known
     for the two saved track indices for both the lab and COM frames.
     The crystal with the maximum energy, one associated to each track, is recorded*/
  B2DEBUG(26, "Extracted time information and E/p for the tracks") ;
 
 
 
  /* Cut on the number of ECL cluster connected to tracks
 
     THIS IS DIFFERENT FROM THE CODE THAT PERFORMS THE CALIBRATIONS.  THIS VALIDATIONS REQUIRES
     THAT THERE ARE EXACTLY TWO CLUSTERS ASSOCIATED TO THE TRACKS WHILE THE CALIBRATION
     CODE ALLOWS FOR MORE THAN ONE CLUSTER PER TRACK.  THIS VALIDATION ALSO DOES NOT CUT ON THE
     NUMBER OF EXTRA CLUSTERS NOT ASSOCIATED TO THE 2 TRACKS, WHICH IS A LOOSER CUT THAN USED
     TO PERFORM THE CALIBRATION. */
  long unsigned int numGoodElectronClusters_cut = 2 ;
  if (goodClustTimes.size() != numGoodElectronClusters_cut) {
    return ;
  }
  // There is exactly two ECL clusters connected to tracks in the event
  cutIndexPassed++ ;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed) ;
  B2DEBUG(22, "Cutflow: Exactly " << numGoodElectronClusters_cut
          << " good clusters connected to tracks: index = " << cutIndexPassed);
 
 
  // Check both electrons to see if their cluster energy / track momentum is good.
  // The Belle II physics book shows that this is the main way of separating electrons from other particles
  // Done in the centre of mass reference frame although I believe E/p is invariant under a boost.
  bool E_DIV_p_instance_passed[2] = {false, false};
  double E_DIV_p_CUT = 0.7;
  for (int icharge = 0; icharge < 2; icharge++) {
    E_DIV_p_instance_passed[icharge] = E_DIV_p[icharge] > E_DIV_p_CUT;
  }
  if (!E_DIV_p_instance_passed[0] || !E_DIV_p_instance_passed[1]) {
    return;
  }
  // E/p sufficiently large
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: E_i/p_i > " << E_DIV_p_CUT  << ": index = " << cutIndexPassed);
 
 
 
  // Cut on the invariant mass of the tracks in the event
  double invMassTrk = (trkp4Lab[0] + trkp4Lab[1]).M();
  double invMass_CUT = 0.9;
 
  bool invMassCutsPassed = invMassTrk > (invMass_CUT * boostrotate.getCMSEnergy());
  if (!invMassCutsPassed) {
    return;
  }
  // Invariable mass of the two tracks are above the minimum
  cutIndexPassed++;
  getObjectPtr<TH1F>("cutflow")->Fill(cutIndexPassed);
  B2DEBUG(22, "Cutflow: m(track 1+2) > " << invMass_CUT << "*E_COM = " << invMass_CUT << " * " << boostrotate.getCMSEnergy() <<
          " : index = " << cutIndexPassed);
 
 
  B2DEBUG(22, "Event passed all cuts");
 
 
  // Fill the histogram for the event level variables
  getObjectPtr<TH1F>("eventT0")->Fill(evt_t0) ;
 
  bool isCDCt0 = m_eventT0->isCDCEventT0();
  bool isECLt0 = m_eventT0->isECLEventT0();
  string t0Detector = "UNKNOWN... WHY?";
  if (isCDCt0) {
    t0Detector = "CDC" ;
  } else if (isECLt0) {
    t0Detector = "ECL" ;
  }
 
  B2DEBUG(26, "t0 = " << evt_t0 << " ns.  t0 is from CDC?=" << isCDCt0 << ", t0 is from ECL?=" << isECLt0 << " t0 from " <<
          t0Detector);
 
 
  //=== For each good electron cluster in the processed event and fill histogram.
  for (long unsigned int i = 0 ; i < goodClustTimes.size() ; i++) {
    getObjectPtr<TH1F>("clusterTime")->Fill(goodClustTimes[i]) ;
    getObjectPtr<TH2F>("clusterTime_cid")->Fill(goodClustMaxEcrys_cid[i] + 0.001, goodClustTimes[i], 1) ;
    getObjectPtr<TH2F>("clusterTime_run")->Fill(m_EventMetaData->getRun() + 0.001, goodClustTimes[i], 1) ;
    getObjectPtr<TH2F>("clusterTimeClusterE")->Fill(goodClustE[i], goodClustTimes[i], 1) ;
    getObjectPtr<TH2F>("dt99_clusterE")->Fill(goodClustE[i], goodClust_dt99[i], 1) ;
 
 
    //== Save debug TTree with detailed information if necessary.
    if (m_saveTree) {
 
      m_tree_time      = goodClustTimes[i] ;
      m_tree_t0        = evt_t0 ;
      m_tree_t0_unc    = evt_t0_unc ;
      m_E_electron_clust = goodClustE[i] ;
      m_NtightTracks   = nTrkTight ;
      m_tree_evt_num   = m_EventMetaData->getEvent() ;
      m_tree_run       = m_EventMetaData->getRun() ;
      m_tree_cid       = goodClustMaxEcrys_cid[i] ;
      m_tree_dt99      = goodClust_dt99[i] ;
 
      m_dbg_tree_electronClusters->Fill() ;
 
    }
  }
  B2DEBUG(26, "Filled cluster tree") ;
 
  //=== Fill histogram for cluster time difference of the two electrons
  double tDiff;
  if (goodClustE[0] > goodClustE[1]) {
    tDiff = goodClustTimes[0] - goodClustTimes[1];
  } else {
    tDiff = goodClustTimes[1] - goodClustTimes[0];
  }
 
  getObjectPtr<TH1F>("clusterTimeE0E1diff")->Fill(tDiff) ;
 
 
 
  if (m_saveTree) {
    m_tree_t0          = evt_t0 ;
    m_tree_t0_unc      = evt_t0_unc ;
    m_tree_evt_num     = m_EventMetaData->getEvent() ;
    m_tree_run         = m_EventMetaData->getRun() ;
    m_NtightTracks     = nTrkTight ;
    m_tree_E0          = goodClustE[0] ;
    m_tree_E1          = goodClustE[1] ;
    m_tree_time_fromE0 = goodClustTimes[0] ;
    m_tree_time_fromE1 = goodClustTimes[1] ;
 
    m_dbg_tree_event->Fill() ;
 
 
    int runNum = m_EventMetaData->getRun();
    if (m_tree_PreviousRun != runNum) {
      for (int icrate = 1; icrate <= 52; icrate++) {
        m_tree_run        = runNum ;
        m_tree_crateid    = icrate ;
        m_tree_tcrate     = Crate_time_ns[icrate] ;
        m_tree_tcrate_unc = Crate_time_unc_ns[icrate] ;
 
        m_dbg_tree_run->Fill() ;
      }
      m_tree_PreviousRun = m_tree_run ;
    }
  }
 
  B2DEBUG(26, "Filled event tree") ;
 
}

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

defineHisto()

void defineHisto ( )

finalvirtualinherited

Runs due to HistoManager, allows us to discover the correct file.

Reimplemented from HistoModule.

Definition at line 127 of file CalibrationCollectorModule.cc.

{
  if (!ProcHandler::parallelProcessingUsed() || ProcHandler::isWorkerProcess()) {
    m_dir = gDirectory->mkdir(getName().c_str(), "", true);
    m_manager.setDirectory(m_dir);
    B2INFO("Saving output to TDirectory " << m_dir->GetPath());
    B2DEBUG(100, "Creating directories for individual collector objects.");
    m_manager.createDirectories();
    m_runRange = new RunRange();
    m_runRange->setGranularity(m_granularity);
    m_runRange->SetName(Calibration::RUN_RANGE_OBJ_NAME.c_str());
    m_dir->Add(m_runRange);
  }
  inDefineHisto();
}

endRun()

void endRun ( void  )

finalvirtualinherited

Write the current collector objects to a file and clear their memory.

Reimplemented from HistoModule.

Definition at line 143 of file CalibrationCollectorModule.cc.

{
  closeRun();
  // Moving between runs possibly creates new objects if getObjectPtr is called and granularity is run
  // So we should write and clear the current memory objects.
  if (m_granularity == "run") {
    ExpRun expRun = make_pair(m_emd->getExperiment(), m_emd->getRun());
    m_manager.writeCurrentObjects(expRun);
    m_manager.clearCurrentObjects(expRun);
  }
}

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  )

finalvirtualinherited

Check current experiment and run and update if needed, fill into RunRange and collect()

Reimplemented from HistoModule.

Definition at line 52 of file CalibrationCollectorModule.cc.

{
  // Should we collect data this event based on the number collected in the run?
  if (m_runCollectOnRun) {
    // If yes, does our preScale return true?
    if (getPreScaleChoice()) {
      collect();
      // Since we collected, do we care about incrementing the number of events collected?
      if (m_maxEventsPerRun > -1) {
        (*m_eventsCollectedInRun) += 1;
        // Now that we incremented, have we exceeded our maximum collected events in this run?
        if ((*m_eventsCollectedInRun) >= m_maxEventsPerRun) {
          // If we have, we should skip collection until further notice
          B2INFO("Reached maximum number of events processed by collector for this run ("
                 << (*m_eventsCollectedInRun)
                 << " >= "
                 << m_maxEventsPerRun
                 << "). Turning off collection.");
          m_runCollectOnRun = false;
        }
      }
    }
  }
}

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)

finish()

virtual void finish ( )

inlineprotectedvirtualinherited

Replacement for terminate(). Do anything you would normally do in terminate here.

Reimplemented in MillepedeCollectorModule, CaTestModule, CDCCalibrationCollectorModule, CDCFudgeFactorCalibrationCollectorModule, CDCT0CalibrationCollectorModule, CDCCrudeT0CollectorModule, EKLMAlignmentAlongStripsCollectorModule, KLMStripEfficiencyCollectorModule, KLMTimeCollectorModule, SVDCrossTalkCalibrationsCollectorModule, and SVDOccupancyCalibrationsCollectorModule.

Definition at line 79 of file CalibrationCollectorModule.h.

{}

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 )

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

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

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

getObjectPtr()

T * getObjectPtr ( std::string  name )

inlineinherited

Calls the CalibObjManager to get the requested stored collector data.

Definition at line 64 of file CalibrationCollectorModule.h.

    {
      return m_manager.getObject<T>(name, m_expRun);
    }

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

getPreScaleChoice()

bool getPreScaleChoice ( )

inlineprivateinherited

I'm a little worried about floating point precision when comparing to 0.0 and 1.0 as special values.

But since a user will have set them (or left them as default) as exactly equal to 0.0 or 1.0 rather than calculating them in almost every case, I think we can assume that the equalities hold.

Definition at line 122 of file CalibrationCollectorModule.h.

    {
      if (m_preScale == 1.) {
        return true;
      } else if (m_preScale == 0.) {
        return false;
      } else {
        const double randomNumber = gRandom->Uniform();
        return randomNumber < m_preScale;
      }
    }

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

inDefineHisto()

void inDefineHisto ( )

overridevirtual

Replacement for defineHisto() in CalibrationCollector modules.

Reimplemented from CalibrationCollectorModule.

Definition at line 93 of file eclBhabhaTimeCalibrationValidationCollectorModule.cc.

{
 
}

initialize()

void initialize ( void  )

finalvirtualinherited

Set up a default RunRange object in datastore and call prepare()

Reimplemented from HistoModule.

Definition at line 44 of file CalibrationCollectorModule.cc.

{
  m_evtMetaData.isRequired();
  REG_HISTOGRAM
  prepare();
}

prepare()

void prepare ( )

overridevirtual

Define histograms and read payloads from DB.

Reimplemented from CalibrationCollectorModule.

Definition at line 98 of file eclBhabhaTimeCalibrationValidationCollectorModule.cc.

{
  //=== Prepare TTree for debug output
  if (m_saveTree) {
    // Per electron cluster
    m_dbg_tree_electronClusters = new TTree("tree_electronClusters",
                                            "Validating crystal and crate time calibrations using electron clusters in events with lots of tracks and clusters") ;
    m_dbg_tree_electronClusters->Branch("EventNum", &m_tree_evt_num)   ->SetTitle("Event number") ;
    m_dbg_tree_electronClusters->Branch("cluster_time", &m_tree_time)   ->SetTitle("Cluster time t (calibrated), ns") ;
    m_dbg_tree_electronClusters->Branch("clust_E", &m_E_electron_clust)   ->SetTitle("Electron type cluster energy, GeV") ;
    m_dbg_tree_electronClusters->Branch("t0", &m_tree_t0)     ->SetTitle("T0, ns") ;
    m_dbg_tree_electronClusters->Branch("t0_unc", &m_tree_t0_unc)     ->SetTitle("T0 uncertainty, ns") ;
    m_dbg_tree_electronClusters->Branch("runNum", &m_tree_run)     ->SetTitle("Run number") ;
    m_dbg_tree_electronClusters->Branch("CrystalCellID", &m_tree_cid)    ->SetTitle("Cell ID, 1..8736") ;
    m_dbg_tree_electronClusters->Branch("dt99", &m_tree_dt99)   ->SetTitle("Cluster dt99, ns") ;
    m_dbg_tree_electronClusters->SetAutoSave(10) ;
 
    // Per event
    m_dbg_tree_event = new TTree("tree_event",
                                 "Validating crystal and crate time calibrations using electron clusters in events with lots of tracks and clusters") ;
    m_dbg_tree_event->Branch("EventNum", &m_tree_evt_num)   ->SetTitle("Event number") ;
    m_dbg_tree_event->Branch("t0", &m_tree_t0)     ->SetTitle("T0, ns") ;
    m_dbg_tree_event->Branch("t0_unc", &m_tree_t0_unc)     ->SetTitle("T0 uncertainty, ns") ;
    m_dbg_tree_event->Branch("runNum", &m_tree_run)     ->SetTitle("Run number") ;
    m_dbg_tree_event->Branch("E0", &m_tree_E0)   ->SetTitle("Highest E cluster E") ;
    m_dbg_tree_event->Branch("E1", &m_tree_E1)   ->SetTitle("2nd highest E cluster E") ;
    m_dbg_tree_event->Branch("time_E0", &m_tree_time_fromE0)   ->SetTitle("Cluster time of highest E cluster") ;
    m_dbg_tree_event->Branch("time_E1", &m_tree_time_fromE1)   ->SetTitle("Cluster time of 2nd highest E cluster") ;
    m_dbg_tree_event->SetAutoSave(10) ;
 
 
    // Per run
    m_dbg_tree_run = new TTree("tree_run", "Storing crate time constants") ;
    m_dbg_tree_run->Branch("runNum", &m_tree_run)               ->SetTitle("Run number") ;
    m_dbg_tree_run->Branch("crateid", &m_tree_crateid)          ->SetTitle("Crate ID") ;
    m_dbg_tree_run->Branch("tcrate", &m_tree_tcrate)            ->SetTitle("Crate time") ;
    m_dbg_tree_run->Branch("tcrate_unc", &m_tree_tcrate_unc)    ->SetTitle("Crate time uncertainty") ;
    m_dbg_tree_run->SetAutoSave(10) ;
 
  }
 
 
  //=== MetaData
  B2INFO("eclBhabhaTimeCalibrationValidationCollector: Experiment = " << m_EventMetaData->getExperiment() <<
         "  run = " << m_EventMetaData->getRun()) ;
 
  //=== Create histograms and register them in the data store
 
  // Define the bin size, which is equivalent to the
  double binSize = 2000.0 / pow(2, 12);
  double halfBinSize = binSize / 2.0;
 
  /* Determine the number of bins required to go from the edge of the bin centred
     on zero to a value just larger than the negative cut off */
  double nBinsNeg = floor((m_timeAbsMax - halfBinSize) / binSize);
  double min_t = -nBinsNeg * binSize - halfBinSize; // lower edge value of left most bin
  int nbins = nBinsNeg * 2 + 1; // number of negative time bins + t=0 bin + number of positive time bins
  double max_t = min_t + nbins * binSize; // upper edge value of right most bin
 
  /* Variable bin width information for the time information vs energy since
     the time width should vary as a function of 1/E */
  const Int_t N_E_BIN_EDGES = 64;
  const Int_t N_E_BINS = N_E_BIN_EDGES - 1;
  Double_t energyBinEdges[N_E_BIN_EDGES] = {0, 0.05, 0.051, 0.052, 0.053, 0.054, 0.055, 0.056, 0.057, 0.058, 0.059, 0.06, 0.062, 0.064, 0.066, 0.068, 0.07, 0.075, 0.08, 0.085, 0.09, 0.095, 0.1, 0.11, 0.12, 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 0.19, 0.2, 0.25, 0.3, 0.35, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1, 1.2, 1.4, 1.6, 1.8, 2, 2.25, 2.5, 2.8, 3.2, 3.6, 4, 4.4, 4.8, 5.2, 5.6, 6, 6.4, 6.8, 7.2, 7.6, 8};
 
 
  auto cutflow = new TH1F("cutflow", " ;Cut label number ;Number of events passing cut", 10, 0, 10) ;
  registerObject<TH1F>("cutflow", cutflow) ;
 
  auto clusterTime = new TH1F("clusterTime", ";Electron ECL cluster time [ns]; number of ECL clusters", nbins, min_t, max_t) ;
  registerObject<TH1F>("clusterTime", clusterTime) ;
 
  auto clusterTime_cid = new TH2F("clusterTime_cid",
                                  ";crystal Cell ID ;Electron ECL cluster time [ns]", ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1, nbins,
                                  min_t, max_t) ;
  registerObject<TH2F>("clusterTime_cid", clusterTime_cid) ;
 
  auto clusterTime_run = new TH2F("clusterTime_run",
                                  ";Run number ;Electron ECL cluster time [ns]", 7000, 0, 7000, nbins, min_t, max_t) ;
  registerObject<TH2F>("clusterTime_run", clusterTime_run) ;
 
 
  auto clusterTimeClusterE = new TH2F("clusterTimeClusterE",
                                      ";Electron cluster energy [GeV];Electron cluster time [ns]", N_E_BINS, energyBinEdges, nbins, min_t, max_t) ;
  registerObject<TH2F>("clusterTimeClusterE", clusterTimeClusterE) ;
 
  auto dt99_clusterE = new TH2F("dt99_clusterE",
                                ";Electron cluster energy [GeV];dt99 [ns]", N_E_BINS, energyBinEdges, nbins, 0, max_t) ;
  registerObject<TH2F>("dt99_clusterE", dt99_clusterE) ;
 
 
  auto eventT0 = new TH1F("eventT0", ";event t0 [ns]; number of events", nbins, min_t, max_t) ;
  registerObject<TH1F>("eventT0", eventT0) ;
 
  auto clusterTimeE0E1diff = new TH1F("clusterTimeE0E1diff",
                                      ";ECL cluster time of max E electron - ECL cluster time of 2nd max E electron [ns]; number of electron ECL cluster time differences",
                                      nbins, min_t, max_t) ;
  registerObject<TH1F>("clusterTimeE0E1diff", clusterTimeE0E1diff) ;
 
 
  //=== Required data objects
  tracks.isRequired() ;
  m_eclClusterArray.isRequired() ;
  m_eclCalDigitArray.isRequired() ;
 
 
  B2INFO("skipTrgSel = " << skipTrgSel);
 
}

registerObject()

void registerObject ( std::string  name, T *  obj  )

inlineinherited

Register object with a name, takes ownership, do not access the pointer beyond prepare()

Definition at line 55 of file CalibrationCollectorModule.h.

    {
      std::shared_ptr<T> calObj(obj);
      calObj->SetName(name.c_str());
      m_manager.addObject(name, calObj);
    }

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

startRun()

virtual void startRun ( )

inlineprotectedvirtualinherited

Replacement for beginRun(). Do anything you would normally do in beginRun here.

Reimplemented in TOPValidationCollectorModule, CaTestModule, CDCCrudeT0CollectorModule, eclAutocovarianceCalibrationC1CollectorModule, eclAutocovarianceCalibrationC3CollectorModule, eclAutocovarianceCalibrationC4CollectorModule, eclWaveformTemplateCalibrationC1CollectorModule, eclWaveformTemplateCalibrationC2CollectorModule, KLMStripEfficiencyCollectorModule, PXDClusterChargeCollectorModule, PXDPerformanceCollectorModule, PXDPerformanceVariablesCollectorModule, SVDCrossTalkCalibrationsCollectorModule, SVDOccupancyCalibrationsCollectorModule, SVDClusterTimeShifterCollectorModule, SVDTimeCalibrationCollectorModule, and SVDTimeValidationCollectorModule.

Definition at line 75 of file CalibrationCollectorModule.h.

{}

terminate()

void terminate ( void  )

finalvirtualinherited

Write the final objects to the file.

Reimplemented from HistoModule.

Definition at line 155 of file CalibrationCollectorModule.cc.

{
  finish();
  // actually this should be done by the write() called by HistoManager....
 
  // Haven't written objects yet if collecting with granularity == all
  // Write them now that everything is done.
//  if (m_granularity == "all") {
//    m_manager.writeCurrentObjects(m_expRun);
//    m_manager.clearCurrentObjects(m_expRun);
//  }
  m_manager.deleteHeldObjects();
}

Member Data Documentation

m_channelMapDB

DBObjPtr<Belle2::ECLChannelMap> m_channelMapDB

private

Mapper of ecl channels to various other objects, like crates.

database object

Definition at line 116 of file eclBhabhaTimeCalibrationValidationCollectorModule.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_CrateTime

std::vector<float> m_CrateTime

private

vector obtained from DB object

Definition at line 112 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_CrateTimeDB

DBObjPtr<ECLCrystalCalib> m_CrateTimeDB

private

database object

Definition at line 111 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_CrateTimeUnc

std::vector<float> m_CrateTimeUnc

private

uncertainty vector obtained from DB object

Definition at line 113 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_crystalMapper

std::unique_ptr< Belle2::ECL::ECLChannelMapper> m_crystalMapper

private

Initial value:

=
      std::make_unique<Belle2::ECL::ECLChannelMapper>()

ECL object for keeping track of mapping between crystals and crates etc.

Definition at line 75 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_dbg_tree_electronClusters

TTree* m_dbg_tree_electronClusters

private

debug output tree for per electron cluster

Definition at line 87 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_dbg_tree_event

TTree* m_dbg_tree_event

private

debug output tree for per event

Definition at line 88 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_dbg_tree_run

TTree* m_dbg_tree_run

private

debug output tree for per run

Definition at line 89 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_dir

TDirectory* m_dir

protectedinherited

The top TDirectory that collector objects for this collector will be stored beneath.

Definition at line 84 of file CalibrationCollectorModule.h.

m_E_electron_clust

double m_E_electron_clust = -1

private

Electron cluster energy.

Definition at line 127 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_eclCalDigitArray

StoreArray<ECLCalDigit> m_eclCalDigitArray

private

Required input array of ECLCalDigits.

Definition at line 69 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_eclClusterArray

StoreArray<ECLCluster> m_eclClusterArray

private

Required input array of ECLClusters.

Definition at line 68 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_emd

StoreObjPtr<EventMetaData> m_emd

protectedinherited

Current EventMetaData.

Definition at line 96 of file CalibrationCollectorModule.h.

m_EperCrys

std::vector<float> m_EperCrys

private

ECL Cal digit energy for each crystal.

Definition at line 125 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_EventMetaData

StoreObjPtr<EventMetaData> m_EventMetaData

private

Event metadata.

Definition at line 79 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_eventsCollectedInRun

int* m_eventsCollectedInRun

privateinherited

Will point at correct value in m_expRunEvents.

Definition at line 117 of file CalibrationCollectorModule.h.

m_eventT0

StoreObjPtr<EventT0> m_eventT0

private

StoreObjPtr for T0.

The event t0 class has an overall event t0 so use that as presumably some code has been run to determine what the best t0 is to use.

Definition at line 85 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_evtMetaData

StoreObjPtr<EventMetaData> m_evtMetaData

privateinherited

Required input for EventMetaData.

Definition at line 108 of file CalibrationCollectorModule.h.

m_expRun

Calibration::ExpRun m_expRun

protectedinherited

Current ExpRun for object retrieval (becomes -1,-1 for granularity=all)

Definition at line 93 of file CalibrationCollectorModule.h.

m_expRunEvents

std::map<Calibration::ExpRun, int> m_expRunEvents

privateinherited

How many events processed for each ExpRun so far, stops counting up once max is hit Only used/incremented if m_maxEventsPerRun > -1.

Definition at line 115 of file CalibrationCollectorModule.h.

m_granularity

std::string m_granularity

privateinherited

Granularity of data collection = run|all(= no granularity, exp,run=-1,-1)

Definition at line 101 of file CalibrationCollectorModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_looseTrkD0

double m_looseTrkD0

private

Loose track d0 minimum cut.

Definition at line 135 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_looseTrkZ0

double m_looseTrkZ0

private

Loose track z0 minimum cut.

Definition at line 133 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_manager

CalibObjManager m_manager

protectedinherited

Controls the creation, collection and access to calibration objects.

Definition at line 87 of file CalibrationCollectorModule.h.

m_maxEventsPerRun

int m_maxEventsPerRun

privateinherited

Maximum number of events to be collected at the start of each run (-1 = no maximum)

Definition at line 103 of file CalibrationCollectorModule.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_NtightTracks

int m_NtightTracks = -1

private

Number of tight tracks.

Definition at line 107 of file eclBhabhaTimeCalibrationValidationCollectorModule.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_preScale

float m_preScale

privateinherited

Prescale module parameter, this fraction of events will have collect() run on them [0.0 -> 1.0].

Definition at line 105 of file CalibrationCollectorModule.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_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_runCollectOnRun

bool m_runCollectOnRun = true

privateinherited

Whether or not we will run the collect() at all this run, basically skips the event() function if false.

Definition at line 111 of file CalibrationCollectorModule.h.

m_runRange

RunRange* m_runRange

protectedinherited

Overall list of runs processed.

Definition at line 90 of file CalibrationCollectorModule.h.

m_saveTree

bool m_saveTree

private

If true, save TTree with more detailed event info.

Definition at line 65 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tightTrkD0

double m_tightTrkD0

private

Tight track d0 minimum cut.

Definition at line 136 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tightTrkZ0

double m_tightTrkZ0

private

Tight track z0 minimum cut.

Definition at line 134 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_timeAbsMax

short m_timeAbsMax

private

Events with abs(time) > m_timeAbsMax are excluded, mostly for histogram x-range purposes.

Definition at line 131 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_cid

int m_tree_cid = -1

private

ECL Cell ID (1..ECLElementNumbers::c_NCrystals) for debug TTree output.

Definition at line 95 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_crateid

int m_tree_crateid = -1

private

Crate ID for debug TTree output.

Definition at line 118 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_dt99

double m_tree_dt99 = -1

private

dt99 for cluster

Definition at line 96 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_E0

double m_tree_E0 = -1

private

Highest E cluster energy.

Definition at line 101 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_E1

double m_tree_E1 = -1

private

second highest E cluster energy

Definition at line 102 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_evt_num

int m_tree_evt_num = -1

private

Event number for debug TTree output.

Definition at line 93 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_PreviousRun

int m_tree_PreviousRun = -1

private

Run number for the previous run for debug TTree output.

Definition at line 121 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_run

int m_tree_run = -1

private

Run number for debug TTree output.

Definition at line 94 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_t0

double m_tree_t0 = -1

private

EventT0 (not from ECL) for debug TTree output.

Definition at line 104 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_t0_unc

double m_tree_t0_unc = -1

private

EventT0 uncertainty for debug TTree output.

Definition at line 105 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_tcrate

double m_tree_tcrate = -1

private

Crate time for debug TTree output.

Definition at line 119 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_tcrate_unc

double m_tree_tcrate_unc = -1

private

Crate time uncertainty for debug TTree output.

Definition at line 120 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_time

double m_tree_time = -1

private

Calibrated time.

Definition at line 97 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_time_fromE0

double m_tree_time_fromE0 = -1

private

Calibrated time - highest E cluster.

Definition at line 99 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_tree_time_fromE1

double m_tree_time_fromE1 = -1

private

Calibrated time - second highest E cluster.

Definition at line 100 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

m_TrgResult

StoreObjPtr<SoftwareTriggerResult> m_TrgResult

private

Store array for Trigger selection.

Definition at line 81 of file eclBhabhaTimeCalibrationValidationCollectorModule.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.

skipTrgSel

bool skipTrgSel

private

flag to skip the trigger skim selection in the module

Definition at line 138 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

tracks

StoreArray<Track> tracks

private

Required input array of tracks.

Definition at line 67 of file eclBhabhaTimeCalibrationValidationCollectorModule.h.

---

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

• ecl/modules/eclBhabhaTimeCalibrationValidationCollector/include/eclBhabhaTimeCalibrationValidationCollectorModule.h
• ecl/modules/eclBhabhaTimeCalibrationValidationCollector/src/eclBhabhaTimeCalibrationValidationCollectorModule.cc