Digitizer for the BEAST CsI system. More...

#include <CsIDigitizerModule.h>

Inheritance diagram for CsIDigitizerModule:

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
	CsIDigitizerModule ()
	Constructor: Sets the description, the properties and the parameters of the module.

virtual	~CsIDigitizerModule ()
	Default destructor.

virtual void	initialize () override
	Register input and output data.

virtual void	beginRun () override
	To do before each runs.

virtual void	event () override
	Each event This is where the actual digitization is done, and the hits are written to the DataStore.

virtual void	endRun () override
	Clean up.

virtual void	terminate () override
	Final clean up.

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
Signal	genTimeSignal (double _energy, double _timeAvg, double _timeRMS, int iChannel, bool _save=0)
	Generates a time signal for a mean energy deposit The energy deposit is modelled at a Gaussian whose parameters are given as inputs.

double	genTimeSignal (Signal *_output, Signal _energies, Signal _times, int _iChannel, int _dt, int _nsam, bool _save=0)
	Generates a time signal for a set of hits.

Signal	genSignalTemplate (int _n, int _i0, double _t1, double _t2=0.0, double _rFastTot=1.0)
	Generates the template for a signal (obsolete)

Signal	firstOrderResponse (double _gain, Signal _u, double _y0, double _dt, double _tSlow, double _delay)
	Calculates the time response of a first order system (such as crystal, PMT, etc)

uint16_t	doChargeIntegration (Signal _u, int _NsamBL, uint16_t BSL, uint32_t Q, uint32_t t, std::vector< uint16_t > _Waveform, std::vector< uint8_t > *_DPPCIBits, int _Treshold, double _TriggerHoldoff=0.0, double _GateWidth=320.0, double _GateOffset=40.0, bool _recordTraces=false)
	Realizes the charge integration of the input signal.

int	addNoise (Signal *y, double _rms, double _offset)
	Adds noise to the signal.

DigitalSignal	doDigitization (Signal _v, double _LSB)
	Digitizes the signal the signal.

double	f (double fi, double u_i, double u_j, double y, double invtau)
	This returns the RHS of first order differential equation.

int	getnSamples () const
	Gets the number of points in the waveforms arrays.

void	setnSamples (int nsamples)
	Sets the number of points in the waveforms arrays.

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
int	m_hitNum
	index of csiHit

double	m_TrueEdep
	Sum of the MC (true) deposited energies in the event-channel.

double	m_Resolution
	Parameter: Resolution (in mV) of the ACD.

double	m_SampleRate
	Parameter: Sample rate (in samples/sec) of the ADC.

