The ECLDigitizer module. More...

#include <ECLDigitizerModule.h>

Inheritance diagram for ECLDigitizerModule:

Classes
struct	calibration_t
	calibration constants per channel More...

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

	~ECLDigitizerModule () override
	Destructor.

virtual void	initialize () override
	Initialize variables.

virtual void	beginRun () override
	Nothing so far.

virtual void	event () override
	Actual digitization of all hits in the ECL.

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

virtual void	endRun ()
	This method is called if the current run ends.

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Types
using	algoparams_t = ECL::EclConfiguration::algoparams_t
	algorithm parameters

using	fitparams_t = ECL::EclConfiguration::fitparams_t
	fit parameters

using	signalsample_t = ECL::EclConfiguration::signalsample_t
	signal sample

using	adccounts_t = ECL::EclConfiguration::adccounts_t
	ADC counts.

using	int_array_192x16_t = fitparams_t::int_array_192x16_t
	weighting coefficients for time and amplitude calculation

using	int_array_24x16_t
	weighting coefficients amplitude calculation.

using	uint_pair_t = std::pair<unsigned int, unsigned int>
	a pair of unsigned ints

Private Member Functions
void	shapeFitterWrapper (const int j, const int *FitA, const int m_ttrig, int &m_lar, int &m_ltr, int &m_lq, int &m_chi) const
	function wrapper for waveform fit

void	callbackHadronSignalShapes ()
	callback hadron signal shapes from database

void	readDSPDB ()
	read Shaper-DSP data from root file

void	shapeSignals ()
	Emulate response of energy deposition in a crystal and attached photodiode and make waveforms.

void	makeWaveforms ()
	Produce and compress waveforms for beam background overlay.

void	repack (const ECLWFAlgoParams &, algoparams_t &)
	repack waveform fit parameters from ROOT format to plain array of unsigned short for the shapeFitter function

void	getfitparams (const ECLWaveformData &, const ECLWFAlgoParams &, fitparams_t &)
	load waveform fit parameters for the shapeFitter function

void	makeElectronicNoiseAndPedestal (int j, int *FitA)
	fill the waveform array FitA by electronic noise and bias it for channel J [0-8735]

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
std::vector< crystallinks_t >	m_tbl
	Lookup table for ECL channels.

std::vector< algoparams_t >	m_idn
	Fit algorithm parameters shared by group of crystals.

std::vector< fitparams_t >	m_fitparams
	Pairs of (waveform parameters, fit parameters)

std::vector< ECLNoiseData >	m_noise
	parameters for correlated noise simulation

std::vector< signalsample_t >	m_ss
	tabulated shape line

std::vector< signalsample_t >	m_ss_HadronShapeSimulations
	tabulated shape line for hadron shape simulations

std::vector< adccounts_t >	m_adc
	Storage for adc hits from entire calorimeter (8736 crystals)

std::vector< calibration_t >	m_calib
	Storage for calibration constants.

std::vector< double >	m_Awave
	Storage for waveform saving thresholds.

unsigned char	m_ttime [ECL::ECL_CRATES] = {}
	storage for trigger time in each ECL.

bool	m_loadOnce = true
	Always load waveform parameters at least once.

DBObjPtr< ECLDigitWaveformParametersForMC >	m_waveformParametersMC
	Hadron signal shapes.

DBObjPtr< TTree >	m_waveformParameters
	CellID-specific signal shapes.

DBObjPtr< TTree >	m_algoParameters
	Shape fitting algorithm parameters.

DBObjPtr< TTree >	m_noiseParameters
	Electronics noise covariance matrix.

DBObjPtr< ECLCrystalCalib >	m_CrystalElectronics {"ECLCrystalElectronics"}
	Crystal electronics.

DBObjPtr< ECLCrystalCalib >	m_CrystalEnergy {"ECLCrystalEnergy"}
	Crystal energy.

DBObjPtr< ECLCrystalCalib >	m_CrystalElectronicsTime {"ECLCrystalElectronicsTime"}
	Crystal electronics time.

DBObjPtr< ECLCrystalCalib >	m_CrystalTimeOffset {"ECLCrystalTimeOffset"}
	Crystal time offset.

DBObjPtr< ECLCrystalCalib >	m_CrateTimeOffset {"ECLCrateTimeOffset"}
	Crate time offset.

DBObjPtr< ECLCrystalCalib >	m_MCTimeOffset {"ECLMCTimeOffset"}
	MC time offset.

DBObjPtr< ECLCrystalCalib >	m_FPGAWaveform {"ECL_FPGA_StoreWaveform"}
	FPGA waveform.

StoreObjPtr< EventMetaData >	m_EventMetaData
	Event metadata.

StoreArray< ECLHit >	m_eclHits
	Hits array.

StoreArray< ECLHit >	m_eclDiodeHits
	Diode hits array.

StoreArray< ECLSimHit >	m_eclSimHits
	SimHits array.

StoreObjPtr< ECLWaveforms >	m_eclWaveforms
	Compressed waveforms.

StoreArray< ECLDigit >	m_eclDigits
	Output Arrays.

StoreArray< ECLDsp >	m_eclDsps
	Generated waveforms.

StoreArray< ECLDspWithExtraMCInfo >	m_eclDspsWithExtraMCInfo
	Generated waveforms with extra MC information.

StoreArray< ECLTrig >	m_eclTrigs
	Trigger information.

ECL::ECLChannelMapper	m_eclMapper
	Channel Mapper.

bool	m_background
	Module parameters.

bool	m_calibration
	calibration flag

bool	m_inter
	internuclear counter effect

bool	m_waveformMaker
	produce only waveform digits

bool	m_storeDspWithExtraMCInfo
	DSP with extra info flag.

unsigned int	m_compAlgo
	compression algorithm for background waveforms

int	m_ADCThreshold
	ADC threshold for wavefom fits.

double	m_WaveformThresholdOverride
	If gt 0, value will override ECL_FPGA_StoreWaveform and apply value (in GeV) as threshold for all crystals for waveform saving.

double	m_DspWithExtraMCInfoThreshold
	Energy threshold above which to store DSPs with extra information.

bool	m_trigTime
	Use trigger time from beam background overlay.

std::string	m_eclWaveformsName
	name of background waveforms storage

bool	m_HadronPulseShape
	hadron pulse shape flag

bool	m_dspDataTest
	DSP data usage flag.

bool	m_useWaveformParameters
	If true, use m_waveformParameters, m_algoParameters, m_noiseParameters.

double	m_unitscale
	Normalization coefficient for ECL signal shape.

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 ECLDigitizer 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. An additional array with more MC information for ECLDsp studies is created upon user request.

\correlationdiagram ECLHit = graph.data('ECLHit') ECLDigit = graph.data('ECLDigit') ECLDsp = graph.data('ECLDsp')

graph.module('ECLDigitizer', [ECLHit], [ECLDigit,ECLDsp]) graph.relation(ECLDigitizer, ECLHit) graph.relation(ECLDigitizer, ECLDigit) graph.relation(ECLDigitizer, ECLDsp) graph.relation(ECLDigitizer, ECLDspWithExtraMCInfo) \endcorrelationdiagram

Definition at line 70 of file ECLDigitizerModule.h.

Member Typedef Documentation

◆ adccounts_t

using adccounts_t = ECL::EclConfiguration::adccounts_t

private

ADC counts.

Definition at line 98 of file ECLDigitizerModule.h.

◆ algoparams_t

using algoparams_t = ECL::EclConfiguration::algoparams_t

private

algorithm parameters

