Belle II Software  release-08-01-10
ECLDigitizerPureCsIModule Class Reference

The ECLDigitizerPureCsI module. More...

#include <ECLDigitizerPureCsIModule.h>

Inheritance diagram for ECLDigitizerPureCsIModule:
Collaboration diagram for ECLDigitizerPureCsIModule:

Classes

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

Public Types

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

Public Member Functions

 ECLDigitizerPureCsIModule ()
 Constructor.
 
 ~ECLDigitizerPureCsIModule ()
 Destructor.
 
virtual void initialize () override
 Initialize variables

 
virtual void beginRun () override
 Nothing so far.
 
virtual void event () override
 Actual digitization of all pure CsI hits in the ECL. 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...
 
LogConfiggetLogConfig ()
 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 ModuleConditiongetCondition () 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< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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 fitparams_type = ECL::EclConfigurationPure::fitparamspure_t
 Type of fitting parameters.
 
using signalsample_type = ECL::EclConfigurationPure::signalsamplepure_t
 Type of signal sample.
 
using adccounts_type = ECL::EclConfigurationPure::adccountspure_t
 Type of ADC counts.
 

Private Member Functions

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

Static Private Member Functions

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

Private Attributes

int m_thetaID [ECL::EclConfigurationPure::m_nch] {}
 ECL ring ID.
 
std::vector< crystallinks_tm_tbl
 Lookup table for ECL channels.
 
StoreArray< ECLDspm_ecldsps
 StoreArray ECLDsp.
 
StoreArray< ECLDigitm_ecldigits
 StoreArray ECLDigit.
 
StoreArray< ECLPureCsIInfom_eclpurecsiinfo
 StoreArray ECLPureCsIInfo.
 
StoreArray< ECLHitm_hitLists
 StoreArray ECLHit.
 