double	m_dt
	Time interval (in ns) (calculated from m_SampleRate.

int	m_nWaveforms
	Number of waveforms to save.

int	m_nWFcounter
	Counter for the number of waveforms to save.

uint8_t	m_CellId
	Cell ID.

uint16_t	m_Baseline
	Baseline (pedestal) frozen during charge integration.

uint32_t	m_Charge
	Integrated Charge.

uint16_t	m_MaxADC
	Max ACD of the hit (to check saturations)

uint32_t	m_Time
	Trigger Time.

int	m_nSamples
	Number of points requested in the waveform arrays.

std::vector< uint16_t >	m_Waveform
	Saved waveform.

std::vector< uint8_t >	m_DPPCIBits
	status of the DPP-CI

const double	m_tRisePMT = 2
	2.6 Rise time of the PMT signal (in ns)

const double	m_tTransitPMT = 48
	48Mean transit time of the PMT signal (in ns)

const double	m_Zl = 50
	Line impedance of the analog chain (to get voltage from anode current)

StoreArray< CsiSimHit >	m_aSimHit
	Each simulated particle in the crystal.

StoreArray< CsiDigiHit >	m_aDigiHit
	Output: a digitized hit.

Signal	m_CsITlSignalTemplate
	Template Signal of a CsITl trace.

std::vector< double >	m_calibConstants
	Calibration constants for each channel (in V/keV)

std::vector< double >	m_noiseLevels
	Noise level for each channel (in V)

std::vector< double >	m_LY
	Light yield for each channel (gamma per GeV)

std::vector< double >	m_tRatio
	Ratio fast light / slow light for each channel.

std::vector< double >	m_tFast
	Fast time constant for each channel (ns)

std::vector< double >	m_tSlow
	Slow time constant for each channel (ns)

std::vector< double >	m_LCE
	Light collection efficiency for each channel.

std::vector< double >	m_PmtQE
	PMT quantum efficiency for each channel.

std::vector< double >	m_PmtGain
	PMT gain for each channel.

Signal	m_SimHitTimes [16]
	Array of signals (each corresponding to one channel)

Signal	m_SimHitEdeps [16]
	Array of signals (each corresponding to one channel)

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

Digitizer for the BEAST CsI system.

This modules reads CsiHits for deposited energy, associates a pulse shape then fits it for amplitude and time. In a future version: calculate pulse shape from sim hits. *

Definition at line 38 of file CsIDigitizerModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

◆ CsIDigitizerModule()

CsIDigitizerModule ( )

Constructor: Sets the description, the properties and the parameters of the module.

Definition at line 44 of file CsIDigitizerModule.cc.

                                       : Module(), m_hitNum(0),
  m_TrueEdep(0.0),
  m_nWFcounter(0),
  m_aDigiHit("CsiDigiHits"),
  m_calibConstants(16, 5),
  m_noiseLevels(16, 0.25e-3),
  m_LY(16, 40e6),
  m_tRatio(16, 0),
  m_tFast(16, 1),
  m_tSlow(16, 1),
  m_LCE(16, 0.1),
  m_PmtQE(16, 0.05),
  m_PmtGain(16, 1e5)
{
  // Set module properties
  setDescription("Digitizer for the BEAST CsI system");
 
  // Parameter definitions
  addParam("Resolution", m_Resolution, "Resolution (in mV) of the ACD", 4.8828e-4);
  addParam("SampleRate", m_SampleRate, "Sample rate (in samples/sec) of the ADC", 250e6);
  addParam("nWaveforms", m_nWaveforms, "Number of waveforms to save. 0: none, -1: all ", 0);
}

◆ ~CsIDigitizerModule()

~CsIDigitizerModule ( )

virtual

Default destructor.

Definition at line 67 of file CsIDigitizerModule.cc.

68{

69}

Member Function Documentation

◆ addNoise()

int addNoise	(	Signal *	y,
		double	_rms,
		double	_offset
	)

private

Adds noise to the signal.

Parameters

y	a pointer to the signal to noisify
_rms	the rms of the high-frequency noise to add
_offset	the offset to apply to the signal (e.g. to simulate low-frew noise)

Returns: The number of samples in the signal

Definition at line 444 of file CsIDigitizerModule.cc.

{
  for (Signal::iterator it = y->begin() ; it != y->end(); ++it)
    *it += _offset + gRandom->Gaus(0, _rms);
 
  return y->size();
}

◆ beginRun()

void beginRun ( void )

overridevirtual

To do before each runs.

NOOP.

Reimplemented from Module.

Definition at line 101 of file CsIDigitizerModule.cc.

{
  //Signal tempo = genTimeSignal(10, 10, 2, 0, 1);
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

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

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

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

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ doChargeIntegration()

uint16_t doChargeIntegration	(	Signal	_u,
		int	_NsamBL,
		uint16_t *	BSL,
		uint32_t *	Q,
		uint32_t *	t,
		std::vector< uint16_t > *	_Waveform,
		std::vector< uint8_t > *	_DPPCIBits,
		int	_Treshold,
		double	_TriggerHoldoff = `0.0`,
		double	_GateWidth = `320.0`,
		double	_GateOffset = `40.0`,
		bool	_recordTraces = `false`
	)

private

Realizes the charge integration of the input signal.

Parameters

_u	The input signal in Volts
_NsamBL	Number of samples to conduct the baseline measurement (8,32,128)
BSL	A pointer to the value of the baseline (in LSB)
Q	A pointer to the value holding the total charge (in LSB.sample)
t	A pointer to the value holding the trigger time
_Waveform	A pointer to the vector holding all waveform data points
_DPPCIBits	A pointer to the vector holding the bits of the DPP-CI status. Order [MSB-LSB] is [stop,holdoff,gate,trigger]
_Treshold	Threshold above which generate a trigger (in LSB)
_TriggerHoldoff	Width of signal integration (in ns)
_GateWidth	Width of signal integration (in ns)
_GateOffset	Width of signal integration (in ns)
_recordTraces	Record traces

Returns: The maximum ADC value (to check for saturations)

< 1 / N_samples used for baseline averaging for most of the signal

< 1 / N_samples used for baseline averaging (at beginning of signal)

Definition at line 213 of file CsIDigitizerModule.cc.

{
 
  B2DEBUG(80, "Arguments: " << &_u << ", " << _NsamBL << ", " << _BSL << ", " << _Q  << ", " <<  _t
          << ", " << _Waveform << ", " <<  _Treshold  << ", " <<  _TriggerHoldoff  << ", " << _GateWidth
          << ", " << _GateOffset << ", " <<  _recordTraces);
 
  vector<int> x = doDigitization(_u, m_Resolution);
  int nSam = x.size();
 
  // Plots for debugging (see CAEN DPP-CI figs 2.2,2.3
  TH1I h_trigger("h_trigger", "Trigger", nSam, 0, nSam - 1);
  TH1I h_gate("h_gate", "Gate", nSam, 0, nSam - 1);
  TH1I h_holdoff("h_holdoff", "Holdoff", nSam, 0, nSam - 1);
  TH1I h_baseline("h_baseline", "Baseline", nSam, 0, nSam - 1);
  TH1I h_charge("h_charge", "Charge", nSam, 0, nSam - 1);
  TH1F h_signal("h_signal", "Continuous signal", nSam, 0, nSam - 1);
  TH1I h_digsig("h_digsig", "Digital signal", nSam, 0, nSam - 1);
 
 
  int max_gated  = (int) floor(_GateWidth / m_dt);
  int gate_offset = (int) floor(_GateOffset / m_dt);
  int max_holdoff = (int) floor(_TriggerHoldoff / m_dt);
 
  int baseline  = 0;
  int charge    = 0;
  int n_holdoff = 0;
  int n_gated   = 0;
 
  bool gate = false;
  bool holdoff = false;
  bool stop = false;
  bool trigger = false;
 
  // Find trigger position
  int i = 0;
  int iFirstTrigger = 0;
  list<int> baselineBuffer;
  vector<int>::iterator it;
  float tempBaseline;
 
  // Saving inverse number of samples used for baseline averaging (avoid division)
  const double invMaxNavgBL = 1.0 / _NsamBL; 
  double invNavgBL;                   
  _Waveform->resize(nSam, 0);
  _DPPCIBits->resize(nSam, 0);
 
  B2DEBUG(140, "Scanning vector: all should have nSam=" << nSam);
 
  uint16_t maxval = 0;
 
  for (it = x.begin(); (it != x.end()); ++it, ++i) {
 
    if (*it > maxval)
      maxval = *it;
 
    _Waveform->at(i) = *it;
    _DPPCIBits->at(i) = trigger + (gate << 1) + (holdoff << 2) + (stop << 3);
 
    if (_recordTraces) {
 
      h_trigger.Fill(i, (int) trigger)  ;
      h_gate.Fill(i, (int) gate)  ;
      h_holdoff.Fill(i, (int) holdoff)  ;
      h_baseline.Fill(i, baseline)  ;
      h_charge.Fill(i, charge)  ;
      h_digsig.Fill(i, *it)  ;
      h_signal.Fill(i, _u.at(i))  ;
    }
 
    if (!gate && !holdoff) {
 
      baselineBuffer.push_back(*it);
 
 
      if ((i + 1)  >  _NsamBL) {
        baselineBuffer.pop_front();
        invNavgBL = invMaxNavgBL;
      } else {
        invNavgBL = (1.0 / i);
      }
 
      tempBaseline = 0;
      for (list<int>::iterator itbl = baselineBuffer.begin(); itbl != baselineBuffer.end(); ++itbl)
        tempBaseline += (float) * itbl;
 
      tempBaseline *= invNavgBL;
 
      baseline = (int) round(tempBaseline);
 
      trigger = (*it - baseline) > _Treshold;
 
      //first time we see a trigger
      if (trigger && !iFirstTrigger)
        iFirstTrigger = i;
 
    } else {
 
      if (gate) {
        charge += (*(it - gate_offset) - baseline);
        *_BSL = baseline;
        n_gated++;
      }
 
      if (holdoff) {
        n_holdoff++;
      }
 
      trigger = false;
    }
 
    holdoff = trigger || (holdoff && (n_holdoff < max_holdoff));
    gate    = trigger || (gate    && (n_gated  < max_gated));
 
    stop = iFirstTrigger && !gate && !holdoff;
  }
 
  *_Q = charge;
  // from the doc: 2 sample uncertainty.
  *_t = (uint)(iFirstTrigger  + 2.0 * (gRandom->Rndm() - 0.5));
 
  if (not(_recordTraces)) {
    _Waveform->clear();
    _DPPCIBits->clear();
  }
 
  return maxval;
}

◆ doDigitization()

vector< int > doDigitization	(	Signal	_v,
		double	_LSB
	)

private

Digitizes the signal the signal.

param _y: The input signal in Volts param _LSB: The value of a LSB in volts (=resolution)

return a std<vector> containing the signal in LSB

Definition at line 347 of file CsIDigitizerModule.cc.

{
  vector<int>  output(_v.size(), 0);
  double invLSB = 1.0 / _LSB;
 
  int i = 0;
  for (Signal::iterator it = _v.begin() ; it != _v.end(); ++it, ++i) {
    output.at(i)  = (int) round(*it * invLSB);
  }
 
  return  output;
}

◆ endRun()

void endRun ( void )

overridevirtual

Clean up.

NOOP.

Reimplemented from Module.

Definition at line 205 of file CsIDigitizerModule.cc.

206{

207}

◆ 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

Each event This is where the actual digitization is done, and the hits are written to the DataStore.

< Number of Crystal hits

< Index of the Cell

< Energy deposited in the current hit

< Distance between the hit and the PIN-diode end of the crystal (cm).

< Time when photons from the hit reach the PIN-diode (in ns).

Reimplemented from Module.

Definition at line 106 of file CsIDigitizerModule.cc.

{
  StoreObjPtr<EventMetaData> eventMetaDataPtr;
  int m_currentEventNumber = eventMetaDataPtr->getEvent();
 
  B2DEBUG(80, "Digitingevent  " << m_currentEventNumber);
 
  //Loop over CsiSimHits
  if (m_aSimHit.getEntries() > 0) {
    int hitNum = m_aSimHit.getEntries(); 
    // double E_tmp[16] = {0};       /**< Sum energy deposited in each cell */
    // double edepSum = 0;           /**< Sum energy deposited in all cells */
 
    for (int i = 0 ; i < 16 ; i++) {
      m_SimHitTimes[i].clear();
      m_SimHitEdeps[i].clear();
    }
 
 
    B2DEBUG(150, "Looping over CsISimHits");
    for (int i = 0; i < hitNum; i++) { // Loop over CsISimHits
      CsiSimHit* aCsISimHit = m_aSimHit[i];
      int m_cellID = aCsISimHit->getCellId();       
      double edep = aCsISimHit->getEnergyDep();     
      double tof = aCsISimHit->getFlightTime();
      //      double hitTime = aCsISimHit->getTimeAve();    /**< Time average of the hit*/
      //      double hitTimeRMS = sqrt( aCsISimHit->getTimeVar()/aCsISimHit->getEnergyDep());    /**< Time rms of the hit*/
      CsiGeometryPar* csip = CsiGeometryPar::Instance();
 
      ROOT::Math::XYZVector hitPos    = aCsISimHit->getPosition();
      ROOT::Math::XYZVector cellPos   = csip->GetPosition(m_cellID);
      ROOT::Math::XYZVector cellAngle = csip->GetOrientation(m_cellID);
 
      double localPos = (15. - (hitPos  - cellPos).Dot(
                           cellAngle));  
      // 0.06 is the speed of light in CsI(Tl)
      double  propagTime = m_SampleRate *
                           (0.0600 * localPos + (tof / CLHEP::ns)) * 1E-9; 
      m_SimHitTimes[m_cellID].push_back(propagTime);
      m_SimHitEdeps[m_cellID].push_back(edep);
 
      /*
      if (i<10){
      B2INFO("Hit No = : " << i );
      B2INFO("Deposited energy = : " << edep );
      B2INFO("Average time = : " << hitTime );
      B2INFO("Time RMS = : " << hitTimeRMS );
 
      csip->Print(m_cellID);
      }
      */
 
    }
 
    for (int iCh = 0; iCh < 16; iCh++) {
 
      int n = m_SimHitTimes[iCh].size();
 
      if (n > 0) {
 
        B2DEBUG(140, "Generating Time signal");
        Signal tempSignal;
        m_TrueEdep = genTimeSignal(&tempSignal, m_SimHitEdeps[iCh], m_SimHitTimes[iCh], iCh,  m_dt,  m_nSamples, false);
 
 
        B2DEBUG(140, "Launching Charge integration");
        bool  recordWaveform = false;
        if ((m_nWaveforms == -1) || (m_nWFcounter < m_nWaveforms)) {
          m_nWFcounter++;
          recordWaveform = true;
          B2DEBUG(80, "Recording WF");
        }
        uint16_t max = doChargeIntegration(tempSignal, 128, &m_Baseline, &m_Charge, &m_Time, &m_Waveform,
                                           &m_DPPCIBits,  5, 1.2e4, 1e4, 1e3, recordWaveform);
 
        if (m_Charge > 0) {
          m_aDigiHit.appendNew();
          m_hitNum = m_aDigiHit.getEntries() - 1;
          m_aDigiHit[m_hitNum]->setCellId(iCh);
          m_aDigiHit[m_hitNum]->setCharge(m_Charge);
          m_aDigiHit[m_hitNum]->setTime(m_Time);
          m_aDigiHit[m_hitNum]->setBaseline(m_Baseline);
          m_aDigiHit[m_hitNum]->setTrueEdep(m_TrueEdep);
 
          m_aDigiHit[m_hitNum]->setMaxVal(max);
 
          m_aDigiHit[m_hitNum]->setWaveform(&m_Waveform);
          m_aDigiHit[m_hitNum]->setStatusBits(&m_DPPCIBits);
        }
      }
    }
  }
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  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)

◆ f()

double f	(	double	fi,
		double	u_i,
		double	u_j,
		double	y,
		double	invtau
	)

private

This returns the RHS of first order differential equation.

param fi: index at which we should evaluate the function. Do linear interpolation of the input in case fi isn't an integer param u_i: input at index i param u_j: input at index j=i+1 param y : output function param invtau: 1 / (time constant)

Definition at line 523 of file CsIDigitizerModule.cc.

{
  //linear interpolation of the input at fractional index fi
  double u = u_i * (fi - floor(fi)) + u_j * (ceil(fi) - fi);
 
  return u - invtau * y;
}

◆ firstOrderResponse()

Signal firstOrderResponse	(	double	_gain,
		Signal	_u,
		double	_y0,
		double	_dt,
		double	_tSlow,
		double	_delay
	)

private

Calculates the time response of a first order system (such as crystal, PMT, etc)

Parameters

_gain	Overall gain applied to the output
_u	The input to the system
_y0	Initial value of the output
_dt	Integration step (in ns)
_tSlow	Time constant of the system
_delay	Time delay of the system (in ns)

Returns: a Signal corresponding tot he time response

Definition at line 470 of file CsIDigitizerModule.cc.

{
 
  B2DEBUG(80, "Generating 1st order response with arguments");
  B2DEBUG(80, "       _gain: " << _gain);
  B2DEBUG(80, "  length(_u): " << _u.size());
  B2DEBUG(80, "         _y0: " << _y0);
  B2DEBUG(80, "         _dt: " << _dt);
  B2DEBUG(80, "        _tau: " << _tau);
  B2DEBUG(80, "      _delay: " << _delay);
 
 
  // First skip everything if the time constant in infinitely short.
  if (_tau == 0)
    return _u;
 
  int n = _u.size();
  Signal y;
  double k[4] = {0};
 
  static const double invSix = 1.0 / 6.0;
  double invtau = 1.0 / _tau;
  y.push_back(_y0);
 
  // Apply delay to input
  int n_delay = (int) round(_delay / _dt);
  Signal::iterator it = _u.begin();
  double _u_0 = _u.front();
  _u.insert(it, n_delay, _u_0);
  _u.resize(n);
 
  // Apply that input to the good old Runge-Kutta 4 routine.
  for (int i = 0, j = 0; i < (n - 1); i++) {
    j = i + 1;
    k[0] = f(i, _u[i], _u[j], y[i], invtau);
    k[1] = f(i + 0.5, _u[i], _u[j], y[i] + 0.5 * _dt * k[0], invtau);
    k[2] = f(i + 0.5, _u[i], _u[j], y[i] + 0.5 * _dt * k[1], invtau);
    k[3] = f(j, _u[i], _u[j], y[i] +       _dt * k[2], invtau);
 
    y.push_back(y[i] + _dt * invSix * (k[0] + 2 * k[1] + 2 * k[2] + k[3]));
  }
 
 
  // Apply gain
  if (_gain != 1) {
    for (Signal::iterator it2 = y.begin() ; it2 != y.end(); ++it2)
      *it2 *= _gain;
  }
 
  return y;
}

◆ genSignalTemplate()

Signal genSignalTemplate	(	int	_n,
		int	_i0,
		double	_t1,
		double	_t2 = `0.0`,
		double	_rFastTot = `1.0`
	)

private

Generates the template for a signal (obsolete)

param _n: number of time samples in the signal to create param _i0: index of the first input param _t1: Fast time constant (in ns) param _t2: Slow time constant (in ns) param _rFastTot: Ratio of the fast light to the total light

◆ genTimeSignal() [1/2]

Signal genTimeSignal	(	double	_energy,
		double	_timeAvg,
		double	_timeRMS,
		int	iChannel,
		bool	_save = `0`
	)

private

Generates a time signal for a mean energy deposit The energy deposit is modelled at a Gaussian whose parameters are given as inputs.

Parameters

_energy	TO BE COMPLETED
_timeAvg	TO BE COMPLETED
_timeRMS	TO BE COMPLETED
iChannel	TO BE COMPLETED
_save	TO BE COMPLETED

◆ genTimeSignal() [2/2]

double genTimeSignal	(	Signal *	_output,
		Signal	_energies,
		Signal	_times,
		int	_iChannel,
		int	_dt,
		int	_nsam,
		bool	_save = `0`
	)

private

Generates a time signal for a set of hits.

The hits correspond to all CsiSimHits of a single event, each are recorded at specific times so the energies and times vectors are given as inputs.

Parameters

_output	TO BE COMPLETED
_energies	TO BE COMPLETED
_times	TO BE COMPLETED
_iChannel	TO BE COMPLETED
_dt	TO BE COMPLETED
_nsam	TO BE COMPLETED
_save	TO BE COMPLETED

Definition at line 360 of file CsIDigitizerModule.cc.

{
 
  double invdt = 1.0 / _dt;
 
  double tf = 0;
  double t0 = 1e9;
  double sumEnergies = 0.0;
 
  for (Signal::iterator it = _times.begin() ; it != _times.end(); ++it) {
    if (*it < t0)
      t0 = *it;
 
    if (*it > tf)
      tf = *it;
  }
 
  Signal edepos(_nsam, 0.0);
 
  int i = 0;
  int ioffset = floor(_nsam * 0.25);
  B2DEBUG(150, "Filling edepos vector. Container length is " << _nsam);
 
  for (Signal::iterator it = _times.begin() ; it != _times.end(); ++it, ++i) {
    sumEnergies += _energies.at(i);
    // time index +/- 1 time bin
    int timeIndex = ((int)(*it - t0) * invdt  + ioffset);
    if ((timeIndex - 1) > (int) edepos.size()) {
      B2WARNING(" genTimeSignal: TimeIndex greater than length of signal container. Skipping deposit of " << _energies.at(i) << "GeV");
    } else {
      edepos.at(timeIndex) += _energies.at(i);
    }
  }
 
  B2DEBUG(80, "Generating time responses for channel " << _iChannel);
  B2DEBUG(80, "    Fast time constant  " << m_tFast[_iChannel]);
  B2DEBUG(80, "    Slow time constant  " << m_tSlow[_iChannel]);
  /*
    Signal Qcathode = firstOrderResponse(m_LY[_iChannel] * m_LCE[_iChannel] * m_PmtQE[_iChannel],
    edepos, 0, _dt, m_tSlow[_iChannel], 0.0, m_tRatio[_iChannel], m_tFast[_iChannel]);
  */
 
  Signal Qcathode = firstOrderResponse((1 - m_tRatio[_iChannel]) * m_LY[_iChannel] * m_LCE[_iChannel] * m_PmtQE[_iChannel], edepos, 0,
                                       _dt, m_tSlow[_iChannel], 0.0);
 
 
  if (m_tRatio[_iChannel]) {
    Signal QcathodeF = firstOrderResponse(m_tRatio[_iChannel] * m_LY[_iChannel] * m_LCE[_iChannel] * m_PmtQE[_iChannel], edepos, 0, _dt,
                                          m_tFast[_iChannel], 0.0);
 
    int j = 0;
    for (Signal::iterator it = Qcathode.begin() ; it != Qcathode.end(); ++it, ++j)
      *it += QcathodeF.at(j);
  }
 
  Signal Vanode   = firstOrderResponse(1.602e-10 * m_Zl * invdt * m_PmtGain[_iChannel], Qcathode, 0, _dt, m_tRisePMT, m_tTransitPMT);
 
  B2DEBUG(150, "Adding noise. Container length is " << Vanode.size());
  addNoise(&Vanode, m_noiseLevels[_iChannel], 5e-3 * gRandom->Rndm() + 1e-2);
 
  if (_save) {
    Signal t(_nsam, 0);
    t.at(0) = t0;
 
    for (i = 1; i < _nsam; i++)
      t.at(i) = t.at(i - 1) + _dt;
 
    TGraph gPlot1(_nsam, &t[0], &edepos[0]);
    gPlot1.SaveAs("EdeposOut.root");
 
    TGraph gPlot2(_nsam, &t[0], &Qcathode[0]);
    gPlot2.SaveAs("QOut.root");
 
    TGraph gPlot3(_nsam, &t[0], &Vanode[0]);
    gPlot3.SaveAs("VOut.root");
  }
 
  *_output = Vanode;
 
  return sumEnergies;
}

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getnSamples()

int getnSamples ( ) const

inlineprivate

Gets the number of points in the waveforms arrays.

Definition at line 181 of file CsIDigitizerModule.h.

181{ return m_nSamples; }

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ 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://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.

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

◆ initialize()

void initialize ( void )

overridevirtual

Register input and output data.

Reimplemented from Module.

Definition at line 71 of file CsIDigitizerModule.cc.

{
 
  B2DEBUG(100, "Initializing ");
 
  m_aSimHit.isRequired();
  m_aDigiHit.registerInDataStore();
 
  //Calculation of the derived parameters
  m_dt = 1e9 / m_SampleRate;
  setnSamples(8192);
 
  //Get crystal and PMT constants from xml files
  CsiGeometryPar* csip = CsiGeometryPar::Instance();
  for (uint i = 0; i != m_LY.size(); ++i) {
    csip->Print(i, 80);
 
    m_LY.at(i)     = 1;//1e3 * csip->GetMaterialProperty(i, "SCINTILLATIONYIELD");
    m_tFast.at(i)  = 1;//csip->GetMaterialProperty(i, "FASTTIMECONSTANT");
    m_tSlow.at(i)  = 1;//csip->GetMaterialProperty(i, "SLOWTIMECONSTANT");
    m_tRatio.at(i) = 1;//csip->GetMaterialProperty(i, "YIELDRATIO");
  }
 
  //Operate the pure CsI at higher gain to compensate for lower light yield
  for (int i = 8; i < 16; i++) {
    m_PmtGain[i] = 35e5;
  }
 
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setnSamples()

void setnSamples ( int nsamples )

inlineprivate

Sets the number of points in the waveforms arrays.

Definition at line 185 of file CsIDigitizerModule.h.

185{ m_nSamples = nsamples; }

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

void terminate ( void )

overridevirtual

Final clean up.

CPU clock stops

Reimplemented from Module.

Definition at line 209 of file CsIDigitizerModule.cc.

210{

211}

Member Data Documentation

◆ m_aDigiHit

StoreArray<CsiDigiHit> m_aDigiHit

private

Output: a digitized hit.

Definition at line 216 of file CsIDigitizerModule.h.

◆ m_aSimHit

StoreArray<CsiSimHit> m_aSimHit

private

Each simulated particle in the crystal.

Definition at line 215 of file CsIDigitizerModule.h.

◆ m_Baseline

uint16_t m_Baseline

private

Baseline (pedestal) frozen during charge integration.

Definition at line 203 of file CsIDigitizerModule.h.

◆ m_calibConstants

std::vector<double> m_calibConstants

private

Calibration constants for each channel (in V/keV)

Definition at line 220 of file CsIDigitizerModule.h.

◆ m_CellId

uint8_t m_CellId

private

Cell ID.

Definition at line 202 of file CsIDigitizerModule.h.

◆ m_Charge

uint32_t m_Charge

private

Integrated Charge.

Definition at line 204 of file CsIDigitizerModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_CsITlSignalTemplate

Signal m_CsITlSignalTemplate

private

Template Signal of a CsITl trace.

Definition at line 218 of file CsIDigitizerModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_DPPCIBits

std::vector<uint8_t> m_DPPCIBits

private

status of the DPP-CI

Definition at line 209 of file CsIDigitizerModule.h.

◆ m_dt

double m_dt

private

Time interval (in ns) (calculated from m_SampleRate.

Definition at line 197 of file CsIDigitizerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hitNum

int m_hitNum

private

index of csiHit

Definition at line 191 of file CsIDigitizerModule.h.

◆ m_LCE

std::vector<double> m_LCE

private

Light collection efficiency for each channel.

Definition at line 226 of file CsIDigitizerModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_LY

std::vector<double> m_LY

private

Light yield for each channel (gamma per GeV)

Definition at line 222 of file CsIDigitizerModule.h.

◆ m_MaxADC

uint16_t m_MaxADC

private

Max ACD of the hit (to check saturations)

Definition at line 205 of file CsIDigitizerModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

◆ m_noiseLevels

std::vector<double> m_noiseLevels

private

Noise level for each channel (in V)

Definition at line 221 of file CsIDigitizerModule.h.

◆ m_nSamples

int m_nSamples

private

Number of points requested in the waveform arrays.

Definition at line 207 of file CsIDigitizerModule.h.

◆ m_nWaveforms

int m_nWaveforms

private

Number of waveforms to save.

0: none, -1: all

Definition at line 198 of file CsIDigitizerModule.h.

◆ m_nWFcounter

int m_nWFcounter

private

Counter for the number of waveforms to save.

Definition at line 199 of file CsIDigitizerModule.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

◆ m_PmtGain

std::vector<double> m_PmtGain

private

PMT gain for each channel.

Definition at line 228 of file CsIDigitizerModule.h.

◆ m_PmtQE

std::vector<double> m_PmtQE

private

PMT quantum efficiency for each channel.

Definition at line 227 of file CsIDigitizerModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

◆ m_Resolution

double m_Resolution

private

Parameter: Resolution (in mV) of the ACD.

Definition at line 195 of file CsIDigitizerModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_SampleRate

double m_SampleRate

private

Parameter: Sample rate (in samples/sec) of the ADC.

Definition at line 196 of file CsIDigitizerModule.h.

◆ m_SimHitEdeps

Signal m_SimHitEdeps[16]

private

Array of signals (each corresponding to one channel)

Definition at line 231 of file CsIDigitizerModule.h.

◆ m_SimHitTimes

Signal m_SimHitTimes[16]

private

Array of signals (each corresponding to one channel)

Definition at line 230 of file CsIDigitizerModule.h.

◆ m_tFast

std::vector<double> m_tFast

private

Fast time constant for each channel (ns)

Definition at line 224 of file CsIDigitizerModule.h.

◆ m_Time

uint32_t m_Time

private

Trigger Time.

Definition at line 206 of file CsIDigitizerModule.h.

◆ m_tRatio

std::vector<double> m_tRatio

private

Ratio fast light / slow light for each channel.

Definition at line 223 of file CsIDigitizerModule.h.

◆ m_tRisePMT

const double m_tRisePMT = 2

private

2.6 Rise time of the PMT signal (in ns)

Definition at line 211 of file CsIDigitizerModule.h.

◆ m_TrueEdep

double m_TrueEdep

private

Sum of the MC (true) deposited energies in the event-channel.

Definition at line 194 of file CsIDigitizerModule.h.

◆ m_tSlow

std::vector<double> m_tSlow

private

Slow time constant for each channel (ns)

Definition at line 225 of file CsIDigitizerModule.h.

◆ m_tTransitPMT

const double m_tTransitPMT = 48

private

48Mean transit time of the PMT signal (in ns)

Definition at line 212 of file CsIDigitizerModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_Waveform

std::vector<uint16_t> m_Waveform

private

Saved waveform.

Definition at line 208 of file CsIDigitizerModule.h.

◆ m_Zl

const double m_Zl = 50

private

Line impedance of the analog chain (to get voltage from anode current)

Definition at line 213 of file CsIDigitizerModule.h.

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

beast/csi/modules/include/CsIDigitizerModule.h
beast/csi/modules/src/CsIDigitizerModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ CsIDigitizerModule()

◆ ~CsIDigitizerModule()

Member Function Documentation

◆ addNoise()

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ doChargeIntegration()

◆ doDigitization()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ f()

◆ firstOrderResponse()

◆ genSignalTemplate()

◆ genTimeSignal() [1/2]

◆ genTimeSignal() [2/2]

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getnSamples()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setnSamples()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_aDigiHit

◆ m_aSimHit

◆ m_Baseline

◆ m_calibConstants