SVDDigitizerModule Class Reference

The SVD Digitizer module. More...

#include <SVDDigitizerModule.h>

Inheritance diagram for SVDDigitizerModule:

Collaboration diagram for SVDDigitizerModule:

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
	SVDDigitizerModule ()
	Constructor.
void	processHit ()
	Process one SVDSimHit by dividing the step in smaller steps and drifting the charge.
void	driftCharge (const ROOT::Math::XYZVector &position, double carriers, SVD::SensorInfo::CarrierType carrierType)
	Drift the charge inside the silicon.
double	addNoise (double charge, double noise)
	Calculate the noise contribution to one strip with given charge.
void	saveDigits ()
	Save digits to the DataStore Saves samples of generated waveforms.
void	saveWaveforms ()
	Save waveforms to the statistics file.
void	saveSignals ()
	Save signals to a root-delimited file (to be analyzed in Python).
virtual void	initialize () override
	Initialize the module and check module parameters.
virtual void	beginRun () override
	Initialize the list of existing SVD Sensors.
virtual void	event () override
	Digitize one event.
virtual void	terminate () override
	Terminate the module.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
virtual void	endRun ()
	This method is called if the current run ends.
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
int	getFirstSample (int triggerBin, int relativShift)
	return the starting sample
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.

Protected Attributes
std::string	m_storeMCParticlesName = ""
	Name of the collection for the MCParticles.
std::string	m_storeSimHitsName = ""
	Name of the collection for the SVDSimhits.
std::string	m_storeTrueHitsName = ""
	Name of the collection for the SVDTrueHits.
std::string	m_relMCParticleSimHitName = ""
	Name of the relation between MCParticles and SVDSimHits.
std::string	m_relTrueHitSimHitName = ""
	Name of the relation between SVDTrueHits and SVDSimHits.
std::string	m_storeShaperDigitsName = ""
	Name of the collection for the SVDShaperDigits.
std::string	m_relShaperDigitMCParticleName = ""
	Name of the relation between SVDShaperDigits and MCParticles.
std::string	m_relShaperDigitTrueHitName = ""
	Name of the relation between SVDShaperDigits and SVDTrueHits.
std::string	m_svdEventInfoName = "SVDEventInfoSim"
	Name of the SVDEventInfo object.
double	m_segmentLength = 0.020
	Max.
bool	m_applyPoisson = true
	Whether or not to apply poisson fluctuation of charge (Fano factor)
double	m_SNAdjacent = 3.0
	Zero-suppression cut.
bool	m_roundZS = true
	Round ZS cut to nearest ADU.
int	m_nSamplesOverZS = 1
	Keep digit if at least m_nSamplesOverZS are over threshold.
double	m_noiseFraction = 0.01
	(derived from SNAdjacent) Fraction of noisy strips per sensor.
DBObjPtr< HardwareClockSettings >	m_hwClock
	Hardware Clocks.
double	m_betaPrimeDecayTimeU = 250.0
	Decay time of betaprime waveform U-side.
double	m_betaPrimeDecayTimeV = 250.0
	Decay time of betaprime waveform V-side.
double	m_samplingTime = -1
	Interval between two waveform samples, by default taken from HardwareClockSettings.
double	m_startSampling = -2
	Time window start, excluding trigger bin effect.
double	m_initTime = 0
	Time window start, including the triggerBin effect.
bool	m_randomizeEventTimes = false
	Randomize event times? If set to true, event times will be randomized uniformly from m_minTimeFrame to m_maxTimeFrame.
float	m_minTimeFrame = -300
	Low edge of randomization time frame.
float	m_maxTimeFrame = 150
	High edge of randomization time frame.
float	m_currentEventTime = 0.0
	Current event time.
bool	m_is3sampleEvent = false
	True if the event should be simulated with 3 sample.
int	m_nAPV25Samples = 6
	number of digitized samples read from SVDEventInfo
std::string	m_rootFilename = ""
	Name of the ROOT filename to output statistics.
bool	m_storeWaveforms = false
	Store waveform data in the reporting file?
std::string	m_signalsList = ""
	Name of the tab-delimited listing of waveforms.
Waveforms	m_waveforms
	Structure containing waveforms in all existing sensors.
const SVDSimHit *	m_currentHit = nullptr
	Pointer to the SVDSimhit currently digitized.
int	m_currentParticle = -1
	Index of the particle which caused the current hit.
int	m_currentTrueHit = -1
	Index of the TrueHit the current hit belongs to.
SensorWaveforms *	m_currentSensorWaveforms = nullptr
	Pointer to the sensor in which the current hit occurred.
const SensorInfo *	m_currentSensorInfo = nullptr
	Pointer to the SensorInfo of the current sensor.
double	m_currentTime = 0
	Time of the current SimHit.
double	m_sensorThickness = 0.03
	Thickness of current sensor (read from m_currentSensorInfo)
int	m_relativeShift = 0
	relative shift in SVDEventInfo obj
int	m_startingSample = 0
	Starting sample for the selection of 3 samples in 3-mixed-6.
SVDFADCMaskedStrips	m_MaskedStr
	FADC masked strip payload.
DBObjPtr< PayloadFile >	m_mapping
	channel mapping payload
std::unique_ptr< SVDOnlineToOfflineMap >	m_map
	channel mapping map
SVDChargeSimulationCalibrations	m_ChargeSimCal
	SVDChargeSimulationCalibrations calibrations db object.
SVDNoiseCalibrations	m_NoiseCal
	SVDNoise calibrations db object.
SVDPulseShapeCalibrations	m_PulseShapeCal
	SVDPulseShapeCalibrations calibrations db object.
TFile *	m_rootFile = nullptr
	Pointer to the ROOT filename for statistics.
TH1D *	m_histChargeSharing_u = nullptr
	Histogram showing the charge sharing + diffusion in u (r-phi).
TH1D *	m_histChargeSharing_v = nullptr
	Histogram showing the charge sharing + diffusion in v (z).
TH1D *	m_histMobility_e = nullptr
	Histogram showing the mobility of e-.
TH1D *	m_histMobility_h = nullptr
	Histogram showing the mobility of h.
TH1D *	m_histVelocity_e = nullptr
	Histogram showing the velocity of e-.
TH1D *	m_histVelocity_h = nullptr
	Histogram showing the velocity of h.
TH1D *	m_histDistanceToPlane_e = nullptr
	Histogram showing the distance to plane for e.
TH1D *	m_histDistanceToPlane_h = nullptr
	Histogram showing the distance to plane for h.
TH1D *	m_histDriftTime_e = nullptr
	Histogram showing the drift time of e.
TH1D *	m_histDriftTime_h = nullptr
	Histogram showing the drift time of h.
TH1D *	m_histHitTime = nullptr
	Histogram showing the hit time.
TH2F *	m_histHitTimeTB = nullptr
	Histogram showing the hit time vs TB.
TH1D *	m_histLorentz_u = nullptr
	Histogram showing the Lorentz angles in u (r-phi).
TH1D *	m_histLorentz_v = nullptr
	Histogram showing the Lorentz angles in v (z).
TH1D *	m_signalDist_u = nullptr
	Histogram showing the distribution of digit signals in u (r-phi).
TH1D *	m_signalDist_v = nullptr
	Histogram showing the distribution of digit signals in v (z).
TTree *	m_waveTree = nullptr
	Tree for waveform storage.

Static Protected Attributes
static std::string	m_xmlFileName = std::string("SVDChannelMapping.xml")
	< channel mapping xml filename

Private Member Functions
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_name
	The name of the module, saved as a string (user-modifiable)
std::string	m_type
	The type of the module, saved as a string.
std::string	m_package
	Package this module is found in (may be empty).
std::string	m_description
	The description of the module.
unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with |) of EModulePropFlags.
LogConfig	m_logConfig
	The log system configuration of the module.
ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.
bool	m_hasReturnValue
	True, if the return value is set.
int	m_returnValue
	The return value.
std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

The SVD Digitizer module.

This module is responsible for converting the simulated energy deposition from Geant4 into real SVD detector response of single strips.

Definition at line 57 of file SVDDigitizerModule.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

SVDDigitizerModule()

SVDDigitizerModule

(

)

Constructor.