Definition at line 95 of file ECLDigitizerModule.h.

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

◆ fitparams_t

using fitparams_t = ECL::EclConfiguration::fitparams_t

private

fit parameters

Definition at line 96 of file ECLDigitizerModule.h.

◆ int_array_192x16_t

using int_array_192x16_t = fitparams_t::int_array_192x16_t

private

weighting coefficients for time and amplitude calculation

Definition at line 100 of file ECLDigitizerModule.h.

◆ int_array_24x16_t

using int_array_24x16_t

private

Initial value:

fitparams_t::int_array_24x16_t

Belle2::ECL::EclConfiguration::fitparams_t::int_array_24x16_t

int int_array_24x16_t[m_ndt/4][16]

Array for DSP coefs in fast fit.

Definition EclConfiguration.h:102

weighting coefficients amplitude calculation.

Time is fixed by trigger

Definition at line 101 of file ECLDigitizerModule.h.

◆ signalsample_t

using signalsample_t = ECL::EclConfiguration::signalsample_t

private

signal sample

Definition at line 97 of file ECLDigitizerModule.h.

◆ uint_pair_t

using uint_pair_t = std::pair<unsigned int, unsigned int>

private

a pair of unsigned ints

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

◆ ECLDigitizerModule()

ECLDigitizerModule ( )

Constructor.

Definition at line 50 of file ECLDigitizerModule.cc.

                                       : Module(), m_waveformParametersMC("ECLDigitWaveformParametersForMC"),
  m_waveformParameters("ECLWFParameters"),
  m_algoParameters("ECLWFAlgoParams"),
  m_noiseParameters("ECLWFNoiseParams")
{
  //Set module properties
  setDescription("Creates ECLDigiHits from ECLHits.");
  setPropertyFlags(c_ParallelProcessingCertified);
  addParam("TriggerTime", m_trigTime,
           "Flag to use crate trigger times from beam background overlay if there are any (default: false)", false);
  addParam("Background", m_background, "Flag to use the Digitizer configuration with backgrounds (default: false)", false);
  addParam("Calibration", m_calibration, "Flag to use the Digitizer for Waveform fit Covariance Matrix calibration (default: false)",
           false);
  addParam("DiodeDeposition", m_inter,
           "Flag to take into account energy deposition in photodiodes; Default diode is sensitive detector (default: true)", true);
  addParam("WaveformMaker", m_waveformMaker, "Flag to produce background waveform digits (default: false)", false);
  addParam("CompressionAlgorithm", m_compAlgo, "Waveform compression algorithm (default: 0u)", 0u);
  addParam("eclWaveformsName", m_eclWaveformsName, "Name of the output/input collection (digitized waveforms)", string(""));
  addParam("HadronPulseShapes", m_HadronPulseShape, "Flag to include hadron component in pulse shape construction (default: true)",
           true);
  addParam("ADCThreshold", m_ADCThreshold, "ADC threshold for waveform fits (default: 25)", 25);
  addParam("WaveformThresholdOverride", m_WaveformThresholdOverride,
           "If gt 0 value is applied to all crystals for waveform saving threshold. If lt 0 dbobject is used. (GeV)", -1.0);
  addParam("StoreDspWithExtraMCInfo", m_storeDspWithExtraMCInfo,
           "Flag to store Dsp with extra MC information in addition to normal Dsp (default: false)", false);
  addParam("DspWithExtraMCInfoThreshold", m_DspWithExtraMCInfoThreshold,
           "Threshold above with to store Dsp with extra MC information [GeV]",
           0.02);
  addParam("DspDataTest", m_dspDataTest,
           "Use DSP coefficients from the database for the processing. This "
           "will significantly reduce performance so this option is to be "
           "used for testing only.", false);
  addParam("useWaveformParameters", m_useWaveformParameters,
           "Use ECLWF{Parameters,AlgoParams,NoiseParams} payloads", true);
  addParam("unitscale", m_unitscale,
           "Normalization coefficient for ECL signal shape. "
           "If positive, use same static value for all ECL channels. "
           "If negative, calculate dynamically at beginRun().", -1.0);
 
}

◆ ~ECLDigitizerModule()

~ECLDigitizerModule ( )

override

Destructor.

Definition at line 91 of file ECLDigitizerModule.cc.

92{

93}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

Nothing so far.

Reimplemented from Module.

Definition at line 129 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
  double ns_per_tick = 1.0 / (4.0 * ec.getRF()) * 1e3;// ~0.49126819903043308239 ns/tick
 
  if (m_useWaveformParameters || m_loadOnce) {
    readDSPDB();
    m_loadOnce = false;
  }
 
  calibration_t def = {1, 0};
  m_calib.assign(ECLElementNumbers::c_NCrystals, def);
 
  if (m_CrystalElectronics.isValid()) {
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_calib[i].ascale /= m_CrystalElectronics->getCalibVector()[i];
  }
  if (m_CrystalEnergy.isValid()) {
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_calib[i].ascale /= m_CrystalEnergy->getCalibVector()[i] * 20000.0;
  }
  if (m_CrystalElectronicsTime.isValid()) {
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_calib[i].tshift += m_CrystalElectronicsTime->getCalibVector()[i] * ns_per_tick;
  }
  if (m_CrystalTimeOffset.isValid()) {
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_calib[i].tshift += m_CrystalTimeOffset->getCalibVector()[i] * ns_per_tick;
  }
  if (m_CrateTimeOffset.isValid()) {
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_calib[i].tshift += m_CrateTimeOffset->getCalibVector()[i] * ns_per_tick;
  }
  if (m_MCTimeOffset.isValid()) {
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_calib[i].tshift += m_MCTimeOffset->getCalibVector()[i] * ns_per_tick;
  }
  m_Awave.assign(ECLElementNumbers::c_NCrystals, -1);
  if (m_WaveformThresholdOverride < 0) {
    if (m_FPGAWaveform.isValid()) {
      for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
        m_Awave[i] = m_FPGAWaveform->getCalibVector()[i];
    }
  } else {
    //If m_WaveformThresholdOverride > 0 override ECL_FPGA_StoreWaveform;
    for (int i = 0; i < ECLElementNumbers::c_NCrystals; i++)
      m_Awave[i] = m_WaveformThresholdOverride * m_calib[i].ascale; // convert GeV to ADC
  }
 
  if (m_HadronPulseShape)
    callbackHadronSignalShapes();
 
  // Initialize channel mapper at run start to account for possible
  // changes in ECL mapping between runs.
  if (!m_eclMapper.initFromDB()) {
    B2FATAL("ECLDigitizer: Can't initialize eclChannelMapper!");
  }
}

◆ callbackHadronSignalShapes()

void callbackHadronSignalShapes ( )

private

callback hadron signal shapes from database

Definition at line 526 of file ECLDigitizerModule.cc.

