ECLDigitizerPureCsIModule Class Reference

The ECLDigitizerPureCsI module. More...

#include <ECLDigitizerPureCsIModule.h>

Inheritance diagram for ECLDigitizerPureCsIModule:

Classes
struct	crystallinks_t
	Indices in arrays with info on ECL channels. More...

Public Types
enum	EModulePropFlags {   c_Input = 1 ,   c_Output = 2 ,   c_ParallelProcessingCertified = 4 ,   c_HistogramManager = 8 ,   c_InternalSerializer = 16 ,   c_TerminateInAllProcesses = 32 ,   c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...
typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	ECLDigitizerPureCsIModule ()
	Constructor.
	~ECLDigitizerPureCsIModule ()
	Destructor.
virtual void	initialize () override
	Initialize variables
virtual void	beginRun () override
	Nothing so far.
virtual void	event () override
	Actual digitization of all pure CsI hits in the ECL.
virtual void	endRun () override
	Nothing so far.
virtual void	terminate () override
	Free memory.
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 Types
using	fitparams_type = ECL::EclConfigurationPure::fitparamspure_t
	Type of fitting parameters.
using	signalsample_type = ECL::EclConfigurationPure::signalsamplepure_t
	Type of signal sample.
using	adccounts_type = ECL::EclConfigurationPure::adccountspure_t
	Type of ADC counts.

Private Member Functions
void	mapGeometry ()
	Returns ring ID for a certain crystal.
bool	isPureCsI (int cellId)
	Returns 1 if corresponding crystal is set as pure CsI crystal.
void	readDSPDB ()
	read Shaper-DSP data from root file.
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.

Static Private Member Functions
static constexpr const char *	eclDigitArrayName ()
	Pure CsI digit array name.
static constexpr const char *	eclDspArrayName ()
	Pure CsI DSP array name.
static constexpr const char *	eclPureCsIInfoArrayName ()
	Pure CsI Info array name.

Private Attributes
int	m_thetaID [ECL::EclConfigurationPure::m_nch] {}
	ECL ring ID.
std::vector< crystallinks_t >	m_tbl
	Lookup table for ECL channels.
StoreArray< ECLDsp >	m_ecldsps
	StoreArray ECLDsp.
StoreArray< ECLDigit >	m_ecldigits
	StoreArray ECLDigit.
StoreArray< ECLPureCsIInfo >	m_eclpurecsiinfo
	StoreArray ECLPureCsIInfo.
StoreArray< ECLHit >	m_hitLists
	StoreArray ECLHit.
StoreArray< ECLDigit >	m_BaselineDigits
	ECL digits (baseline, i.e.
std::vector< fitparams_type >	m_fitparams
	Fitting parameters.
std::vector< signalsample_type >	m_ss
	Tabulated shape line.
std::vector< adccounts_type >	m_adc
	Storage for adc hits from entire calorimeter (8736 crystals).
std::vector< ECLNoiseData >	m_noise
	Parameters for correlated noise stimation.
int	m_nEvent = 0
	Event number.
int	m_thetaIdMin
	Module parameters.
int	m_thetaIdMax
	Ring ID of last pure CsI ring in FWD.
bool	m_background
	Flag to set covariance matrix for WF with beam-bkg.
bool	m_calibration
	Flag to use the DigitizerPureCsI for Waveform fit Covariance Matrix calibration.
bool	m_NoCovMatrix
	Flag to use a diagonal (neutral) Covariance matrix.
int	m_tickFactor
	multiplication factor to get adc tick from trigger tick.
double	m_sigmaTrigger
	Trigger resolution.
double	m_elecNoise
	Electronic Noise energy equivalente in MeV.
double	m_photostatresolution
	Resolution for a 1 MeV energy deposit.
bool	m_debug
	Flag for debug mode.
int	m_testtrg
	Fixed trigger time for testing purposes.
double	m_testsig
	Shift in signal arrival time, for testing purposes.
double	m_testenedep
	Fixed energy deposition in all crystals, for testing purposes.
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

The ECLDigitizerPureCsI module.

This module is responsible to digitize all hits found in the ECL from ECLHit First, we simulate the sampling array by waveform and amplitude of hit, and smear this sampling array by corresponding error matrix. We then fit the array as hardware of shaper DSP board to obtain the fit result of amplitude, time and quality. The initial parameters of fit and algorithm are same as hardware. This module outputs two array which are ECLDsp and ECLDigit.

Definition at line 44 of file ECLDigitizerPureCsIModule.h.

Member Typedef Documentation

adccounts_type

using adccounts_type = ECL::EclConfigurationPure::adccountspure_t

private

Type of ADC counts.

Definition at line 108 of file ECLDigitizerPureCsIModule.h.

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

fitparams_type

using fitparams_type = ECL::EclConfigurationPure::fitparamspure_t

private

Type of fitting parameters.

Definition at line 104 of file ECLDigitizerPureCsIModule.h.

signalsample_type

using signalsample_type = ECL::EclConfigurationPure::signalsamplepure_t

private

Type of signal sample.

Definition at line 106 of file ECLDigitizerPureCsIModule.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

ECLDigitizerPureCsIModule()

ECLDigitizerPureCsIModule

(

)

Constructor.

Definition at line 45 of file ECLDigitizerPureCsIModule.cc.

                                                     : Module()
{
  //Set module properties
  setDescription("Creates ECLDigiHits from ECLHits for Pure CsI.");
  setPropertyFlags(c_ParallelProcessingCertified);
  addParam("FirstRing", m_thetaIdMin, "First ring (0-12)", 0);
  addParam("LastRing", m_thetaIdMax, "Last ring (0-12)", 12);
  addParam("Background", m_background, "Flag to use the DigitizerPureCsI configuration with backgrounds; Default is no background",
           false);
  addParam("Calibration", m_calibration,
           "Flag to use the DigitizerPureCsI for Waveform fit Covariance Matrix calibration; Default is false",
           false);
  addParam("adcTickFactor", m_tickFactor, "multiplication factor to get adc tick from trigger tick", 8);
  addParam("sigmaTrigger", m_sigmaTrigger, "Trigger resolution used", 0.);
  addParam("elecNoise", m_elecNoise, "Electronics noise energy equivalent in MeV", 0.5);
  /* photo statistics resolution measurement at LNF sigma = 55 % at 1 MeV
     Csi(Tl) is 12%
  */
  addParam("photostatresolution", m_photostatresolution, "sigma for 1 MeV energy deposit", 0.22);
  addParam("Debug", m_debug, "debug mode on (default off)", false);
  addParam("debugtrgtime", m_testtrg, "set fixed trigger time for testing purposes", 0);
  addParam("debugsigtimeshift", m_testsig, "shift signal arrival time for testing purposes (in microsec)", 0.);
  addParam("debugenergydeposit", m_testenedep, "energy deposit in all crystals for testing purposes", 0.);
  addParam("NoCovMatrix", m_NoCovMatrix, "Use a diagonal (neutral) Covariance matrix", true);
 
}

~ECLDigitizerPureCsIModule()

~ECLDigitizerPureCsIModule

(

)

Destructor.

Definition at line 72 of file ECLDigitizerPureCsIModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Nothing so far.

Reimplemented from Module.

Definition at line 100 of file ECLDigitizerPureCsIModule.cc.

{
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

eclDigitArrayName()

static constexpr const char * eclDigitArrayName ( )

inlinestaticconstexprprivate

Pure CsI digit array name.

Definition at line 163 of file ECLDigitizerPureCsIModule.h.

{ return "ECLDigitsPureCsI"; }

eclDspArrayName()

static constexpr const char * eclDspArrayName ( )

inlinestaticconstexprprivate

Pure CsI DSP array name.

Definition at line 165 of file ECLDigitizerPureCsIModule.h.

{ return "ECLDspsPureCsI"; }

eclPureCsIInfoArrayName()

static constexpr const char * eclPureCsIInfoArrayName ( )

inlinestaticconstexprprivate

Pure CsI Info array name.

Definition at line 167 of file ECLDigitizerPureCsIModule.h.

{ return "ECLPureCsIInfo"; }

endRun()

void endRun ( void  )

overridevirtual

Nothing so far.

Reimplemented from Module.

Definition at line 235 of file ECLDigitizerPureCsIModule.cc.

{
}

evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

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

event()

void event ( void  )

overridevirtual

Actual digitization of all pure CsI hits in the ECL.

The digitized hits are written into the DataStore.

Reimplemented from Module.

Definition at line 104 of file ECLDigitizerPureCsIModule.cc.

{
  /* add trigger resolution defined in a module parameter
     shifting the waveform starting time by a random deltaT,
     assuming that t0=0 adc channel is determined by the trigger */
  double deltaT = m_sigmaTrigger == 0 ? 0 : gRandom->Gaus(0, m_sigmaTrigger);
 
  // clear the storage for the event
  memset(m_adc.data(), 0, m_adc.size()*sizeof(adccounts_type));
 
  // emulate response for ECL hits after ADC measurements
  vector< vector< const ECLHit*> > hitmap(EclConfigurationPure::m_nch);
 
  for (const auto& eclHit : m_hitLists) {
    int j = eclHit.getCellId() - 1; //0~8735
    if (isPureCsI(j + 1)) {
      assert(j < EclConfigurationPure::m_nch);
      double hitE       = eclHit.getEnergyDep() / Unit::GeV;
      double hitTime    = eclHit.getTimeAve() / Unit::us;
      if (m_photostatresolution > 0) {
        double nphotavg1MeV = 1 / (m_photostatresolution * m_photostatresolution);
        int nphotavg = round((hitE / 0.001) * nphotavg1MeV);
        int nphot = gRandom->Poisson(nphotavg);
        hitE = (nphot / nphotavg1MeV) / 1000;
 
        // hitE = gRandom->Gaus(hitE, 0.001 * m_photostatresolution * sqrt(hitE * 1000));
      }
      m_adc[j].AddHit(hitE, hitTime + deltaT, m_ss[m_tbl[j].iss]);
      if (eclHit.getBackgroundTag() == BackgroundMetaData::bg_none) hitmap[j].push_back(&eclHit);
    }
  }
 
  // loop over entire calorimeter
 
  for (int j = 0; j < EclConfigurationPure::m_nch; j++) {
    if (! isPureCsI(j + 1)) continue;
 
    if (m_debug) {
      m_adc[j].AddHit(m_testenedep, m_testsig, m_ss[m_tbl[j].iss]);
      //cout << "Adding enedep = " << m_testenedep << " time: " << m_testsig << endl;
    }
    adccounts_type& a = m_adc[j];
    if (! m_calibration && a.total < 0.0001) continue;
 
    //Noise generation
    float adcNoise[EclConfigurationPure::m_nsmp];
    memset(adcNoise, 0, sizeof(adcNoise));
    if (m_elecNoise > 0) {
      float z[EclConfigurationPure::m_nsmp];
      for (int i = 0; i < EclConfigurationPure::m_nsmp; i++)
        z[i] = gRandom->Gaus(0, 1);
      m_noise[0].generateCorrelatedNoise(z, adcNoise);
    }
 
    int FitA[EclConfigurationPure::m_nsmp];
    for (int  i = 0; i < EclConfigurationPure::m_nsmp; i++) {
      FitA[i] = 20 * (1000 * a.c[i] + adcNoise[i]) + 3000;
    }
 
    int  energyFit = 0; // fit output : Amplitude 18 bits
    double    tFit = 0; // fit output : T_ave     12 bits
    int qualityFit = 0; // fit output : quality    2 bits
 
    if (! m_calibration) {
      double fitChi2 = 0;
      if (m_debug) {
        DSPFitterPure(m_fitparams[m_tbl[j].idn], FitA, m_testtrg, energyFit, tFit, fitChi2, qualityFit);
        /*
        cout << "energy: " << energyFit
              << " tFit: " << tFit
              << " qualityfit: " << qualityFit
              << endl;
        */
      } else {
        DSPFitterPure(m_fitparams[m_tbl[j].idn], FitA, 0, energyFit, tFit, fitChi2, qualityFit);
        /*
        cout << "energy: " << energyFit
        << " tFit: " << tFit
        << " qualityfit: " << qualityFit
        << endl;
        */
      }
    }
 
    if (m_calibration || energyFit > 0) {
      int CellId = j + 1;
      auto eclDsp = m_ecldsps.appendNew();
      eclDsp->setCellId(CellId);
      eclDsp->setDspA(FitA);
 
      auto eclDigit = m_ecldigits.appendNew();
      eclDigit->setCellId(CellId); // cellId in range from 1 to 8736
      eclDigit->setAmp(energyFit); // E (GeV) = energyFit/20000;
      eclDigit->setTimeFit(int(tFit * 10)); // time is in 0.1 ns units
      eclDigit->setQuality(qualityFit);
 
      auto AeclPureCsIInfo = m_eclpurecsiinfo.appendNew();
      eclDigit->addRelationTo(AeclPureCsIInfo);
      AeclPureCsIInfo->setPureCsI(1);
      AeclPureCsIInfo->setCellId(CellId);
 
      eclDigit->addRelationTo(eclDsp);
      for (const auto& hit : hitmap[j])
        eclDigit->addRelationTo(hit);
    }
  } //store each crystal hit
 
  // temporary solution to run Pure CsI reconstruction
  // and baseline independently and simultaneously
  // cloning barrel and bwd digits
 
  for (const auto& eclDigit : m_BaselineDigits) {
    int cellid = eclDigit.getCellId();
    if (! isPureCsI(cellid)) {
      auto eclDigitClone = m_ecldigits.appendNew();
      eclDigitClone->setCellId(cellid);
      eclDigitClone->setAmp(eclDigit.getAmp());
      eclDigitClone->setTimeFit(eclDigit.getTimeFit());
      eclDigitClone->setQuality(eclDigit.getQuality());
      //eclDigitClone->setPureCsI(0);
      auto AeclPureCsIInfo = m_eclpurecsiinfo.appendNew();
      eclDigitClone->addRelationTo(AeclPureCsIInfo);
      AeclPureCsIInfo->setPureCsI(0);
      AeclPureCsIInfo->setCellId(cellid);
    }
  }
 
 
  m_nEvent++;
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void  )

overridevirtual

Initialize variables

Reimplemented from Module.

Definition at line 76 of file ECLDigitizerPureCsIModule.cc.

{
  m_nEvent  = 0 ;
  EclConfigurationPure::setTickPure(m_tickFactor * EclConfiguration::getTick() / EclConfiguration::m_ntrg);
 
  m_ecldsps.registerInDataStore(eclDspArrayName());
 
  m_ecldigits.registerInDataStore(eclDigitArrayName());
 
  m_ecldigits.registerRelationTo(m_ecldsps);
 
 
  m_eclpurecsiinfo.registerInDataStore(eclPureCsIInfoArrayName());
  m_ecldigits.registerRelationTo(m_eclpurecsiinfo);
 
 
  m_ecldigits.registerRelationTo(m_hitLists);
  readDSPDB();
 
  m_adc.resize(EclConfigurationPure::m_nch);
 
  mapGeometry();
}

isPureCsI()

bool isPureCsI ( int  cellId )

inlineprivate

Returns 1 if corresponding crystal is set as pure CsI crystal.

Definition at line 80 of file ECLDigitizerPureCsIModule.h.

    {
      if (cellId > ECL::EclConfigurationPure::m_nch) return false;
      int thId = m_thetaID[cellId - 1];
      if (thId >= m_thetaIdMin && thId <= m_thetaIdMax) return true;
      return false;
    }

mapGeometry()

void mapGeometry ( )

private

Returns ring ID for a certain crystal.

Definition at line 330 of file ECLDigitizerPureCsIModule.cc.

{
  ECLGeometryPar* eclgeo = ECLGeometryPar::Instance();
  for (int cellId0 = 0; cellId0 < EclConfigurationPure::m_nch; cellId0++) {
    eclgeo->Mapping(cellId0);
    m_thetaID[cellId0] = eclgeo->GetThetaID();
  }
}

readDSPDB()

void readDSPDB ( )

private

read Shaper-DSP data from root file.

Definition at line 243 of file ECLDigitizerPureCsIModule.cc.

{
  string dataFileName, dataFileName2;
  if (m_background) {
    dataFileName = FileSystem::findFile("/data/ecl/ECL-WF-Pure.root");
    if (! m_calibration)
      dataFileName2 = FileSystem::findFile("/data/ecl/ECL-WF-cov-Pure-BG.root");
    B2INFO("ECLDigitizerPureCsI: Reading configuration data with background from: " << dataFileName);
    B2INFO("ECLDigitizerPureCsI: Reading configuration data with background from: " << dataFileName2);
 
  } else {
    dataFileName = FileSystem::findFile("/data/ecl/ECL-WF-Pure.root");
    if (! m_calibration)
      dataFileName2 = FileSystem::findFile("/data/ecl/ECL-WF-cov-Pure.root");
    B2INFO("ECLDigitizerPureCsI: Reading configuration data without background from: " << dataFileName);
    B2INFO("ECLDigitizerPureCsI: Reading configuration data without background from: " << dataFileName2);
  }
  assert(! dataFileName.empty());
 
  TFile rootfile(dataFileName.c_str());
  const TH1F* sampledWF = dynamic_cast<TH1F*>(rootfile.Get("sampleddsp"));
  assert(sampledWF != nullptr);
  const TH1F* sampledWF1 = dynamic_cast<TH1F*>(rootfile.Get("sampleddsp1"));
  assert(sampledWF1 != nullptr);
 
  m_tbl.resize(EclConfigurationPure::m_nch);
 
  // at the moment there is only one sampled signal shape in the pool
  // since all shaper parameters are the same for all crystals
  m_ss.resize(1);
  m_ss[0].InitSample(sampledWF, sampledWF1);
 
  for (int i = 0; i < EclConfigurationPure::m_nch; i++) m_tbl[i].iss = 0;
  B2INFO("ECLDigitizerPureCsI: " << m_ss.size() << " sampled signal templates were created.");
 
  rootfile.Close();
 
  if (!(m_calibration || m_NoCovMatrix)) {
    TFile rootfile2(dataFileName2.c_str());
    TTree* tree = (TTree*) rootfile2.Get("EclWF");
    ECLWaveformData* eclWFData = new ECLWaveformData;
    const int maxncellid = 512;
    int ncellId;
    vector<int> cellId(maxncellid);//[ncellId] buffer for crystal identification number
 
    tree->SetBranchAddress("ncellId", &ncellId);
    tree->SetBranchAddress("cellId", cellId.data());
    tree->SetBranchAddress("CovarianceM", &eclWFData);
    for (Long64_t j = 0, jmax = tree->GetEntries(); j < jmax; j++) {
      tree->GetEntry(j);
      assert(ncellId <= maxncellid);
      for (int i = 0; i < ncellId; ++i)
        m_tbl[cellId[i]].idn = m_fitparams.size();
      fitparams_type params;
      eclWFData->getMatrix(params.invC);
      m_fitparams.push_back(params);
    }
  }
  B2INFO("ECLDigitizerPureCsI: parameters vector size : " << m_fitparams.size());
  // at the moment there is one set of fitparams
  if (m_NoCovMatrix) {
    m_fitparams.resize(1);
    for (int i = 0; i < EclConfigurationPure::m_nch; i++)
      m_tbl[i].idn = 0;
    for (int i = 0; i < 16; i++)
      for (int j = 0; j < 16; j++)
        if (i != j) m_fitparams[0].invC[i][j] = 0;
        else m_fitparams[0].invC[i][j] = 1.0;
    initParams(m_fitparams[0], m_ss[0]);
  } else {
    for (auto& param : m_fitparams) {
      initParams(param, m_ss[0]);
    }
  }
 
  // at the moment same noise for all crystals
  m_noise.resize(1);
  int index = 0;
  for (int i = 0; i < EclConfigurationPure::m_nsmp; i++)
    for (int j = 0; j <= i; j++)
      if (i == j) m_noise[0].setMatrixElement(index++, m_elecNoise);     // units are MeV energy noise eq from electronics
      else m_noise[0].setMatrixElement(index++, 0.);  //uncorrelated
 
  float testM[31][31];
  m_noise[0].getMatrix(testM);
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

terminate()

void terminate ( void  )

overridevirtual

Free memory.

Reimplemented from Module.

Definition at line 239 of file ECLDigitizerPureCsIModule.cc.

{
}

Member Data Documentation

m_adc

std::vector<adccounts_type> m_adc

private

Storage for adc hits from entire calorimeter (8736 crystals).

Definition at line 128 of file ECLDigitizerPureCsIModule.h.

m_background

bool m_background

private

Flag to set covariance matrix for WF with beam-bkg.

Definition at line 141 of file ECLDigitizerPureCsIModule.h.

m_BaselineDigits

StoreArray<ECLDigit> m_BaselineDigits

private

ECL digits (baseline, i.e.

the array "ECLDigits").

Definition at line 120 of file ECLDigitizerPureCsIModule.h.

m_calibration

bool m_calibration

private

Flag to use the DigitizerPureCsI for Waveform fit Covariance Matrix calibration.

Definition at line 143 of file ECLDigitizerPureCsIModule.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_debug

bool m_debug

private

Flag for debug mode.

Definition at line 155 of file ECLDigitizerPureCsIModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_ecldigits

StoreArray<ECLDigit> m_ecldigits

private

StoreArray ECLDigit.

Definition at line 113 of file ECLDigitizerPureCsIModule.h.

m_ecldsps

StoreArray<ECLDsp> m_ecldsps

private

StoreArray ECLDsp.

Definition at line 111 of file ECLDigitizerPureCsIModule.h.

m_eclpurecsiinfo

StoreArray<ECLPureCsIInfo> m_eclpurecsiinfo

private

StoreArray ECLPureCsIInfo.

Definition at line 115 of file ECLDigitizerPureCsIModule.h.

m_elecNoise

double m_elecNoise

private

Electronic Noise energy equivalente in MeV.

Definition at line 151 of file ECLDigitizerPureCsIModule.h.

m_fitparams

std::vector<fitparams_type> m_fitparams

private

Fitting parameters.

Definition at line 123 of file ECLDigitizerPureCsIModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_hitLists

StoreArray<ECLHit> m_hitLists

private

StoreArray ECLHit.

Definition at line 117 of file ECLDigitizerPureCsIModule.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_nEvent

int m_nEvent = 0

private

Event number.

Definition at line 134 of file ECLDigitizerPureCsIModule.h.

m_NoCovMatrix

bool m_NoCovMatrix

private

Flag to use a diagonal (neutral) Covariance matrix.

Definition at line 145 of file ECLDigitizerPureCsIModule.h.

m_noise

std::vector<ECLNoiseData> m_noise

private

Parameters for correlated noise stimation.

Definition at line 130 of file ECLDigitizerPureCsIModule.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_photostatresolution

double m_photostatresolution

private

Resolution for a 1 MeV energy deposit.

Definition at line 153 of file ECLDigitizerPureCsIModule.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_sigmaTrigger

double m_sigmaTrigger

private

Trigger resolution.

Definition at line 149 of file ECLDigitizerPureCsIModule.h.

m_ss

std::vector<signalsample_type> m_ss

private

Tabulated shape line.

Definition at line 125 of file ECLDigitizerPureCsIModule.h.

m_tbl

std::vector<crystallinks_t> m_tbl

private

Lookup table for ECL channels.

Definition at line 101 of file ECLDigitizerPureCsIModule.h.

m_testenedep

double m_testenedep

private

Fixed energy deposition in all crystals, for testing purposes.

Definition at line 161 of file ECLDigitizerPureCsIModule.h.

m_testsig

double m_testsig

private

Shift in signal arrival time, for testing purposes.

Definition at line 159 of file ECLDigitizerPureCsIModule.h.

m_testtrg

int m_testtrg

private

Fixed trigger time for testing purposes.

Definition at line 157 of file ECLDigitizerPureCsIModule.h.

m_thetaID

int m_thetaID[ECL::EclConfigurationPure::m_nch] {}

private

ECL ring ID.

Definition at line 76 of file ECLDigitizerPureCsIModule.h.

m_thetaIdMax

int m_thetaIdMax

private

Ring ID of last pure CsI ring in FWD.

Definition at line 139 of file ECLDigitizerPureCsIModule.h.

m_thetaIdMin

int m_thetaIdMin

private

Module parameters.

Ring ID of first pure CsI ring.

Definition at line 137 of file ECLDigitizerPureCsIModule.h.

m_tickFactor

int m_tickFactor

private

multiplication factor to get adc tick from trigger tick.

Definition at line 147 of file ECLDigitizerPureCsIModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

---

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

• ecl/modules/eclDigitizer/include/ECLDigitizerPureCsIModule.h
• ecl/modules/eclDigitizer/src/ECLDigitizerPureCsIModule.cc