Class ECL Trigger Timiing Calibration Module. More...

#include <TrgEclTimingCalibration.h>

Inheritance diagram for TRGECLTimingCalModule:

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

virtual	~TRGECLTimingCalModule ()
	Destructor.

virtual void	initialize () override
	initialize function

virtual void	beginRun () override
	Begin Run function.

virtual void	event () override
	Event function.

virtual void	endRun () override
	End Run function.

virtual void	terminate () override
	Terminate function.

void	Set_TCposition ()
	Set TC position from TRGECLMap.

int	Solve_Matrix ()
	Solve matrix.

int	ReadData ()
	Fill data from.

int	FillMatrix ()
	Fill matrix and vector components.

void	InitParams ()
	Parameters initialization.

void	Save_Result ()
	Save time offset and chisq as a root file.

void	Calculate_Chisq ()
	Calculate chisq based on time offset obtained from "Solve_Matrix" function.

void	TRGECLTimingCalClear ()
	Clear vector every event.

void	GetTimeOffset ()
	Get previous time offsets (iteration mode)

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

const std::string &	getName () const
	Returns the name of the module.

const std::string &	getType () const
	Returns the type of the module (i.e.

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module.

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

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

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module.

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.

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

void	setDescription (const std::string &description)
	Sets the description of the module.

void	setType (const std::string &type)
	Set the module type.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.

void	setReturnValue (int value)
	Sets the return value for this module as integer.

void	setReturnValue (bool value)
	Sets the return value for this module as bool.

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
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
int	fSimulation
	Flag simulation 0 : real data 1 : simulation data.

int	fCalType
	Calibration type 0 : beam 1 : cosmic.

int	f3Dbhabha_veto
	Flag 3D bhabha veto 0 : not use 1 : use.

int	fInclude_FWD
	Flag include forward endcap 0 : exclude FWD 1 : include FWD.

int	fInclude_BR
	Flag include barrel 0 : exclude BR 1 : include BR.

int	fInclude_BWD
	Flag include backward endcap 0 : exclude BWD 1 : include BWD.

int	fIteration
	Flag iteration 0 : first calbiration 1 : iteration.

double	cut_high_energy
	TC energy cut upper limit.

double	cut_low_energy
	TC energy cut lower limit.

int	cut_ntc
	The number of TC cut.

int	TC_ref
	Reference TC whose time offset set to be 0.

int	nevt_selected = 0
	The number of selected events.

int	nevt_read = 0
	The number of read events.

double	TCEnergyCalibrationConstant
	ADC to GeV energy conversion factor.

double	cut_chisq
	TC chisq cut (iteration mode)

std::string	str_default_name = "TCTimeOffset.root"
	Default output root file name.

std::string	str_ofilename
	Output root file name.

std::string	str_timeoffset_fname
	Input time offset file name (iteration mode)

std::vector< int >	TCId
	Trigger Cell TCID.

std::vector< double >	TCEnergy
	TC energy.

std::vector< double >	TCTiming
	TC time.

std::vector< ROOT::Math::XYZVector >	TCPosition
	TC position from TRGECLMap (cosmic calibration)

TMatrixDSym	_Matrix
	Matrix Marix component.

std::vector< std::vector< double > >	Chisq1
	chisq component1

std::vector< std::vector< double > >	Chisq2
	chisq component2

std::vector< std::vector< double > >	Chisq3
	chisq component3

std::vector< int >	Nevent_TC
	The number of uesed TC hit (TC by TC)

std::vector< double >	chisq_result
	Chisq values based on time offset obtained from "Solve_Matrix" function.

TVectorD	_Vector
	Vector component.

std::vector< bool >	b_Inc_TC
	Flag TC included.

std::vector< bool >	b_Exclude_TC
	Flag TC excluded.

std::vector< double >	tcal_result
	Time offset calibration result.

std::vector< double >	tcal_result_err
	Time offset error.

int	FlagMatrixSolved = 0
	Flag matrix solved (0 : not solved 1 : solved)

std::vector< double >	TimeOffset
	Time offset Input time offset (iteration mode)

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

Class ECL Trigger Timiing Calibration Module.

Definition at line 39 of file TrgEclTimingCalibration.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

◆ TRGECLTimingCalModule()

TRGECLTimingCalModule ( )

Constructor.

Definition at line 20 of file TrgEclTimingCalibration.cc.

                                             : Module()
{
 
  setDescription("example module for TRGECL timing calibration");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("TRGECLCalSim", fSimulation,
           "0 : Raw data  1 : Simulation data", 0);
 
  addParam("TRGECLCalType", fCalType,
           "0 : Beam data  1 : Cosmic ray data", 0);
 
  addParam("TRGECLCal3DBhabhaVeto", f3Dbhabha_veto,
           "0 : Not using 3D bhabha veto bit  1 : Using 3D bhabha veto bit ", 1);
 
  addParam("TRGECLCalTCRef", TC_ref,
           "Reference TCID. Default setting : 184", 184);
 
  addParam("TCEnergyCalibrationConstant", TCEnergyCalibrationConstant,
           "A TC energy calibration factor (GeV/ADC), default 0.00525", 0.00525);
 
  addParam("TRGECLCalnTC", cut_ntc,
           "Number of TC cut : Events will be used < ntc", 999);
 
  addParam("TRGECLCalHighEnergyCut", cut_high_energy,
           "High energy cut", 9999.0);
 
  addParam("TRGECLCalLowEnergyCut", cut_low_energy,
           "Low energy cut", 0.0);
 
  addParam("TRGECLCalFWD", fInclude_FWD,
           "Flag including FWD end cap", 1);
 
  addParam("TRGECLCalBR", fInclude_BR,
           "Flag including Barrel", 1);
 
  addParam("TRGECLCalBWD", fInclude_BWD,
           "Flag including BWD end cap", 1);
 
  addParam("TRGECLCalofname", str_ofilename,
           "Output file name", str_default_name);
 
  addParam("TRGECLCalIteration", fIteration,
           "iteration", 0);
 
  addParam("TRGECLCalChisqCut", cut_chisq,
           "iteration chisq cut", 1000.0);
 
  addParam("TRGECLCalOffsetFname", str_timeoffset_fname,
           "Input offset file name", str_timeoffset_fname);
 
}

◆ ~TRGECLTimingCalModule()

~TRGECLTimingCalModule ( )

virtual

Destructor.

Definition at line 73 of file TrgEclTimingCalibration.cc.

74{

75}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

Begin Run function.

Reimplemented from Module.

Definition at line 102 of file TrgEclTimingCalibration.cc.

103{

104}

◆ Calculate_Chisq()

void Calculate_Chisq ( )

Calculate chisq based on time offset obtained from "Solve_Matrix" function.

Definition at line 441 of file TrgEclTimingCalibration.cc.

{
  chisq_result.assign(576, 0.0);
  if (FlagMatrixSolved == 1) {
    for (int i = 0; i < 576; i++) {
      if (b_Inc_TC[i] == false && i != TC_ref - 1) continue;
      std::vector<double> offsetdiff;
      offsetdiff.assign(576, 0.0);
      for (int j = 0; j < 576; j++) {
        if (i == j || (b_Inc_TC[j] == false && j != TC_ref - 1)) continue;
        offsetdiff[j] = tcal_result[i] - tcal_result[j];
        chisq_result[i] += Chisq1[i][j] * offsetdiff[j] * offsetdiff[j] + Chisq2[i][j] * offsetdiff[j] + Chisq3[i][j];
      }
    }
  } else {
    for (int i = 0; i < 576; i++) {
      chisq_result[i] = -1.0;
    }
  }
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 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 function.

Reimplemented from Module.

Definition at line 106 of file TrgEclTimingCalibration.cc.

107{

108}

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

Reimplemented from Module.

Definition at line 122 of file TrgEclTimingCalibration.cc.

{
  nevt_read++;
 
  if (f3Dbhabha_veto == 1) {
    if (fSimulation == 0) {
      StoreArray<TRGECLUnpackerEvtStore> TRGECLEvtStore;
      int nEvtStore = TRGECLEvtStore.getEntries();
      if (nEvtStore <= 0) return;
      if (TRGECLEvtStore[0] -> getCheckSum() != 0) return;
      if (TRGECLEvtStore[0] -> get3DBhabhaV() != 1)  return;
    }
 
    if (fSimulation == 1) {
      StoreArray<TRGECLTrg> TRGECLTrg;
      int nEvtStore = TRGECLTrg.getEntries();
      if (nEvtStore <= 0) return;
      if (TRGECLTrg[0] -> get3DBhabha() != 1) return;
    }
  }
  TRGECLTimingCalClear();
 
  if (ReadData() == 0) return;
  if (FillMatrix() == 1)
    nevt_selected++;
 
  return;
}

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

◆ FillMatrix()

int FillMatrix ( )

Fill matrix and vector components.

Definition at line 181 of file TrgEclTimingCalibration.cc.

{
  int flag_event_used = 0;
  int ntc = TCId.size();
 
  for (int itc1 = 0; itc1 < ntc; itc1++) {
    if (TCEnergy[itc1] > cut_high_energy || TCEnergy[itc1] < cut_low_energy) continue;
 
    int m_TCID1 = TCId[itc1] - 1;
    if (b_Exclude_TC[m_TCID1] == true) continue;
 
    for (int itc2 = itc1 + 1; itc2 < ntc; itc2++) {
      int m_TCID2 = TCId[itc2] - 1;
      if (b_Exclude_TC[m_TCID2] == true) continue;
      // energy cut
      if (TCEnergy[itc2] > cut_high_energy || TCEnergy[itc2] < cut_low_energy) continue;
      //double sigma2 = 1.0/(TCEnergy[itc1]*TCEnergy[itc1]) + 1.0/(TCEnergy[itc2]*TCEnergy[itc2]); // sigma i,j or j,i
 
      double sigma2 = 5.0 * 5.0; // temporal resolution
      double tmp_chisq =  pow((TCTiming[itc1] - TimeOffset[m_TCID1]) - (TCTiming[itc2] - TimeOffset[m_TCID2]), 2) / sigma2;
      if (fIteration == 1 && tmp_chisq > cut_chisq)  continue;
 
      // Fill symmetric matrix
      _Matrix[m_TCID1][m_TCID2] += (-1.0 / sigma2);
      _Matrix[m_TCID2][m_TCID1] += (-1.0 / sigma2);
      // Fill diagonal component
      _Matrix[m_TCID1][m_TCID1] += (1.0 / sigma2);
      _Matrix[m_TCID2][m_TCID2] += (1.0 / sigma2);
 
      // Fill Chisq matrix1
      Chisq1[m_TCID1][m_TCID2] += (1.0 / sigma2);
      Chisq1[m_TCID2][m_TCID1] += (1.0 / sigma2);
 
 
      // TOF correction & Fill vector component
      double Vector_component = 0;
      if (fCalType == 0) { //no TOF correction for beam calibration
        Vector_component = (TCTiming[itc1] - TCTiming[itc2]);
      }
 
      else if (fCalType == 1) { //cosmic ray data
        double TOF_TC2TC = (TCPosition[m_TCID1] - TCPosition[m_TCID2]).R() / 29.9792458;
        if (TCPosition[m_TCID1].y() > TCPosition[m_TCID2].y()) {
          Vector_component = (TCTiming[itc1] - (TCTiming[itc2] - TOF_TC2TC));
        } else Vector_component = ((TCTiming[itc1] - TOF_TC2TC) - TCTiming[itc2]);
      }
      Vector_component /= sigma2;
      _Vector[m_TCID1] += Vector_component;
      _Vector[m_TCID2] += -Vector_component;
      // Fill Chisq matrix2,3
      Chisq2[m_TCID1][m_TCID2] += -2.0 * Vector_component;
      Chisq2[m_TCID2][m_TCID1] += 2.0 * Vector_component;
 
      Chisq3[m_TCID1][m_TCID2] += Vector_component * Vector_component * sigma2;
      Chisq3[m_TCID2][m_TCID1] += Vector_component * Vector_component * sigma2;
 
      Nevent_TC[m_TCID1]++;
      Nevent_TC[m_TCID2]++;
      flag_event_used = 1;
      if (b_Inc_TC[m_TCID2] == false) {b_Inc_TC[m_TCID2] = true;}
    }// for itc2
    if (b_Inc_TC[m_TCID1] == false) {b_Inc_TC[m_TCID1] = true;}
  }// for itc1
  return flag_event_used;
}

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

◆ GetTimeOffset()

void GetTimeOffset ( )

Get previous time offsets (iteration mode)

Definition at line 462 of file TrgEclTimingCalibration.cc.

{
  if (fIteration != 0) {
    TString str_fname_tmp = str_timeoffset_fname;
    TFile* tf = new TFile(str_fname_tmp, "READ");
    auto tr = (TTree*) tf -> Get("tree");
    vector<double>* TimeOffset_tmp = 0;
    tr -> SetBranchAddress("TimeOffset", &TimeOffset_tmp);
    TimeOffset = *TimeOffset_tmp;
    tr -> GetEntry(0);
    tf -> Close();
  }
}

◆ 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://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

initialize function

Reimplemented from Module.

Definition at line 77 of file TrgEclTimingCalibration.cc.

{
  StoreArray<TRGECLHit> TCHit;
  StoreArray<TRGECLUnpackerStore> TCHitUnpacker;
  StoreArray<TRGECLUnpackerEvtStore> TRGECLEvtStore;
  StoreArray<TRGECLTrg> TRGECLTrg;
  //StoreArray<TRGECLCluster> TCCluster;
 
  if (fSimulation == 1) {
    TCHit.isRequired();
    if (f3Dbhabha_veto == 1) {
      TRGECLTrg.isRequired();
    }
    //StoreArray<TRGECLHit>::registerPersistent();
  } else if (fSimulation == 0) {
    TCHitUnpacker.isRequired();
    if (f3Dbhabha_veto == 1) {
      TRGECLEvtStore.isRequired();
    }
    //StoreArray<TRGECLUnpackerStore>::registerPersistent();
  }
 
  InitParams();
}

◆ InitParams()

void InitParams ( )

Parameters initialization.

Definition at line 325 of file TrgEclTimingCalibration.cc.

{
  nevt_selected = 0;
  nevt_read = 0;
 
  if (fCalType == 1) {
    Set_TCposition();
  }
 
  // initialize matrix and vector
  for (int i = 0; i < 576; i++) {
    b_Inc_TC.push_back(false);
  }
  TimeOffset.assign(576, 0.0);
  _Matrix = TMatrixDSym(576);
  _Vector = TVectorD(576);
  _Matrix.ResizeTo(576, 576, 0.0);
  _Vector.ResizeTo(576);
  for (int i = 0; i < 576; i++) {
    _Vector[i] = 0.0;
    for (int j = 0; j < 576; j++) {
      _Matrix[i][j] = 0.0;
    }
  }
  // initialize chisq matrix
  Chisq1.resize(576);
  Chisq2.resize(576);
  Chisq3.resize(576);
  Nevent_TC.assign(576, 0);
  for (int i = 0; i < 576; i++) {
    Chisq1[i].assign(576, 0.0);
    Chisq2[i].assign(576, 0.0);
    Chisq3[i].assign(576, 0.0);
  }
 
  // Exclude TC setup
  b_Exclude_TC.resize(576);
  for (int i = 0; i < 576; i++) {
    b_Exclude_TC[i] = false;
  }
 
  if (fInclude_FWD == 0) {
    for (int i = 0; i < 80; i++) {
      b_Exclude_TC[i] = true;
    }
  }
  if (fInclude_BR == 0) {
    for (int i = 80; i < 512; i++) {
      b_Exclude_TC[i] = true;
    }
  }
  if (fInclude_BWD == 0) {
    for (int i = 512; i < 576; i++) {
      b_Exclude_TC[i] = true;
    }
  }
 
  GetTimeOffset();
 
}

◆ ReadData()

int ReadData ( )

Fill data from.

Definition at line 152 of file TrgEclTimingCalibration.cc.

{
 
  int ntc;
  if (fSimulation == 1) { // Simulation data : TRGECLHit table
    StoreArray<TRGECLHit> TCHit;
    ntc = TCHit.getEntries();
    if (ntc < 2 || ntc > cut_ntc) return 0;  // ntc cut
    for (int itc = 0; itc < ntc; itc++) {
      TCId.push_back(TCHit[itc]->getTCId());
      TCEnergy.push_back(TCHit[itc]->getEnergyDep());
      TCTiming.push_back((double) TCHit[itc]->getTimeAve());
    }
  } else {              // Raw data : TRGECLUnpackerStore table
    StoreArray<TRGECLUnpackerStore> TCHit;
    ntc = TCHit.getEntries();
    if (ntc < 2 || ntc > cut_ntc) return 0;   // ntc cut
    for (int itc = 0; itc < ntc; itc++) {
      if (TCHit[itc] -> getChecksum() != 0) return 0;
      if (!(TCHit[itc] -> getHitWin() == 3 || TCHit[itc] -> getHitWin() == 4)) continue;
      TCId.push_back(TCHit[itc]->getTCId());
      TCEnergy.push_back((double) TCHit[itc]->getTCEnergy() * TCEnergyCalibrationConstant);
      TCTiming.push_back((double) TCHit[itc]->getTCTime());
    }
  }
  return 1;
}

◆ Save_Result()

void Save_Result ( )

Save time offset and chisq as a root file.

Definition at line 386 of file TrgEclTimingCalibration.cc.

{
  TString fname = str_ofilename;
  TFile* tf = new TFile(fname, "RECREATE");
  TTree* tr = new TTree("tree", "TC time calibration result");
  vector<double> time_offset;
  vector<double> time_offset_err;
  vector<int> TCID;
  vector<double> chisq;
  vector<int> Nevent;
  time_offset.resize(576);
  time_offset_err.resize(576);
  TCID.resize(576);
  chisq.resize(576);
  Nevent.resize(576);
  double timeoffsetave = 0.0;
  tr -> Branch("TCID", &TCID);
  tr -> Branch("TimeOffset", &time_offset);
  tr -> Branch("TimeOffAve", &timeoffsetave);
  tr -> Branch("TimeOffsetErr", &time_offset_err);
  tr -> Branch("Chisq", &chisq);
  tr -> Branch("Nevent", &Nevent);
  tr -> Branch("FlagSolved", &FlagMatrixSolved);
  tr -> Branch("Matrix", &_Matrix);
  tr -> Branch("Vector", &_Vector);
  tr -> Branch("ChisqComponent1", &Chisq1);
  tr -> Branch("ChisqComponent2", &Chisq2);
  tr -> Branch("ChisqComponent3", &Chisq3);
  tr -> Branch("NeventRead", &nevt_read);
  tr -> Branch("NeventUsed", &nevt_selected);
  for (int i = 0; i < 576; i++) {
    TCID[i] = i + 1;
    time_offset[i] = tcal_result[i];
    timeoffsetave += tcal_result[i];
    time_offset_err[i] = tcal_result_err[i];
    chisq[i] = chisq_result[i];
    Nevent[i] = Nevent_TC[i];
  }
  timeoffsetave /= 576.0;
 
  tr -> Fill();
  tf -> cd();
  tr -> Write();
  tf -> Close();
 
}

◆ Set_TCposition()

void Set_TCposition ( )

Set TC position from TRGECLMap.

Definition at line 316 of file TrgEclTimingCalibration.cc.

{
  for (int iTCID = 0; iTCID < 576; iTCID++) {
    TrgEclMapping* trgeclMap = new TrgEclMapping();
    TCPosition.push_back(trgeclMap->getTCPosition(iTCID + 1));
    delete trgeclMap;
  }
}

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

◆ Solve_Matrix()

int Solve_Matrix ( )

Solve matrix.

Definition at line 247 of file TrgEclTimingCalibration.cc.

{
  tcal_result.clear();
  tcal_result_err.clear();
  tcal_result.resize(576);
  tcal_result_err.resize(576);
  const int nTC_tot = 576;
  TMatrixDSym mat_A(575);
  mat_A.ResizeTo(575, 575, 0.0);
  TVectorD vec_b(575);
  vec_b.ResizeTo(575);
 
  // copy matrix excluding reference TC
  for (int i = 0; i < 576; i++) {
    if (i == TC_ref - 1) continue;
    int indexi = i;
    if (i > TC_ref - 1) indexi = i - 1;
    vec_b[indexi] = _Vector[i];
    for (int j = 0; j < 576; j++) {
      if (j == TC_ref - 1) continue;
      int indexj = j;
      if (j > TC_ref - 1) indexj = j - 1;
      mat_A[indexi][indexj] = _Matrix[i][j];
    }
  }
 
  //     error calculation
  //**** Not supported yet ***********//
 
  // (A^T * A)^-1_ii : error^2 of t_i
  //TMatrixDSym mat_offset_err(mat_A);
  //TMatrixDSym mat_offset_errT = mat_offset_err.Transpose();
  //mat_offset_err.ResizeTo(576,576,0.0);
  //mat_offset_errT.ResizeTo(576,576,0.0);
 
  //mat_offset_errT.TMult(mat_offset_err);
  //mat_offset_errT.Invert();
  //double *element_mat_offset_err = mat_offset_err.GetMatrixArray();
  for (int i = 0; i < 576; i++) {
    //tcal_result_err[i] = mat_offset_errT[i][i];
    tcal_result_err[i] = 0.0;
  }
 
  TDecompLU lu(mat_A);
  bool b_solve; // Is this matrix solvable?   0 : no, singular    1 : yes, solvable
 
  // Solve Ax = b
  TVectorD x = lu.Solve(vec_b, b_solve);
  /* cppcheck-suppress variableScope */
  int ix = 0;
  if (b_solve) {
    for (int i = 0; i < nTC_tot; i++) {
      if (i == TC_ref - 1) {
        tcal_result[i] = 0.0;
      } else {
        tcal_result[i] = x[ix];
        ++ix;
      }
    }
    return 1;
  } else {
    for (int i = 0; i < nTC_tot; i++) {
      tcal_result[i] = -999.0;
      tcal_result_err[i] = -999.0;
    }
    return 0;
  }
}

◆ terminate()

void terminate ( void )

overridevirtual

Terminate function.

Reimplemented from Module.

Definition at line 110 of file TrgEclTimingCalibration.cc.

{
 
  FlagMatrixSolved = Solve_Matrix();
  // -1 : No event for reference TC
  //  0 : Singular matrix
  //  1 : Solvable matrix
  Calculate_Chisq();
  Save_Result();
 
}

◆ TRGECLTimingCalClear()

void TRGECLTimingCalClear ( )

Clear vector every event.

Definition at line 433 of file TrgEclTimingCalibration.cc.

{
  TCId.clear();
  TCEnergy.clear();
  TCTiming.clear();
 
}

Member Data Documentation

◆ _Matrix

TMatrixDSym _Matrix

private

Matrix Marix component.

Definition at line 140 of file TrgEclTimingCalibration.h.

◆ _Vector

TVectorD _Vector

private

Vector component.

Definition at line 153 of file TrgEclTimingCalibration.h.

◆ b_Exclude_TC

std::vector<bool> b_Exclude_TC

private

Flag TC excluded.

Definition at line 157 of file TrgEclTimingCalibration.h.

◆ b_Inc_TC

std::vector<bool> b_Inc_TC

private

Flag TC included.

Definition at line 155 of file TrgEclTimingCalibration.h.

◆ Chisq1

std::vector<std::vector<double> > Chisq1

private

chisq component1

Definition at line 142 of file TrgEclTimingCalibration.h.

◆ Chisq2

std::vector<std::vector<double> > Chisq2

private

chisq component2

Definition at line 144 of file TrgEclTimingCalibration.h.

◆ Chisq3

std::vector<std::vector<double> > Chisq3

private

chisq component3

Definition at line 146 of file TrgEclTimingCalibration.h.

◆ chisq_result

std::vector<double> chisq_result

private

Chisq values based on time offset obtained from "Solve_Matrix" function.

Definition at line 151 of file TrgEclTimingCalibration.h.

◆ cut_chisq

double cut_chisq

private

TC chisq cut (iteration mode)

Definition at line 119 of file TrgEclTimingCalibration.h.

◆ cut_high_energy

double cut_high_energy

private

TC energy cut upper limit.

Definition at line 104 of file TrgEclTimingCalibration.h.

◆ cut_low_energy

double cut_low_energy

private

TC energy cut lower limit.

Definition at line 106 of file TrgEclTimingCalibration.h.

◆ cut_ntc

int cut_ntc

private

The number of TC cut.

Definition at line 108 of file TrgEclTimingCalibration.h.

◆ f3Dbhabha_veto

int f3Dbhabha_veto

private

Flag 3D bhabha veto 0 : not use 1 : use.

Definition at line 93 of file TrgEclTimingCalibration.h.

◆ fCalType

int fCalType

private

Calibration type 0 : beam 1 : cosmic.

Definition at line 91 of file TrgEclTimingCalibration.h.

◆ fInclude_BR

int fInclude_BR

private

Flag include barrel 0 : exclude BR 1 : include BR.

Definition at line 97 of file TrgEclTimingCalibration.h.

◆ fInclude_BWD

int fInclude_BWD

private

Flag include backward endcap 0 : exclude BWD 1 : include BWD.

Definition at line 99 of file TrgEclTimingCalibration.h.

◆ fInclude_FWD

int fInclude_FWD

private

Flag include forward endcap 0 : exclude FWD 1 : include FWD.

Definition at line 95 of file TrgEclTimingCalibration.h.

◆ fIteration

int fIteration

private

Flag iteration 0 : first calbiration 1 : iteration.

Definition at line 101 of file TrgEclTimingCalibration.h.

◆ FlagMatrixSolved

int FlagMatrixSolved = 0

private

Flag matrix solved (0 : not solved 1 : solved)

Definition at line 164 of file TrgEclTimingCalibration.h.

◆ fSimulation

int fSimulation

private

Flag simulation 0 : real data 1 : simulation data.

Definition at line 89 of file TrgEclTimingCalibration.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_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.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_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_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ Nevent_TC

std::vector<int> Nevent_TC

private

The number of uesed TC hit (TC by TC)

Definition at line 149 of file TrgEclTimingCalibration.h.

◆ nevt_read

int nevt_read = 0

private

The number of read events.

Definition at line 115 of file TrgEclTimingCalibration.h.

◆ nevt_selected

int nevt_selected = 0

private

The number of selected events.

Definition at line 113 of file TrgEclTimingCalibration.h.

◆ str_default_name

std::string str_default_name = "TCTimeOffset.root"

private

Default output root file name.

Definition at line 122 of file TrgEclTimingCalibration.h.

◆ str_ofilename

std::string str_ofilename

private

Output root file name.

Definition at line 124 of file TrgEclTimingCalibration.h.

◆ str_timeoffset_fname

std::string str_timeoffset_fname

private

Input time offset file name (iteration mode)

Definition at line 126 of file TrgEclTimingCalibration.h.

◆ TC_ref

int TC_ref

private

Reference TC whose time offset set to be 0.

Definition at line 110 of file TrgEclTimingCalibration.h.

◆ tcal_result

std::vector<double> tcal_result

private

Time offset calibration result.

Definition at line 159 of file TrgEclTimingCalibration.h.

◆ tcal_result_err

std::vector<double> tcal_result_err

private

Time offset error.

Definition at line 161 of file TrgEclTimingCalibration.h.

◆ TCEnergy

std::vector<double> TCEnergy

private

TC energy.

Definition at line 132 of file TrgEclTimingCalibration.h.

◆ TCEnergyCalibrationConstant

double TCEnergyCalibrationConstant

private

ADC to GeV energy conversion factor.

Definition at line 117 of file TrgEclTimingCalibration.h.

◆ TCId

std::vector<int> TCId

private

Trigger Cell TCID.

Definition at line 130 of file TrgEclTimingCalibration.h.

◆ TCPosition

std::vector<ROOT::Math::XYZVector> TCPosition

private

TC position from TRGECLMap (cosmic calibration)

Definition at line 136 of file TrgEclTimingCalibration.h.

◆ TCTiming

std::vector<double> TCTiming

private

TC time.

Definition at line 134 of file TrgEclTimingCalibration.h.

◆ TimeOffset

std::vector<double> TimeOffset

private

Time offset Input time offset (iteration mode)

Definition at line 168 of file TrgEclTimingCalibration.h.

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

trg/ecl/modules/trgeclTimingCal/include/TrgEclTimingCalibration.h
trg/ecl/modules/trgeclTimingCal/src/TrgEclTimingCalibration.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ TRGECLTimingCalModule()

◆ ~TRGECLTimingCalModule()

Member Function Documentation

◆ beginRun()

◆ Calculate_Chisq()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ FillMatrix()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ GetTimeOffset()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ InitParams()

◆ ReadData()

◆ Save_Result()

◆ Set_TCposition()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ Solve_Matrix()

◆ terminate()

◆ TRGECLTimingCalClear()

Member Data Documentation

◆ _Matrix

◆ _Vector

◆ b_Exclude_TC

◆ b_Inc_TC

◆ Chisq1