{
 
  if (m_waveformParametersMC.hasChanged()) {
 
    m_ss_HadronShapeSimulations.resize(3);
 
    //read MC templates from database
    float photonParsPSD[10];
    float hadronParsPSD[10];
    float diodeParsPSD[10];
    for (int i = 0; i < 10; i++) {
      photonParsPSD[i] = m_waveformParametersMC->getPhotonParameters()[i + 1];
      hadronParsPSD[i] = m_waveformParametersMC->getHadronParameters()[i + 1];
      diodeParsPSD[i] = m_waveformParametersMC->getDiodeParameters()[i + 1];
    }
 
    //Initialize templates for hadron shape simulations
    m_ss_HadronShapeSimulations[0].InitSample(photonParsPSD, m_waveformParametersMC->getPhotonParameters()[0]);
    m_ss_HadronShapeSimulations[1].InitSample(hadronParsPSD, m_waveformParametersMC->getHadronParameters()[0]);
    m_ss_HadronShapeSimulations[2].InitSample(diodeParsPSD, m_waveformParametersMC->getDiodeParameters()[0]);
 
  }
 
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ 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 438 of file Module.h.

438{ 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 431 of file Module.h.

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

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

444{ terminate(); }

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Definition at line 165 of file Module.h.

165{};

◆ 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 hits in the ECL.

The digitized hits are written into the DataStore.

Reimplemented from Module.

Definition at line 390 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
 
  // make relation between cellid and eclhits
  struct ch_t {int cell, id;};
  vector<ch_t> hitmap;
  for (const auto& hit : m_eclHits) {
    int j = hit.getCellId() - 1; //0~8735
    if (hit.getBackgroundTag() == BackgroundMetaData::bg_none) hitmap.push_back({j, hit.getArrayIndex()});
    //    cout<<"C:"<<hit.getBackgroundTag()<<" "<<hit.getCellId()<<" "<<hit.getEnergyDep()<<" "<<hit.getTimeAve()<<endl;
  }
 
  bool isBGOverlay = m_eclWaveforms.isValid(), isTrigTime = false;
  BitStream out;
  ECLCompress* comp = nullptr;
 
  // check background overlay
  if (isBGOverlay) {
    std::swap(out.getStore(), m_eclWaveforms->getStore());
    out.setPos(0);
    unsigned int compAlgo = out.getNBits(8);
    comp = selectAlgo(compAlgo & 0x7f);
    if (comp == nullptr)
      B2FATAL("Unknown compression algorithm: " << compAlgo);
    isTrigTime = compAlgo >> 7; // crate trigger times are stored and retrieved
    if (isTrigTime) {
      for (int i = 0; i < ECL::ECL_CRATES; i++) {
        unsigned char t = out.getNBits(7); // [0..72)
        m_ttime[i] = t;
      }
    }
  }
 
  if (!m_trigTime || !isTrigTime) { // reproduce previous logic -- one trigger time for all crates
    int DeltaT = gRandom->Uniform(0, double(ec.m_ntrg) * 0.5); // trigger decision can come in any time [0..72)
    for (int id = 0; id < ECL::ECL_CRATES; id++) m_ttime[id] = DeltaT;
  }
 
  int triggerTag0 = m_EventMetaData->getEvent();
  for (int id = 0; id < ECL::ECL_CRATES; id++) {
    auto eclTrig = m_eclTrigs.appendNew();
    int triggerPhase0 = 2 * (m_ttime[id] + m_ttime[id] / 3);
    eclTrig->setTrigId(id);
    eclTrig->setTimeTrig(triggerPhase0);
    eclTrig->setTrigTag(triggerTag0);
  }
 
  shapeSignals();
 
  // We want to produce background waveforms in simulation first than
  // dump to a disk, read from the disk to test before real data
  if (m_waveformMaker) { makeWaveforms(); return; }
 
  std::vector<int> FitA(ec.m_nsmp); // buffer for the waveform fitter
 
  // loop over entire calorimeter
  for (int j = 0; j < ec.m_nch; j++) {
    const adccounts_t& a = m_adc[j];
 
    //normalize the MC true arrival times
    if (m_adc[j].totalDep > 0) {
      m_adc[j].flighttime /= m_adc[j].totalDep;
      m_adc[j].timeshift /= m_adc[j].totalDep;
      m_adc[j].timetosensor /= m_adc[j].totalDep;
    }
 
    // if background waveform is here there is no need to generate
    // electronic noise since it is already in the waveform
    if (isBGOverlay) {
      comp->uncompress(out, FitA.data());
    } else {
      // Signal amplitude should be above 100 keV
      if (a.total < 0.0001) continue;
      makeElectronicNoiseAndPedestal(j, FitA.data());
    }
 
    for (int i = 0; i < ec.m_nsmp; i++) {
      int A = 20000 * a.c[i] + FitA[i];
      FitA[i] = max(0, min(A, (1 << 18) - 1));
    }
 
    int  energyFit = 0; // fit output : Amplitude 18 bits
    int       tFit = 0; // fit output : T_ave     12 bits
    int qualityFit = 0; // fit output : quality    2 bits
    int        chi = 0; // fit output : chi square   it is not available in the experiment
 
    int id = m_eclMapper.getCrateID(j + 1) - 1; // 0 .. 51
    int ttrig = 2 * m_ttime[id];
 
    shapeFitterWrapper(j, FitA.data(), ttrig, energyFit, tFit, qualityFit, chi);
 
    if (energyFit > m_ADCThreshold) {
      int CellId = j + 1;
 
      //note energyFit and m_Awave is in ADC units
      if (energyFit > m_Awave[CellId - 1]) {
        //only save waveforms above ADC threshold
        const auto eclDsp = m_eclDsps.appendNew();
        eclDsp->setCellId(CellId);
        eclDsp->setDspA(FitA.data());
      }
 
      // only store extra MC info if requested and above threshold
      if (m_storeDspWithExtraMCInfo and  a.totalDep >= m_DspWithExtraMCInfoThreshold) {
        const auto eclDspWithExtraMCInfo = m_eclDspsWithExtraMCInfo.appendNew();
        eclDspWithExtraMCInfo->setCellId(CellId);
        eclDspWithExtraMCInfo->setDspA(FitA.data());
        eclDspWithExtraMCInfo->setEnergyDep(a.totalDep);
        eclDspWithExtraMCInfo->setHadronEnergyDep(a.totalHadronDep);
        eclDspWithExtraMCInfo->setFlightTime(a.flighttime);
        eclDspWithExtraMCInfo->setTimeShift(a.timeshift);
        eclDspWithExtraMCInfo->setTimeToSensor(a.timetosensor);
        eclDspWithExtraMCInfo->setEnergyConversion(a.energyConversion * 20000);
      }
 
      const auto eclDigit = m_eclDigits.appendNew();
      eclDigit->setCellId(CellId); // cellId in range from 1 to 8736
      eclDigit->setAmp(energyFit); // E (GeV) = energyFit/20000;
      eclDigit->setTimeFit(tFit);  // t0 (us)= (1520 - m_ltr)*24.*12/508/(3072/2) ;
      eclDigit->setQuality(qualityFit);
      if (qualityFit == 2)
        eclDigit->setChi(chi);
      else eclDigit->setChi(0);
      for (const auto& hit : hitmap)
        if (hit.cell == j) eclDigit->addRelationTo(m_eclHits[hit.id]);
 
      // set relation to DspWithExtraInfo
      for (auto& DspWithExtraMCInfo : m_eclDspsWithExtraMCInfo) {
        if (eclDigit->getCellId() == DspWithExtraMCInfo.getCellId()) DspWithExtraMCInfo.addRelationTo(eclDigit);
      }
    }
  } //store each crystal hit
  if (comp) delete comp;
}

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

◆ 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, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getfitparams()

void getfitparams	(	const ECLWaveformData &	eclWFData,
		const ECLWFAlgoParams &	eclWFAlgo,
		fitparams_t &	p )

private

load waveform fit parameters for the shapeFitter function

Definition at line 736 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
 
  double ssd[16][16];
  eclWFData.getMatrix(ssd);
  vector<double> MP(10);
  eclWFData.getWaveformParArray(MP.data());
 
  // shape function parameters
  int iff = 1 << 14;   //Alex Bobrov for correct chi square
 
  int ia = 1 << eclWFAlgo.getka();
  int ib = 1 << eclWFAlgo.getkb();
  int ic = 1 << eclWFAlgo.getkc();
 
  double dbl_f   [192][16];
  double dbl_f1  [192][16];
  double dbl_fg31[192][16];
  double dbl_fg32[192][16];
  double dbl_fg33[192][16];
  double dbl_fg41[24][16];
  double dbl_fg43[24][16];
 
  int_array_192x16_t& ref_f    = p.f;
  int_array_192x16_t& ref_f1   = p.f1;
  int_array_192x16_t& ref_fg31 = p.fg31;
  int_array_192x16_t& ref_fg32 = p.fg32;
  int_array_192x16_t& ref_fg33 = p.fg33;
  int_array_24x16_t&  ref_fg41 = p.fg41;
  int_array_24x16_t&  ref_fg43 = p.fg43;
 
  // Dynamic normalization coefficient for shape function
  double fm = 0;
 
  double unitscale = 1.0;
  if (m_unitscale > 0) unitscale = m_unitscale;
 
  ShaperDSP_t dsp(MP, unitscale);
  dsp.settimestride(ec.m_step);
  dsp.setseedoffset(ec.m_step / ec.m_ndt);
  dsp.settimeseed(-(ec.m_step - (ec.m_step / ec.m_ndt)));
  vector<dd_t> f(16);
  for (int k = 0; k < 2 * ec.m_ndt; k++, dsp.nextseed()) { // calculate fit parameters around 0 +- 1 ADC tick
    dsp.fillvector(f);
 
    double g0g0 = 0, g0g1 = 0, g1g1 = 0, g0g2 = 0, g1g2 = 0, g2g2 = 0;
    double sg0[16], sg1[16], sg2[16];
    for (int j = 0; j < 16; j++) {
      double g0 = 0, g1 = 0, g2 = 0;
      for (int i = 0; i < 16; i++) {
        if (fm < f[i].first) fm = f[i].first;
        g0 += ssd[j][i] * f[i].first;
        g1 += ssd[j][i] * f[i].second;
        g2 += ssd[j][i];
      }
      g0g0 += g0 * f[j].first;
      g0g1 += g1 * f[j].first;
      g1g1 += g1 * f[j].second;
      g0g2 += g0;
      g1g2 += g1;
      g2g2 += g2;
      sg0[j] = g0;
      sg1[j] = g1;
      sg2[j] = g2;
    }
 
    double a00 = g1g1 * g2g2 - g1g2 * g1g2;
    double a11 = g0g0 * g2g2 - g0g2 * g0g2;
    double a22 = g0g0 * g1g1 - g0g1 * g0g1;
    double a01 = g1g2 * g0g2 - g0g1 * g2g2;
    double a02 = g0g1 * g1g2 - g1g1 * g0g2;
    double a12 = g0g1 * g0g2 - g0g0 * g1g2;
 
    double igg2 = 1 / (a11 * g1g1 + g0g1 * a01 + g1g2 * a12);
 
    // to fixed point representation
    const double isd = 3. / 4., sd = 1 / isd ; // conversion factor (???)
    for (int i = 0; i < 16; i++) {
      double w = i ? 1.0 : 1. / 16.;
 
      dbl_f   [k][i] = (f[i].first  * iff * w);
      dbl_f1  [k][i] = (f[i].second * iff * w * sd);
 
      double fg31 = (a00 * sg0[i] + a01 * sg1[i] + a02 * sg2[i]) * igg2;
      double fg32 = (a01 * sg0[i] + a11 * sg1[i] + a12 * sg2[i]) * igg2;
      double fg33 = (a02 * sg0[i] + a12 * sg1[i] + a22 * sg2[i]) * igg2;
 
      dbl_fg31[k][i] = (fg31 * ia * w);
      dbl_fg32[k][i] = (fg32 * ib * w * isd);
      dbl_fg33[k][i] = (fg33 * ic * w);
    }
 
    //first approximation without time correction
    int jk = 23 + ((48 - k) >> 2);
    if (jk >= 0 && jk < 24 && (48 - k) % 4 == 0) {
 
      double igg1 = 1 / a11;
      // to fixed point
      for (int i = 0; i < 16; i++) {
        double w = i ? 1.0 : 1. / 16.;
 
        double fg41 = (g2g2 * sg0[i] - g0g2 * sg2[i]) * igg1;
        double fg43 = (g0g0 * sg2[i] - g0g2 * sg0[i]) * igg1;
        dbl_fg41[jk][i] = (fg41 * ia * w);
        dbl_fg43[jk][i] = (fg43 * ic * w);
      }
    }
  }
  // Ignore dynamically calculated normalization coefficient if
  // unitscale is set to a static positive value.
  if (m_unitscale > 0) fm = 1.0;
  for (int k = 0; k < 2 * ec.m_ndt; k++) {
    for (int j = 0; j < 16; j++) {
      ref_f   [k][j] = lrint(dbl_f   [k][j] / fm);
      ref_f1  [k][j] = lrint(dbl_f1  [k][j] / fm);
      ref_fg31[k][j] = lrint(dbl_fg31[k][j] * fm);
      ref_fg32[k][j] = lrint(dbl_fg32[k][j] * fm);
      ref_fg33[k][j] = lrint(dbl_fg33[k][j]);
      if (k >= 24) continue;
      ref_fg41[k][j] = lrint(dbl_fg41[k][j] * fm);
      ref_fg43[k][j] = lrint(dbl_fg43[k][j]);
    }
  }
}

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

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

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

