Class derived from ECLDigitCalibratorModule, only difference are the names. More...

#include <ECLDigitCalibratorModule.h>

Inheritance diagram for ECLDigitCalibratorPureCsIModule:

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
virtual const char *	eclDigitArrayName () const override
	PureCsI Name of the ECLDigitsPureCsI.

virtual const char *	eclCalDigitArrayName () const override
	PureCsI Name of the ECLCalDigitsPureCsI.

virtual const char *	eclDspArrayName () const override
	Name of the ECLDspPureCsI.

virtual const char *	eventLevelClusteringInfoName () const override
	PureCsI Name of the EventLevelClusteringInfoPureCsI.

virtual void	initialize () override
	Initialize variables.

virtual void	beginRun () override
	begin run.

virtual void	event () override
	event per event.

virtual void	endRun () override
	end run.

virtual void	terminate () override
	terminate.

virtual const char *	eclPureCsIInfoArrayName () const
	Name of the ECL pure CsI Information.

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
void	initializeCalibration ()
	reads calibration constants, performs checks, put them into a vector

void	callbackCalibration (DBObjPtr< ECLCrystalCalib > &cal, std::vector< float > &constants, std::vector< float > &constantsUnc)
	reads calibration constants

double	getT99 (const int cellid, const double energy, const bool fitfailed, const int bgcount) const
	t99%.

int	determineBackgroundECL ()
	count out of time digits to determine baclground levels

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
double	m_backgroundEnergyCut
	Energy cut for background level counting.

double	m_backgroundTimingCut
	Timing window for background level counting.

const int	c_nCrystals = ECLElementNumbers::c_NCrystals
	Number of ECL crystals.

std::vector< float >	v_calibrationCrystalElectronics
	single crystal electronics calibration as vector

std::vector< float >	v_calibrationCrystalElectronicsUnc
	single crystal electronics calibration as vector uncertainty

DBObjPtr< ECLCrystalCalib >	m_calibrationCrystalElectronics
	single crystal electronics calibration

std::vector< float >	v_calibrationCrystalEnergy
	single crystal energy calibration as vector

std::vector< float >	v_calibrationCrystalEnergyUnc
	single crystal energy calibration as vector uncertainty

DBObjPtr< ECLCrystalCalib >	m_calibrationCrystalEnergy
	single crystal energy calibration

std::vector< float >	v_calibrationCrystalElectronicsTime
	single crystal time calibration offset electronics as vector

std::vector< float >	v_calibrationCrystalElectronicsTimeUnc
	single crystal time calibration offset electronics as vector uncertainty

DBObjPtr< ECLCrystalCalib >	m_calibrationCrystalElectronicsTime
	single crystal time calibration offset electronics

std::vector< float >	v_calibrationCrystalTimeOffset
	single crystal time calibration offset as vector

std::vector< float >	v_calibrationCrystalTimeOffsetUnc
	single crystal time calibration offset as vector uncertainty

DBObjPtr< ECLCrystalCalib >	m_calibrationCrystalTimeOffset
	single crystal time calibration offset

std::vector< float >	v_calibrationCrateTimeOffset
	single crate time calibration offset as vector (per crystal)

std::vector< float >	v_calibrationCrateTimeOffsetUnc
	single crate time calibration offset as vector uncertainty (per crystal)

DBObjPtr< ECLCrystalCalib >	m_calibrationCrateTimeOffset
	single crate time calibration offset (per crystal)

std::vector< float >	v_calibrationCrystalFlightTime
	single crystal time calibration TOF as vector

std::vector< float >	v_calibrationCrystalFlightTimeUnc
	single crystal time calibration TOF as vector uncertainty

DBObjPtr< ECLCrystalCalib >	m_calibrationCrystalFlightTime
	single crystal time calibration TOF

StoreObjPtr< EventLevelClusteringInfo >	m_eventLevelClusteringInfo
	event level clustering info

StoreArray< ECLDigit >	m_eclDigits
	storearray ECLDigit

StoreArray< ECLCalDigit >	m_eclCalDigits
	storearray ECLCalDigit

StoreArray< ECLDsp >	m_eclDsps
	storearray ECLDsp

StoreArray< ECLPureCsIInfo >	m_eclPureCsIInfo
	storearray ECLPureCsIInfo - Special information for pure CsI simulation

double	m_timeInverseSlope
	Time calibration inverse slope "a".

double	m_pureCsIEnergyCalib = 0.00005
	conversion factor from ADC counts to GeV.

double	m_pureCsITimeCalib = 10.
	conversion factor from eclPureCsIDigitizer to ns.

double	m_pureCsITimeOffset = 0.31
	ad-hoc offset correction for pureCsI timing/

const double	c_timeResolutionForFitFailed = 1.0e9
	Time resolution for failed fits".

