ECLLocalRunCalibratorModule is the module developed to perform ECL local run calibration. More...

#include <ECLLocalRunCalibratorModule.h>

Inheritance diagram for ECLLocalRunCalibratorModule:

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

	~ECLLocalRunCalibratorModule ()
	Destructor.

void	beginRun () override
	Begin run.

void	event () override
	Event.

void	endRun () override
	End run.

virtual void	initialize ()
	Initialize the Module.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.

virtual void	terminate ()
	This method is called at the end of the event processing.

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
int16_t	getTimeShift (const ECLDigit &digit) const
	Calculate time shift.

uint32_t	decodeTrigTime (uint32_t time) const
	Decode time.

void	writeHistoToFile ()
	Write histograms to file in the case, if the histogram filling mode is enabled.

void	writeCalibResultsToDB ()
	Write calibration results into a database.

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_isFillHisto
	If m_isFillHisto is false, than the mode of local run calibration is enabled.

int	m_cellid
	cell id number.

std::string	m_histoFileName
	The path of the .root file with the histograms obtained in the histogram filling mode.

float	m_minTime
	Minimum allowed time value.

float	m_maxTime
	Maximum allowed time value.

float	m_minAmpl
	Minimum allowed amplitude value.

float	m_maxAmpl
	Maximum allowed amplitude value.

int	m_devs
	Number of standard deviations used to update value limits.

std::string	m_dbName
	Tag of central database or path to a local database.

bool	m_isLocal
	Enables local database usage.

bool	m_changePrev
	If m_changePrev is true, the validity intervals of the previous payloads stored into the database will be changed.

bool	m_addref
	If m_addref is true, then the current calibration run will be marked as reference run immediately after saving to the database.

TH1F *	m_histo_time {nullptr}
	m_histo_time is the name of the histogram, which contains time distribution for a certain cell id.

TH1F *	m_histo_ampl {nullptr}
	m_histo_ampl is the name of the histogram, which contains amplitude distribution for a certain cell id.

int	m_lowRun
	Low run of the validity interval.

int	m_highRun
	High run of the validity interval.

ECLLocalRunCalibUnit *	m_time
	m_time contains time mean value and standard deviation accumulators for all cell ids.

ECLLocalRunCalibUnit *	m_ampl
	m_ampl contains amplitude mean value and standard deviation accumulators for all cell ids.

StoreObjPtr< EventMetaData >	m_EventMetaData
	Event metadata.

StoreArray< ECLDigit >	m_ECLDigits
	ECL digits.

bool	m_fulltree
	Write full tree of times and amplitudes per each cellid (before calculating mean values) to file "ecl_local_run_fulltree.root".

TTree *	m_tree {nullptr}
	Full tree of times and amplitudes per each cellid before calculating mean values.

int	m_tree_cellid {0}
	Cellid variable used to fill tree.

float	m_tree_time {0}
	Time variable used to fill tree.

float	m_tree_ampl {0}
	Amplitude variable used to fill tree.

int	m_tree_event {0}
	Event variable used to fill tree.

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.

Static Private Attributes
static const int	c_ncellids = ECLElementNumbers::c_NCrystals
	Number of cell ids.

static const std::string	c_timePayloadName = "ECLCalibTime"
	Name of the time payload.

static const std::string	c_amplPayloadName = "ECLCalibAmplitude"
	Name of the amplitude payload.

Detailed Description

ECLLocalRunCalibratorModule is the module developed to perform ECL local run calibration.

Definition at line 38 of file ECLLocalRunCalibratorModule.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

◆ ECLLocalRunCalibratorModule()

ECLLocalRunCalibratorModule ( )

Constructor.