overridevirtual

Initialize variables.

Reimplemented from Module.

Definition at line 95 of file ECLDigitizerModule.cc.

{
  m_eclDsps.registerInDataStore();
  if (m_storeDspWithExtraMCInfo) m_eclDspsWithExtraMCInfo.registerInDataStore();
  m_eclDigits.registerInDataStore();
  m_eclTrigs.registerInDataStore();
 
  if (m_HadronPulseShape) {
    B2DEBUG(20,
            "Hadron pulse shapes for ECL simulations are enabled.  Pulse shape simulations use techniques validated with test beam data documented in: S. Longo and J. M. Roney 2018 JINST 13 P03018");
  } else {
    B2DEBUG(20, "Hadron pulse shapes for ECL simulations are disabled.");
  }
 
  if (m_inter) {
    B2DEBUG(20, "Diode-crossing pulse shapes for ECL simulations are enabled.");
  } else {
    B2DEBUG(20, "Diode-crossing pulse shapes for ECL simulations are disabled.");
  }
 
  m_eclDiodeHits.registerInDataStore("ECLDiodeHits");
 
  m_eclDsps.registerRelationTo(m_eclDigits);
  if (m_storeDspWithExtraMCInfo)
    m_eclDspsWithExtraMCInfo.registerRelationTo(m_eclDigits);
  m_eclDigits.registerRelationTo(m_eclHits);
  if (m_waveformMaker)
    m_eclWaveforms.registerInDataStore(m_eclWaveformsName);
 
  m_adc.resize(EclConfiguration::m_nch);
 
  EclConfiguration::get().setBackground(m_background);
}

◆ makeElectronicNoiseAndPedestal()

void makeElectronicNoiseAndPedestal	(	int	j,
		int *	FitA )

private

fill the waveform array FitA by electronic noise and bias it for channel J [0-8735]