const double	c_timeForFitFailed = 0.0
	Time for failed fits".

std::string	m_fileBackgroundName
	Background filename.

TFile *	m_fileBackground {nullptr}
	Background file.

TH1F *	m_th1fBackground {nullptr}
	Background histogram.

const double	c_pol2Var1 = 1684.0
	2-order fit for p1 Var1 + Var2bg + Var3bg^2.

const double	c_pol2Var2 = 3080.0
	2-order fit for p1.

const double	c_pol2Var3 = -613.9
	2-order fit for p1.

double	m_pol2Max
	Maximum of p1 2-order fit to limit values.

const int	c_nominalBG = 183
	Number of out of time digits at BGx1.0.

double	m_averageBG
	Average dose per crystal calculated from m_th1dBackground.

const double	c_minT99 = 3.5
	The minimum t99.

bool	m_simulatePure = 0
	Flag to set pure CsI simulation option.

std::unique_ptr< Belle2::ECL::ECLTimingUtilities >	ECLTimeUtil
	ECL timing tools.

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 derived from ECLDigitCalibratorModule, only difference are the names.

Definition at line 170 of file ECLDigitCalibratorModule.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,  
    };

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtualinherited

begin run.

Reimplemented from Module.

Definition at line 148 of file ECLDigitCalibratorModule.cc.

{
  // Check if any of the calibration constants have changed
  if (m_calibrationCrystalElectronics.hasChanged()) {
    if (m_calibrationCrystalElectronics) {
      callbackCalibration(m_calibrationCrystalElectronics, v_calibrationCrystalElectronics, v_calibrationCrystalElectronicsUnc);
    } else
      B2ERROR("ECLDigitCalibratorModule::beginRun - Couldn't find m_calibrationCrystalElectronics for current run!");
  }
 
  if (m_calibrationCrystalEnergy.hasChanged()) {
    if (m_calibrationCrystalEnergy) {
      callbackCalibration(m_calibrationCrystalEnergy, v_calibrationCrystalEnergy, v_calibrationCrystalEnergyUnc);
    } else
      B2ERROR("ECLDigitCalibratorModule::beginRun - Couldn't find m_calibrationCrystalEnergy for current run!");
  }
 
  if (m_calibrationCrystalElectronicsTime.hasChanged()) {
    if (m_calibrationCrystalElectronicsTime) {
      callbackCalibration(m_calibrationCrystalElectronicsTime, v_calibrationCrystalElectronicsTime,
                          v_calibrationCrystalElectronicsTimeUnc);
    } else
      B2ERROR("ECLDigitCalibratorModule::beginRun - Couldn't find m_calibrationCrystalElectronicsTime for current run!");
  }
 
  if (m_calibrationCrystalTimeOffset.hasChanged()) {
    if (m_calibrationCrystalTimeOffset) {
      callbackCalibration(m_calibrationCrystalTimeOffset, v_calibrationCrystalTimeOffset, v_calibrationCrystalTimeOffsetUnc);
    } else
      B2ERROR("ECLDigitCalibratorModule::beginRun - Couldn't find m_calibrationCrystalTimeOffset for current run!");
  }
 
  if (m_calibrationCrateTimeOffset.hasChanged()) {
    if (m_calibrationCrateTimeOffset) {
      callbackCalibration(m_calibrationCrateTimeOffset, v_calibrationCrateTimeOffset, v_calibrationCrateTimeOffsetUnc);
    } else
      B2ERROR("ECLDigitCalibratorModule::beginRun - Couldn't find m_calibrationCrateTimeOffset for current run!");
  }
 
  if (m_calibrationCrystalFlightTime.hasChanged()) {
    if (m_calibrationCrystalFlightTime) {
      callbackCalibration(m_calibrationCrystalFlightTime, v_calibrationCrystalFlightTime, v_calibrationCrystalFlightTimeUnc);
    } else
      B2ERROR("ECLDigitCalibratorModule::beginRun - Couldn't find m_calibrationCrystalFlightTime for current run!");
  }
}

◆ callbackCalibration()

void callbackCalibration	(	DBObjPtr< ECLCrystalCalib > &	cal,
		std::vector< float > &	constants,
		std::vector< float > &	constantsUnc
	)

privateinherited

reads calibration constants

Definition at line 102 of file ECLDigitCalibratorModule.cc.