Definition at line 58 of file SVDDigitizerModule.cc.

                                       : Module(),
  m_currentSensorWaveforms(nullptr),
  m_mapping(m_xmlFileName)
{
  //Set module properties
  setDescription("Creates SVDShaperDigits from SVDSimHits");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Define module parameters
 
  // 1. Collections
  addParam("MCParticles", m_storeMCParticlesName,
           "MCParticle collection name", m_storeMCParticlesName);
  addParam("SimHits", m_storeSimHitsName, "SimHit collection name",
           m_storeSimHitsName);
  addParam("TrueHits", m_storeTrueHitsName, "TrueHit collection name",
           m_storeTrueHitsName);
  addParam("ShaperDigits", m_storeShaperDigitsName, "ShaperDigits collection name", m_storeShaperDigitsName);
  addParam("SVDEventInfo", m_svdEventInfoName, "SVDEventInfo name", m_svdEventInfoName);
 
  // 2. Physics
  addParam("SegmentLength", m_segmentLength,
           "Maximum segment length (in millimeters)", m_segmentLength);
 
  // 3. Noise
  addParam("PoissonSmearing", m_applyPoisson,
           "Apply Poisson smearing on chargelets", m_applyPoisson);
  addParam("ZeroSuppressionCut", m_SNAdjacent,
           "Zero suppression cut in sigmas of strip noise", m_SNAdjacent);
  addParam("FADCmode", m_roundZS,
           "FADC mode: if True, ZS cut is rounded to nearest ADU ", m_roundZS);
  addParam("numberOfSamples", m_nSamplesOverZS,
           "Keep digit if numberOfSamples or more samples are over ZS threshold",
           m_nSamplesOverZS);
 
  // 4. Timing
  addParam("BetaPrimeDecayTimeU", m_betaPrimeDecayTimeU, "Decay time of betaprime waveform in ns, U-side",
           m_betaPrimeDecayTimeU);
  addParam("BetaPrimeDecayTimeV", m_betaPrimeDecayTimeV, "Decay time of betaprime waveform in ns, V-side",
           m_betaPrimeDecayTimeV);
  addParam("ADCSamplingTime", m_samplingTime,
           "Interval between ADC samples in ns, if = -1 taken from HardwareClockSettings payload (default).", m_samplingTime);
  addParam("StartSampling", m_startSampling,
           "Start of the sampling window, in ns. Used to tune the SVD latency.", m_startSampling);
  addParam("RandomizeEventTimes", m_randomizeEventTimes,
           "Randomize event times over a frame interval", m_randomizeEventTimes);
  addParam("TimeFrameLow", m_minTimeFrame,
           "Left edge of event time randomization window, ns", m_minTimeFrame);
  addParam("TimeFrameHigh", m_maxTimeFrame,
           "Right edge of event time randomization window, ns", m_maxTimeFrame);
 
 
  // 6. Reporting
  addParam("statisticsFilename", m_rootFilename,
           "ROOT Filename for statistics generation. If filename is empty, no statistics will be produced",
           m_rootFilename);
  addParam("storeWaveforms", m_storeWaveforms,
           "Store waveforms in a TTree in the statistics file.", m_storeWaveforms);
  addParam("signalsList", m_signalsList,
           "Store signals (time/charge/tau) in a tab-delimited file",
           m_signalsList);
}

Member Function Documentation

addNoise()

double addNoise	(	double	charge,
		double	noise
	)

Calculate the noise contribution to one strip with given charge.

Parameters

charge	the original charge on the strip
noise	the standard RMS noise on the strip

Returns

the new charge of the strip.

Definition at line 683 of file SVDDigitizerModule.cc.

{
  charge += gRandom->Gaus(0., noise);
  return charge;
}

beginRun()

void beginRun ( void  )

overridevirtual

Initialize the list of existing SVD Sensors.

Reimplemented from Module.

Definition at line 265 of file SVDDigitizerModule.cc.