Definition at line 351 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
  std::vector<float> z(ec.m_nsmp), AdcNoise(ec.m_nsmp); // buffers with electronic noise
  // Noise generation
  for (int i = 0; i < ec.m_nsmp; i++) z[i] = gRandom->Gaus(0, 1);
  m_noise[m_tbl[J].inoise].generateCorrelatedNoise(z.data(), AdcNoise.data());
  for (int i = 0; i < ec.m_nsmp; i++) FitA[i] = 20 * AdcNoise[i] + 3000;
}

◆ makeWaveforms()

void makeWaveforms ( )

private

Produce and compress waveforms for beam background overlay.

Definition at line 361 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
  BitStream out(ec.m_nch * ec.m_nsmp * 18 / 32);
  out.putNBits(m_compAlgo & 0xff, 8);
  ECLCompress* comp = selectAlgo(m_compAlgo & 0xff);
  if (comp == nullptr)
    B2FATAL("Unknown compression algorithm: " << m_compAlgo);
 
  std::vector<int> FitA(ec.m_nsmp); // buffer for the waveform fitter
  // loop over entire calorimeter
  for (int j = 0; j < ec.m_nch; j++) {
    const adccounts_t& a = m_adc[j];
    makeElectronicNoiseAndPedestal(j, FitA.data());
    for (int  i = 0; i < ec.m_nsmp; i++) {
      int A = 20000 * a.c[i] + FitA[i];
      FitA[i] = max(0, min(A, (1 << 18) - 1));
    }
    comp->compress(out, FitA.data());
  }
  out.resize();
 
  ECLWaveforms* wf = new ECLWaveforms;
  m_eclWaveforms.assign(wf);
 
  std::swap(out.getStore(), wf->getStore());
  delete comp;
}

◆ readDSPDB()

void readDSPDB ( )

private

read Shaper-DSP data from root file

Definition at line 552 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
 
  TFile* rootfile = nullptr;
  TTree* tree  = nullptr;
  TTree* tree2 = nullptr;
  TTree* tree3 = nullptr;
 
  if (m_useWaveformParameters) {
    bool hasChanged = false;
    hasChanged |= m_waveformParameters.hasChanged();
    hasChanged |= m_algoParameters.hasChanged();
    hasChanged |= m_noiseParameters.hasChanged();
 
    if (!hasChanged) return;
 
    tree  = const_cast<TTree*>(&*m_waveformParameters);
    tree2 = const_cast<TTree*>(&*m_algoParameters);
    tree3 = const_cast<TTree*>(&*m_noiseParameters);
  } else {
    string dataFileName;
    if (m_background) {
      dataFileName = FileSystem::findFile("/data/ecl/ECL-WF-BG.root");
      B2DEBUG(150, "ECLDigitizer: Reading configuration data with background from: " << dataFileName);
    } else {
      dataFileName = FileSystem::findFile("/data/ecl/ECL-WF.root");
      B2DEBUG(150, "ECLDigitizer: Reading configuration data without background from: " << dataFileName);
    }
    assert(! dataFileName.empty());
 
    rootfile = new TFile(dataFileName.c_str(), "read");
    tree  = static_cast<TTree*>(rootfile->Get("EclWF"));
    tree2 = static_cast<TTree*>(rootfile->Get("EclAlgo"));
    tree3 = static_cast<TTree*>(rootfile->Get("EclNoise"));
  }
 
  if (tree == 0 || tree2 == 0 || tree3 == 0) B2FATAL("Data not found");
 
  m_tbl.resize(ec.m_nch);
 
  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());
 
  vector<int> eclWaveformDataTable(ec.m_nch);
  for (Long64_t j = 0, jmax = tree->GetEntries(); j < jmax; j++) {
    tree->GetEntry(j);
    assert(ncellId <= maxncellid);
    for (int i = 0; i < ncellId; ++i)
      eclWaveformDataTable[cellId[i] - 1] = j;
  }
  B2DEBUG(150, "ECLDigitizer: " << tree->GetEntries() << " sets of wave form covariance matrices will be used.");
 
  ECLWFAlgoParams* algo = new ECLWFAlgoParams;
  tree2->SetBranchAddress("Algopars", &algo);
  tree2->SetBranchAddress("ncellId", &ncellId);
  tree2->SetBranchAddress("cellId", cellId.data());
  Long64_t jmax2 = tree2->GetEntries();
  vector<ECLWFAlgoParams> eclWFAlgoParams;
  eclWFAlgoParams.reserve(jmax2);
  for (Long64_t j = 0; j < jmax2; j++) {
    tree2->GetEntry(j);
    assert(ncellId <= maxncellid);
    eclWFAlgoParams.push_back(*algo);
    for (int i = 0; i < ncellId; ++i)
      m_tbl[cellId[i] - 1].idn = j;
  }
  if (algo) delete algo;
  B2DEBUG(150, "ECLDigitizer: " << eclWFAlgoParams.size() << " parameter sets of fitting algorithm were read.");
 
  ECLNoiseData* noise = new ECLNoiseData;
  tree3->SetBranchAddress("NoiseM", &noise);
  tree3->SetBranchAddress("ncellId", &ncellId);
  tree3->SetBranchAddress("cellId", cellId.data());
 
  Long64_t jmax3 = tree3->GetEntries();
  m_noise.reserve(jmax3);
  for (Long64_t j = 0; j < jmax3; j++) {
    tree3->GetEntry(j);
    assert(ncellId <= maxncellid);
    m_noise.push_back(*noise);
    if (ncellId == 0) {
      for (int i = 0; i < ec.m_nch; i++)
        m_tbl[i].inoise = 0;
      break;
    } else {
      for (int i = 0; i < ncellId; ++i)
        m_tbl[cellId[i] - 1].inoise = j;
    }
  }
  if (noise) delete noise;
  B2DEBUG(150, "ECLDigitizer: " << eclWFAlgoParams.size() << " noise matrices were loaded.");
 
  // repack fitting algorithm parameters
  m_idn.resize(eclWFAlgoParams.size());
  for (int i = 0, imax = eclWFAlgoParams.size(); i < imax; i++)
    repack(eclWFAlgoParams[i], m_idn[i]);
 
  vector<uint_pair_t> pairIdx;
  for (int i = 0; i < ec.m_nch; i++) {
    unsigned int   wfIdx = eclWaveformDataTable[i];
    unsigned int algoIdx = m_tbl[i].idn;
    uint_pair_t p(wfIdx, algoIdx);
    vector<uint_pair_t>::iterator ip = find(pairIdx.begin(), pairIdx.end(), p);
    if (ip != pairIdx.end()) { // crystal i already have the same parameters as before
      m_tbl[i].ifunc = ip - pairIdx.begin();
    } else {                  // new combination of parameters
      m_tbl[i].ifunc = pairIdx.size();
      pairIdx.push_back(p);
    }
  }
 
  // now we know how many distinct elements of the (Waveform x AlgoParams) matrix should be
  m_fitparams.resize(pairIdx.size());
 
  ECLWaveformData* eclWFData = new ECLWaveformData;
  tree->SetBranchAddress("CovarianceM", &eclWFData);
  tree->SetBranchStatus("ncellId", 0); // do not read it at the moment
  tree->SetBranchStatus("cellId", 0); // do not read it at the moment
 
  // fill parameters for each (Waveform x AlgoParams) parameter set
  for (unsigned int ip = 0; ip < pairIdx.size(); ip++) {
    const uint_pair_t& p = pairIdx[ip];
    tree->GetEntry(p.first); // retrieve data to eclWFData pointer
    getfitparams(*eclWFData, eclWFAlgoParams[p.second], m_fitparams[ip]);
  }
  B2DEBUG(150, "ECLDigitizer: " << m_fitparams.size() << " fitting crystals groups were created.");
 
  // 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(2);
  float MP[10]; eclWFData->getWaveformParArray(MP);
  m_ss[0].InitSample(MP, 27.7221);
  // parameters vector from ps.dat file, time offset 0.5 usec added to
  // have peak position with parameters from ps.dat roughly in the
  // same place as in current MC
  // double crystal_params[10] = {0.5, 0.301298, 0.631401, 0.470911, 0.903988, -0.11734200/19.5216, 2.26567, 0.675393, 0.683995, 0.0498786};
  // m_ss[0].InitSample(crystal_params, 0.9999272*19.5216);
  for (int i = 0; i < ec.m_nch; i++) m_tbl[i].iss = 0;
  // one sampled diode response in the pool, parameters vector from
  // pg.dat file, time offset 0.5 usec added to have peak position with
  // parameters from ps.dat roughly in the same place as in current MC
  const double diode_params[] = {0 + 0.5, 0.100002, 0.756483, 0.456153, 0.0729031, 0.3906 / 9.98822, 2.85128, 0.842469, 0.854184, 0.110284};
  m_ss[1].InitSample(diode_params, 0.9569100 * 9.98822);
 
  B2DEBUG(150, "ECLDigitizer: " << m_ss.size() << " sampled signal templates were created.");
 
  delete eclWFData;
 
  if (!m_useWaveformParameters) rootfile->Close();
}