{
  constants = cal->getCalibVector();
  constantsUnc = cal->getCalibUncVector();
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:146

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

438{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:165

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:156

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

419{ 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 444 of file Module.h.

444{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:175

◆ determineBackgroundECL()

int determineBackgroundECL ( )

privateinherited

count out of time digits to determine baclground levels

Definition at line 398 of file ECLDigitCalibratorModule.cc.

{
  // EventLevelClustering counters
  using regionCounter = std::unordered_map<ECL::DetectorRegion, uint>;
 
  regionCounter outOfTimeCount{{ECL::DetectorRegion::FWD, 0},
    {ECL::DetectorRegion::BRL, 0},
    {ECL::DetectorRegion::BWD, 0}};
 
  ECLGeometryPar* geom = ECLGeometryPar::Instance();
 
  // Loop over the input array
  for (auto& aECLCalDigit : m_eclCalDigits) {
    if (abs(aECLCalDigit.getTime()) >= m_backgroundTimingCut) {
      if (aECLCalDigit.getEnergy() >= m_backgroundEnergyCut) {
        // Get digit theta
        const B2Vector3D position = geom->GetCrystalPos(aECLCalDigit.getCellId() - 1);
        const double theta = position.Theta();
 
        // Get detector region
        const auto detectorRegion = ECL::getDetectorRegion(theta);
 
        // Count out of time digits per region
        ++outOfTimeCount.at(detectorRegion);
      }
    }
  }
 
  // Save EventLevelClusteringInfo
  if (!m_eventLevelClusteringInfo) {
    m_eventLevelClusteringInfo.create();
  }
 
  m_eventLevelClusteringInfo->setNECLCalDigitsOutOfTimeFWD(outOfTimeCount.at(ECL::DetectorRegion::FWD));
  m_eventLevelClusteringInfo->setNECLCalDigitsOutOfTimeBarrel(outOfTimeCount.at(ECL::DetectorRegion::BRL));
  m_eventLevelClusteringInfo->setNECLCalDigitsOutOfTimeBWD(outOfTimeCount.at(ECL::DetectorRegion::BWD));
 
  B2DEBUG(35, "ECLDigitCalibratorModule::determineBackgroundECL found " << outOfTimeCount.at(ECL::DetectorRegion::FWD) << ", " <<
          outOfTimeCount.at(ECL::DetectorRegion::BRL) << ", " << outOfTimeCount.at(ECL::DetectorRegion::BWD) <<
          " out of time digits in FWD, BRL, BWD");
 
  return m_eventLevelClusteringInfo->getNECLCalDigitsOutOfTime();
}

◆ eclCalDigitArrayName()

virtual const char * eclCalDigitArrayName ( ) const

inlineoverridevirtual

PureCsI Name of the ECLCalDigitsPureCsI.

Reimplemented from ECLDigitCalibratorModule.

Definition at line 177 of file ECLDigitCalibratorModule.h.

178 { return "ECLCalDigitsPureCsI" ; }

◆ eclDigitArrayName()

virtual const char * eclDigitArrayName ( ) const

inlineoverridevirtual

PureCsI Name of the ECLDigitsPureCsI.

Reimplemented from ECLDigitCalibratorModule.

Definition at line 173 of file ECLDigitCalibratorModule.h.

174 { return "ECLDigitsPureCsI" ; }

◆ eclDspArrayName()

virtual const char * eclDspArrayName ( ) const

inlineoverridevirtual

Name of the ECLDspPureCsI.

Reimplemented from ECLDigitCalibratorModule.

Definition at line 181 of file ECLDigitCalibratorModule.h.

182 { return "ECLDspsPureCsI" ; }

◆ eclPureCsIInfoArrayName()

virtual const char * eclPureCsIInfoArrayName ( ) const

inlinevirtualinherited

Name of the ECL pure CsI Information.

Definition at line 87 of file ECLDigitCalibratorModule.h.

88 { return "ECLPureCsIInfo" ; }

◆ endRun()

void endRun ( void )

overridevirtualinherited

end run.

Reimplemented from Module.

Definition at line 354 of file ECLDigitCalibratorModule.cc.

355{

356}

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

overridevirtualinherited

event per event.

Reimplemented from Module.

Definition at line 196 of file ECLDigitCalibratorModule.cc.

{
 
  // Loop over the input array
  for (auto& aECLDigit : m_eclDigits) {
 
    bool is_pure_csi = 0;
 
    // append an ECLCalDigit to the storearray
    const auto aECLCalDigit = m_eclCalDigits.appendNew();
 
    // get the cell id from the ECLDigit as identifier
    const int cellid = aECLDigit.getCellId();
 
    // check that the cell id is valid
    if (cellid < 1 or cellid > c_nCrystals) {
      B2FATAL("ECLDigitCalibrationModule::event():" << cellid << " out of range!");
    }
 
    // perform the digit energy calibration: E = A * Ce * Cs
    const int amplitude = aECLDigit.getAmp();
    double calibratedEnergy = 0;
 
    if (m_simulatePure) {
      if (aECLDigit.getRelated<ECLPureCsIInfo>(eclPureCsIInfoArrayName()) != nullptr) {
        if (aECLDigit.getRelated<ECLPureCsIInfo>(eclPureCsIInfoArrayName())->getPureCsI())
          is_pure_csi = 1;
      }
    }
 
    if (is_pure_csi) {
      calibratedEnergy = amplitude * m_pureCsIEnergyCalib;
    } else {
      calibratedEnergy = amplitude * v_calibrationCrystalElectronics[cellid - 1] * v_calibrationCrystalEnergy[cellid - 1];
    }
    if (calibratedEnergy < 0.0)
      calibratedEnergy = 0.0;
 
    // perform the digit timing calibration: t = c * (tfit - Te - Ts)
    const int time = aECLDigit.getTimeFit();
    const int quality = aECLDigit.getQuality();
    double calibratedTime = c_timeForFitFailed;
    if (quality == 1) {
      aECLCalDigit->addStatus(ECLCalDigit::c_IsFailedFit); // this is used to flag failed fits
    } else {
      // only calibrate digit time if we have a good waveform fit
      if (is_pure_csi) {
        calibratedTime = m_pureCsITimeCalib * m_timeInverseSlope * (time - v_calibrationCrystalElectronicsTime[cellid - 1] -
                                                                    v_calibrationCrystalTimeOffset[cellid - 1] - v_calibrationCrateTimeOffset[cellid - 1]) - v_calibrationCrystalFlightTime[cellid - 1]
                         + m_pureCsITimeOffset;
      } else {
        calibratedTime = m_timeInverseSlope * (time - v_calibrationCrystalElectronicsTime[cellid - 1] -
                                               v_calibrationCrystalTimeOffset[cellid - 1] -
                                               v_calibrationCrateTimeOffset[cellid - 1]) -
                         v_calibrationCrystalFlightTime[cellid - 1];
      }
 
      // For data, apply a correction to the time as a function of the signal amplitude.  Correction determined from a fit.
      // No correction for MC
      bool m_IsMCFlag = Environment::Instance().isMC();
      B2DEBUG(35, "cellid = " << cellid << ", m_IsMCFlag = " << m_IsMCFlag);
 
      if (!m_IsMCFlag) {
        double energyTimeShift = ECLTimeUtil->energyDependentTimeOffsetElectronic(amplitude * v_calibrationCrystalElectronics[cellid - 1]) *
                                 m_timeInverseSlope;
        B2DEBUG(35, "cellid = " << cellid << ", amplitude = " << amplitude << ", corrected amplitude = " << amplitude*
                v_calibrationCrystalElectronics[cellid - 1] << ", time before t(E) shift = " << calibratedTime << ", t(E) shift = " <<
                energyTimeShift << " ns");
        calibratedTime -= energyTimeShift;
      }
    }
 
    B2DEBUG(35, "cellid = " << cellid << ", amplitude = " << amplitude << ", calibrated energy = " << calibratedEnergy);
    B2DEBUG(35, "cellid = " << cellid << ", time = " << time << ", calibratedTime = " << calibratedTime);
 
    // Calibrating offline fit results
    ECLDsp* aECLDsp = ECLDsp::getByCellID(cellid);
    aECLCalDigit->setTwoComponentChi2(-1);
    aECLCalDigit->setTwoComponentSavedChi2(ECLDsp::photonHadron, -1);
    aECLCalDigit->setTwoComponentSavedChi2(ECLDsp::photonHadronBackgroundPhoton, -1);
    aECLCalDigit->setTwoComponentSavedChi2(ECLDsp::photonDiodeCrossing, -1);
    aECLCalDigit->setTwoComponentTotalEnergy(-1);
    aECLCalDigit->setTwoComponentHadronEnergy(-1);
    aECLCalDigit->setTwoComponentDiodeEnergy(-1);
    // copy online fit quality from ECLDigit
    const int online_quality = aECLDigit.getQuality();
    if (online_quality == 1) {
      aECLCalDigit->addStatus(ECLCalDigit::c_OnlineFitQuality1);
    } else if (online_quality == 2) {
      aECLCalDigit->addStatus(ECLCalDigit::c_OnlineFitQuality2);
    } else if (online_quality == 3) {
      aECLCalDigit->addStatus(ECLCalDigit::c_OnlineFitQuality3);
    } else if (online_quality == 0) {
      aECLCalDigit->addStatus(ECLCalDigit::c_OnlineFitQuality0);
    }
 
    if (aECLDsp) {
      // require ECLDigit to have offline waveform
      if (aECLDsp->getTwoComponentChi2() > 0) {
        // require offline waveform to have offline fit result
 
        const double calibratedTwoComponentTotalEnergy = aECLDsp->getTwoComponentTotalAmp() * v_calibrationCrystalElectronics[cellid - 1] *
                                                         v_calibrationCrystalEnergy[cellid - 1];
        const double calibratedTwoComponentHadronEnergy = aECLDsp->getTwoComponentHadronAmp() * v_calibrationCrystalElectronics[cellid -
                                                                 1] *
                                                          v_calibrationCrystalEnergy[cellid - 1];
        const double calibratedTwoComponentDiodeEnergy = aECLDsp->getTwoComponentDiodeAmp() * v_calibrationCrystalElectronics[cellid - 1] *
                                                         v_calibrationCrystalEnergy[cellid - 1];
        const double twoComponentChi2 = aECLDsp->getTwoComponentChi2();
        const ECLDsp::TwoComponentFitType twoComponentFitType = aECLDsp->getTwoComponentFitType();
 
        aECLCalDigit->setTwoComponentTotalEnergy(calibratedTwoComponentTotalEnergy);
        aECLCalDigit->setTwoComponentHadronEnergy(calibratedTwoComponentHadronEnergy);
        aECLCalDigit->setTwoComponentDiodeEnergy(calibratedTwoComponentDiodeEnergy);
        aECLCalDigit->setTwoComponentChi2(twoComponentChi2);
        aECLCalDigit->setTwoComponentSavedChi2(ECLDsp::photonHadron, aECLDsp->getTwoComponentSavedChi2(ECLDsp::photonHadron));
        aECLCalDigit->setTwoComponentSavedChi2(ECLDsp::photonHadronBackgroundPhoton,
                                               aECLDsp->getTwoComponentSavedChi2(ECLDsp::photonHadronBackgroundPhoton));
        aECLCalDigit->setTwoComponentSavedChi2(ECLDsp::photonDiodeCrossing, aECLDsp->getTwoComponentSavedChi2(ECLDsp::photonDiodeCrossing));
        aECLCalDigit->setTwoComponentFitType(twoComponentFitType);
      }
    }
 
    // fill the ECLCalDigit with the cell id, the calibrated information and calibration status
    aECLCalDigit->setCellId(cellid);
 
    aECLCalDigit->setEnergy(calibratedEnergy);
    aECLCalDigit->addStatus(ECLCalDigit::c_IsEnergyCalibrated);
 
    aECLCalDigit->setTime(calibratedTime);
    aECLCalDigit->addStatus(ECLCalDigit::c_IsTimeCalibrated);
 
    // set a relation to the ECLDigit
    aECLCalDigit->addRelationTo(&aECLDigit);
  }
 
  // determine background level
  const int bgCount = determineBackgroundECL();
 
  // set the t99 (time resolution)
  for (auto& aECLCalDigit : m_eclCalDigits) {
 
    // perform the time resolution calibration
    const double t99 = getT99(aECLCalDigit.getCellId(),
                              aECLCalDigit.getEnergy(),
                              aECLCalDigit.hasStatus(ECLCalDigit::c_IsFailedFit),
                              bgCount); // calibrated time resolution
    aECLCalDigit.setTimeResolution(t99);
 
    if (t99 == c_timeResolutionForFitFailed) {
      aECLCalDigit.addStatus(ECLCalDigit::c_IsFailedTimeResolution);
    }
 
    aECLCalDigit.addStatus(ECLCalDigit::c_IsTimeResolutionCalibrated);
  }
}

◆ eventLevelClusteringInfoName()

virtual const char * eventLevelClusteringInfoName ( ) const

inlineoverridevirtual

PureCsI Name of the EventLevelClusteringInfoPureCsI.

Reimplemented from ECLDigitCalibratorModule.

Definition at line 185 of file ECLDigitCalibratorModule.h.

186 { return "EventLevelClusteringInfoPureCsI" ; }

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 313 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

201{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:510

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 186 of file Module.h.

186{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:507

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns: A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 380 of file Module.h.

380{ return m_returnValue; }

◆ getT99()

double getT99	(	const int	cellid,
		const double	energy,
		const bool	fitfailed,
		const int	bgcount
	)		const

privateinherited

t99%.

Definition at line 364 of file ECLDigitCalibratorModule.cc.

{
 
  // if this digit is calibrated to the trigger time, we set the resolution to 'very bad' (to be discussed)
  if (fitfailed)
    return c_timeResolutionForFitFailed;
 
  // Get the background level [MeV / mus]
  const double bglevel = TMath::Min((double)bgcount / (double)c_nominalBG * m_th1fBackground->GetBinContent(cellid) / m_averageBG,
                                    m_pol2Max); // c_nominalBG = 183 for actual version of digitizer, m_averageBG is about 2 MeV/ mus
 
  // Get p1 as function of background level
  const double p1 = c_pol2Var1 + c_pol2Var2 * bglevel + c_pol2Var3 * bglevel * bglevel;
 
  // inverse energy in 1/MeV
  double einv = 0.;
  if (energy > 1e-12)
    einv = 1. / (energy / Belle2::Unit::MeV);
 
  // calculate t99 using the inverse energy and p1 (p0 is zero)
  double t99 = p1 * einv;
 
  // for high energies we fix t99 to 3.5ns
  if (t99 < c_minT99)
    t99 = c_minT99;
 
  B2DEBUG(35, "ECLDigitCalibratorModule::getCalibratedTimeResolution: dose = " << m_th1fBackground->GetBinContent(
            cellid)
          << ", bglevel = " << bglevel << ", cellid = " << cellid << ", t99 = " << t99 << ", energy = " << energy / Belle2::Unit::MeV);
 
  return t99;
}

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 310 of file Module.h.

310{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 377 of file Module.h.

377{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

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

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

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

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtualinherited

Initialize variables.

Reimplemented from Module.

Definition at line 110 of file ECLDigitCalibratorModule.cc.

{
  // mdst dataobjects
  // This object is registered by few packages. Let's be agnostic about the
  // execution order of the modules: the first package run registers the module
  m_eventLevelClusteringInfo.isOptional(eventLevelClusteringInfoName()) ? m_eventLevelClusteringInfo.isRequired(
    eventLevelClusteringInfoName())
  : m_eventLevelClusteringInfo.registerInDataStore(eventLevelClusteringInfoName());
 
  // Register Digits, CalDigits and their relation in datastore
  m_eclDigits.isRequired(eclDigitArrayName());
  m_eclCalDigits.registerInDataStore(eclCalDigitArrayName());
  m_eclCalDigits.registerRelationTo(m_eclDigits);
 
  // initialize calibration
  initializeCalibration();
 
  // initialize time resolution (not yet from the database)
  // read the Background correction factors (for full background)
  m_fileBackground = new TFile(m_fileBackgroundName.c_str(), "READ");
  if (!m_fileBackground)
    B2FATAL("Could not find file: " << m_fileBackgroundName);
  m_th1fBackground = dynamic_cast<TH1F*>(m_fileBackground->Get("background"));
  if (!m_th1fBackground)
    B2FATAL("Could not find m_th1fBackground");
 
  // average BG value from m_th1fBackground
  m_averageBG = m_th1fBackground->Integral() / m_th1fBackground->GetEntries();
 
  // get maximum position ("x") of 2-order pol background for t99
  if (fabs(c_pol2Var3) > 1e-12) {
    m_pol2Max = -c_pol2Var2 / (2 * c_pol2Var3);
  } else {
    m_pol2Max = 0.;
  }
}

◆ initializeCalibration()

void initializeCalibration ( )

privateinherited

reads calibration constants, performs checks, put them into a vector

Definition at line 83 of file ECLDigitCalibratorModule.cc.

{
 
  // 1/(4fRF) = 0.4913 ns/clock tick, where fRF is the accelerator RF frequency. Same for all crystals:
  m_timeInverseSlope = 1.0 / (4.0 * EclConfiguration::getRF()) * 1e3;
  m_pureCsIEnergyCalib = 0.00005; // conversion factor from ADC counts to GeV
  m_pureCsITimeCalib = 0.1;       // conversion factor from eclPureCsIDigitizer to ns
  m_pureCsITimeOffset = 0.31;     // ad-hoc offset correction for pureCsI timing
 
  callbackCalibration(m_calibrationCrystalElectronics, v_calibrationCrystalElectronics, v_calibrationCrystalElectronicsUnc);
  callbackCalibration(m_calibrationCrystalEnergy, v_calibrationCrystalEnergy, v_calibrationCrystalEnergyUnc);
  callbackCalibration(m_calibrationCrystalElectronicsTime, v_calibrationCrystalElectronicsTime,
                      v_calibrationCrystalElectronicsTimeUnc);
  callbackCalibration(m_calibrationCrystalTimeOffset, v_calibrationCrystalTimeOffset, v_calibrationCrystalTimeOffsetUnc);
  callbackCalibration(m_calibrationCrateTimeOffset, v_calibrationCrateTimeOffset, v_calibrationCrateTimeOffsetUnc);
  callbackCalibration(m_calibrationCrystalFlightTime, v_calibrationCrystalFlightTime, v_calibrationCrystalFlightTimeUnc);
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 213 of file Module.h.

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

void terminate ( void )

overridevirtualinherited

terminate.

Reimplemented from Module.

Definition at line 359 of file ECLDigitCalibratorModule.cc.

360{

361}

Member Data Documentation

◆ c_minT99

const double c_minT99 = 3.5

privateinherited

The minimum t99.

Definition at line 159 of file ECLDigitCalibratorModule.h.

◆ c_nCrystals

const int c_nCrystals = ECLElementNumbers::c_NCrystals

privateinherited

Number of ECL crystals.

Definition at line 97 of file ECLDigitCalibratorModule.h.

◆ c_nominalBG

const int c_nominalBG = 183

privateinherited

Number of out of time digits at BGx1.0.

Definition at line 157 of file ECLDigitCalibratorModule.h.

◆ c_pol2Var1

const double c_pol2Var1 = 1684.0

privateinherited

2-order fit for p1 Var1 + Var2*bg + Var3*bg^2.

Definition at line 153 of file ECLDigitCalibratorModule.h.

◆ c_pol2Var2

const double c_pol2Var2 = 3080.0

privateinherited

2-order fit for p1.

Definition at line 154 of file ECLDigitCalibratorModule.h.

◆ c_pol2Var3

const double c_pol2Var3 = -613.9

privateinherited

2-order fit for p1.

Definition at line 155 of file ECLDigitCalibratorModule.h.

◆ c_timeForFitFailed

const double c_timeForFitFailed = 0.0

privateinherited

Time for failed fits".

Definition at line 146 of file ECLDigitCalibratorModule.h.

◆ c_timeResolutionForFitFailed

const double c_timeResolutionForFitFailed = 1.0e9

privateinherited

Time resolution for failed fits".

Definition at line 145 of file ECLDigitCalibratorModule.h.

◆ ECLTimeUtil

std::unique_ptr< Belle2::ECL::ECLTimingUtilities > ECLTimeUtil

privateinherited

Initial value:

=

std::make_unique<Belle2::ECL::ECLTimingUtilities>()

ECL timing tools.

Definition at line 164 of file ECLDigitCalibratorModule.h.

◆ m_averageBG

double m_averageBG

privateinherited

Average dose per crystal calculated from m_th1dBackground.

Definition at line 158 of file ECLDigitCalibratorModule.h.

◆ m_backgroundEnergyCut

double m_backgroundEnergyCut

privateinherited

Energy cut for background level counting.

Definition at line 94 of file ECLDigitCalibratorModule.h.

◆ m_backgroundTimingCut

double m_backgroundTimingCut

privateinherited

Timing window for background level counting.

Definition at line 95 of file ECLDigitCalibratorModule.h.

◆ m_calibrationCrateTimeOffset

DBObjPtr<ECLCrystalCalib> m_calibrationCrateTimeOffset

privateinherited

single crate time calibration offset (per crystal)

Definition at line 119 of file ECLDigitCalibratorModule.h.

◆ m_calibrationCrystalElectronics

DBObjPtr<ECLCrystalCalib> m_calibrationCrystalElectronics

privateinherited

single crystal electronics calibration

Definition at line 101 of file ECLDigitCalibratorModule.h.

◆ m_calibrationCrystalElectronicsTime

DBObjPtr<ECLCrystalCalib> m_calibrationCrystalElectronicsTime

privateinherited

single crystal time calibration offset electronics

Definition at line 110 of file ECLDigitCalibratorModule.h.

◆ m_calibrationCrystalEnergy

DBObjPtr<ECLCrystalCalib> m_calibrationCrystalEnergy

privateinherited

single crystal energy calibration

Definition at line 105 of file ECLDigitCalibratorModule.h.

◆ m_calibrationCrystalFlightTime

DBObjPtr<ECLCrystalCalib> m_calibrationCrystalFlightTime

privateinherited

single crystal time calibration TOF

Definition at line 123 of file ECLDigitCalibratorModule.h.

◆ m_calibrationCrystalTimeOffset

DBObjPtr<ECLCrystalCalib> m_calibrationCrystalTimeOffset

privateinherited

single crystal time calibration offset

Definition at line 114 of file ECLDigitCalibratorModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_eclCalDigits

StoreArray<ECLCalDigit> m_eclCalDigits

privateinherited

storearray ECLCalDigit

Definition at line 128 of file ECLDigitCalibratorModule.h.

◆ m_eclDigits

StoreArray<ECLDigit> m_eclDigits

privateinherited

storearray ECLDigit

Definition at line 127 of file ECLDigitCalibratorModule.h.

◆ m_eclDsps

StoreArray<ECLDsp> m_eclDsps

privateinherited

storearray ECLDsp

Definition at line 129 of file ECLDigitCalibratorModule.h.

◆ m_eclPureCsIInfo

StoreArray<ECLPureCsIInfo> m_eclPureCsIInfo

privateinherited

storearray ECLPureCsIInfo - Special information for pure CsI simulation

Definition at line 130 of file ECLDigitCalibratorModule.h.

◆ m_eventLevelClusteringInfo

StoreObjPtr<EventLevelClusteringInfo> m_eventLevelClusteringInfo

privateinherited

event level clustering info

Definition at line 125 of file ECLDigitCalibratorModule.h.

◆ m_fileBackground

TFile* m_fileBackground {nullptr}

privateinherited

Background file.

Definition at line 150 of file ECLDigitCalibratorModule.h.

◆ m_fileBackgroundName

std::string m_fileBackgroundName

privateinherited

Background filename.

Definition at line 149 of file ECLDigitCalibratorModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_name

std::string m_name

privateinherited

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

Definition at line 507 of file Module.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 509 of file Module.h.

◆ m_pol2Max

double m_pol2Max

privateinherited

Maximum of p1 2-order fit to limit values.

Definition at line 156 of file ECLDigitCalibratorModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 511 of file Module.h.

◆ m_pureCsIEnergyCalib

double m_pureCsIEnergyCalib = 0.00005

privateinherited

conversion factor from ADC counts to GeV.

Definition at line 134 of file ECLDigitCalibratorModule.h.

◆ m_pureCsITimeCalib

double m_pureCsITimeCalib = 10.

privateinherited

conversion factor from eclPureCsIDigitizer to ns.

Definition at line 135 of file ECLDigitCalibratorModule.h.

◆ m_pureCsITimeOffset

double m_pureCsITimeOffset = 0.31

privateinherited

ad-hoc offset correction for pureCsI timing/

Definition at line 136 of file ECLDigitCalibratorModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_simulatePure

bool m_simulatePure = 0

privateinherited

Flag to set pure CsI simulation option.

Definition at line 161 of file ECLDigitCalibratorModule.h.

◆ m_th1fBackground

TH1F* m_th1fBackground {nullptr}

privateinherited

Background histogram.

Definition at line 151 of file ECLDigitCalibratorModule.h.

◆ m_timeInverseSlope

double m_timeInverseSlope

privateinherited

Time calibration inverse slope "a".

Definition at line 132 of file ECLDigitCalibratorModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ v_calibrationCrateTimeOffset

std::vector< float > v_calibrationCrateTimeOffset

privateinherited

single crate time calibration offset as vector (per crystal)

Definition at line 116 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrateTimeOffsetUnc

std::vector< float > v_calibrationCrateTimeOffsetUnc

privateinherited

single crate time calibration offset as vector uncertainty (per crystal)

Definition at line 117 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalElectronics

std::vector< float > v_calibrationCrystalElectronics

privateinherited

single crystal electronics calibration as vector

Definition at line 99 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalElectronicsTime

std::vector< float > v_calibrationCrystalElectronicsTime

privateinherited

single crystal time calibration offset electronics as vector

Definition at line 107 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalElectronicsTimeUnc

std::vector< float > v_calibrationCrystalElectronicsTimeUnc

privateinherited

single crystal time calibration offset electronics as vector uncertainty

Definition at line 109 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalElectronicsUnc

std::vector< float > v_calibrationCrystalElectronicsUnc

privateinherited

single crystal electronics calibration as vector uncertainty

Definition at line 100 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalEnergy

std::vector< float > v_calibrationCrystalEnergy

privateinherited

single crystal energy calibration as vector

Definition at line 103 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalEnergyUnc

std::vector< float > v_calibrationCrystalEnergyUnc

privateinherited

single crystal energy calibration as vector uncertainty

Definition at line 104 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalFlightTime

std::vector< float > v_calibrationCrystalFlightTime

privateinherited

single crystal time calibration TOF as vector

Definition at line 121 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalFlightTimeUnc

std::vector< float > v_calibrationCrystalFlightTimeUnc

privateinherited

single crystal time calibration TOF as vector uncertainty

Definition at line 122 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalTimeOffset

std::vector< float > v_calibrationCrystalTimeOffset

privateinherited

single crystal time calibration offset as vector

Definition at line 112 of file ECLDigitCalibratorModule.h.

◆ v_calibrationCrystalTimeOffsetUnc

std::vector< float > v_calibrationCrystalTimeOffsetUnc

privateinherited

single crystal time calibration offset as vector uncertainty

Definition at line 113 of file ECLDigitCalibratorModule.h.

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

ecl/modules/eclDigitCalibration/include/ECLDigitCalibratorModule.h

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

Member Function Documentation

◆ beginRun()

◆ callbackCalibration()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ determineBackgroundECL()

◆ eclCalDigitArrayName()

◆ eclDigitArrayName()

◆ eclDspArrayName()

◆ eclPureCsIInfoArrayName()

◆ endRun()

◆ evalCondition()

◆ event()

◆ eventLevelClusteringInfoName()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getT99()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ initializeCalibration()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ c_minT99

◆ c_nCrystals

◆ c_nominalBG

◆ c_pol2Var1

◆ c_pol2Var2

◆ c_pol2Var3

◆ c_timeForFitFailed

◆ c_timeResolutionForFitFailed