Definition at line 36 of file ECLLocalRunCalibratorModule.cc.

                                                        :
  m_time(nullptr), m_ampl(nullptr)
{
  // Module description.
  setDescription("ECL Local Run Calibration.");
  // Initial lower limit for time.
  addParam("minTime", m_minTime, "Initial lower limit for time.", -500.f);
  // Initial upper limit for time.
  addParam("maxTime", m_maxTime, "Initial upper limit for time.", 500.f);
  // Initial lower limit for amplitude.
  addParam("minAmpl", m_minAmpl, "Initial lower limit for amplitude.", 1.e+04f);
  // Initial upper limit for amplitude.
  addParam("maxAmpl", m_maxAmpl, "Initial upper limit for amplitude.", 3.e+04f);
  // Number of standard deviations
  // used to update lower and
  // upper value limits.
  addParam("nOfStdDevs", m_devs,
           "Number of standard deviations used to form initial limits.", 5);
  // Boolean flag used to choose local or central DB.
  addParam("isLocal", m_isLocal, "Boolean flag used to"
           "select local or central DB.", true);
  // Default path to a local database.
  std::string defaultDBName = "localdb/database.txt";
  // Central DB name or path to a local DB.
  addParam("dbName", m_dbName, "Central DB name or path "
           "to a local DB.", defaultDBName);
  // Used to change validity intervals in the previous run.
  addParam("changePrev", m_changePrev,
           "If changePrev is set, the upper run in the interval of "
           "validity for the previous written payload will be changed.",
           false);
  // Low run for the current validity interval.
  addParam("lowRun", m_lowRun,
           "Low run for validity interval. "
           "If the low run value is negative, "
           "current run number "
           "is used as a low run.", -1);
  // High run for the current validity interval.
  addParam("highRun", m_highRun,
           "High run for validity interval. "
           "If the high run value is equal to -1, "
           "the high run of validity interval is not limited.",
           -1);
  // Mark current run as reference.
  addParam("addRef", m_addref,
           "Mark run as reference if it is"
           "needed to do that at start",
           false);
  // Enables histogram filling mode.
  addParam("fillHisto", m_isFillHisto,
           "Fill time and amplitude histograms"
           "for a certain cell id.", false);
  // Cell id.
  addParam("cellid", m_cellid,
           "Cell id number, used to "
           "fill amplitude or time histogram.");
  // Default file name used to save histograms,
  // obtained in the histogram filling mode.
  const std::string defaultHistoFileName =
    "time_ampl_histo.root";
  // File name used to save histograms,
  // obtained in the histogram filling mode.
  addParam("histoFileName", m_histoFileName,
           "File name used to save amplitude and time"
           "histograms for a certain cell id.",
           defaultHistoFileName);
  // Enables full tree writing mode.
  addParam("fulltree", m_fulltree,
           "Fill full tree.", false);
}

◆ ~ECLLocalRunCalibratorModule()

~ECLLocalRunCalibratorModule ( )

Destructor.

Definition at line 107 of file ECLLocalRunCalibratorModule.cc.

{
  if (m_time) {
    delete m_time;
  }
  if (m_ampl) {
    delete m_ampl;
  }
}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

Begin run.

Reimplemented from Module.

Definition at line 117 of file ECLLocalRunCalibratorModule.cc.

{
  if (m_isFillHisto) {
    // Histogram filling mode.
    // Creating histograms, which will
    // be contain time and amplitude distributions
    // for a certain cell id.
    m_histo_time = new TH1F("histo_time", "", 10000, -1, -1);
    m_histo_ampl = new TH1F("histo_ampl", "", 10000, -1, -1);
  } else {
    // Local run calibration mode.
    // Creating objects, which will be contain
    // time and amplitude accumulators for all
    // cell ids.
    m_time = new ECLLocalRunCalibUnit(c_ncellids,
                                      m_minTime, m_maxTime,
                                      &m_devs);
    m_ampl = new ECLLocalRunCalibUnit(c_ncellids,
                                      m_minAmpl, m_maxAmpl,
                                      &m_devs);
    if (m_fulltree) {
      m_tree = new TTree("localrun", "");
      m_tree->Branch("cellid", &m_tree_cellid,
                     "m_tree_cellid/I");
      m_tree->Branch("time", &m_tree_time,
                     "time/F");
      m_tree->Branch("ampl", &m_tree_ampl,
                     "ampl/F");
      m_tree_event = 0;
      m_tree->Branch("event", &m_tree_event,
                     "event/I");
    }
  }
}

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