◆ repack()

void repack	(	const ECLWFAlgoParams &	eclWFAlgo,
		algoparams_t &	t )

private

repack waveform fit parameters from ROOT format to plain array of unsigned short for the shapeFitter function

Definition at line 708 of file ECLDigitizerModule.cc.

{
  // filling short int array
  t.id[ 0] = eclWFAlgo.getlAT() + 128;
  t.id[ 1] = eclWFAlgo.getsT()  + 128;
  t.id[ 2] = eclWFAlgo.gethT();
  t.id[ 3] = 17952;
  t.id[ 4] = 19529;
  t.id[ 5] = 69;
  t.id[ 6] = 0;
  t.id[ 7] = 0;
  t.id[ 8] = 257;
  t.id[ 9] = -1;
  t.id[10] = 0;
  t.id[11] = 0;
 
  // filling unsigned char array
  t.ic[12 * 2 + 0] = eclWFAlgo.getk1();
  t.ic[12 * 2 + 1] = eclWFAlgo.getk2();
  t.ic[13 * 2 + 0] = eclWFAlgo.getka();
  t.ic[13 * 2 + 1] = eclWFAlgo.getkb();
  t.ic[14 * 2 + 0] = eclWFAlgo.getkc();
  t.ic[14 * 2 + 1] = eclWFAlgo.gety0s() - 16;
 
  // again, filling short int array
  t.id[15] = eclWFAlgo.getcT();
}

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

◆ shapeFitterWrapper()

void shapeFitterWrapper	(	const int	j,
		const int *	FitA,
		const int	m_ttrig,
		int &	m_lar,
		int &	m_ltr,
		int &	m_lq,
		int &	m_chi ) const

private

function wrapper for waveform fit

Definition at line 189 of file ECLDigitizerModule.cc.

{
  const crystallinks_t& t = m_tbl[j]; //lookup table [0,8735]
  const fitparams_t& r = m_fitparams[t.ifunc];
 
  ECLShapeFit result;
 
  if (!m_dspDataTest) {
    const short int* id = m_idn[t.idn].id;
 
    int A0  = (int) * (id + 0) - 128;
    int Askip  = (int) * (id + 1) - 128;
 
    int Ahard  = (int) * (id + 2);
    int k_a = (int) * (reinterpret_cast<const unsigned char*>(id) + 26);
    int k_b = (int) * (reinterpret_cast<const unsigned char*>(id) + 27);
    int k_c = (int) * (reinterpret_cast<const unsigned char*>(id) + 28);
    int k_16 = (int) * (reinterpret_cast<const unsigned char*>(id) + 29);
    int k1_chi = (int) * (reinterpret_cast<const unsigned char*>(id) + 24);
    int k2_chi = (int) * (reinterpret_cast<const unsigned char*>(id) + 25);
 
    int chi_thres = (int) * (id + 15);
 
    int trg_time = ttrig;
 
    result = lftda_(reinterpret_cast<const int*>(r.f), reinterpret_cast<const int*>(r.f1), reinterpret_cast<const int*>(r.fg41),
                    reinterpret_cast<const int*>(r.fg43),
                    reinterpret_cast<const int*>(r.fg31), reinterpret_cast<const int*>(r.fg32), reinterpret_cast<const int*>(r.fg33), FitA,
                    trg_time, A0, Ahard, Askip, k_a, k_b, k_c, k_16, k1_chi,
                    k2_chi, chi_thres);
  } else {
    std::vector<int> adc(31);
    for (int i = 0; i < 31; i++) adc[i] = FitA[i];
    // NOTE: ttrig_packed is any even number in set {8*Z, 8*Z + 2, 8*Z + 4}
    //       where Z is an integer number in 0..23 range
    // ttrig = ttrig_packed - 2 * (ttrig_packed / 8);
    // ttrig = 6*Z + q
    int ttrig_packed = ttrig / 6 * 8 + ttrig % 6;
    result = ECLDspUtilities::shapeFitter(j + 1, adc, ttrig_packed);
  }
 
  m_lar = result.amp;
  m_ltr = result.time;
  m_lq  = result.quality;
  m_chi = result.chi2;
 
  //== Set precision of chi^2 to be the same as in the raw data.
  int discarded_bits = 0;
  if ((m_chi & 0x7800000) != 0) {
    m_chi = 0x7800000;
  } else if ((m_chi & 0x0600000) != 0) {
    discarded_bits = 14;
  } else if ((m_chi & 0x0180000) != 0) {
    discarded_bits = 12;
  } else if ((m_chi & 0x0060000) != 0) {
    discarded_bits = 10;
  } else if ((m_chi & 0x0018000) != 0) {
    discarded_bits = 8;
  } else if ((m_chi & 0x0006000) != 0) {
    discarded_bits = 6;
  } else if ((m_chi & 0x0001800) != 0) {
    discarded_bits = 4;
  } else if ((m_chi & 0x0000600) != 0) {
    discarded_bits = 2;
  }
  if (discarded_bits > 0) {
    m_chi >>= discarded_bits;
    m_chi <<= discarded_bits;
  }
}

◆ shapeSignals()

void shapeSignals ( )

private

Emulate response of energy deposition in a crystal and attached photodiode and make waveforms.

Definition at line 261 of file ECLDigitizerModule.cc.

