The ECLDigitizer module. More...

#include <ECLDigitizerModule.h>

Inheritance diagram for ECLDigitizerModule:

Collaboration diagram for ECLDigitizerModule:

[legend]

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 ()
	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. More...

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

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

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

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

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

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

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

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

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

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

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). More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 = fitparams_t::int_array_24x16_t
	weighting coefficients amplitude calculation. More...

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

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

Private Attributes
std::vector< crystallinks_t >	m_tbl
	Lookup table for ECL channels.

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

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) More...

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

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

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

bool	m_background
	Module parameters. More...

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

double	m_unitscale
	Normalization coefficient for ECL signal shape. More...

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 73 of file ECLDigitizerModule.h.

Member Typedef Documentation

◆ int_array_24x16_t

using int_array_24x16_t = fitparams_t::int_array_24x16_t

private

weighting coefficients amplitude calculation.

Time is fixed by trigger

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

Member Function Documentation

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

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

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

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

◆ 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 389 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 retrived
     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; }
  
   int FitA[ec.m_nsmp]; // buffer for the waveform fitter
  
   // loop over entire calorimeter
   for (int j = 0; j < ec.m_nch; j++) {
     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);
     } else {
       // Signal amplitude should be above 100 keV
       if (a.total < 0.0001) continue;
       makeElectronicNoiseAndPedestal(j, FitA);
     }
  
     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, 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);
       }
  
       // 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);
         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;
 }

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

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

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

Definition at line 134 of file Module.h.

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

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

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

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

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

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

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

inherited

Add a condition to the module.

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

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

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

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

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

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

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

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

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

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

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 137 of file ECLDigitizerModule.h.

◆ m_background

bool m_background

private

Module parameters.

background flag

Definition at line 247 of file ECLDigitizerModule.h.

◆ m_eclDigits

StoreArray<ECLDigit> m_eclDigits

private

Output Arrays.

Waveform fit result.

Definition at line 232 of file ECLDigitizerModule.h.

◆ m_eclMapper

ECL::ECLChannelMapper m_eclMapper

private

Channel Mapper.

channel mapper to utilize trigger information

Definition at line 244 of file ECLDigitizerModule.h.

◆ m_idn

std::vector<algoparams_t> m_idn

private

Fit algorihtm parameters shared by group of crystals.

parameters that needs for waveform fit

Definition at line 130 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 154 of file ECLDigitizerModule.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 270 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 264 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

◆ int_array_24x16_t

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_adc

◆ m_background

◆ m_eclDigits

◆ m_eclMapper

◆ m_idn

◆ m_ttime

◆ m_unitscale

◆ m_useWaveformParameters