{
 
  if (m_mapping.hasChanged()) { m_map = std::make_unique<SVDOnlineToOfflineMap>(m_mapping->getFileName()); }
 
  //read sampling time from HardwareClockSettings
  if (m_samplingTime == -1 && m_hwClock.isValid())
    m_samplingTime = 1. / m_hwClock->getClockFrequency(Const::EDetector::SVD, "sampling");
  else if (m_samplingTime == -1)
    m_samplingTime = 16000. / 509;
 
  //Fill map with all possible sensors This is too slow to be done every event so
  //we fill it once and only clear the content of the sensors per event, not
  //the whole map
  m_waveforms.clear();
  VXD::GeoCache& geo = VXD::GeoCache::getInstance();
  for (VxdID layer : geo.getLayers(SensorInfo::SVD)) {
    for (VxdID ladder : geo.getLadders(layer)) {
      for (VxdID sensor : geo.getSensors(ladder)) {
        m_waveforms[sensor] = SensorWaveforms();
      }
    }
  }
 
  if (!m_MaskedStr.isValid())
    B2WARNING("No valid SVDFADCMaskedStrip for the requested IoV -> no strips masked");
  if (!m_map)
    B2WARNING("No valid channel mapping -> all APVs will be enabled");
 
 
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

driftCharge()

void driftCharge	(	const ROOT::Math::XYZVector &	position,
		double	carriers,
		SVD::SensorInfo::CarrierType	carrierType
	)

Drift the charge inside the silicon.

This method will drift the charge inside the silicon along the E/B fieldlines.

Parameters

position	start position of the charge
carriers	number of electrons and holes to drift
carrierType	electrons or holes

Definition at line 466 of file SVDDigitizerModule.cc.

{
  bool have_electrons = (carrierType == SVD::SensorInfo::electron);
 
  string carrierName = (have_electrons) ? "electron" : "hole";
  B2DEBUG(29,
          "Drifting " << carriers << " " << carrierName << "s at position (" << position.X() << ", " << position.Y() << ", " << position.Z()
          << ").");
  B2DEBUG(29, "@@@ driftCharge: drifting " << carriers << " " << carrierName << "s at position (" << position.X() << ", " <<
          position.Y() << ", " << position.Z()
          << ").");
 
  // Get references to current sensor/info for ease of use
  const SensorInfo& info = *m_currentSensorInfo;
  StripWaveforms& waveforms = (!have_electrons) ? m_currentSensorWaveforms->first : m_currentSensorWaveforms->second;
 
  double distanceToPlane = (have_electrons) ?
                           0.5 * m_sensorThickness - position.Z() :
                           -0.5 * m_sensorThickness - position.Z(); //cm
 
  if (m_histDistanceToPlane_e && have_electrons) m_histDistanceToPlane_e->Fill(distanceToPlane);
  if (m_histDistanceToPlane_h && !have_electrons) m_histDistanceToPlane_h->Fill(distanceToPlane);
 
  // Approximation: calculate drift velocity at the point halfway towards
  // the respective sensor surface.
  ROOT::Math::XYZVector mean_pos(position.X(), position.Y(), position.Z() + 0.5 * distanceToPlane);
 
  // Calculate drift times and widths of charge clouds.
  ROOT::Math::XYZVector v = info.getVelocity(carrierType, mean_pos);
  if (m_histVelocity_e && have_electrons) m_histVelocity_e->Fill(v.Z()); //Unit::cm/Unit::cm*Unit::eV/Unit::e*Unit::s);
  if (m_histVelocity_h && !have_electrons) m_histVelocity_h->Fill(v.Z()); //Unit::cm/Unit::cm*Unit::eV/Unit::e*Unit::s);
 
  double driftTime = distanceToPlane / v.Z(); //ns
  if (m_histDriftTime_e && have_electrons) m_histDriftTime_e->Fill(driftTime); //ns
  if (m_histDriftTime_h && !have_electrons) m_histDriftTime_h->Fill(driftTime); //ns
 
  ROOT::Math::XYZVector center = position + driftTime * v; //cm
  double mobility = (have_electrons) ?
                    info.getElectronMobility(info.getEField(mean_pos).R()) :
                    info.getHoleMobility(info.getEField(mean_pos).R());
 
  if (m_histMobility_e && have_electrons) m_histMobility_e->Fill(mobility); //cm2/V/ns
  if (m_histMobility_h && !have_electrons) m_histMobility_h->Fill(mobility); //cm2/V/ns
 
  double D = Const::kBoltzmann * info.getTemperature() / Unit::e * mobility;
  double sigma = std::max(1.0e-4, sqrt(2.0 * D * driftTime));
  double tanLorentz = (!have_electrons) ? v.X() / v.Z() : v.Y() / v.Z();
 
  B2DEBUG(29, "velocity (" << v.X() / Unit::um << ", " << v.Y() / Unit::um << ", " << v.Z() / Unit::um << ") um/ns");
  B2DEBUG(29, "D = " << D << ", driftTime = " << driftTime / Unit::ns << " ns");
  B2DEBUG(29, "sigma = " << sigma / Unit::um << " um");
  B2DEBUG(29, "tan Lorentz = " << tanLorentz);
 
  sigma *= sqrt(1.0 + tanLorentz * tanLorentz);
  if (m_histLorentz_u && !have_electrons) m_histLorentz_u->Fill(tanLorentz);
  if (m_histLorentz_v && have_electrons) m_histLorentz_v->Fill(tanLorentz);
 
  //Distribute carrier cloud on strips
  int vID = info.getVCellID(center.Y(), true);
  int uID = info.getUCellID(center.X(), center.Y(), true);
  int seedStrip = (!have_electrons) ? uID : vID;
  double seedPos = (!have_electrons) ?
                   info.getUCellPosition(seedStrip, vID) :
                   info.getVCellPosition(seedStrip);
  double geomPitch = (!have_electrons) ? 0.5 * info.getUPitch(center.Y()) : 0.5 * info.getVPitch();
  int nCells = (!have_electrons) ? info.getUCells() : info.getVCells();
  std::deque<double> stripCharges;
  std::deque<double> strips; // intermediate strips will be half-integers, like 2.5.
#define NORMAL_CDF(z) 0.5 * std::erfc( - (z) * 0.707107)
  double current_pos = (!have_electrons) ? seedPos - center.X() : seedPos - center.Y();
  double current_strip = seedStrip;
  double cdf_low = NORMAL_CDF((current_pos - 0.5 * geomPitch) / sigma);
  double cdf_high = NORMAL_CDF((current_pos + 0.5 * geomPitch) / sigma);
  double charge = carriers * (cdf_high - cdf_low);
 
  B2DEBUG(29, "geomPitch = " << geomPitch / Unit::um << " um");
  B2DEBUG(29, "charge = " << charge << " = " << carriers << "(carriers) * (" << cdf_high << "(cdf_high) - " << cdf_low <<
          "(cdf_low));");
 
  stripCharges.push_back(charge);
  strips.push_back(current_strip);
  while (cdf_low > 1.0e-5) {
    current_pos -= geomPitch;
    current_strip -= 0.5;
    double cdf_current = NORMAL_CDF((current_pos - 0.5 * geomPitch) / sigma);
    charge = carriers * (cdf_low - cdf_current);
    stripCharges.push_front(charge);
    strips.push_front(current_strip);
    cdf_low = cdf_current;
  }
  current_pos = (!have_electrons) ? seedPos - center.X() : seedPos - center.Y();
  current_strip = seedStrip;
  while (cdf_high < 1.0 - 1.0e-5) {
    current_pos += geomPitch;
    current_strip += 0.5;
    double cdf_current = NORMAL_CDF((current_pos + 0.5 * geomPitch) / sigma);
    charge = carriers * (cdf_current - cdf_high);
    stripCharges.push_back(charge);
    strips.push_back(current_strip);
    cdf_high = cdf_current;
  }
#undef NORMAL_CDF
 
  // Pad with zeros for smoothing
  int npads = (strips.front() - floor(strips.front()) == 0) ? 5 : 4;
  for (int i = 0; i < npads; ++i) {
    strips.push_front(strips.front() - 0.5);
    stripCharges.push_front(0);
  }
  npads = (strips.back() - floor(strips.back()) == 0) ? 5 : 4;
  for (int i = 0; i < npads; ++i) {
    strips.push_back(strips.back() + 0.5);
    stripCharges.push_back(0);
  }
  // Charge sharing
  B2DEBUG(29, "  --> charge sharing simulation, # strips = " << strips.size());
  std::deque<double> readoutCharges;
  std::deque<int> readoutStrips;
  VxdID currentSensorID = m_currentHit->getSensorID();
  for (std::size_t index = 3; index <  strips.size() - 3; index += 2) {
    B2DEBUG(29, "  index = " << index << ", strip = " << strips[index] << ", stripCharge = " << stripCharges[index]);
    int currentStrip = static_cast<int>(strips[index]);
 
    double c0 = m_ChargeSimCal.getCouplingConstant(currentSensorID, !have_electrons, "C0");
    double c1 = m_ChargeSimCal.getCouplingConstant(currentSensorID, !have_electrons, "C1");
    double c2 = m_ChargeSimCal.getCouplingConstant(currentSensorID, !have_electrons, "C2");
    double c3 = m_ChargeSimCal.getCouplingConstant(currentSensorID, !have_electrons, "C3");
 
    B2DEBUG(29, "  current strip = " << currentStrip);
    B2DEBUG(29, "     index-3 = " << index - 3 << ", strip = " << strips[index - 3] << ", stripCharge = " << stripCharges[index - 3]);
    B2DEBUG(29, "     index-2 = " << index - 2 << ", strip = " << strips[index - 2] << ", stripCharge = " << stripCharges[index - 2]);
    B2DEBUG(29, "     index-1 = " << index - 1 << ", strip = " << strips[index - 1] << ", stripCharge = " << stripCharges[index - 1]);
    B2DEBUG(29, "     index   = " << index << ", strip = " << strips[index] << ", stripCharge = " << stripCharges[index]);
    B2DEBUG(29, "     index+1 = " << index + 1 << ", strip = " << strips[index + 1] << ", stripCharge = " << stripCharges[index + 1]);
    B2DEBUG(29, "     index+2 = " << index + 2 << ", strip = " << strips[index + 2] << ", stripCharge = " << stripCharges[index + 2]);
    B2DEBUG(29, "     index+3 = " << index + 3 << ", strip = " << strips[index + 3] << ", stripCharge = " << stripCharges[index + 3]);
 
    readoutCharges.push_back(c3 * stripCharges[index - 3]
                             + c2 * stripCharges[index - 2]
                             + c1 * stripCharges[index - 1]
                             + c0 * stripCharges[index]
                             + c1 * stripCharges[index + 1]
                             + c2 * stripCharges[index + 2]
                             + c3 * stripCharges[index + 3]
                            );
    readoutStrips.push_back(currentStrip);
    B2DEBUG(29, "    post simulation: " << index << ", strip = " << currentStrip << ", readoutCharge = " <<
            readoutCharges[readoutCharges.size() - 1]);
  }
  // Trim at sensor edges
  double tail = 0;
  while (readoutStrips.size() > 0 && readoutStrips.front() < 0) {
    readoutStrips.pop_front();
    tail += readoutCharges.front();
    readoutCharges.pop_front();
  }
  readoutCharges.front() += tail;
  tail = 0;
  while (readoutStrips.size() > 0 && readoutStrips.back() > nCells - 1) {
    readoutStrips.pop_back();
    tail += readoutCharges.back();
    readoutCharges.pop_back();
  }
  readoutCharges.back() += tail;
  // Poisson smearing - Gaussian approximation
  if (m_applyPoisson)
    for (auto& c : readoutCharges)
      c = (c <= 0) ? 0 : std::max(0.0, gRandom->Gaus(c, std::sqrt(info.c_fanoFactorSi * c)));
 
  // Fill diagnostic charts
  if (m_histChargeSharing_u && m_histChargeSharing_v) {
    TH1D* histo = (!have_electrons) ? m_histChargeSharing_u : m_histChargeSharing_v;
    double d = (!have_electrons) ? seedPos - center.X() : seedPos - center.Y();
    for (std::size_t index = 0; index < readoutStrips.size(); ++ index) {
      double dist = d + (readoutStrips[index] - seedStrip) * 2 * geomPitch;
      histo->Fill(dist / Unit::um, readoutCharges[index]);
    }
  }
  if (m_histHitTime) {
    m_histHitTime->Fill(m_currentTime);
    StoreObjPtr<SVDEventInfo> storeSVDEvtInfo(m_svdEventInfoName);
    SVDModeByte modeByte = storeSVDEvtInfo->getModeByte();
    m_histHitTimeTB->Fill(m_currentTime, modeByte.getTriggerBin());
  }
 
  // Store
  B2DEBUG(29, "currentTime = " << m_currentTime << " + 0.5 driftTime = " << 0.5 * driftTime << " = " << m_currentTime + 0.5 *
          driftTime);
 
  // Specify beta prime decay time
  double betaPrimeDecayTime = (!have_electrons) ? m_betaPrimeDecayTimeU : m_betaPrimeDecayTimeV;
 
  // Specify coupling and adjacent-channel waveform shape
  double apvCoupling = m_ChargeSimCal.getCouplingConstant(currentSensorID, !have_electrons, "APVCoupling");
  WaveformShape w_adjacent = (!have_electrons) ? w_adjacentU : w_adjacentV;
 
  double recoveredCharge = 0;
  for (std::size_t index = 0; index <  readoutStrips.size(); index ++) {
    // NB> To first approximation, we assign to the signal 1/2*driftTime.
    // This doesn't change the charge collection, only charge collection timing.
    waveforms[readoutStrips[index]].add(m_currentTime + 0.5 * driftTime, readoutCharges[index],
                                        betaPrimeDecayTime, m_currentParticle, m_currentTrueHit, w_betaprime);
    // coupled signal left neighbour
    if (index > 0)
      waveforms[readoutStrips[index]].add(m_currentTime + 0.5 * driftTime, apvCoupling * readoutCharges[index - 1],
                                          1, m_currentParticle, m_currentTrueHit, w_adjacent);
    // coupled signal right neighbour
    if (index < readoutStrips.size() - 1)
      waveforms[readoutStrips[index]].add(m_currentTime + 0.5 * driftTime, apvCoupling * readoutCharges[index + 1],
                                          1, m_currentParticle, m_currentTrueHit, w_adjacent);
    recoveredCharge += readoutCharges[index];
    B2DEBUG(29, "strip: " << readoutStrips[index] << " charge: " << readoutCharges[index]);
  }
  B2DEBUG(29, "Digitized " << recoveredCharge << " of " << carriers << " original carriers.");
}

endRun()

virtual void endRun ( void  )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Reimplemented in BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, AlignDQMModule, CosmicsAlignmentValidationModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, arichBtestModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, TPCStudyModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, Root2RawModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCalibratorModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, EvtGenDecayModule, OverrideGenerationFlagsModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, AWESOMEBasicModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, Convert2RawDetModule, PrintDataModule, PrintEventRateModule, Root2BinaryModule, EventT0ValidationModule, DataWriterModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDTriggerQualityGeneratorModule, SVDUnpackerModule, TOPBackgroundModule, TOPChannelT0MCModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPWaveformQualityPlotterModule, TOPXTalkChargeShareSetterModule, ExtModule, GenfitVisModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, MCSlowPionPXDROICreatorModule, PXDROIFinderModule, SVDROIDQMModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, RT2SPTCConverterModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, NoKickCutsEvalModule, SectorMapBootstrapModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, PyModule, SVDUnpackerDQMModule, TrackSetEvaluatorHopfieldNNDEVModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisTRGModule, and DQMHistOutputToEPICSModule.

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

{
  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

Digitize one event.

Reimplemented from Module.

Definition at line 297 of file SVDDigitizerModule.cc.

{
 
  //get number of samples and relativeShift
  StoreObjPtr<SVDEventInfo> storeSVDEvtInfo(m_svdEventInfoName);
  SVDModeByte modeByte = storeSVDEvtInfo->getModeByte();
  m_relativeShift = storeSVDEvtInfo->getRelativeShift();
  m_nAPV25Samples = storeSVDEvtInfo->getNSamples();
 
  //Compute time of the first sample, update latency
  const double systemClockPeriod = 1. / m_hwClock->getGlobalClockFrequency();
  int triggerBin = modeByte.getTriggerBin();
 
  m_initTime = m_startSampling - systemClockPeriod * triggerBin;
 
  m_is3sampleEvent = false;
  if (m_nAPV25Samples == 3) {
    m_is3sampleEvent = true;
    m_startingSample = getFirstSample(triggerBin, m_relativeShift);
    B2DEBUG(25, "3-sample event, starting sample = " << m_startingSample);
  } else m_startingSample = 0; //not used
 
  // set APV mode for background overlay
  SVDShaperDigit::setAPVMode(m_nAPV25Samples, m_startingSample);
 
  // Generate current event time
  if (m_randomizeEventTimes) {
    StoreObjPtr<EventMetaData> storeEvent;
    m_currentEventTime = gRandom->Uniform(m_minTimeFrame, m_maxTimeFrame);
    // We have negative event times, so we have to encode!
    storeEvent->setTime(static_cast<unsigned long>(1000 + m_currentEventTime));
  } else
    m_currentEventTime = 0.0;
 
  // Clear sensors' waveforms and process SimHits
  for (Waveforms::value_type& sensorWaveforms : m_waveforms) {
    sensorWaveforms.second.first.clear();  // u-side channels
    sensorWaveforms.second.second.clear(); // v-side channels
  }
  // m_currentSensorWaveforms = 0;
  // m_currentSensorInfo = 0;
 
  StoreArray<MCParticle> storeMCParticles(m_storeMCParticlesName);
  StoreArray<SVDSimHit> storeSimHits(m_storeSimHitsName);
  StoreArray<SVDTrueHit> storeTrueHits(m_storeTrueHitsName);
 
  RelationArray mcParticlesToSimHits(storeMCParticles, storeSimHits, m_relMCParticleSimHitName);
  RelationArray trueHitsToSimHits(storeTrueHits, storeSimHits, m_relTrueHitSimHitName);
 
  RelationIndex<MCParticle, SVDSimHit> relMCParticleSimHit(storeMCParticles, storeSimHits, m_relMCParticleSimHitName);
  RelationIndex<SVDTrueHit, SVDSimHit> relTrueHitSimHit(storeTrueHits, storeSimHits, m_relTrueHitSimHitName);
 
  unsigned int nSimHits = storeSimHits.getEntries();
  if (nSimHits == 0) {
    return;
  }
 
  //Check sensor info and set pointers to current sensor
  for (unsigned int i = 0; i < nSimHits; ++i) {
    m_currentHit = storeSimHits[i];
    const RelationIndex<MCParticle, SVDSimHit>::Element* mcRel =
      relMCParticleSimHit.getFirstElementTo(m_currentHit);
    if (mcRel) {
      m_currentParticle = mcRel->indexFrom;
      if (mcRel->weight < 0) {
        //This simhit is from a particle which was not saved by the simulation
        //so we do not take it into account for relations. Otherwise we might
        //end up adding positive and negative weights together
        m_currentParticle = -1;
      }
    } else {
      // Don't bother with warnings for background SimHits
      if (m_currentHit->getBackgroundTag() == BackgroundMetaData::bg_none)
        B2WARNING(
          "Could not find MCParticle which produced SVDSimhit " << i);
      m_currentParticle = -1;
    }
    const RelationIndex<SVDTrueHit, SVDSimHit>::Element* trueRel =
      relTrueHitSimHit.getFirstElementTo(m_currentHit);
    //We only care about true hits from particles which have not been ignored
    if (trueRel && trueRel->weight > 0) {
      m_currentTrueHit = trueRel->indexFrom;
    } else {
      m_currentTrueHit = -1;
    }
 
    VxdID sensorID = m_currentHit->getSensorID();
    if (!m_currentSensorInfo || sensorID != m_currentSensorInfo->getID()) {
      m_currentSensorInfo =
        dynamic_cast<const SensorInfo*>(&VXD::GeoCache::get(sensorID));
      if (!m_currentSensorInfo)
        B2FATAL(
          "Sensor Information for Sensor " << sensorID << " not found, make sure that the geometry is set up correctly");
 
      const SensorInfo& info = *m_currentSensorInfo;
      // Publish some useful data
      m_sensorThickness = info.getThickness();
      m_currentSensorWaveforms = &m_waveforms[sensorID];
      B2DEBUG(29,
              "Sensor Parameters for Sensor " << sensorID << ": " << endl
              << " --> Width:          " << m_currentSensorInfo->getWidth() << endl
              << " --> Length:         " << m_currentSensorInfo->getLength() << endl
              << " --> uPitch:         " << m_currentSensorInfo->getUPitch() << endl
              << " --> vPitch:         " << m_currentSensorInfo->getVPitch(-m_currentSensorInfo->getLength() / 2.0)
              << ", " << m_currentSensorInfo->getVPitch(m_currentSensorInfo->getLength() / 2.0) << endl
              << " --> Thickness:      " << m_currentSensorInfo->getThickness() << endl
              << " --> Deplet. voltage:" << m_currentSensorInfo->getDepletionVoltage() << endl
              << " --> Bias voltage:   " << m_currentSensorInfo->getBiasVoltage() << endl
             );
 
    }
    B2DEBUG(28,
            "Processing hit " << i << " in Sensor " << sensorID << ", related to MCParticle " << m_currentParticle);
    processHit();
  }
  // If storage of waveforms is required, store them in the statistics file.
  if (m_storeWaveforms) {
    m_rootFile->cd();
    saveWaveforms();
  }
  if (m_signalsList != "")
    saveSignals();
 
 
  saveDigits();
 
 
 
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

getFirstSample()

int getFirstSample ( int  triggerBin, int  relativShift  )

protected

return the starting sample

Definition at line 967 of file SVDDigitizerModule.cc.

{
  int nTriggerClocks = triggerBin + relativeShift;
  return floor(nTriggerClocks / 4);
}

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void  )

overridevirtual

Initialize the module and check module parameters.

Reimplemented from Module.

Definition at line 121 of file SVDDigitizerModule.cc.

{
 
  //Register all required collections
  StoreArray<MCParticle> storeMCParticles(m_storeMCParticlesName);
 
  StoreArray<SVDTrueHit> storeTrueHits(m_storeTrueHitsName);
 
  StoreArray<SVDShaperDigit>storeShaperDigits(m_storeShaperDigitsName);
  storeShaperDigits.registerInDataStore();
  storeShaperDigits.registerRelationTo(storeMCParticles);
  storeShaperDigits.registerRelationTo(storeTrueHits);
 
  m_relShaperDigitMCParticleName = DataStore::relationName(
                                     DataStore::arrayName<SVDShaperDigit>(m_storeShaperDigitsName),
                                     DataStore::arrayName<MCParticle>(m_storeMCParticlesName));
  m_relShaperDigitTrueHitName = DataStore::relationName(
                                  DataStore::arrayName<SVDShaperDigit>(m_storeShaperDigitsName),
                                  DataStore::arrayName<SVDTrueHit>(m_storeTrueHitsName));
 
  if (m_randomizeEventTimes)
    StoreObjPtr<EventMetaData> storeEvents;
 
  //Set names in case default was used. We need the names to initialize the RelationIndices.
  m_relMCParticleSimHitName = DataStore::relationName(
                                DataStore::arrayName<MCParticle>(m_storeMCParticlesName),
                                DataStore::arrayName<SVDSimHit>(m_storeSimHitsName));
  m_relTrueHitSimHitName = DataStore::relationName(
                             DataStore::arrayName<SVDTrueHit>(m_storeTrueHitsName),
                             DataStore::arrayName<SVDSimHit>(m_storeSimHitsName));
 
  // Convert parameters to correct units
  m_segmentLength *= Unit::mm;
  m_noiseFraction = TMath::Freq(m_SNAdjacent); // 0.9... !
  m_samplingTime *= Unit::ns;
  m_betaPrimeDecayTimeU *= Unit::ns;
  m_betaPrimeDecayTimeV *= Unit::ns;
  m_minTimeFrame *= Unit::ns;
  m_maxTimeFrame *= Unit::ns;
 
  B2DEBUG(29,
          "SVDDigitizer parameters (in default system units, *=cannot be set directly):");
  B2DEBUG(29, " DATASTORE COLLECTIONS:");
  B2DEBUG(29,
          " -->  MCParticles:        " << DataStore::arrayName<MCParticle>(m_storeMCParticlesName));
  B2DEBUG(29,
          " -->  Digits:             " << DataStore::arrayName<SVDShaperDigit>(m_storeShaperDigitsName));
  B2DEBUG(29,
          " -->  SimHits:            " << DataStore::arrayName<SVDSimHit>(m_storeSimHitsName));
  B2DEBUG(29,
          " -->  TrueHits:           " << DataStore::arrayName<SVDTrueHit>(m_storeTrueHitsName));
  B2DEBUG(29, " -->  MCSimHitRel:        " << m_relMCParticleSimHitName);
  B2DEBUG(29, " -->  DigitMCRel:         " << m_relShaperDigitMCParticleName);
  B2DEBUG(29, " -->  TrueSimRel:         " << m_relTrueHitSimHitName);
  B2DEBUG(29, " -->  DigitTrueRel:       " << m_relShaperDigitTrueHitName);
  B2DEBUG(29, " PHYSICS: ");
  B2DEBUG(29, " -->  SegmentLength:      " << m_segmentLength);
  B2DEBUG(29, " NOISE: ");
  B2DEBUG(29, " -->  Add Poisson noise   " << (m_applyPoisson ? "true" : "false"));
  B2DEBUG(29, " -->  Zero suppression cut" << m_SNAdjacent);
  B2DEBUG(29, " -->  Round ZS cut:       " << (m_roundZS ? "true" : "false"));
  B2DEBUG(29, " -->  Samples over ZS cut:" << m_nSamplesOverZS);
  B2DEBUG(29, " -->  Noise fraction*:    " << 1.0 - m_noiseFraction);
  B2DEBUG(29, " TIMING: ");
  B2DEBUG(29, " -->  Sampling time:      " << m_samplingTime);
  B2DEBUG(29, " -->  Start of int. wind.:" << m_startSampling);
  B2DEBUG(29, " -->  Random event times. " << (m_randomizeEventTimes ? "true" : "false"));
  B2DEBUG(29, " REPORTING: ");
  B2DEBUG(29, " -->  statisticsFilename: " << m_rootFilename);
  B2DEBUG(29,
          " -->  storeWaveforms:     " << (m_storeWaveforms ? "true" : "false"));
 
  if (!m_rootFilename.empty()) {
    m_rootFile = new TFile(m_rootFilename.c_str(), "RECREATE");
    m_rootFile->cd();
    m_histChargeSharing_v = new TH1D("h_Diffusion_v", " 'Diffusion' distance, v",
                                     200, -500, 500);
    m_histChargeSharing_v->GetXaxis()->SetTitle(" distance v [um]");
    m_histChargeSharing_u = new TH1D("h_Diffusion_u",
                                     " 'Diffusion' distance, u", 100, -200, 200);
    m_histChargeSharing_u->GetXaxis()->SetTitle("distance u [um]");
    m_histLorentz_u = new TH1D("h_LorentzAngle_u", "Lorentz angle, holes",
                               100, -0.08, 0);
    m_histLorentz_u->GetXaxis()->SetTitle("Lorentz angle");
    m_histLorentz_v = new TH1D("h_LorentzAngle_v",
                               "Lorentz angle, electrons", 100, -0.002, 0.002);
    m_histLorentz_v->GetXaxis()->SetTitle("Lorentz angle");
    m_signalDist_u = new TH1D("h_signalDist_u",
                              "Strip signals vs. TrueHits, holes", 100, -400, 400);
    m_signalDist_u->GetXaxis()->SetTitle("U strip position - TrueHit u [um]");
    m_signalDist_v = new TH1D("h_signalDist_v",
                              "Strip signals vs. TrueHits, electrons", 100, -400, 400);
    m_signalDist_v->GetXaxis()->SetTitle("V strip position - TrueHit v [um]");
 
    m_histMobility_e = new TH1D("h_elecMobility", "electron Mobility",
                                30, 900, 1200);
    m_histMobility_e->GetXaxis()->SetTitle("Electron Mobility");
    m_histMobility_h = new TH1D("h_holeMobility", "hole Mobility",
                                30, 400, 500);
    m_histMobility_h->GetXaxis()->SetTitle("Holes Mobility");
 
    m_histDistanceToPlane_e = new TH1D("h_elecDistToPlane", "electron Distance to Plane",
                                       50, -0.05, 0.05);
    m_histDistanceToPlane_e->GetXaxis()->SetTitle("Electron Distance To Plane [cm]");
    m_histDistanceToPlane_h = new TH1D("h_holeDistToPlane", "holes Distance to Plane",
                                       50, -0.05, 0.05);
    m_histDistanceToPlane_h->GetXaxis()->SetTitle("Holes Distance To Plane [cm]");
 
    m_histVelocity_e = new TH1D("h_elecVelocity", "electrons Velocity (z)",
                                100, 0.001, 0.01);
 
    m_histVelocity_e->GetXaxis()->SetTitle("Electron Velocity [cm/s]");
    m_histVelocity_h = new TH1D("h_holeVelocity", "holes Velocity (z)",
                                30, -0.002, -0.0004);
    m_histVelocity_h->GetXaxis()->SetTitle("holes Velocity [cm/s]");
 
    m_histDriftTime_e = new TH1D("h_elecDriftTime", "electron Drift Time",
                                 30, 0, 30);
    m_histDriftTime_e->GetXaxis()->SetTitle("Electron Drift Time");
    m_histDriftTime_h = new TH1D("h_holeDriftTime", "hole Drift Time",
                                 30, 0, 30);
    m_histDriftTime_h->GetXaxis()->SetTitle("Hole Drift Time");
 
    m_histHitTime = new TH1D("h_startAPVTime", "start APV Time",
                             200, -100, 100);
    m_histHitTime->GetXaxis()->SetTitle("time (ns)");
    m_histHitTimeTB = new TH2F("h_startAPVTimeTB", "start APV Time vs TB",
                               200, -100, 100, 4, -0.5, 3.5);
    m_histHitTimeTB->GetXaxis()->SetTitle("time (ns)");
    m_histHitTimeTB->GetYaxis()->SetTitle("TB");
 
    if (m_storeWaveforms) {
      m_waveTree = new TTree("waveTree", "SVD waveforms");
      m_waveTree->Branch("sensor", &tree_vxdID, "sensor/I");
      m_waveTree->Branch("u_or_v", &tree_uv, "u_or_v/I");
      m_waveTree->Branch("strip", &tree_strip, "strip/I");
      m_waveTree->Branch("signal", tree_signal, "signal[20]/D");
    }
  } else {
    // No waveforms can be stored if there is no statistics file.
    m_storeWaveforms = false;
  }
}

processHit()

void processHit

(

)

Process one SVDSimHit by dividing the step in smaller steps and drifting the charge.

Definition at line 427 of file SVDDigitizerModule.cc.

{
  // Set time of the hit
  m_currentTime = m_currentEventTime + m_currentHit->getGlobalTime();
 
  //Get Steplength and direction
  const ROOT::Math::XYZVector& startPoint = m_currentHit->getPosIn();
  const ROOT::Math::XYZVector& stopPoint = m_currentHit->getPosOut();
  ROOT::Math::XYZVector direction = stopPoint - startPoint;
  double trackLength = direction.R();
 
  if (m_currentHit->getPDGcode() == Const::photon.getPDGCode() || trackLength < 0.1 * Unit::um) {
    //Photons deposit energy at the end of their step
    driftCharge(stopPoint, m_currentHit->getElectrons(), SVD::SensorInfo::electron);
    driftCharge(stopPoint, m_currentHit->getElectrons(), SVD::SensorInfo::hole);
  } else {
    //Otherwise, split into segments of (default) max. 5µm and
    //drift the charges from the center of each segment
    auto segments = m_currentHit->getElectronsConstantDistance(m_segmentLength);
    double lastFraction {0};
    double lastElectrons {0};
 
    for (auto& segment : segments) {
      //Simhit returns step fraction and cumulative electrons. We want the
      //center of these steps and electrons in this step
      const double f = (segment.first + lastFraction) / 2;
      const double e = segment.second - lastElectrons;
      //Update last values
      std::tie(lastFraction, lastElectrons) = segment;
 
      //And drift charge from that position
      const ROOT::Math::XYZVector position = startPoint + f * direction;
      driftCharge(position, e, SVD::SensorInfo::electron);
      driftCharge(position, e, SVD::SensorInfo::hole);
    }
  }
}

saveDigits()

void saveDigits

(

)

Save digits to the DataStore Saves samples of generated waveforms.

Definition at line 689 of file SVDDigitizerModule.cc.

{
 
  StoreArray<MCParticle> storeMCParticles(m_storeMCParticlesName);
  StoreArray<SVDTrueHit> storeTrueHits(m_storeTrueHitsName);
  StoreArray<SVDShaperDigit> storeShaperDigits(m_storeShaperDigitsName);
  RelationArray relShaperDigitMCParticle(storeShaperDigits, storeMCParticles,
                                         m_relShaperDigitMCParticleName);
  RelationArray relShaperDigitTrueHit(storeShaperDigits, storeTrueHits,
                                      m_relShaperDigitTrueHitName);
 
  //Get SVD config from SVDEventInfo
  //  int runType = (int) modeByte.getRunType();
  //  int eventType = (int) modeByte.getEventType();
 
 
  // ... to store digit-digit relations
  vector<pair<unsigned int, float> > digit_weights;
 
  // Take samples at the desired times, add noise, zero-suppress and save digits.
  for (Waveforms::value_type& sensorWaveforms : m_waveforms) {
    int sensorID = sensorWaveforms.first;
    // u-side digits:
 
    // Cycle through signals and generate samples
    for (StripWaveforms::value_type& stripWaveform : sensorWaveforms.second.first) {
      short int iStrip = stripWaveform.first;
      SVDWaveform& s = stripWaveform.second;
      // Now generate samples in time and save as digits.
      vector<double> samples;
      // ... to store digit-digit relations
      digit_weights.clear();
      digit_weights.reserve(SVDShaperDigit::c_nAPVSamples);
 
      double elNoise = m_NoiseCal.getNoiseInElectrons(sensorID, true, iStrip);
      double gain = 1 / m_PulseShapeCal.getChargeFromADC(sensorID, true, iStrip, 1);
      double electronWeight = m_ChargeSimCal.getElectronWeight(sensorID, true);
 
      double t = m_initTime;
      B2DEBUG(25, "start sampling at " << m_initTime);
      for (int iSample = 0; iSample < (int) SVDShaperDigit::c_nAPVSamples; iSample ++) {
        samples.push_back(addNoise(electronWeight * s(t), elNoise));
        t += m_samplingTime;
      }
 
      SVDWaveform::relations_map particles = s.getMCParticleRelations();
      SVDWaveform::relations_map truehits = s.getTrueHitRelations();
 
      // Save SVDShaperDigits
 
      // 1. Convert to ADU
      SVDShaperDigit::APVRawSamples rawSamples;
      std::transform(samples.begin(), samples.end(), rawSamples.begin(),
      [&](double x)->SVDShaperDigit::APVRawSampleType {
        return SVDShaperDigit::trimToSampleRange(x * gain);
      });
 
      // 2.a Check if over threshold
      auto rawThreshold = m_SNAdjacent * elNoise * gain;
      if (m_roundZS) rawThreshold = round(rawThreshold);
      auto n_over = std::count_if(rawSamples.begin(), rawSamples.end(),
                                  std::bind2nd(std::greater<double>(), rawThreshold)
                                 );
      if (n_over < m_nSamplesOverZS) continue;
 
      // 2.b check if the strip is masked
      if (m_MaskedStr.isMasked(sensorID, true, iStrip)) continue;
 
      // 2.c check if the APV is disabled
      if (!m_map->isAPVinMap(sensorID, true, iStrip)) continue;
 
      // 2.d.1 check if it's a 3-sample event
      if (m_is3sampleEvent) {
        rawSamples[0] = rawSamples[m_startingSample];
        rawSamples[1] = rawSamples[m_startingSample + 1];
        rawSamples[2] = rawSamples[m_startingSample + 2];
        rawSamples[3] = 0.;
        rawSamples[4] = 0.;
        rawSamples[5] = 0.;
        //2.d.2 check if still over threshold
        n_over = std::count_if(rawSamples.begin(), rawSamples.end(),
                               std::bind2nd(std::greater<double>(), rawThreshold)
                              );
        if (n_over < m_nSamplesOverZS) continue;
 
      }
 
      // 3. Save as a new digit
      int digIndex = storeShaperDigits.getEntries();
      storeShaperDigits.appendNew(sensorID, true, iStrip, rawSamples, 0);
 
      //If the digit has any relations to MCParticles, add the Relation
      if (particles.size() > 0) {
        relShaperDigitMCParticle.add(digIndex, particles.begin(), particles.end());
      }
      //If the digit has any relations to truehits, add the Relations.
      if (truehits.size() > 0) {
        relShaperDigitTrueHit.add(digIndex, truehits.begin(), truehits.end());
      }
      // generate SVDShaperDigits
    } // for stripSignals
 
    // v-side digits:
 
    // Cycle through signals and generate samples
    for (StripWaveforms::value_type& stripWaveform : sensorWaveforms.second.second) {
      short int iStrip = stripWaveform.first;
      SVDWaveform& s = stripWaveform.second;
      // Now generate samples in time and save as digits.
      vector<double> samples;
      // ... to store digit-digit relations
      digit_weights.clear();
      digit_weights.reserve(SVDShaperDigit::c_nAPVSamples);
 
      double elNoise = m_NoiseCal.getNoiseInElectrons(sensorID, false, iStrip);
      double gain = 1 / m_PulseShapeCal.getChargeFromADC(sensorID, false, iStrip, 1);
      double electronWeight = m_ChargeSimCal.getElectronWeight(sensorID, false);
 
      double t = m_initTime;
      for (int iSample = 0; iSample < (int)SVDShaperDigit::c_nAPVSamples; iSample ++) {
        samples.push_back(addNoise(electronWeight * s(t), elNoise));
        t += m_samplingTime;
      }
 
      SVDWaveform::relations_map particles = s.getMCParticleRelations();
      SVDWaveform::relations_map truehits = s.getTrueHitRelations();
 
      // Save SVDShaperDigits
      // 1. Convert to ADU
      SVDShaperDigit::APVRawSamples rawSamples;
      std::transform(samples.begin(), samples.end(), rawSamples.begin(),
      [&](double x)->SVDShaperDigit::APVRawSampleType {
        return SVDShaperDigit::trimToSampleRange(x * gain);
      });
 
      // 2.a Check if over threshold
      auto rawThreshold = m_SNAdjacent * elNoise * gain;
      if (m_roundZS) rawThreshold = round(rawThreshold);
      auto n_over = std::count_if(rawSamples.begin(), rawSamples.end(),
                                  std::bind2nd(std::greater<double>(), rawThreshold)
                                 );
      if (n_over < m_nSamplesOverZS) continue;
 
      // 2.b check if the strip is masked
      if (m_MaskedStr.isMasked(sensorID, false, iStrip)) continue;
 
      // 2.c check if the APV is disabled
      if (!m_map->isAPVinMap(sensorID, false, iStrip)) continue;
 
      // 2.d.1 check if it's a 3-sample event
      if (m_is3sampleEvent) {
        rawSamples[0] = rawSamples[m_startingSample];
        rawSamples[1] = rawSamples[m_startingSample + 1];
        rawSamples[2] = rawSamples[m_startingSample + 2];
        rawSamples[3] = 0.;
        rawSamples[4] = 0.;
        rawSamples[5] = 0.;
        //2.d.2 check if still over threshold
        n_over = std::count_if(rawSamples.begin(), rawSamples.end(),
                               std::bind2nd(std::greater<double>(), rawThreshold)
                              );
        if (n_over < m_nSamplesOverZS) continue;
      }
 
      // 3. Save as a new digit
      int digIndex = storeShaperDigits.getEntries();
      storeShaperDigits.appendNew(sensorID, false, iStrip, rawSamples, 0);
 
      //If the digit has any relations to MCParticles, add the Relation
      if (particles.size() > 0) {
        relShaperDigitMCParticle.add(digIndex, particles.begin(), particles.end());
      }
      //If the digit has any relations to truehits, add the Relations.
      if (truehits.size() > 0) {
        relShaperDigitTrueHit.add(digIndex, truehits.begin(), truehits.end());
      }
    } // for stripSignals
  } // FOREACH sensor
}

saveSignals()

void saveSignals

(

)

Save signals to a root-delimited file (to be analyzed in Python).

This method is only called when a name is set for the file.

Definition at line 907 of file SVDDigitizerModule.cc.

{
  static size_t recordNo = 0;
  static const string header("Event\tSensor\tSide\tStrip\tContrib\tTime\tCharge\tTau");
  regex startLine("^|\n"); // for inserting event/sensor/etc info
  ofstream outfile(m_signalsList, ios::out | ios::app);
  if (recordNo == 0) outfile << header << endl;
  for (Waveforms::value_type& sensorWaveforms : m_waveforms) {
    VxdID sensorID(sensorWaveforms.first);
    const SensorInfo& info =
      dynamic_cast<const SensorInfo&>(VXD::GeoCache::get(sensorWaveforms.first));
    // u-side digits:
    size_t isU = 1;
    double thresholdU = 3.0 * info.getElectronicNoiseU();
    for (StripWaveforms::value_type& stripWaveform : sensorWaveforms.second.first) {
      size_t strip = stripWaveform.first;
      SVDWaveform& s = stripWaveform.second;
      // Read the value only if the signal is large enough.
      if (s.getCharge() < thresholdU)
        continue;
      // Else print to a string
      ostringstream preamble;
      // We don't have eventNo, but we don't care about event boundaries.
      preamble << "$&" << recordNo << '\t' << sensorID << '\t' << isU << '\t' << strip << '\t';
      string signalString = s.toString();
      signalString.pop_back(); // remove the last newline!!!
      string tableString = regex_replace(signalString, startLine, preamble.str());
      outfile << tableString << endl; // now we have to add the newline back.
    } // FOREACH stripSignal
    // x-side digits:
    isU = 0;
    double thresholdV = 3.0 * info.getElectronicNoiseV();
    for (StripWaveforms::value_type& stripWaveform : sensorWaveforms.second.second) {
      size_t strip = stripWaveform.first;
      SVDWaveform& s = stripWaveform.second;
      // Read the value only if the signal is large enough.
      if (s.getCharge() < thresholdV)
        continue;
      // Else print to a string
      ostringstream preamble;
      // We don't have eventNo, but we don't care about event boundaries.
      preamble << "$&" << recordNo << '\t' << sensorID << '\t' << isU << '\t' << strip << '\t';
      string signalString = s.toString();
      signalString.pop_back(); // remove the last newline!!!
      string tableString = regex_replace(signalString, startLine, preamble.str());
      outfile << tableString << endl; // now we have to add the newline back.
    } // FOREACH stripSignal
  } // for sensors
  outfile.close();
  recordNo++;
}

saveWaveforms()

void saveWaveforms

(

)

Save waveforms to the statistics file.

This method is only called when storage of waveforms is required.

Definition at line 869 of file SVDDigitizerModule.cc.

{
  for (Waveforms::value_type& sensorWaveforms : m_waveforms) {
    tree_vxdID = sensorWaveforms.first;
    const SensorInfo& info =
      dynamic_cast<const SensorInfo&>(VXD::GeoCache::get(sensorWaveforms.first));
    // u-side digits:
    tree_uv = 1;
    double thresholdU = 3.0 * info.getElectronicNoiseU();
    for (StripWaveforms::value_type& stripWaveform : sensorWaveforms.second.first) {
      tree_strip = stripWaveform.first;
      SVDWaveform& s = stripWaveform.second;
      // Read the value only if the signal is large enough.
      if (s.getCharge() < thresholdU)
        continue;
      for (int iTime = 0; iTime < 20; ++iTime) {
        tree_signal[iTime] = s(10 * iTime);
      }
      m_waveTree->Fill();
    } // FOREACH stripSignal
    // v-side digits:
    tree_uv = 0;
    double thresholdV = 3.0 * info.getElectronicNoiseV();
    for (StripWaveforms::value_type& stripWaveform : sensorWaveforms.second.second) {
      tree_strip = stripWaveform.first;
      SVDWaveform& s = stripWaveform.second;
      // Read the values only if the signal is large enough
      if (s.getCharge() < thresholdV)
        continue;
      for (int iTime = 0; iTime < 20; ++iTime) {
        tree_signal[iTime] = s(10. * iTime);
      }
      m_waveTree->Fill();
    } // FOREACH stripSignal
  } // FOREACH sensor
  m_rootFile->Flush();
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

terminate()

void terminate ( void  )

overridevirtual

Terminate the module.

Reimplemented from Module.

Definition at line 959 of file SVDDigitizerModule.cc.

{
  if (m_rootFile) {
    m_rootFile->Write();
    m_rootFile->Close();
  }
}

Member Data Documentation

m_applyPoisson

bool m_applyPoisson = true

protected

Whether or not to apply poisson fluctuation of charge (Fano factor)

Definition at line 134 of file SVDDigitizerModule.h.

m_betaPrimeDecayTimeU

double m_betaPrimeDecayTimeU = 250.0

protected

Decay time of betaprime waveform U-side.

Definition at line 148 of file SVDDigitizerModule.h.

m_betaPrimeDecayTimeV

double m_betaPrimeDecayTimeV = 250.0

protected

Decay time of betaprime waveform V-side.

Definition at line 150 of file SVDDigitizerModule.h.

m_ChargeSimCal

SVDChargeSimulationCalibrations m_ChargeSimCal

protected

SVDChargeSimulationCalibrations calibrations db object.

Definition at line 225 of file SVDDigitizerModule.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_currentEventTime

float m_currentEventTime = 0.0

protected

Current event time.

This is what gets randomized if m_randomizeEventTimes is true.

Definition at line 174 of file SVDDigitizerModule.h.

m_currentHit

const SVDSimHit* m_currentHit = nullptr

protected

Pointer to the SVDSimhit currently digitized.

Definition at line 197 of file SVDDigitizerModule.h.

m_currentParticle

int m_currentParticle = -1

protected

Index of the particle which caused the current hit.

Definition at line 199 of file SVDDigitizerModule.h.

m_currentSensorInfo

const SensorInfo* m_currentSensorInfo = nullptr

protected

Pointer to the SensorInfo of the current sensor.

Definition at line 205 of file SVDDigitizerModule.h.

m_currentSensorWaveforms

SensorWaveforms* m_currentSensorWaveforms = nullptr

protected

Pointer to the sensor in which the current hit occurred.

Definition at line 203 of file SVDDigitizerModule.h.

m_currentTime

double m_currentTime = 0

protected

Time of the current SimHit.

Definition at line 207 of file SVDDigitizerModule.h.

m_currentTrueHit

int m_currentTrueHit = -1

protected

Index of the TrueHit the current hit belongs to.

Definition at line 201 of file SVDDigitizerModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_histChargeSharing_u

TH1D* m_histChargeSharing_u = nullptr

protected

Histogram showing the charge sharing + diffusion in u (r-phi).

Definition at line 233 of file SVDDigitizerModule.h.

m_histChargeSharing_v

TH1D* m_histChargeSharing_v = nullptr

protected

Histogram showing the charge sharing + diffusion in v (z).

Definition at line 235 of file SVDDigitizerModule.h.

m_histDistanceToPlane_e

TH1D* m_histDistanceToPlane_e = nullptr

protected

Histogram showing the distance to plane for e.

Definition at line 246 of file SVDDigitizerModule.h.

m_histDistanceToPlane_h

TH1D* m_histDistanceToPlane_h = nullptr

protected

Histogram showing the distance to plane for h.

Definition at line 248 of file SVDDigitizerModule.h.

m_histDriftTime_e

TH1D* m_histDriftTime_e = nullptr

protected

Histogram showing the drift time of e.

Definition at line 250 of file SVDDigitizerModule.h.

m_histDriftTime_h

TH1D* m_histDriftTime_h = nullptr

protected

Histogram showing the drift time of h.

Definition at line 252 of file SVDDigitizerModule.h.

m_histHitTime

TH1D* m_histHitTime = nullptr

protected

Histogram showing the hit time.

Definition at line 254 of file SVDDigitizerModule.h.

m_histHitTimeTB

TH2F* m_histHitTimeTB = nullptr

protected

Histogram showing the hit time vs TB.

Definition at line 256 of file SVDDigitizerModule.h.

m_histLorentz_u

TH1D* m_histLorentz_u = nullptr

protected

Histogram showing the Lorentz angles in u (r-phi).

Definition at line 259 of file SVDDigitizerModule.h.

m_histLorentz_v

TH1D* m_histLorentz_v = nullptr

protected

Histogram showing the Lorentz angles in v (z).

Definition at line 261 of file SVDDigitizerModule.h.

m_histMobility_e

TH1D* m_histMobility_e = nullptr

protected

Histogram showing the mobility of e-.

Definition at line 238 of file SVDDigitizerModule.h.

m_histMobility_h

TH1D* m_histMobility_h = nullptr

protected

Histogram showing the mobility of h.

Definition at line 240 of file SVDDigitizerModule.h.

m_histVelocity_e

TH1D* m_histVelocity_e = nullptr

protected

Histogram showing the velocity of e-.

Definition at line 242 of file SVDDigitizerModule.h.

m_histVelocity_h

TH1D* m_histVelocity_h = nullptr

protected

Histogram showing the velocity of h.

Definition at line 244 of file SVDDigitizerModule.h.

m_hwClock

DBObjPtr<HardwareClockSettings> m_hwClock

protected

Hardware Clocks.

Definition at line 146 of file SVDDigitizerModule.h.

m_initTime

double m_initTime = 0

protected

Time window start, including the triggerBin effect.

Starting from this time, signal samples are taken in samplingTime intervals.

Definition at line 160 of file SVDDigitizerModule.h.

m_is3sampleEvent

bool m_is3sampleEvent = false

protected

True if the event should be simulated with 3 sample.

Definition at line 178 of file SVDDigitizerModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_map

std::unique_ptr<SVDOnlineToOfflineMap> m_map

protected

channel mapping map

Definition at line 223 of file SVDDigitizerModule.h.

m_mapping

DBObjPtr<PayloadFile> m_mapping

protected

channel mapping payload

Definition at line 222 of file SVDDigitizerModule.h.

m_MaskedStr

SVDFADCMaskedStrips m_MaskedStr

protected

FADC masked strip payload.

Definition at line 220 of file SVDDigitizerModule.h.

m_maxTimeFrame

float m_maxTimeFrame = 150

protected

High edge of randomization time frame.

Definition at line 170 of file SVDDigitizerModule.h.

m_minTimeFrame

float m_minTimeFrame = -300

protected

Low edge of randomization time frame.

Definition at line 168 of file SVDDigitizerModule.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_nAPV25Samples

int m_nAPV25Samples = 6

protected

number of digitized samples read from SVDEventInfo

Definition at line 180 of file SVDDigitizerModule.h.

m_NoiseCal

SVDNoiseCalibrations m_NoiseCal

protected

SVDNoise calibrations db object.

Definition at line 226 of file SVDDigitizerModule.h.

m_noiseFraction

double m_noiseFraction = 0.01

protected

(derived from SNAdjacent) Fraction of noisy strips per sensor.

Definition at line 142 of file SVDDigitizerModule.h.

m_nSamplesOverZS

int m_nSamplesOverZS = 1

protected

Keep digit if at least m_nSamplesOverZS are over threshold.

Definition at line 140 of file SVDDigitizerModule.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_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_PulseShapeCal

SVDPulseShapeCalibrations m_PulseShapeCal

protected

SVDPulseShapeCalibrations calibrations db object.

Definition at line 227 of file SVDDigitizerModule.h.

m_randomizeEventTimes

bool m_randomizeEventTimes = false

protected

Randomize event times? If set to true, event times will be randomized uniformly from m_minTimeFrame to m_maxTimeFrame.

Definition at line 166 of file SVDDigitizerModule.h.

m_relativeShift

int m_relativeShift = 0

protected

relative shift in SVDEventInfo obj

Definition at line 212 of file SVDDigitizerModule.h.

m_relMCParticleSimHitName

std::string m_relMCParticleSimHitName = ""

protected

Name of the relation between MCParticles and SVDSimHits.

Definition at line 116 of file SVDDigitizerModule.h.

m_relShaperDigitMCParticleName

std::string m_relShaperDigitMCParticleName = ""

protected

Name of the relation between SVDShaperDigits and MCParticles.

Definition at line 122 of file SVDDigitizerModule.h.

m_relShaperDigitTrueHitName

std::string m_relShaperDigitTrueHitName = ""

protected

Name of the relation between SVDShaperDigits and SVDTrueHits.

Definition at line 124 of file SVDDigitizerModule.h.

m_relTrueHitSimHitName

std::string m_relTrueHitSimHitName = ""

protected

Name of the relation between SVDTrueHits and SVDSimHits.

Definition at line 118 of file SVDDigitizerModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_rootFile

TFile* m_rootFile = nullptr

protected

Pointer to the ROOT filename for statistics.

Definition at line 231 of file SVDDigitizerModule.h.

m_rootFilename

std::string m_rootFilename = ""

protected

Name of the ROOT filename to output statistics.

Definition at line 184 of file SVDDigitizerModule.h.

m_roundZS

bool m_roundZS = true

protected

Round ZS cut to nearest ADU.

Definition at line 138 of file SVDDigitizerModule.h.

m_samplingTime

double m_samplingTime = -1

protected

Interval between two waveform samples, by default taken from HardwareClockSettings.

Definition at line 152 of file SVDDigitizerModule.h.

m_segmentLength

double m_segmentLength = 0.020

protected

Max.

Segment length to use for charge drifting

Definition at line 130 of file SVDDigitizerModule.h.

m_sensorThickness

double m_sensorThickness = 0.03

protected

Thickness of current sensor (read from m_currentSensorInfo)

Definition at line 209 of file SVDDigitizerModule.h.

m_signalDist_u

TH1D* m_signalDist_u = nullptr

protected

Histogram showing the distribution of digit signals in u (r-phi).

Definition at line 263 of file SVDDigitizerModule.h.

m_signalDist_v

TH1D* m_signalDist_v = nullptr

protected

Histogram showing the distribution of digit signals in v (z).

Definition at line 265 of file SVDDigitizerModule.h.

m_signalsList

std::string m_signalsList = ""

protected

Name of the tab-delimited listing of waveforms.

Definition at line 188 of file SVDDigitizerModule.h.

m_SNAdjacent

double m_SNAdjacent = 3.0

protected

Zero-suppression cut.

Definition at line 136 of file SVDDigitizerModule.h.

m_startingSample

int m_startingSample = 0

protected

Starting sample for the selection of 3 samples in 3-mixed-6.

Definition at line 214 of file SVDDigitizerModule.h.

m_startSampling

double m_startSampling = -2

protected

Time window start, excluding trigger bin effect.

This is the parameter used to tune the latency wrt L1 trigger.

Definition at line 156 of file SVDDigitizerModule.h.

m_storeMCParticlesName

std::string m_storeMCParticlesName = ""

protected

Name of the collection for the MCParticles.

Definition at line 110 of file SVDDigitizerModule.h.

m_storeShaperDigitsName

std::string m_storeShaperDigitsName = ""

protected

Name of the collection for the SVDShaperDigits.

Definition at line 120 of file SVDDigitizerModule.h.

m_storeSimHitsName

std::string m_storeSimHitsName = ""

protected

Name of the collection for the SVDSimhits.

Definition at line 112 of file SVDDigitizerModule.h.

m_storeTrueHitsName

std::string m_storeTrueHitsName = ""

protected

Name of the collection for the SVDTrueHits.

Definition at line 114 of file SVDDigitizerModule.h.

m_storeWaveforms

bool m_storeWaveforms = false

protected

Store waveform data in the reporting file?

Definition at line 186 of file SVDDigitizerModule.h.

m_svdEventInfoName

std::string m_svdEventInfoName = "SVDEventInfoSim"

protected

Name of the SVDEventInfo object.

Definition at line 126 of file SVDDigitizerModule.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_waveforms

Waveforms m_waveforms

protected

Structure containing waveforms in all existing sensors.

Definition at line 194 of file SVDDigitizerModule.h.

m_waveTree

TTree* m_waveTree = nullptr

protected

Tree for waveform storage.

Definition at line 267 of file SVDDigitizerModule.h.

m_xmlFileName

std::string m_xmlFileName = std::string("SVDChannelMapping.xml")

staticprotected

< channel mapping xml filename

Definition at line 221 of file SVDDigitizerModule.h.

---

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

• svd/modules/svdSimulation/include/SVDDigitizerModule.h
• svd/modules/svdSimulation/src/SVDDigitizerModule.cc