{
  const EclConfiguration& ec = EclConfiguration::get();
  ECLGeometryPar* eclp = ECLGeometryPar::Instance();
 
  const double trgtick = ec.s_clock / ec.getRF() / ec.m_ntrg;   // trigger tick
  const double tscale = 2 * trgtick, toff = ec.s_clock / (2 * ec.getRF());
 
  // clear the storage for the event
  memset(m_adc.data(), 0, m_adc.size()*sizeof(adccounts_t));
 
  const double E2GeV = 1 / Unit::GeV; // convert Geant energy units to GeV
  const double T2us = 1 / Unit::us; // convert Geant time units to microseconds
 
  // emulate response for ECL hits after ADC measurements
  for (const auto& hit : m_eclSimHits) {
    int cellId = hit.getCellId(); // 1 .. 8736
    int j = cellId - 1; // 0 .. 8735
    int id = m_eclMapper.getCrateID(cellId) - 1; // 0 .. 51
    double timeOffset = tscale * m_ttime[id] - toff;
    double hitE       = hit.getEnergyDep() * m_calib[j].ascale * E2GeV;
    double hitTimeAve = (hit.getFlightTime() + m_calib[j].tshift + eclp->time2sensor(j, hit.getPosition())) * T2us;
 
    m_adc[j].energyConversion = m_calib[j].ascale * E2GeV * 20000;
    m_adc[j].flighttime += hit.getFlightTime() * hit.getEnergyDep(); //true time weighted by energy
    m_adc[j].timeshift += m_calib[j].tshift * hit.getEnergyDep();
    m_adc[j].timetosensor += eclp->time2sensor(j, hit.getPosition()) * hit.getEnergyDep();
    m_adc[j].totalHadronDep += hit.getHadronEnergyDep(); // true deposited energy hadron component (in GeV)
    m_adc[j].totalDep += hit.getEnergyDep(); //true deposited energy (in GeV)
 
    if (m_HadronPulseShape == true) {
      double hitHadronE       = hit.getHadronEnergyDep() * m_calib[j].ascale * E2GeV;
      m_adc[j].AddHit(hitE - hitHadronE, hitTimeAve + timeOffset, m_ss_HadronShapeSimulations[0]);//Gamma Component
      m_adc[j].AddHit(hitHadronE, hitTimeAve + timeOffset, m_ss_HadronShapeSimulations[1]); //Hadron Component
    } else {
      m_adc[j].AddHit(hitE, hitTimeAve + timeOffset, m_ss[m_tbl[j].iss]);
    }
  }
 
  // add only background hits
  for (const auto& hit : m_eclHits) {
    if (hit.getBackgroundTag() == BackgroundMetaData::bg_none) continue;
    int cellId = hit.getCellId(); // 1 .. 8736
    int j = cellId - 1; // 0 .. 8735
    int id = m_eclMapper.getCrateID(cellId) - 1; // 0 .. 51
    double timeOffset = tscale * m_ttime[id] - toff;
    double hitE       = hit.getEnergyDep() * m_calib[j].ascale * E2GeV;
    double hitTimeAve = (hit.getTimeAve() + m_calib[j].tshift) * T2us;
    m_adc[j].AddHit(hitE, hitTimeAve + timeOffset, m_ss[m_tbl[j].iss]);
  }
 
  // internuclear counter effect -- charged particle crosses diode and produces signal
  if (m_inter) {
    // ionisation energy in Si is I = 3.6x10^-6 MeV for electron-hole pair
    // 5000 pairs in the diode per 1 MeV deposited in the crystal attached to the diode
    // conversion factor to get equivalent energy deposition in the crystal to sum up it with deposition in crystal
    const double diodeEdep2crystalEdep = E2GeV * (1 / (5000 * 3.6e-6));
    for (const auto& hit : m_eclDiodeHits) {
      int cellId = hit.getCellId(); // 1 .. 8736
      int j = cellId - 1; // 0 .. 8735
      int id = m_eclMapper.getCrateID(cellId) - 1; // 0 .. 51
      double timeOffset = tscale * m_ttime[id] - toff;
      double hitE       = hit.getEnergyDep() * m_calib[j].ascale * diodeEdep2crystalEdep;
      double hitTimeAve = (hit.getTimeAve() + m_calib[j].tshift) * T2us;
 
      adccounts_t& a = m_adc[j];
      // cout << "internuclearcountereffect " << j << " " << hit.getEnergyDep() << " " << hit.getTimeAve() << " " << a.total << endl;
      // for (int  i = 0; i < ec.m_nsmp; i++) cout << i << " " << a.c[i] << endl;
      if (m_HadronPulseShape) {
        a.AddHit(hitE, hitTimeAve + timeOffset, m_ss_HadronShapeSimulations[2]); // diode component
      } else {
        a.AddHit(hitE, hitTimeAve + timeOffset, m_ss[1]); // m_ss[1] is the sampled diode response
      }
      //    for (int  i = 0; i < ec.m_nsmp; i++) cout << i << " " << a.c[i] << endl;
    }
  }
 
  if (m_calibration) {
    // This has been added by Alex Bobrov for calibration
    // of covariance matrix artificially generate 100 MeV in time for each crystal
    double hitE = 0.1, hitTimeAve = 0.0;
    for (int j = 0; j < ec.m_nch; j++) {
      int cellId = j + 1; // 1 .. 8736
      int id = m_eclMapper.getCrateID(cellId) - 1; // 0 .. 51
      double timeOffset = tscale * m_ttime[id] - toff;
      m_adc[j].AddHit(hitE, hitTimeAve + timeOffset, m_ss[m_tbl[j].iss]);
    }
  }
}

◆ terminate()

virtual void terminate ( void )

inlinevirtualinherited

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

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

This method can be implemented by subclasses.

Definition at line 175 of file Module.h.

175{};

Member Data Documentation

◆ m_adc

std::vector<adccounts_t> m_adc

private

Storage for adc hits from entire calorimeter (8736 crystals)

ACD counts

Definition at line 128 of file ECLDigitizerModule.h.

◆ m_ADCThreshold

int m_ADCThreshold

private

ADC threshold for wavefom fits.

Definition at line 244 of file ECLDigitizerModule.h.

◆ m_algoParameters

DBObjPtr<TTree> m_algoParameters

private

Shape fitting algorithm parameters.

Definition at line 177 of file ECLDigitizerModule.h.

◆ m_Awave

std::vector<double> m_Awave

private

Storage for waveform saving thresholds.

Definition at line 139 of file ECLDigitizerModule.h.

◆ m_background

bool m_background

private

Module parameters.

background flag

Definition at line 238 of file ECLDigitizerModule.h.

◆ m_calib

std::vector<calibration_t> m_calib

private

Storage for calibration constants.

Definition at line 136 of file ECLDigitizerModule.h.

◆ m_calibration

bool m_calibration

private

calibration flag

Definition at line 239 of file ECLDigitizerModule.h.

◆ m_compAlgo

unsigned int m_compAlgo

private

compression algorithm for background waveforms

Definition at line 243 of file ECLDigitizerModule.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_CrateTimeOffset

DBObjPtr<ECLCrystalCalib> m_CrateTimeOffset {"ECLCrateTimeOffset"}

private

Crate time offset.

Definition at line 195 of file ECLDigitizerModule.h.

195{"ECLCrateTimeOffset"};

◆ m_CrystalElectronics

DBObjPtr<ECLCrystalCalib> m_CrystalElectronics {"ECLCrystalElectronics"}

private

Crystal electronics.

Definition at line 183 of file ECLDigitizerModule.h.

183{"ECLCrystalElectronics"};

◆ m_CrystalElectronicsTime

DBObjPtr<ECLCrystalCalib> m_CrystalElectronicsTime {"ECLCrystalElectronicsTime"}

private

Crystal electronics time.

Definition at line 189 of file ECLDigitizerModule.h.

189{"ECLCrystalElectronicsTime"};

◆ m_CrystalEnergy

DBObjPtr<ECLCrystalCalib> m_CrystalEnergy {"ECLCrystalEnergy"}

private

Crystal energy.

Definition at line 186 of file ECLDigitizerModule.h.

186{"ECLCrystalEnergy"};

◆ m_CrystalTimeOffset

DBObjPtr<ECLCrystalCalib> m_CrystalTimeOffset {"ECLCrystalTimeOffset"}