StoreArray< ECLDigitm_BaselineDigits
 ECL digits (baseline, i.e. More...
 
std::vector< fitparams_typem_fitparams
 Fitting parameters.
 
std::vector< signalsample_typem_ss
 Tabulated shape line.
 
std::vector< adccounts_typem_adc
 Storage for adc hits from entire calorimeter (8736 crystals).
 
std::vector< ECLNoiseDatam_noise
 Parameters for correlated noise stimation.
 
int m_nEvent = 0
 Event number.
 
int m_thetaIdMin
 Module parameters. More...
 
int m_thetaIdMax
 Ring ID of last pure CsI ring in FWD.
 
bool m_background
 Flag to set covariance matrix for WF with beam-bkg.
 
bool m_calibration
 Flag to use the DigitizerPureCsI for Waveform fit Covariance Matrix calibration.
 
bool m_NoCovMatrix
 Flag to use a diagonal (neutral) Covariance matrix.
 
int m_tickFactor
 multiplication factor to get adc tick from trigger tick.
 
double m_sigmaTrigger
 Trigger resolution.
 
double m_elecNoise
 Electronic Noise energy equivalente in MeV.
 
double m_photostatresolution
 Resolution for a 1 MeV energy deposit.
 
bool m_debug
 Flag for debug mode.
 
int m_testtrg
 Fixed trigger time for testing purposes.
 
double m_testsig
 Shift in signal arrival time, for testing purposes.
 
double m_testenedep
 Fixed energy deposition in all crystals, for testing purposes.
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

The ECLDigitizerPureCsI module.

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

Definition at line 44 of file ECLDigitizerPureCsIModule.h.

Member 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 pure CsI hits in the ECL.

The digitized hits are written into the DataStore.

Reimplemented from Module.

Definition at line 104 of file ECLDigitizerPureCsIModule.cc.

105 {
106  /* add trigger resolution defined in a module paramer
107  shifting the waveform starting time by a random deltaT,
108  assuming that t0=0 adc channel is determined by the trigger */
109  double deltaT = m_sigmaTrigger == 0 ? 0 : gRandom->Gaus(0, m_sigmaTrigger);
110 
111  // clear the storage for the event
112  memset(m_adc.data(), 0, m_adc.size()*sizeof(adccounts_type));
113 
114  // emulate response for ECL hits after ADC measurements
115  vector< vector< const ECLHit*> > hitmap(EclConfigurationPure::m_nch);
116 
117  for (const auto& eclHit : m_hitLists) {
118  int j = eclHit.getCellId() - 1; //0~8735
119  if (isPureCsI(j + 1)) {
120  assert(j < EclConfigurationPure::m_nch);
121  double hitE = eclHit.getEnergyDep() / Unit::GeV;
122  double hitTime = eclHit.getTimeAve() / Unit::us;
123  if (m_photostatresolution > 0) {
124  double nphotavg1MeV = 1 / (m_photostatresolution * m_photostatresolution);
125  int nphotavg = round((hitE / 0.001) * nphotavg1MeV);
126  int nphot = gRandom->Poisson(nphotavg);
127  hitE = (nphot / nphotavg1MeV) / 1000;
128 
129  // hitE = gRandom->Gaus(hitE, 0.001 * m_photostatresolution * sqrt(hitE * 1000));
130  }
131  m_adc[j].AddHit(hitE, hitTime + deltaT, m_ss[m_tbl[j].iss]);
132  if (eclHit.getBackgroundTag() == BackgroundMetaData::bg_none) hitmap[j].push_back(&eclHit);
133  }
134  }
135 
136  // loop over entire calorimeter
137 
138  for (int j = 0; j < EclConfigurationPure::m_nch; j++) {
139  if (! isPureCsI(j + 1)) continue;
140 
141  if (m_debug) {
142  m_adc[j].AddHit(m_testenedep, m_testsig, m_ss[m_tbl[j].iss]);
143  //cout << "Adding enedep = " << m_testenedep << " time: " << m_testsig << endl;
144  }
145  adccounts_type& a = m_adc[j];
146  if (! m_calibration && a.total < 0.0001) continue;
147 
148  //Noise generation
149  float adcNoise[EclConfigurationPure::m_nsmp];
150  memset(adcNoise, 0, sizeof(adcNoise));
151  if (m_elecNoise > 0) {
153  for (int i = 0; i < EclConfigurationPure::m_nsmp; i++)
154  z[i] = gRandom->Gaus(0, 1);
155  m_noise[0].generateCorrelatedNoise(z, adcNoise);
156  }
157 
159  for (int i = 0; i < EclConfigurationPure::m_nsmp; i++) {
160  FitA[i] = 20 * (1000 * a.c[i] + adcNoise[i]) + 3000;
161  }
162 
163  int energyFit = 0; // fit output : Amplitude 18 bits
164  double tFit = 0; // fit output : T_ave 12 bits
165  int qualityFit = 0; // fit output : quality 2 bits
166 
167  if (! m_calibration) {
168  double fitChi2 = 0;
169  if (m_debug) {
170  DSPFitterPure(m_fitparams[m_tbl[j].idn], FitA, m_testtrg, energyFit, tFit, fitChi2, qualityFit);
171  /*
172  cout << "energy: " << energyFit
173  << " tFit: " << tFit
174  << " qualityfit: " << qualityFit
175  << endl;
176  */
177  } else {
178  DSPFitterPure(m_fitparams[m_tbl[j].idn], FitA, 0, energyFit, tFit, fitChi2, qualityFit);
179  /*
180  cout << "energy: " << energyFit
181  << " tFit: " << tFit
182  << " qualityfit: " << qualityFit
183  << endl;
184  */
185  }
186  }
187 
188  if (m_calibration || energyFit > 0) {
189  int CellId = j + 1;
190  auto eclDsp = m_ecldsps.appendNew();
191  eclDsp->setCellId(CellId);
192  eclDsp->setDspA(FitA);
193 
194  auto eclDigit = m_ecldigits.appendNew();
195  eclDigit->setCellId(CellId); // cellId in range from 1 to 8736
196  eclDigit->setAmp(energyFit); // E (GeV) = energyFit/20000;
197  eclDigit->setTimeFit(int(tFit * 10)); // time is in 0.1 ns units
198  eclDigit->setQuality(qualityFit);
199 
200  auto AeclPureCsIInfo = m_eclpurecsiinfo.appendNew();
201  eclDigit->addRelationTo(AeclPureCsIInfo);
202  AeclPureCsIInfo->setPureCsI(1);
203  AeclPureCsIInfo->setCellId(CellId);
204 
205  eclDigit->addRelationTo(eclDsp);
206  for (const auto& hit : hitmap[j])
207  eclDigit->addRelationTo(hit);
208  }
209  } //store each crystal hit
210 
211  // temporary solution to run Pure CsI reconstruction
212  // and baseline independently and simultaneously
213  // cloning barrel and bwd digits
214 
215  for (const auto& eclDigit : m_BaselineDigits) {
216  int cellid = eclDigit.getCellId();
217  if (! isPureCsI(cellid)) {
218  auto eclDigitClone = m_ecldigits.appendNew();
219  eclDigitClone->setCellId(cellid);
220  eclDigitClone->setAmp(eclDigit.getAmp());
221  eclDigitClone->setTimeFit(eclDigit.getTimeFit());
222  eclDigitClone->setQuality(eclDigit.getQuality());
223  //eclDigitClone->setPureCsI(0);
224  auto AeclPureCsIInfo = m_eclpurecsiinfo.appendNew();
225  eclDigitClone->addRelationTo(AeclPureCsIInfo);
226  AeclPureCsIInfo->setPureCsI(0);
227  AeclPureCsIInfo->setCellId(cellid);
228  }
229  }
230 
231 
232  m_nEvent++;
233 }
StoreArray< ECLDigit > m_BaselineDigits
ECL digits (baseline, i.e.
StoreArray< ECLDigit > m_ecldigits
StoreArray ECLDigit.
std::vector< signalsample_type > m_ss
Tabulated shape line.
ECL::EclConfigurationPure::adccountspure_t adccounts_type
Type of ADC counts.
double m_elecNoise
Electronic Noise energy equivalente in MeV.
StoreArray< ECLHit > m_hitLists
StoreArray ECLHit.
int m_testtrg
Fixed trigger time for testing purposes.
bool isPureCsI(int cellId)
Returns 1 if corresponding crystal is set as pure CsI crystal.
std::vector< adccounts_type > m_adc
Storage for adc hits from entire calorimeter (8736 crystals).
double m_testenedep
Fixed energy deposition in all crystals, for testing purposes.
StoreArray< ECLPureCsIInfo > m_eclpurecsiinfo
StoreArray ECLPureCsIInfo.
double m_photostatresolution
Resolution for a 1 MeV energy deposit.
std::vector< fitparams_type > m_fitparams
Fitting parameters.
std::vector< crystallinks_t > m_tbl
Lookup table for ECL channels.
StoreArray< ECLDsp > m_ecldsps
StoreArray ECLDsp.
double m_testsig
Shift in signal arrival time, for testing purposes.
bool m_calibration
Flag to use the DigitizerPureCsI for Waveform fit Covariance Matrix calibration.
std::vector< ECLNoiseData > m_noise
Parameters for correlated noise stimation.
static constexpr int m_nch
total number of electronic channels (crystals) in fwd endcap calorimeter
static constexpr int m_nsmp
number of ADC measurements for signal fitting
static const double us
[microsecond]
Definition: Unit.h:97
static const double GeV
Standard of [energy, momentum, mass].
Definition: Unit.h:51

◆ 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
propertyFlagsOred 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat 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
descriptionA 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
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat 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
nameThe 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
nameThe unique name of the parameter.
pyObjThe 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
dictionaryThe 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
propertyFlagsbitwise 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
valueThe 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
valueThe 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_BaselineDigits

StoreArray<ECLDigit> m_BaselineDigits
private

ECL digits (baseline, i.e.

the array "ECLDigits").

Definition at line 120 of file ECLDigitizerPureCsIModule.h.

◆ m_thetaIdMin

int m_thetaIdMin
private

Module parameters.

Ring ID of first pure CsI ring.

Definition at line 137 of file ECLDigitizerPureCsIModule.h.


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