◆ decodeTrigTime()

uint32_t decodeTrigTime ( uint32_t time ) const

inlineprivate

Decode time.

Parameters

time	is the raw time value.

Definition at line 294 of file ECLLocalRunCalibratorModule.cc.

{
  // Bits magic by
  // Vladimir Zhulanov.
  return time - 2 * (time / 8);
}

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

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

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

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

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

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

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

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

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

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

This method is called at the end of the event processing.

Definition: Module.h:176

◆ endRun()

void endRun ( void )

overridevirtual

End run.

Reimplemented from Module.

Definition at line 250 of file ECLLocalRunCalibratorModule.cc.

{
  if (m_isFillHisto) {
    // Histogram filling mode.
    // Writing histograms to file.
    writeHistoToFile();
  } else {
    // Local run calibration
    // mode.
    // Getting accumulated
    // mean values and
    // standard deviations.
    m_time->calc();
    m_ampl->calc();
    // Saving calibration results
    // into a database.
    writeCalibResultsToDB();
    if (m_fulltree) {
      auto fl = TFile::Open("/ghi/fs01/belle2/bdata/group/detector/ECL/local-run-db/data-full/ecl_local_run_fulltree.root",
                            "recreate");
      fl->cd();
      m_tree->Write();
      fl->Close();
      delete m_tree;
    }
  }
}

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

Reimplemented from Module.

Definition at line 152 of file ECLLocalRunCalibratorModule.cc.

{
  // Getting amplitude and time input values.
  if (!m_ECLDigits.isValid()) {
    B2FATAL("ECLDigits not valid");
  }
  // Loop over the input array.
  for (const auto& digit : m_ECLDigits) {
    // Getting cell id and setting the
    // corresponding index.
    auto cellid = digit.getCellId();
    auto index = cellid - 1;
    // Check that the cell id is valid.
    if (index < 0 || index >= signed(c_ncellids)) {
      B2FATAL("ECLLocalRunCalibratorModule::event(): cell id = "
              << cellid << " out of range!");
    }
    // Getting raw time and decoding it.
    auto time = digit.getTimeFit();
    auto shiftedTime = time + getTimeShift(digit);
    // Getting amplitude.
    auto ampl = digit.getAmp();
    if (m_isFillHisto) {
      // Histogram filling mode.
      // Filling time and amplitude
      // histograms for a certain
      // cell id.
      if (cellid == m_cellid) {
        m_histo_time->Fill(shiftedTime);
        m_histo_ampl->Fill(ampl);
      }
    } else {
      // Local run calibration mode.
      // Accumulating time mean
      // values and standard deviations.
      m_time->add(index, shiftedTime);
      // Accumulating amplitude mean
      // values and standard deviations.
      m_ampl->add(index, ampl);
      if (m_fulltree) {
        m_tree_cellid = cellid;
        m_tree_time = shiftedTime;
        m_tree_ampl = ampl;
        m_tree->Fill();
      }
      // Enabling negative value alarm,
      // if there are negative amplitudes.
      if (ampl < 0) {
        m_ampl->enableNegAmpl();
      }
    }
  }
 
  if (m_fulltree) {
    m_tree_event++;
  }
}

◆ 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://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 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.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

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