private

Crystal time offset.

Definition at line 192 of file ECLDigitizerModule.h.

192{"ECLCrystalTimeOffset"};

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_dspDataTest

bool m_dspDataTest

private

DSP data usage flag.

Definition at line 251 of file ECLDigitizerModule.h.

◆ m_DspWithExtraMCInfoThreshold

double m_DspWithExtraMCInfoThreshold

private

Energy threshold above which to store DSPs with extra information.

Definition at line 246 of file ECLDigitizerModule.h.

◆ m_eclDigits

StoreArray<ECLDigit> m_eclDigits

private

Output Arrays.

Waveform fit result.

Definition at line 223 of file ECLDigitizerModule.h.

◆ m_eclDiodeHits

StoreArray<ECLHit> m_eclDiodeHits

private

Diode hits array.

Definition at line 212 of file ECLDigitizerModule.h.

◆ m_eclDsps

StoreArray<ECLDsp> m_eclDsps

private

Generated waveforms.

Definition at line 226 of file ECLDigitizerModule.h.

◆ m_eclDspsWithExtraMCInfo

StoreArray<ECLDspWithExtraMCInfo> m_eclDspsWithExtraMCInfo

private

Generated waveforms with extra MC information.

Definition at line 229 of file ECLDigitizerModule.h.

◆ m_eclHits

StoreArray<ECLHit> m_eclHits

private

Hits array.

Definition at line 209 of file ECLDigitizerModule.h.

◆ m_eclMapper

ECL::ECLChannelMapper m_eclMapper

private

Channel Mapper.

channel mapper to utilize trigger information

Definition at line 235 of file ECLDigitizerModule.h.

◆ m_eclSimHits

StoreArray<ECLSimHit> m_eclSimHits

private

SimHits array.

Definition at line 215 of file ECLDigitizerModule.h.

◆ m_eclTrigs

StoreArray<ECLTrig> m_eclTrigs

private

Trigger information.

Definition at line 232 of file ECLDigitizerModule.h.

◆ m_eclWaveforms

StoreObjPtr<ECLWaveforms> m_eclWaveforms

private

Compressed waveforms.

Definition at line 218 of file ECLDigitizerModule.h.

◆ m_eclWaveformsName

std::string m_eclWaveformsName

private

name of background waveforms storage

Definition at line 248 of file ECLDigitizerModule.h.

◆ m_EventMetaData

StoreObjPtr<EventMetaData> m_EventMetaData

private

Event metadata.

Definition at line 204 of file ECLDigitizerModule.h.

◆ m_fitparams

std::vector<fitparams_t> m_fitparams

private

Pairs of (waveform parameters, fit parameters)

Definition at line 122 of file ECLDigitizerModule.h.

◆ m_FPGAWaveform

DBObjPtr<ECLCrystalCalib> m_FPGAWaveform {"ECL_FPGA_StoreWaveform"}

private

FPGA waveform.

Definition at line 201 of file ECLDigitizerModule.h.

201{"ECL_FPGA_StoreWaveform"};

◆ m_HadronPulseShape

bool m_HadronPulseShape

private

hadron pulse shape flag

Definition at line 249 of file ECLDigitizerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_idn

std::vector<algoparams_t> m_idn

private

Fit algorithm parameters shared by group of crystals.

parameters that needs for waveform fit

Definition at line 121 of file ECLDigitizerModule.h.

◆ m_inter

bool m_inter

private

internuclear counter effect

Definition at line 240 of file ECLDigitizerModule.h.

◆ m_loadOnce

bool m_loadOnce = true

private

Always load waveform parameters at least once.

Definition at line 152 of file ECLDigitizerModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_MCTimeOffset

DBObjPtr<ECLCrystalCalib> m_MCTimeOffset {"ECLMCTimeOffset"}

private

MC time offset.

Definition at line 198 of file ECLDigitizerModule.h.

198{"ECLMCTimeOffset"};

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

std::vector<ECLNoiseData> m_noise

private

parameters for correlated noise simulation

Definition at line 123 of file ECLDigitizerModule.h.

◆ m_noiseParameters

DBObjPtr<TTree> m_noiseParameters

private

Electronics noise covariance matrix.

Definition at line 180 of file ECLDigitizerModule.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_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_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_ss

std::vector<signalsample_t> m_ss

private

tabulated shape line

Definition at line 124 of file ECLDigitizerModule.h.

◆ m_ss_HadronShapeSimulations

std::vector<signalsample_t> m_ss_HadronShapeSimulations

private

tabulated shape line for hadron shape simulations

Definition at line 125 of file ECLDigitizerModule.h.

◆ m_storeDspWithExtraMCInfo

bool m_storeDspWithExtraMCInfo

private

DSP with extra info flag.

Definition at line 242 of file ECLDigitizerModule.h.

◆ m_tbl

std::vector<crystallinks_t> m_tbl

private

Lookup table for ECL channels.

Definition at line 118 of file ECLDigitizerModule.h.

◆ m_trigTime

bool m_trigTime

private

Use trigger time from beam background overlay.

Definition at line 247 of file ECLDigitizerModule.h.

◆ m_ttime

unsigned char m_ttime[ECL::ECL_CRATES] = {}

private

storage for trigger time in each ECL.

The crate trigger time is an even number from 0 to 142, so here it is stored as numbers from 0 to 71 inclusive.

Definition at line 145 of file ECLDigitizerModule.h.

145{};

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_unitscale

double m_unitscale

private

Normalization coefficient for ECL signal shape.

If positive, use same static value for all ECL channels. If negative, calculate it dynamically at beginRun(). (for default shape parameters, the static value is 27.7221)

Definition at line 261 of file ECLDigitizerModule.h.

◆ m_useWaveformParameters

bool m_useWaveformParameters

private

If true, use m_waveformParameters, m_algoParameters, m_noiseParameters.

If false, use the data from ecl/data/ECL-WF.root or ECL-WF-BG.root

Definition at line 255 of file ECLDigitizerModule.h.

◆ m_waveformMaker

bool m_waveformMaker

private

produce only waveform digits

Definition at line 241 of file ECLDigitizerModule.h.

◆ m_waveformParameters

DBObjPtr<TTree> m_waveformParameters

private

CellID-specific signal shapes.

Definition at line 174 of file ECLDigitizerModule.h.

◆ m_waveformParametersMC

DBObjPtr<ECLDigitWaveformParametersForMC> m_waveformParametersMC

private

Hadron signal shapes.

Definition at line 171 of file ECLDigitizerModule.h.

◆ m_WaveformThresholdOverride

double m_WaveformThresholdOverride

private

If gt 0, value will override ECL_FPGA_StoreWaveform and apply value (in GeV) as threshold for all crystals for waveform saving.

Definition at line 245 of file ECLDigitizerModule.h.

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

ecl/modules/eclDigitizer/include/ECLDigitizerModule.h
ecl/modules/eclDigitizer/src/ECLDigitizerModule.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ adccounts_t

◆ algoparams_t

◆ EAfterConditionPath

◆ fitparams_t

◆ int_array_192x16_t

◆ int_array_24x16_t

◆ signalsample_t

◆ uint_pair_t

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLDigitizerModule()

◆ ~ECLDigitizerModule()

Member Function Documentation

◆ beginRun()

◆ callbackHadronSignalShapes()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getfitparams()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ makeElectronicNoiseAndPedestal()

◆ makeWaveforms()

◆ readDSPDB()

◆ repack()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ shapeFitterWrapper()