225{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.

506{ 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.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{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.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getTimeShift()

int16_t getTimeShift ( const ECLDigit & digit ) const

private

Calculate time shift.

Parameters

digit is input time ecl digit.

Definition at line 279 of file ECLLocalRunCalibratorModule.cc.

{
  auto trig =
    static_cast<uint32_t>(
      digit.getRelationsTo<ECLTrig>()[0]->getTimeTrig());
  switch (decodeTrigTime(trig) % 3) {
    case 1 : return 8;
    case 2 : return -8;
  }
  return 0;
}

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

311{ 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.

378{ 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()

virtual void initialize ( void )

inlinevirtualinherited

Initialize the Module.

This method is called once before the actual event processing starts. Use this method to initialize variables, open files etc.

This method can be implemented by subclasses.

Definition at line 109 of file Module.h.

109{};

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

230{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.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ 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()

virtual void terminate ( void )

inlinevirtualinherited

This method is called at the end of the event processing.

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Definition at line 176 of file Module.h.

176{};

◆ writeCalibResultsToDB()

void writeCalibResultsToDB ( )

private

Write calibration results into a database.

Definition at line 224 of file ECLLocalRunCalibratorModule.cc.

{
  // Getting experiment and run
  // numbers.
  int exp = m_EventMetaData->getExperiment();
  int run = m_EventMetaData->getRun();
  int lowrun;
  // Setting low run
  // of validity interval.
  if (m_lowRun < 0) {
    lowrun = run;
  } else {
    lowrun = m_lowRun;
  }
  // Creating validity interval.
  IntervalOfValidity iov(exp, lowrun, exp, m_highRun);
  // Saving time payload.
  m_time->writeToDB(m_isLocal, m_dbName,
                    c_timePayloadName, iov,
                    run, m_changePrev, m_addref);
  // Saving amplitude payload.
  m_ampl->writeToDB(m_isLocal, m_dbName,
                    c_amplPayloadName, iov,
                    run, m_changePrev, m_addref);
}

◆ writeHistoToFile()

void writeHistoToFile ( )

private

Write histograms to file in the case, if the histogram filling mode is enabled.

Definition at line 212 of file ECLLocalRunCalibratorModule.cc.

{
  TFile fl(m_histoFileName.c_str(), "recreate");
  fl.cd();
  m_histo_time->Write();
  m_histo_ampl->Write();
  fl.Close();
  delete m_histo_time;
  delete m_histo_ampl;
}

Member Data Documentation

◆ c_amplPayloadName

const std::string c_amplPayloadName = "ECLCalibAmplitude"

staticprivate

Name of the amplitude payload.

Definition at line 176 of file ECLLocalRunCalibratorModule.h.

◆ c_ncellids

const int c_ncellids = ECLElementNumbers::c_NCrystals

staticprivate

Number of cell ids.

Definition at line 74 of file ECLLocalRunCalibratorModule.h.

◆ c_timePayloadName

const std::string c_timePayloadName = "ECLCalibTime"

staticprivate

Name of the time payload.

Definition at line 172 of file ECLLocalRunCalibratorModule.h.

◆ m_addref

bool m_addref

private

If m_addref is true, then the current calibration run will be marked as reference run immediately after saving to the database.

Definition at line 150 of file ECLLocalRunCalibratorModule.h.

◆ m_ampl

ECLLocalRunCalibUnit* m_ampl

private

m_ampl contains amplitude mean value and standard deviation accumulators for all cell ids.

Definition at line 194 of file ECLLocalRunCalibratorModule.h.

◆ m_cellid

int m_cellid

private

cell id number.

This variable is used only in the histogram filling mode.

Definition at line 91 of file ECLLocalRunCalibratorModule.h.

◆ m_changePrev

bool m_changePrev

private

If m_changePrev is true, the validity intervals of the previous payloads stored into the database will be changed.

The default validity interval for the certain run is [certain run number, -1 == inf). The validity interval for the previous run will be changer form [previous run number, -1) to [previous run number, current run number - 1)

Definition at line 142 of file ECLLocalRunCalibratorModule.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_dbName

std::string m_dbName

private

Tag of central database or path to a local database.

Definition at line 125 of file ECLLocalRunCalibratorModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_devs

int m_devs

private

Number of standard deviations used to update value limits.

Definition at line 120 of file ECLLocalRunCalibratorModule.h.

◆ m_ECLDigits

StoreArray<ECLDigit> m_ECLDigits

private

ECL digits.

Definition at line 202 of file ECLLocalRunCalibratorModule.h.

◆ m_EventMetaData

StoreObjPtr<EventMetaData> m_EventMetaData

private

Event metadata.

Definition at line 198 of file ECLLocalRunCalibratorModule.h.

◆ m_fulltree

bool m_fulltree

private

Write full tree of times and amplitudes per each cellid (before calculating mean values) to file "ecl_local_run_fulltree.root".

Definition at line 209 of file ECLLocalRunCalibratorModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_highRun

int m_highRun

private

High run of the validity interval.

Definition at line 184 of file ECLLocalRunCalibratorModule.h.

◆ m_histo_ampl

TH1F* m_histo_ampl {nullptr}

private

m_histo_ampl is the name of the histogram, which contains amplitude distribution for a certain cell id.

This histogram will be filled only if the histogram filling mode is enabled.

Definition at line 168 of file ECLLocalRunCalibratorModule.h.

◆ m_histo_time

TH1F* m_histo_time {nullptr}

private

m_histo_time is the name of the histogram, which contains time distribution for a certain cell id.

This histogram will be filled only if the histogram filling mode is enabled.

Definition at line 159 of file ECLLocalRunCalibratorModule.h.

◆ m_histoFileName

std::string m_histoFileName

private

The path of the .root file with the histograms obtained in the histogram filling mode.

Definition at line 98 of file ECLLocalRunCalibratorModule.h.

◆ m_isFillHisto

bool m_isFillHisto

private

If m_isFillHisto is false, than the mode of local run calibration is enabled.

If m_isFillHisto is true, than the mode of histogram filling mode is enabled. In the second case, the only output result of the module is the file with the amplitude and time distributions for a certain cell id (m_cellid) in a certain run.

Definition at line 85 of file ECLLocalRunCalibratorModule.h.

◆ m_isLocal

bool m_isLocal

private

Enables local database usage.

Definition at line 130 of file ECLLocalRunCalibratorModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_lowRun

int m_lowRun

private

Low run of the validity interval.

Definition at line 180 of file ECLLocalRunCalibratorModule.h.

◆ m_maxAmpl

float m_maxAmpl

private

Maximum allowed amplitude value.

Definition at line 114 of file ECLLocalRunCalibratorModule.h.

◆ m_maxTime

float m_maxTime

private

Maximum allowed time value.

Definition at line 106 of file ECLLocalRunCalibratorModule.h.

◆ m_minAmpl

float m_minAmpl

private

Minimum allowed amplitude value.

Definition at line 110 of file ECLLocalRunCalibratorModule.h.

◆ m_minTime

float m_minTime

private

Minimum allowed time value.

Definition at line 102 of file ECLLocalRunCalibratorModule.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_package

std::string m_package

privateinherited

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

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

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_time

ECLLocalRunCalibUnit* m_time

private

m_time contains time mean value and standard deviation accumulators for all cell ids.

Definition at line 189 of file ECLLocalRunCalibratorModule.h.

◆ m_tree

TTree* m_tree {nullptr}

private

Full tree of times and amplitudes per each cellid before calculating mean values.

Definition at line 215 of file ECLLocalRunCalibratorModule.h.

◆ m_tree_ampl

float m_tree_ampl {0}

private

Amplitude variable used to fill tree.

Definition at line 230 of file ECLLocalRunCalibratorModule.h.

◆ m_tree_cellid

int m_tree_cellid {0}

private

Cellid variable used to fill tree.

Definition at line 220 of file ECLLocalRunCalibratorModule.h.

◆ m_tree_event

int m_tree_event {0}

private

Event variable used to fill tree.

Definition at line 235 of file ECLLocalRunCalibratorModule.h.

◆ m_tree_time

float m_tree_time {0}

private

Time variable used to fill tree.

Definition at line 225 of file ECLLocalRunCalibratorModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

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

ecl/modules/eclLocalRunCalibration/include/ECLLocalRunCalibratorModule.h
ecl/modules/eclLocalRunCalibration/src/ECLLocalRunCalibratorModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLLocalRunCalibratorModule()

◆ ~ECLLocalRunCalibratorModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ decodeTrigTime()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getTimeShift()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

◆ writeCalibResultsToDB()

◆ writeHistoToFile()

Member Data Documentation

◆ c_amplPayloadName

◆ c_ncellids

◆ c_timePayloadName

◆ m_addref

◆ m_ampl

◆ m_cellid

◆ m_changePrev

◆ m_conditions

◆ m_dbName