The Class for Detailed Digitization of CDC. More...

#include <CDCDigitizerModule.h>

Inheritance diagram for CDCDigitizerModule:

Classes
struct	SignalInfo
	Structure for saving the signal information. More...

struct	XTalkInfo
	Structure for saving the x-talk information. More...

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

typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	CDCDigitizerModule ()
	Constructor.

void	initialize () override
	Initialize variables, print info, and start CPU clock.

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

void	terminate () override
	Terminate func.

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

virtual void	beginRun ()
	Called when entering a new run.

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
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
double	smearDriftLength (double driftLength, double dDdt)
	Method used to smear the drift length.

double	getdDdt (double driftLength)
	The method to get dD/dt.

double	getDriftTime (double driftLength, bool addTof, bool addDelay)
	The method to get drift time based on drift length.

void	makeSignalsAfterShapers (const WireID &wid, double edep, double dx, double costh, unsigned short &adcCount, double &convFactorForThreshold)
	Function to write ADC-count and conversion factor for threshold.

double	getPositiveT0 (const WireID &)
	Modify t0 for negative-t0 case.

void	setFEElectronics ()
	Set FEE parameters (from DB)

double	Polya (double xmax=10)
	Generate random number according to Polya distribution.

void	setSemiTotalGain ()
	Set semi-total gain (from DB)

double	getSemiTotalGain (int clayer, int cell) const
	Return semi-total gain of the specified wire.

double	getSemiTotalGain (const WireID &wireID) const
	Return semi-total gain of the specified wire.

void	addXTalk ()
	Add crosstalk.

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
StoreArray< MCParticle >	m_mcParticles
	Set edep-to-ADC conversion params.

StoreArray< CDCSimHit >	m_simHits
	CDCSimHit array.

StoreArray< CDCHit >	m_cdcHits
	CDCHit array.

StoreArray< CDCHit >	m_cdcHits4Trg
	CDCHit4trg array.

std::string	m_inputCDCSimHitsName
	Input array name.

std::string	m_outputCDCHitsName
	Output array name.

std::string	m_outputCDCHitsName4Trg
	Output array name for trigger.

std::string	m_MCParticlesToSimHitsName
	Relation for origin of incoming SimHits.

std::string	m_SimHitsTOCDCHitsName
	Relation for outgoing CDCHits.

std::string	m_OptionalFirstMCParticlesToHitsName
	Relation name for optional matching of up to first three MCParticles.

std::string	m_OptionalAllMCParticlesToHitsName
	Relation name for optional matching of all MCParticles.

bool	m_useSimpleDigitization
	Use float Gaussian Smearing instead of proper digitization.

double	m_fraction
	Fraction of the first Gaussian used to smear drift length.

double	m_mean1
	Mean value of the first Gaussian used to smear drift length.

double	m_resolution1
	Resolution of the first Gaussian used to smear drift length.

double	m_mean2
	Mean value of the second Gaussian used to smear drift length.

double	m_resolution2
	Resolution of the second Gaussian used to smear drift length.

double	m_tdcThreshold4Outer
	TDC threshold for outer layers in unit of eV.

double	m_tdcThreshold4Inner
	TDC threshold for inner layers in unit of eV.

int	m_eDepInGasMode
	Mode for extracting dE(gas) from dE(gas+wire)

int	m_adcThreshold
	Threshold for ADC in unit of count.

double	m_tMin
	Lower edge of time window in ns.

double	m_tMaxOuter
	Upper edge of time window in ns for the outer layers.

double	m_tMaxInner
	Upper edge of time window in ns for the inner layers.

double	m_trigTimeJitter
	Magnitude of trigger timing jitter (ns).

CDC::CDCGeometryPar *	m_cdcgp
	Cached Pointer to CDCGeometryPar.

CDC::CDCGeoControlPar *	m_gcp
	Cached pointer to CDCGeoControlPar.

CDCSimHit *	m_aCDCSimHit
	Pointer to CDCSimHit.

WireID	m_wireID
	WireID of this hit.

unsigned short	m_posFlag
	left or right flag of this hit

unsigned short	m_boardID = 0
	FEE board ID.

B2Vector3D	m_posWire
	wire position of this hit

B2Vector3D	m_posTrack
	track position of this hit

B2Vector3D	m_momentum
	3-momentum of this hit

double	m_driftLength
	drift length of this hit

double	m_flightTime
	flight time of this hit

double	m_globalTime
	global time of this hit

double	m_tdcBinWidth
	Width of a TDC bin (in ns)

double	m_tdcBinWidthInv
	m_tdcBinWidth^-1 (in ns^-1)

double	m_tdcResol
	TDC resolution (in ns)

double	m_driftV
	Nominal drift velocity (in cm/ns)

double	m_driftVInv
	m_driftV^-1 (in ns/cm)

double	m_propSpeedInv
	Inv.

double	m_tdcThresholdOffset
	Offset for TDC(digital) threshold (mV)

double	m_analogGain
	analog gain (V/pC)

double	m_digitalGain
	digital gain (V/pC)

double	m_adcBinWidth
	ADC bin width (mV)

double	m_addFudgeFactorForSigma
	additional fudge factor for space resol.

double	m_totalFudgeFactor = 1.
	total fudge factor for space resol.

bool	m_gasGainSmearing = true
	Switch for gas gain smearing.

double	m_effWForGasGainSmearing = 0.0266
	Effective energy (keV) for one electron prod.

double	m_thetaOfPolya = 0.5
	theta of Polya function for gas gain smearing

bool	m_extraADCSmearing = false
	Switch for extra ADC smearing.

double	m_runGain = 1.
	run gain.

float	m_semiTotalGain [c_maxNSenseLayers][c_maxNDriftCells] = {{}}
	total gain per wire

double	m_overallGainFactor = 1.
	Overall gain factor.

double	m_degOfSPEOnThreshold = 0
	Degree of space charge effect on timing threshold.

bool	m_doSmearing
	A switch to control drift length smearing.

bool	m_addTimeWalk
	A switch used to control adding time-walk delay into the total drift time or not.

bool	m_addInWirePropagationDelay
	A switch used to control adding propagation delay into the total drift time or not.

bool	m_addTimeOfFlight
	A switch used to control adding time of flight into the total drift time or not.

bool	m_addInWirePropagationDelay4Bg
	A switch used to control adding propagation delay into the total drift time or not for beam bg.

bool	m_addTimeOfFlight4Bg
	A switch used to control adding time of flight into the total drift time or not for beam bg.

bool	m_outputNegativeDriftTime
	A switch to output negative drift time to CDCHit.

bool	m_output2ndHit
	A switch to output 2nd hit.

bool	m_align
	A switch to control alignment.

bool	m_correctForWireSag
	A switch to control wire sag.

bool	m_treatNegT0WiresAsGood
	A switch for negative-t0 wires.

bool	m_matchFirstMCParticles
	A switch to match first three MCParticles, not just the one with smallest drift time.

bool	m_matchAllMCParticles
	A switch to match all particles to a hit, regardless whether they produced a hit or not.

bool	m_useDB4FEE
	Fetch FEE params from DB.

DBArray< CDCFEElectronics > *	m_fEElectronicsFromDB = nullptr
	Pointer to FE electronics params.

float	m_lowEdgeOfTimeWindow [c_nBoards] = {0}
	Lower edge of time-window.

float	m_uprEdgeOfTimeWindow [c_nBoards] = {0}
	Upper edge of time-window.

float	m_tdcThresh [c_nBoards] = {0}
	Threshold for timing-signal.

float	m_adcThresh [c_nBoards] = {0}
	Threshold for FADC.

unsigned short	m_widthOfTimeWindowInCount [c_nBoards] = {0}
	Width of time window.

bool	m_useDB4EDepToADC
	Fetch edep-to-ADC conversion params.

bool	m_useDB4RunGain
	Fetch run gain from DB.

bool	m_spaceChargeEffect
	Space charge effect.

DBObjPtr< CDCDedxRunGain > *	m_runGainFromDB = nullptr
	Pointer to run gain from DB.

DBObjPtr< CDCDedxScaleFactor > *	m_gain0FromDB = nullptr
	Pointer to overall gain factor from DB.

DBObjPtr< CDCDedxWireGain > *	m_wireGainFromDB = nullptr
	Pointer to wire gain from DB.

bool	m_addXTalk
	Flag to switch on/off crosstalk.

bool	m_issue2ndHitWarning
	Flag to switch on/off a warning on the 2nd TDC hit.

bool	m_includeEarlyXTalks
	Flag to switch on/off xtalks earlier than the hit.

int	m_debugLevel
	Debug level.

int	m_debugLevel4XTalk
	Debug level for crosstalk.

DBObjPtr< CDCCrossTalkLibrary > *	m_xTalkFromDB = nullptr
	Pointer to cross-talk from DB.

DBObjPtr< CDCCorrToThresholds > *	m_corrToThresholdFromDB = nullptr
	Pointer to threshold correction from DB.

StoreObjPtr< SimClockState >	m_simClockState
	generated hardware clock state

bool	m_synchronization = true
	Flag to switch on/off timing synchronization.

bool	m_randomization = true
	Flag to switch on/off timing randomization.

int	m_tSimMode = 0
	Timing simulation mode.

int	m_offsetForTriggerBin = 1
	Input to getCDCTriggerBin(offset)

int	m_trgTimingOffsetInCount = 4
	Trigger timing offset in unit of count.

int	m_shiftOfTimeWindowIn32Count = 153
	Shift of time window for synchronization in 32count.

unsigned short	m_trgDelayInCount [c_nBoards] = {0}
	Trigger delay in frontend electronics in count.

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 Class for Detailed Digitization of CDC.

Currently a float Gaussian with steerable parameters is used for the digitization. If there are two or more hits in one cell, only the shortest drift length is selected. The signal amplitude is the sum of all hits deposited energy in this cell.

Definition at line 54 of file CDCDigitizerModule.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

◆ CDCDigitizerModule()

CDCDigitizerModule ( )

Constructor.

Definition at line 28 of file CDCDigitizerModule.cc.

                                       : Module(),
  m_cdcgp(), m_gcp(), m_aCDCSimHit(), m_posFlag(0),
  m_driftLength(0.0), m_flightTime(0.0), m_globalTime(0.0),
  m_tdcBinWidth(1.0), m_tdcBinWidthInv(1.0),
  m_tdcResol(0.9825), m_driftV(4.0e-3),
  m_driftVInv(250.0), m_propSpeedInv(27.25), m_align(true)
{
  // Set description
  setDescription("Creates CDCHits from CDCSimHits.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Add parameters
  // I/O
  addParam("InputCDCSimHitsName",         m_inputCDCSimHitsName, "Name of input array. Should consist of CDCSimHits.", string(""));
  addParam("OutputCDCHitsName",           m_outputCDCHitsName,   "Name of output array. Will consist of CDCHits.",     string(""));
  addParam("OutputCDCHitsName4Trg",       m_outputCDCHitsName4Trg,
           "Name of output array for trigger. Can contain several hits per wire, "
           "if they correspond to different time windows of 32ns.",
           string("CDCHits4Trg"));
 
  //Relations
  addParam("MCParticlesToCDCSimHitsName", m_MCParticlesToSimHitsName,
           "Name of relation between MCParticles and CDCSimHits used",     string(""));
  addParam("CDCSimHistToCDCHitsName", m_SimHitsTOCDCHitsName,
           "Name of relation between the CDCSimHits and the CDCHits used", string(""));
  addParam("OptionalFirstMCParticlesToHitsName",  m_OptionalFirstMCParticlesToHitsName,
           "Optional name of relation between the first MCParticles and CDCHits used", string("FirstMatchedParticles"));
  addParam("OptionalAllMCParticlesToHitsName", m_OptionalAllMCParticlesToHitsName,
           "Optional name of relation between all MCParticles and CDCHits used", string("AllMatchedParticles"));
 
 
  //Parameters for Digitization
  addParam("UseSimpleDigitization",       m_useSimpleDigitization,
           "If true, a simple x-t with a constant velocity is used for the drift-length to -time conversion", false);
 
  //float Gauss Parameters
  addParam("Fraction",                    m_fraction,    "Fraction of first Gaussian used to smear drift length in cm",    1.0);
  addParam("Mean1",                       m_mean1,       "Mean value of first Gaussian used to smear drift length in cm",  0.0000);
  addParam("Resolution1",                 m_resolution1, "Resolution of first Gaussian used to smear drift length in cm",  0.0130);
  addParam("Mean2",                       m_mean2,       "Mean value of second Gaussian used to smear drift length in cm", 0.0000);
  addParam("Resolution2",                 m_resolution2, "Resolution of second Gaussian used to smear drift length in cm", 0.0000);
 
  //Switch to control smearing
  addParam("DoSmearing", m_doSmearing,
           "If false, drift length will not be smeared.", true);
 
  addParam("TrigTimeJitter", m_trigTimeJitter,
           "Magnitude (w) of trigger timing jitter (ns). The trigger timing is randuminzed uniformly in a time window of [-w/2, +w/2].",
           0.);
  //Switches to control time information handling
  addParam("AddTimeWalk", m_addTimeWalk, "A switch for time-walk (pulse-heght dep. delay); true: on; false: off", true);
  addParam("AddInWirePropagationDelay",   m_addInWirePropagationDelay,
           "A switch used to control adding propagation delay in the wire into the final drift time or not; this is for signal hits.", true);
  addParam("AddInWirePropagationDelay4Bg",  m_addInWirePropagationDelay4Bg,
           "The same switch but for beam bg. hits.", true);
  addParam("AddTimeOfFlight",  m_addTimeOfFlight,
           "A switch used to control adding time of flight into the final drift time or not; this is for signal hits.", true);
  addParam("AddTimeOfFlight4Bg",   m_addTimeOfFlight4Bg,
           "The same switch but for beam bg. hits.", true);
  addParam("OutputNegativeDriftTime", m_outputNegativeDriftTime, "Output hits with negative drift time", true);
  addParam("Output2ndHit", m_output2ndHit,
           "Output the 2nd hit if exists in the time window. Note that it is not well-simulated at all, partly because no cross-talk betw. channels is simulated.",
           false);
  //Switch to control sense wire sag
  addParam("CorrectForWireSag",   m_correctForWireSag,
           "A switch for sense wire sag effect; true: drift-time is calculated with the sag taken into account; false: not. Here, sag means the perturbative part which corresponds to alignment in case of wire-position. The main part (corresponding to design+displacement in wire-position) is taken into account in FullSim; you can control it via CDCJobCntlParModifier.",
           true);
  //Switch for negative-t0 wires
  addParam("TreatNegT0WiresAsGood", m_treatNegT0WiresAsGood, "Treat wires with negative t0 (calibrated) as good wire4s.", true);
 
  //Threshold
  addParam("TDCThreshold4Outer", m_tdcThreshold4Outer,
           "TDC threshold (dE in eV) for Layers#8-56. The value corresponds to He-C2H6 gas", 250.);
  addParam("TDCThreshold4Inner", m_tdcThreshold4Inner,
           "Same as TDCThreshold4Outer but for Layers#0-7,", 150.);
  addParam("EDepInGasMode", m_eDepInGasMode,
           "Mode for extracting energy deposit in gas from energy deposit in gas+wire; =0: scaling using electron density; 1: scaling using most probab. energy deposit; 2: similar to 2 but slightly different; 3: extraction based on probability; 4: regeneration following probability",
           0);
 
  //ADC Threshold
  addParam("ADCThreshold", m_adcThreshold,
           "Threshold for ADC-count (in unit of count). ADC-count < threshold is treated as count=0.", 2);
  addParam("tMin", m_tMin, "Lower edge of time window in ns; valid only for UseDB4FEE=false", -100.);
  addParam("tMaxOuter", m_tMaxOuter, "Upper edge of time window in ns for the normal-cell layers; valid only for UseDB4FEE=false",
           500.);
  addParam("tMaxInner", m_tMaxInner, "Upper edge of time window in ns for the small-cell layers; valid only for UseDB4FEE=false",
           300.);
  // The following doesn't make any sense. The only reasonable steerable would be a switch to decide if the jitter shall be
  // activated. Then there has to be event by event jitter.
  /*  addParam("EventTime",                   m_eventTime,
             "It is a timing of event, which includes a time jitter due to the trigger system, set in ns",     float(0.0));*/
 
  //Switch for database
  addParam("UseDB4FEE", m_useDB4FEE, "Fetch and use FEE params. from database or not", true);
  addParam("UseDB4EDepToADC", m_useDB4EDepToADC, "Uuse edep-to-ADC conversion params. from database or not", true);
  addParam("UseDB4RunGain", m_useDB4RunGain, "Fetch and use run gain from database or not", true);
  addParam("OverallGainFactor", m_overallGainFactor, "Overall gain factor for adjustment", 1.0);
 
  //Switch for synchronization
  addParam("Synchronization", m_synchronization, "Synchronize timing with other sub-detectors", m_synchronization);
  addParam("Randomization", m_randomization, "Randomize timing with other sub-detectors; valid only for Synchronization=false",
           m_randomization);
  addParam("OffsetForGetTriggerBin", m_offsetForTriggerBin, "Input to getCDCTriggerBin(offset), either of 0,1,2 or 3",
           m_offsetForTriggerBin);
  addParam("TrgTimingOffsetInCount", m_trgTimingOffsetInCount,
           "L1 trigger timing offset in count, [0,7] in a trigger bin. The defaut value is from exp14, while the value from exp12 is 2. This run dependence may be taken into account later if needed",
           m_trgTimingOffsetInCount);
  addParam("ShiftOfTimeWindowIn32Count", m_shiftOfTimeWindowIn32Count,
           "Shift of time window in 32count for synchronization (L1 timing=0)", m_shiftOfTimeWindowIn32Count);
 
  //Some FEE params.
  addParam("TDCThresholdOffset", m_tdcThresholdOffset, "Offset for TDC (digital) threshold (mV)", 3828.);
  addParam("AnalogGain",   m_analogGain, "Analog  gain (V/pC)", 1.09);
  addParam("DigitalGain", m_digitalGain, "Digital gain (V/pC)", 7.);
  addParam("ADCBinWidth", m_adcBinWidth, "ADC bin width  (mV)",  2.);
 
  addParam("AddFudgeFactorForSigma", m_addFudgeFactorForSigma,
           "Additional fudge factor for space resol. (common to all cells)",  1.);
  addParam("SpaceChargeEffect", m_spaceChargeEffect, "Switch for space charge effect", true);
  addParam("DegOfSPEOnThreshold", m_degOfSPEOnThreshold,
           "Degree of space charge effect on timing threshold; specify the range [0,1]; =1: full effect on threshold; =0: no effect",
           m_degOfSPEOnThreshold);
 
  addParam("AddXTalk", m_addXTalk, "A switch for crosstalk; true: on; false: off", true);
  addParam("Issue2ndHitWarning", m_issue2ndHitWarning, "=true: issue a warning when a 2nd TDC hit is found.", true);
  addParam("IncludeEarlyXTalks", m_includeEarlyXTalks, "=true: include earlier x-talks as well than the signal hit in question.",
           true);
  addParam("DebugLevel", m_debugLevel, "Debug level; 20-29 are usable.", 20);
  addParam("DebugLevel4XTalk", m_debugLevel4XTalk, "Debug level for crosstalk; 20-29 are usable.", 21);
 
  //Gain smearing
  addParam("GasGainSmearing", m_gasGainSmearing, "Switch for gas gain smearing for ADC simulation; true: on; false: off",
           m_gasGainSmearing);
  addParam("EffWForGasGainSmearing", m_effWForGasGainSmearing,
           "Effective energy (keV) needed for one electron production for gas gain smearing; average for alpha- and beta-sources.",
           m_effWForGasGainSmearing);
  addParam("ThetaOfPolyaFunction", m_thetaOfPolya, "Theta of Polya function for gas gain smearing", m_thetaOfPolya);
  addParam("ExtraADCSmearing", m_extraADCSmearing, "Switch for extra ADC smearing; true: on; false: off", m_extraADCSmearing);
  //  addParam("SigmaForExtraADCSmearing", m_sigmaForExtraADCSmearing, "Gaussian sigma for extra ADC smearing; specify range [0,1]", m_sigmaForExtraADCSmearing);
 
  // Switch for optional relations
  addParam("MatchAllMCParticles", m_matchAllMCParticles, "Switch to store all MCRelations that produced a SimHit", false);
  addParam("MatchFirstMCParticles", m_matchFirstMCParticles,
           "Switch to store all MCRelations for the first three SimHits instead of only the first", false);
 
#if defined(CDC_DEBUG)
  cout << " " << endl;
  cout << "CDCDigitizer constructor" << endl;
#endif
}

Member Function Documentation

◆ addXTalk()

void addXTalk ( )

private

Add crosstalk.

Definition at line 1266 of file CDCDigitizerModule.cc.

{
  map<WireID, XTalkInfo> xTalkMap;
  map<WireID, XTalkInfo> xTalkMap1;
  map<WireID, XTalkInfo>::iterator iterXTalkMap1;
 
  // Loop over all cdc hits to create a xtalk map
  int OriginalNoOfHits = m_cdcHits.getEntries();
  B2DEBUG(m_debugLevel4XTalk, "\n \n" << "#CDCHits " << OriginalNoOfHits);
  for (const auto& aHit : m_cdcHits) {
    if (m_issue2ndHitWarning && aHit.is2ndHit()) {
      B2WARNING("2nd TDC hit found, but not ready for it!");
    }
    WireID wid(aHit.getID());
    //    B2DEBUG(m_debugLevel4XTalk, "Encoded wireid of current CDCHit: " << wid);
    short tdcCount = aHit.getTDCCount();
    short adcCount = aHit.getADCCount();
    short tot      = aHit.getTOT();
    short board    = m_cdcgp->getBoardID(wid);
    short channel  = m_cdcgp->getChannelID(wid);
    const vector<pair<short, asicChannel>> xTalks = (*m_xTalkFromDB)->getLibraryCrossTalk(channel, tdcCount, adcCount, tot);
 
    int nXTalks = xTalks.size();
    for (int i = 0; i < nXTalks; ++i) {
      const unsigned short tdcCount4XTalk = xTalks[i].second.TDC;
      if (i == 0) {
        B2DEBUG(m_debugLevel4XTalk, "\n" << "          signal: " << channel << " " << tdcCount << " " << adcCount << " " << tot);
      }
      B2DEBUG(m_debugLevel4XTalk, "xtalk: " << xTalks[i].first << " " << tdcCount4XTalk << " " << xTalks[i].second.ADC << " " <<
              xTalks[i].second.TOT);
      WireID widx = m_cdcgp->getWireID(board, xTalks[i].first);
      if (!m_cdcgp->isBadWire(widx)) { // for non-bad wire
        if (m_includeEarlyXTalks || (xTalks[i].second.TDC <= tdcCount)) {
          const double t0 = getPositiveT0(widx);
          const double ULOfTDC = (t0 - m_lowEdgeOfTimeWindow[board]) * m_tdcBinWidthInv;
          const double LLOfTDC = (t0 - m_uprEdgeOfTimeWindow[board]) * m_tdcBinWidthInv;
          if (LLOfTDC <= tdcCount4XTalk && tdcCount4XTalk <= ULOfTDC) {
            const unsigned short status = 0;
            xTalkMap.insert(make_pair(widx, XTalkInfo(tdcCount4XTalk, xTalks[i].second.ADC, xTalks[i].second.TOT, status)));
          }
        }
        //  } else {
        //    cout<<"badwire= " << widx.getICLayer() <<" "<< widx.getIWire() << endl;
      }
    } //end of xtalk loop
  } //end of cdc hit loop
 
  //Loop over all xtalk hits to creat a new xtalk map with only the fastest hits kept (approx.)
  B2DEBUG(m_debugLevel4XTalk, "#xtalk  hits: " << xTalkMap.size());
  for (const auto& aHit : xTalkMap) {
    WireID wid = aHit.first;
 
    iterXTalkMap1 = xTalkMap1.find(wid);
    unsigned short tdcCount = aHit.second.m_tdc;
    unsigned short adcCount = aHit.second.m_adc;
    unsigned short tot      = aHit.second.m_tot;
    unsigned short status   = aHit.second.m_status;
 
    if (iterXTalkMap1 == xTalkMap1.end()) { // new entry
      xTalkMap1.insert(make_pair(wid, XTalkInfo(tdcCount, adcCount, tot, status)));
      //      B2DEBUG(m_debugLevel4XTalk, "Creating a new xtalk hit with encoded wire no.: " << wid);
    } else { // not new; check if fastest
      if (tdcCount < iterXTalkMap1->second.m_tdc) {
        iterXTalkMap1->second.m_tdc = tdcCount;
        B2DEBUG(m_debugLevel4XTalk, "TDC-count of current xtalk: " << tdcCount);
      }
      iterXTalkMap1->second.m_adc += adcCount;
      iterXTalkMap1->second.m_tot += tot; // approx.
    }
  } // end of xtalk loop
 
  //add xtalk in the same way as the beam bg. overlay
  B2DEBUG(m_debugLevel4XTalk, "#xtalk1 hits: " << xTalkMap1.size());
  for (const auto& aX : xTalkMap1) {
    bool append = true;
    const unsigned short tdc4Bg = aX.second.m_tdc;
    const unsigned short adc4Bg = aX.second.m_adc;
    const unsigned short tot4Bg = aX.second.m_tot;
    const unsigned short status4Bg = aX.second.m_status;
 
    for (int iHit = 0; iHit < OriginalNoOfHits; ++iHit) {
      CDCHit& aH = *(m_cdcHits[iHit]);
      if (aH.getID() != aX.first.getEWire()) { //wire id unmatched
        continue;
      } else { //wire id matched
        append = false;
        const unsigned short tdc4Sg = aH.getTDCCount();
        const unsigned short adc4Sg = aH.getADCCount();
        const unsigned short tot4Sg = aH.getTOT();
        //  B2DEBUG(m_debuglevel4XTalk, "Sg tdc,adc,tot= " << tdc4Sg << " " << adc4Sg << " " << tot4Sg);
        //  B2DEBUG(m_debugLevel4XTalk, "Bg tdc,adc,tot= " << tdc4Bg << " " << adc4Bg << " " << tot4Bg);
 
        // If the BG hit is faster than the true hit, the TDC count is replaced, and
        // the relations are removed. ADC counts are summed up.
        if (tdc4Sg < tdc4Bg) {
          aH.setTDCCount(tdc4Bg);
          aH.setStatus(status4Bg);
          auto relSimHits = aH.getRelationsFrom<CDCSimHit>();
          for (int i = relSimHits.size() - 1; i >= 0; --i) {
            relSimHits.remove(i);
          }
          auto relMCParticles = aH.getRelationsFrom<MCParticle>();
          for (int i = relMCParticles.size() - 1; i >= 0; --i) {
            relMCParticles.remove(i);
          }
        }
 
        aH.setADCCount(adc4Sg + adc4Bg);
 
        //Set TOT for signal+background case. It is assumed that the start timing
        //of a pulse (input to ADC) is given by the TDC-count. This is an
        //approximation becasue analog (for ADC) and digital (for TDC) parts are
        //different in the front-end electronics.
        unsigned short s1 = tdc4Sg; //start time of 1st pulse
        unsigned short s2 = tdc4Bg; //start time of 2nd pulse
        unsigned short w1 = tot4Sg; //its width
        unsigned short w2 = tot4Bg; //its width
        if (tdc4Sg < tdc4Bg) {
          s1 = tdc4Bg;
          w1 = tot4Bg;
          s2 = tdc4Sg;
          w2 = tot4Sg;
        }
        w1 *= 32;
        w2 *= 32;
        const unsigned short e1 = s1 - w1; //end time of 1st pulse
        const unsigned short e2 = s2 - w2; //end time of 2nd pulse
        //  B2DEBUG(m_debuglevel4Xtalk, "s1,e1,w1,s2,e2,w2= " << s1 << " " << e1 << " " << w1 << " " << s2 << " " << e2 << " " << w2);
 
        double pulseW = w1 + w2;
        if (e1 <= e2) {
          pulseW = w1;
        } else if (e1 <= s2) {
          pulseW = s1 - e2;
        }
 
        unsigned short board = m_cdcgp->getBoardID(aX.first);
        aH.setTOT(std::min(std::round(pulseW / 32.), static_cast<double>(m_widthOfTimeWindowInCount[board])));
        B2DEBUG(m_debugLevel4XTalk, "replaced tdc,adc,tot,wid,status= " << aH.getTDCCount() << " " << aH.getADCCount() << " " << aH.getTOT()
                <<
                " " << aH.getID() << " " << aH.getStatus());
        break;
      }
    } //end of cdc hit loop
 
    if (append) {
      m_cdcHits.appendNew(tdc4Bg, adc4Bg, aX.first, status4Bg, tot4Bg);
      B2DEBUG(m_debugLevel4XTalk, "appended tdc,adc,tot,wid,status= " << tdc4Bg << " " << adc4Bg << " " << tot4Bg << " " << aX.first <<
              " " <<
              status4Bg);
    }
  } //end of x-talk loop
  B2DEBUG(m_debugLevel4XTalk, "original #hits, #hits= " << OriginalNoOfHits << " " << m_cdcHits.getEntries());
}

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

147{};

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns: True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

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

◆ event()

void event ( void )

overridevirtual

Actual digitization of all hits in the CDC.

The digitized hits are written into the DataStore.

Reimplemented from Module.

Definition at line 319 of file CDCDigitizerModule.cc.

{
  // Get SimHit array, MCParticle array, and relation between the two.
  RelationArray mcParticlesToCDCSimHits(m_mcParticles, m_simHits);  //RelationArray created by CDC SensitiveDetector
 
 
  //--- Start Digitization --------------------------------------------------------------------------------------------
  // Merge the hits in the same cell and save them into CDC signal map.
 
  // Define signal map
  map<WireID, SignalInfo> signalMap;
  map<WireID, SignalInfo>::iterator iterSignalMap;
  // Define adc map
  map<WireID, unsigned short> adcMap;
  map<WireID, unsigned short>::iterator iterADCMap;
  //  map<WireID, double> adcMap;
  //  map<WireID, double>::iterator iterADCMap;
 
  // signal map for trigger
  map<pair<WireID, unsigned>, SignalInfo> signalMapTrg;
  map<pair<WireID, unsigned>, SignalInfo>::iterator iterSignalMapTrg;
 
  // signal map for all MCParticles: Wire <-> MCArrayIndex
  map<WireID, std::set<int>> particleMap;
  map<WireID, std::set<int>>::iterator iterParticleMap;
 
 
  // Set time window per event
  if (m_tSimMode == 0 || m_tSimMode == 1) {
    int trigBin = 0;
    if (m_simClockState.isValid()) {
      trigBin = m_simClockState->getCDCTriggerBin(m_offsetForTriggerBin);
    } else {
      if (m_tSimMode == 0) {
        B2DEBUG(m_debugLevel, "SimClockState unavailable so switched the mode from synchro to random.");
        m_tSimMode = 1;
      }
      trigBin = gRandom->Integer(4);
    }
    if (trigBin < 0 || trigBin > 3) B2ERROR("Invalid trigger bin; must be an integer [0,3]!");
    unsigned short offs = 8 * trigBin + m_trgTimingOffsetInCount;
    B2DEBUG(m_debugLevel, "tSimMode,trigBin,offs= " << m_tSimMode << " " << trigBin << " " << offs);
 
    //TODO: simplify the following 7 lines and setFEElectronics()
    for (unsigned short bd = 1; bd < c_nBoards; ++bd) {
      const short tMaxInCount = 32 * (m_shiftOfTimeWindowIn32Count - m_trgDelayInCount[bd]) - offs;
      const short tMinInCount = tMaxInCount - 32 * m_widthOfTimeWindowInCount[bd];
      B2DEBUG(m_debugLevel, bd << " " << tMinInCount << " " << tMaxInCount);
      m_uprEdgeOfTimeWindow[bd] = m_tdcBinWidth * tMaxInCount;
      m_lowEdgeOfTimeWindow[bd] = m_tdcBinWidth * tMinInCount;
    }
  }
 
  // Set trigger timing jitter for this event
  double trigTiming = m_trigTimeJitter == 0. ? 0. : m_trigTimeJitter * (gRandom->Uniform() - 0.5);
  //  std::cout << "trigTiming= " << trigTiming << std::endl;
  // Loop over all hits
  int nHits = m_simHits.getEntries();
  B2DEBUG(m_debugLevel, "Number of CDCSimHits in the current event: " << nHits);
  for (int iHits = 0; iHits < nHits; ++iHits) {
    // Get a hit
    m_aCDCSimHit = m_simHits[iHits];
 
    // Hit geom. info
    m_wireID = m_aCDCSimHit->getWireID();
    if (m_wireID.getISuperLayer() < m_cdcgp->getOffsetOfFirstSuperLayer()) {
      B2FATAL("SimHit with wireID " << m_wireID << " is in CDC SuperLayer: " << m_wireID.getISuperLayer() << " which should not happen.");
    }
    //    B2DEBUG(29, "Encoded wire number of current CDCSimHit: " << m_wireID);
 
    m_posFlag    = m_aCDCSimHit->getLeftRightPassageRaw();
    m_boardID    = m_cdcgp->getBoardID(m_wireID);
    //    B2DEBUG(29, "m_boardID= " << m_boardID);
    m_posWire    = m_aCDCSimHit->getPosWire();
    m_posTrack   = m_aCDCSimHit->getPosTrack();
    m_momentum   = m_aCDCSimHit->getMomentum();
    m_flightTime = m_aCDCSimHit->getFlightTime();
    m_globalTime = m_aCDCSimHit->getGlobalTime();
    m_driftLength = m_aCDCSimHit->getDriftLength() * Unit::cm;
 
    //include alignment effects
    //basically align flag should be always on since on/off is controlled by the input alignment.xml file itself.
    m_align = true;
 
    B2Vector3D bwpAlign = m_cdcgp->wireBackwardPosition(m_wireID, CDCGeometryPar::c_Aligned);
    B2Vector3D fwpAlign = m_cdcgp->wireForwardPosition(m_wireID, CDCGeometryPar::c_Aligned);
 
    B2Vector3D bwp = m_cdcgp->wireBackwardPosition(m_wireID);
    B2Vector3D fwp = m_cdcgp->wireForwardPosition(m_wireID);
 
    //skip correction for wire-position alignment if unnecessary
    if ((bwpAlign - bwp).Mag() == 0. && (fwpAlign - fwp).Mag() == 0.) m_align = false;
    //    std::cout << "a m_align= " << m_align << std::endl;
 
    if (m_align || m_correctForWireSag) {
 
      bwp = bwpAlign;
      fwp = fwpAlign;
 
      if (m_correctForWireSag) {
        double zpos = m_posWire.Z();
        double bckYSag = bwp.Y();
        double forYSag = fwp.Y();
 
        //        CDCGeometryPar::EWirePosition set = m_align ?
        //                                            CDCGeometryPar::c_Aligned : CDCGeometryPar::c_Base;
        CDCGeometryPar::EWirePosition set = CDCGeometryPar::c_Aligned;
        const int layerID = m_wireID.getICLayer();
        const int  wireID = m_wireID.getIWire();
        m_cdcgp->getWireSagEffect(set, layerID, wireID, zpos, bckYSag, forYSag);
        bwp.SetY(bckYSag);
        fwp.SetY(forYSag);
      }
 
      const B2Vector3D L = 5. * m_momentum.Unit(); //(cm) tentative
      B2Vector3D posIn  = m_posTrack - L;
      B2Vector3D posOut = m_posTrack + L;
      B2Vector3D posTrack = m_posTrack;
      B2Vector3D posWire = m_posWire;
 
      //      m_driftLength = m_cdcgp->ClosestApproach(bwp, fwp, posIn, posOut, posTrack, posWire);
      m_driftLength = ClosestApproach(bwp, fwp, posIn, posOut, posTrack, posWire);
      //      std::cout << "base-dl, sag-dl, diff= " << m_aCDCSimHit->getDriftLength() <<" "<< m_driftLength <<" "<< m_driftLength - m_aCDCSimHit->getDriftLength() << std::endl;
      m_posTrack = posTrack;
      m_posWire  = posWire;
 
      double deltaTime = 0.; //tentative (probably ok...)
      //      double deltaTime = (posTrack - m_posTrack).Mag() / speed;
      m_flightTime += deltaTime;
      m_globalTime += deltaTime;
      m_posFlag = m_cdcgp->getNewLeftRightRaw(m_posWire, m_posTrack, m_momentum);
    }
 
    // Calculate measurement time.
    // Smear drift length
    double hitDriftLength = m_driftLength;
    double dDdt = getdDdt(hitDriftLength);
    if (m_doSmearing) {
      hitDriftLength = smearDriftLength(hitDriftLength, dDdt);
    }
 
    //set flags
    bool addTof   = m_addTimeOfFlight4Bg;
    bool addDelay = m_addInWirePropagationDelay4Bg;
    if (m_aCDCSimHit->getBackgroundTag() == 0) {
      addTof   = m_addTimeOfFlight;
      addDelay = m_addInWirePropagationDelay;
    }
    double hitDriftTime = getDriftTime(hitDriftLength, addTof, addDelay);
 
    //add randamized event time for a beam bg. hit
    if (m_aCDCSimHit->getBackgroundTag() != 0) {
      hitDriftTime += m_globalTime - m_flightTime;
    }
 
    //add trigger timing jitter
    hitDriftTime += trigTiming;
 
    //apply time window cut
    double tMin = m_tMin;
    double tMax = m_tMaxOuter;
    if (m_wireID.getISuperLayer() == 0) tMax = m_tMaxInner;
    if (m_tSimMode <= 2) {
      tMin = m_lowEdgeOfTimeWindow[m_boardID];
      tMax = m_uprEdgeOfTimeWindow[m_boardID];
    }
    if (hitDriftTime < tMin || hitDriftTime > tMax) continue;
 
    //Sum ADC count
    const double stepLength  = m_aCDCSimHit->getStepLength() * Unit::cm;
    const double costh = m_momentum.Z() / m_momentum.Mag();
    double hitdE = m_aCDCSimHit->getEnergyDep();
    if (m_cdcgp->getMaterialDefinitionMode() != 2) {  // for non wire-by-wire mode
      static EDepInGas& edpg = EDepInGas::getInstance();
      hitdE = edpg.getEDepInGas(m_eDepInGasMode, m_aCDCSimHit->getPDGCode(), m_momentum.Mag(), stepLength, hitdE);
    }
 
    double convFactorForThreshold = 1;
    //TODO: modify the following function so that it can output timing signal in Volt in future
    unsigned short adcCount = 0;
    makeSignalsAfterShapers(m_wireID, hitdE, stepLength, costh, adcCount, convFactorForThreshold);
    const unsigned short adcTh = m_useDB4FEE ? m_adcThresh[m_boardID] : m_adcThreshold;
    //    B2DEBUG(29, "adcTh,adcCount,convFactorForThreshold= " << adcTh <<" "<< adcCount <<" "<< convFactorForThreshold);
    if (adcCount < adcTh) adcCount = 0;
    iterADCMap = adcMap.find(m_wireID);
    if (iterADCMap == adcMap.end()) {
      adcMap.insert(make_pair(m_wireID, adcCount));
      //      adcMap.insert(make_pair(m_wireID, hitdE));
    } else {
      iterADCMap->second += adcCount;
      //      iterADCMap->second += hitdE;
    }
 
    //Apply energy threshold
    // If hitdE < dEThreshold, the hit is ignored
    double dEThreshold = 0.;
    if (m_useDB4FEE && m_useDB4EDepToADC) {
      dEThreshold = m_tdcThresh[m_boardID] / convFactorForThreshold * Unit::keV;
    } else {
      dEThreshold = (m_wireID.getISuperLayer() == 0) ? m_tdcThreshold4Inner : m_tdcThreshold4Outer;
      dEThreshold *= Unit::eV;
    }
    dEThreshold *= (*m_corrToThresholdFromDB)->getParam(m_wireID.getICLayer());
    B2DEBUG(m_debugLevel, "hitdE,dEThreshold,driftLength " << hitdE << " " << dEThreshold << " " << hitDriftLength);
 
    if (hitdE < dEThreshold) {
      B2DEBUG(m_debugLevel, "Below Ethreshold: " << hitdE << " " << dEThreshold);
      continue;
    }
 
    // add one hit per trigger time window to the trigger signal map
    unsigned short trigWindow = floor((hitDriftTime - tMin) * m_tdcBinWidthInv / 32);
    iterSignalMapTrg = signalMapTrg.find(make_pair(m_wireID, trigWindow));
    if (iterSignalMapTrg == signalMapTrg.end()) {
      //      signalMapTrg.insert(make_pair(make_pair(m_wireID, trigWindow),
      //                                    SignalInfo(iHits, hitDriftTime, hitdE)));
      signalMapTrg.insert(make_pair(make_pair(m_wireID, trigWindow),
                                    SignalInfo(iHits, hitDriftTime, adcCount)));
    } else {
      if (hitDriftTime < iterSignalMapTrg->second.m_driftTime) {
        iterSignalMapTrg->second.m_driftTime = hitDriftTime;
        iterSignalMapTrg->second.m_simHitIndex = iHits;
      }
      //      iterSignalMapTrg->second.m_charge += hitdE;
      iterSignalMapTrg->second.m_charge += adcCount;
    }
 
    // Reject totally-dead wire; to be replaced by isDeadWire() in future
    // N.B. The following lines for badwire must be after the above lines for trigger becuse badwires are different between trigger and tracking.
    // Badwires for trigger are taken into account separately in the tsim module
    if (m_cdcgp->isBadWire(m_wireID)) {
      //      std::cout<<"badwire= " << m_wireID.getICLayer() <<" "<< m_wireID.getIWire() << std::endl;
      continue;
    }
    // Reject partly-dead wire as well
    double eff = 1.;
    if (m_cdcgp->isDeadWire(m_wireID, eff)) {
      //      std::cout << "wid,eff= " << m_wireID << " " << eff << std::endl;
      if (eff < gRandom->Uniform()) continue;
    }
 
    // For TOT simulation, calculate drift length from In to the wire, and Out to the wire. The calculation is apprximate ignoring wire sag (this would be ok because TOT simulation is not required to be so accurate).
    const double a = bwpAlign.X();
    const double b = bwpAlign.Y();
    const double c = bwpAlign.Z();
    const B2Vector3D fmbAlign = fwpAlign - bwpAlign;
    const double lmn = 1. / fmbAlign.Mag();
    const double l = fmbAlign.X() * lmn;
    const double m = fmbAlign.Y() * lmn;
    const double n = fmbAlign.Z() * lmn;
 
    double dx = m_aCDCSimHit->getPosIn().X() - a;
    double dy = m_aCDCSimHit->getPosIn().Y() - b;
    double dz = m_aCDCSimHit->getPosIn().Z() - c;
    double sub = l * dx + m * dy + n * dz;
    const double driftLFromIn = sqrt(dx * dx + dy * dy + dz * dz - sub * sub);
 
    dx = m_aCDCSimHit->getPosOut().X() - a;
    dy = m_aCDCSimHit->getPosOut().Y() - b;
    dz = m_aCDCSimHit->getPosOut().Z() - c;
    sub = l * dx + m * dy + n * dz;
    const double driftLFromOut = sqrt(dx * dx + dy * dy + dz * dz - sub * sub);
 
    const double maxDriftL = std::max(driftLFromIn, driftLFromOut);
    const double minDriftL = m_driftLength;
    B2DEBUG(m_debugLevel, "driftLFromIn= " << driftLFromIn << " driftLFromOut= " << driftLFromOut << " minDriftL= " << minDriftL <<
            " maxDriftL= "
            <<
            maxDriftL << "m_driftLength= " << m_driftLength);
 
    iterSignalMap = signalMap.find(m_wireID);
 
    if (m_matchAllMCParticles) {
      iterParticleMap = particleMap.find(m_wireID);
      RelationVector<MCParticle> rels = m_aCDCSimHit->getRelationsFrom<MCParticle>();
 
      int mcIndex = -1;
      if (rels.size() != 0) {
        if (rels.weight(0) > 0) {
          const MCParticle* mcparticle = rels[0];
          mcIndex = int(mcparticle->getIndex());
        }
      }
 
      if (mcIndex >= 0) {
        if (iterParticleMap == particleMap.end()) {
          std::set<int> vecmc = {mcIndex};
          particleMap.insert(make_pair(m_wireID, vecmc));
        } else {
          iterParticleMap->second.insert(mcIndex);
        }
      }
    }
 
    if (iterSignalMap == signalMap.end()) {
      // new entry
      //      signalMap.insert(make_pair(m_wireID, SignalInfo(iHits, hitDriftTime, hitdE)));
      signalMap.insert(make_pair(m_wireID, SignalInfo(iHits, hitDriftTime, adcCount, maxDriftL, minDriftL)));
      B2DEBUG(m_debugLevel, "Creating new Signal with encoded wire number: " << m_wireID);
    } else {
      // ... smallest drift time has to be checked, ...
      if (hitDriftTime < iterSignalMap->second.m_driftTime) {
        iterSignalMap->second.m_driftTime3 = iterSignalMap->second.m_driftTime2;
        iterSignalMap->second.m_simHitIndex3 = iterSignalMap->second.m_simHitIndex2;
        iterSignalMap->second.m_driftTime2 = iterSignalMap->second.m_driftTime;
        iterSignalMap->second.m_simHitIndex2 = iterSignalMap->second.m_simHitIndex;
        iterSignalMap->second.m_driftTime   = hitDriftTime;
        iterSignalMap->second.m_simHitIndex = iHits;
        B2DEBUG(m_debugLevel, "hitDriftTime of current Signal: " << hitDriftTime << ",  hitDriftLength: " << hitDriftLength);
      } else if (hitDriftTime < iterSignalMap->second.m_driftTime2) {
        iterSignalMap->second.m_driftTime3 = iterSignalMap->second.m_driftTime2;
        iterSignalMap->second.m_simHitIndex3 = iterSignalMap->second.m_simHitIndex2;
        iterSignalMap->second.m_driftTime2   = hitDriftTime;
        iterSignalMap->second.m_simHitIndex2 = iHits;
      } else if (hitDriftTime < iterSignalMap->second.m_driftTime3) {
        iterSignalMap->second.m_driftTime3   = hitDriftTime;
        iterSignalMap->second.m_simHitIndex3 = iHits;
      }
      // ... total charge has to be updated.
      //      iterSignalMap->second.m_charge += hitdE;
      iterSignalMap->second.m_charge += adcCount;
 
      // set max and min driftLs
      if (iterSignalMap->second.m_maxDriftL < maxDriftL) iterSignalMap->second.m_maxDriftL = maxDriftL;
      if (iterSignalMap->second.m_minDriftL > minDriftL) iterSignalMap->second.m_minDriftL = minDriftL;
      B2DEBUG(m_debugLevel, "maxDriftL in struct= " << iterSignalMap->second.m_maxDriftL << "minDriftL in struct= " <<
              iterSignalMap->second.m_minDriftL);
    }
 
  } // end loop over SimHits.
 
  //--- Now Store the results into CDCHits and
  // create corresponding relations between SimHits and CDCHits.
 
  unsigned int iCDCHits = 0;
  RelationArray cdcSimHitsToCDCHits(m_simHits, m_cdcHits); //SimHit<->CDCHit
  RelationArray mcParticlesToCDCHits(m_mcParticles, m_cdcHits); //MCParticle<->CDCHit
 
  for (iterSignalMap = signalMap.begin(); iterSignalMap != signalMap.end(); ++iterSignalMap) {
 
    //add time-walk (here for simplicity)
    //    unsigned short adcCount = getADCCount(iterSignalMap->second.m_charge);
    //    unsigned short adcCount = iterSignalMap->second.m_charge;
    iterADCMap = adcMap.find(iterSignalMap->first);
    unsigned short adcCount = iterADCMap != adcMap.end() ? iterADCMap->second : 0;
    /*
    unsigned short adcCount = 0;
    if (iterADCMap != adcMap.end()) {
      adcCount = getADCCount(iterSignalMap->first, iterADCMap->second, 1., 0.);
      unsigned short boardID = m_cdcgp->getBoardID(iterSignalMap->first);
      //      B2DEBUG(29, "boardID= " << boardID);
      const unsigned short adcTh = m_useDB4FEE ? m_adcThresh[boardID] : m_adcThreshold;
      if (adcCount < adcTh) adcCount = 0;
    }
    */
 
    if (m_addTimeWalk) {
      B2DEBUG(m_debugLevel, "timewalk= " << m_cdcgp->getTimeWalk(iterSignalMap->first, adcCount));
      iterSignalMap->second.m_driftTime += m_cdcgp->getTimeWalk(iterSignalMap->first, adcCount);
    }
 
    //remove negative drift time (TDC) upon request
    if (!m_outputNegativeDriftTime &&
        iterSignalMap->second.m_driftTime < 0.) {
      continue;
    }
 
    //N.B. No bias (+ or -0.5 count) is introduced on average in digitization by the real TDC (info. from KEK electronics division). So round off (t0 - drifttime) below.
    unsigned short tdcCount = static_cast<unsigned short>((getPositiveT0(iterSignalMap->first) - iterSignalMap->second.m_driftTime) *
                                                          m_tdcBinWidthInv + 0.5);
 
    //calculate tot; hard-coded currently
    double deltaDL = iterSignalMap->second.m_maxDriftL - iterSignalMap->second.m_minDriftL;
    if (deltaDL < 0.) {
      B2DEBUG(m_debugLevel, "negative deltaDL= " << deltaDL);
      deltaDL = 0.;
    }
    const unsigned short boardID = m_cdcgp->getBoardID(iterSignalMap->first);
    unsigned short tot = std::min(std::round(5.92749 * deltaDL + 2.59706), static_cast<double>(m_widthOfTimeWindowInCount[boardID]));
    if (m_adcThresh[boardID] > 0) {
      tot = std::min(static_cast<int>(tot), static_cast<int>(adcCount / m_adcThresh[boardID]));
    }
 
    CDCHit* firstHit = m_cdcHits.appendNew(tdcCount, adcCount, iterSignalMap->first, 0, tot);
    //    std::cout <<"firsthit?= " << firstHit->is2ndHit() << std::endl;
    //set a relation: CDCSimHit -> CDCHit
    cdcSimHitsToCDCHits.add(iterSignalMap->second.m_simHitIndex, iCDCHits);
 
    //set a relation: MCParticle -> CDCHit
    RelationVector<MCParticle> rels = m_simHits[iterSignalMap->second.m_simHitIndex]->getRelationsFrom<MCParticle>();
    if (rels.size() != 0) {
      //assumption: only one MCParticle
      const MCParticle* mcparticle = rels[0];
      double weight = rels.weight(0);
      mcparticle->addRelationTo(firstHit, weight);
    }
 
    // Set relations to all particles that created a SimHit
    if (m_matchAllMCParticles) {
      iterParticleMap = particleMap.find(iterSignalMap->first);
      if (iterParticleMap != particleMap.end()) {
        std::set<int> vv = iterParticleMap->second;
        for (std::set<int>::iterator it = vv.begin(); it != vv.end(); ++it) {
          // set all relations
          int idx = *it;
          MCParticle* part = m_mcParticles[idx - 1];
          part->addRelationTo(firstHit, 1.0, m_OptionalAllMCParticlesToHitsName);
        }
      }
    }
 
    //set all relations to first hit if requested but dont create additional hits!
    // relation 1
    if (m_matchFirstMCParticles > 0) {
      if (iterSignalMap->second.m_simHitIndex >= 0) {
        RelationVector<MCParticle> rels1 = m_simHits[iterSignalMap->second.m_simHitIndex]->getRelationsFrom<MCParticle>();
        if (rels1.size() != 0) {
          //assumption: only one MCParticle
          const MCParticle* mcparticle = rels1[0];
          double weight = rels1.weight(0);
          mcparticle->addRelationTo(firstHit, weight, m_OptionalFirstMCParticlesToHitsName);
        }
      }
 
      // relation 2
      if (iterSignalMap->second.m_simHitIndex2 >= 0) {
        RelationVector<MCParticle> rels2 = m_simHits[iterSignalMap->second.m_simHitIndex2]->getRelationsFrom<MCParticle>();
        if (rels2.size() != 0) {
          //assumption: only one MCParticle
          const MCParticle* mcparticle = rels2[0];
          double weight = rels2.weight(0);
          mcparticle->addRelationTo(firstHit, weight, m_OptionalFirstMCParticlesToHitsName);
        }
      }
 
      // relation 3
      if (iterSignalMap->second.m_simHitIndex3 >= 0) {
        RelationVector<MCParticle> rels3 = m_simHits[iterSignalMap->second.m_simHitIndex3]->getRelationsFrom<MCParticle>();
        if (rels3.size() != 0) {
          //assumption: only one MCParticle
          const MCParticle* mcparticle = rels3[0];
          double weight = rels3.weight(0);
          mcparticle->addRelationTo(firstHit, weight, m_OptionalFirstMCParticlesToHitsName);
        }
      }
 
 
    }
 
    //Set 2nd-hit related things if it exists
    if (m_output2ndHit && iterSignalMap->second.m_simHitIndex2 >= 0) {
      unsigned short tdcCount2 = static_cast<unsigned short>((getPositiveT0(iterSignalMap->first) - iterSignalMap->second.m_driftTime2) *
                                                             m_tdcBinWidthInv + 0.5);
      if (tdcCount2 != tdcCount) {
        CDCHit* secondHit = m_cdcHits.appendNew(tdcCount2, adcCount, iterSignalMap->first, 0, tot);
        secondHit->set2ndHitFlag();
        secondHit->setOtherHitIndices(firstHit);
        //  std::cout <<"2ndhit?= " << secondHit->is2ndHit() << std::endl;
        //  std::cout <<"1st-otherhitindex= " << firstHit->getOtherHitIndex() << std::endl;
        //  std::cout <<"2nd-otherhitindex= " << secondHit->getOtherHitIndex() << std::endl;
        //  secondHit->setOtherHitIndex(firstHit->getArrayIndex());
        //  firstHit->setOtherHitIndex(secondHit->getArrayIndex());
        //  std::cout <<"1st-otherhitindex= " << firstHit->getOtherHitIndex() << std::endl;
        //  std::cout <<"2nd-otherhitindex= " << secondHit->getOtherHitIndex() << std::endl;
 
        //set a relation: CDCSimHit -> CDCHit
        ++iCDCHits;
        cdcSimHitsToCDCHits.add(iterSignalMap->second.m_simHitIndex2, iCDCHits);
        //        std::cout << "settdc2 " << firstHit->getTDCCount() << " " << secondHit->getTDCCount() << std::endl;
 
        //set a relation: MCParticle -> CDCHit
        rels = m_simHits[iterSignalMap->second.m_simHitIndex2]->getRelationsFrom<MCParticle>();
        if (rels.size() != 0) {
          //assumption: only one MCParticle
          const MCParticle* mcparticle = rels[0];
          double weight = rels.weight(0);
          mcparticle->addRelationTo(secondHit, weight);
        }
      } else { //Check the 3rd hit when tdcCount = tdcCount2
        //        std::cout << "tdcCount1=2" << std::endl;
        if (iterSignalMap->second.m_simHitIndex3 >= 0) {
          unsigned short tdcCount3 = static_cast<unsigned short>((getPositiveT0(iterSignalMap->first) - iterSignalMap->second.m_driftTime3) *
                                                                 m_tdcBinWidthInv + 0.5);
          //          std::cout << "tdcCount3= " << tdcCount3 << " " << tdcCount << std::endl;
          if (tdcCount3 != tdcCount) {
            CDCHit* secondHit = m_cdcHits.appendNew(tdcCount3, adcCount, iterSignalMap->first, 0, tot);
            secondHit->set2ndHitFlag();
            secondHit->setOtherHitIndices(firstHit);
            //      secondHit->setOtherHitIndex(firstHit->getArrayIndex());
            //      firstHit->setOtherHitIndex(secondHit->getArrayIndex());
            //      std::cout <<"2ndhit?= " << secondHit->is2ndHit() << std::endl;
 
            //set a relation: CDCSimHit -> CDCHit
            ++iCDCHits;
            cdcSimHitsToCDCHits.add(iterSignalMap->second.m_simHitIndex3, iCDCHits);
            //            std::cout << "settdc3 " << firstHit->getTDCCount() << " " << secondHit->getTDCCount() << std::endl;
 
            //set a relation: MCParticle -> CDCHit
            rels = m_simHits[iterSignalMap->second.m_simHitIndex3]->getRelationsFrom<MCParticle>();
            if (rels.size() != 0) {
              //assumption: only one MCParticle
              const MCParticle* mcparticle = rels[0];
              double weight = rels.weight(0);
              mcparticle->addRelationTo(secondHit, weight);
            }
          }
        }
      } //end of checking tdcCount 1=2 ?
    } //end of 2nd hit setting
 
    //    std::cout <<"t0= " << m_cdcgp->getT0(iterSignalMap->first) << std::endl;
    /*    unsigned short tdcInCommonStop = static_cast<unsigned short>((m_tdcOffset - iterSignalMap->second.m_driftTime) * m_tdcBinWidthInv);
    float driftTimeFromTDC = static_cast<float>(m_tdcOffset - (tdcInCommonStop + 0.5)) * m_tdcBinWidth;
    std::cout <<"driftT bf digitization, TDC in common stop, digitized driftT = " << iterSignalMap->second.m_driftTime <<" "<< tdcInCommonStop <<" "<< driftTimeFromTDC << std::endl;
    */
    ++iCDCHits;
  }
 
  //Add crosstalk
  if (m_addXTalk) addXTalk();
 
  // Store the results with trigger time window in a separate array
  // with corresponding relations.
  for (iterSignalMapTrg = signalMapTrg.begin(); iterSignalMapTrg != signalMapTrg.end(); ++iterSignalMapTrg) {
    /*
    unsigned short adcCount = getADCCount(iterSignalMapTrg->first.first, iterSignalMapTrg->second.m_charge, 1., 0.);
    unsigned short boardID = m_cdcgp->getBoardID(iterSignalMapTrg->first.first);
    //    B2DEBUG(29, "boardID= " << boardID);
    const unsigned short adcTh = m_useDB4FEE ? m_adcThresh[boardID] : m_adcThreshold;
    if (adcCount < adcTh) adcCount = 0;
    */
    //    unsigned short adcCount = getADCCount(iterSignalMapTrg->second.m_charge);
    unsigned short adcCount = iterSignalMapTrg->second.m_charge;
    unsigned short tdcCount =
      static_cast<unsigned short>((getPositiveT0(iterSignalMapTrg->first.first) -
                                   iterSignalMapTrg->second.m_driftTime) * m_tdcBinWidthInv + 0.5);
    const CDCHit* cdcHit = m_cdcHits4Trg.appendNew(tdcCount, adcCount, iterSignalMapTrg->first.first);
 
    // relations
    m_simHits[iterSignalMapTrg->second.m_simHitIndex]->addRelationTo(cdcHit);
    RelationVector<MCParticle> rels = m_simHits[iterSignalMapTrg->second.m_simHitIndex]->getRelationsFrom<MCParticle>();
    if (rels.size() != 0) {
      //assumption: only one MCParticle
      const MCParticle* mcparticle = rels[0];
      double weight = rels.weight(0);
      mcparticle->addRelationTo(cdcHit, weight);
    }
  }
 
  /*
  std::cout << " " << std::endl;
  RelationIndex<MCParticle, CDCHit> mcp_to_hit(mcParticles, cdcHits);
  if (!mcp_to_hit) B2FATAL("No MCParticle -> CDCHit relation founf!");
  typedef RelationIndex<MCParticle, CDCHit>::Element RelationElement;
  int ncdcHits = cdcHits.getEntries();
  for (int j = 0; j < ncdcHits; ++j) {
    for (const RelationElement& rel : mcp_to_hit.getElementsTo(cdcHits[j])) {
      std::cout << j << " " << cdcHits[j]->is2ndHit() <<" "<< rel.from->getIndex() << " " << rel.weight << std::endl;
    }
  }
  */
}

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

◆ getdDdt()

double getdDdt ( double driftLength )

private

The method to get dD/dt.

In this method, X-T function will be used to calculate dD/dt (drift velocity).

Parameters

driftLength The value of drift length.

Returns: dDdt.

Definition at line 927 of file CDCDigitizerModule.cc.

{
  //---------------------------------------------------------------------------------
  // Calculates the 1'st derivative: dD/dt, where D: drift length before smearing; t: drift time
  //---------------------------------------------------------------------------------
 
  double dDdt = m_driftV;
 
  if (!m_useSimpleDigitization) {
    const unsigned short layer = m_wireID.getICLayer();
    const unsigned short leftRight = m_posFlag;
    double alpha = m_cdcgp->getAlpha(m_posWire, m_momentum);
    double theta = m_cdcgp->getTheta(m_momentum);
    double t = m_cdcgp->getDriftTime(driftL, layer, leftRight, alpha, theta);
    dDdt = m_cdcgp->getDriftV(t, layer, leftRight, alpha, theta);
 
#if defined(CDC_DEBUG)
    cout << " " << endl;
    cout << "CDCDigitizerModule::getdDdt" << endl;
    cout << "**layer= " << layer << endl;
    cout << "alpha= " << 180.*alpha / M_PI << std::endl;
    if (layer == 55) {
      int lr = 0;
      for (int i = 0; i < 1000; ++i) {
        t = 1.0 * i;
        double d = m_cdcgp->getDriftLength(t, layer, lr, alpha, theta);
        cout << t << " " << d << endl;
      }
 
      cout << " " << endl;
 
      lr = 1;
      for (int i = 0; i < 100; ++i) {
        t = 5 * i;
        double d = m_cdcgp->getDriftLength(t, layer, lr, alpha, theta);
        cout << t << " " << d << endl;
      }
      exit(-1);
    }
#endif
  }
 
  return dDdt;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getDriftTime()

double getDriftTime	(	double	driftLength,
		bool	addTof,
		bool	addDelay
	)

private

The method to get drift time based on drift length.

In this method, X-T function will be used to calculate drift time.

Parameters

driftLength	The value of drift length.
addTof	Switch for adding time of flight.
addDelay	Switch for adding signal propagation delay in the wire.

Returns: Drift time.

Definition at line 973 of file CDCDigitizerModule.cc.

{
  //---------------------------------------------------------------------------------
  // Method returning electron drift time (parameters: position in cm)
  // T(drift) = TOF + T(true drift time) + T(propagation delay in wire) - T(event),
  // T(event) is a timing of event, which includes a time jitter due to
  // the trigger system.
  //---------------------------------------------------------------------------------
 
  double driftT = 0.;
 
  if (m_useSimpleDigitization) {
    driftT = (driftLength / Unit::cm) * m_driftVInv;
 
#if defined(CDC_DEBUG)
    cout << " " << endl;
    cout << "CDCDigitizerModule::getDriftTime" << endl;
    cout << "driftvinv= " << m_driftVInv << endl;
#endif
  } else {
    const unsigned short layer = m_wireID.getICLayer();
    const unsigned short leftRight = m_posFlag;
    double alpha = m_cdcgp->getAlpha(m_posWire, m_momentum);
    double theta = m_cdcgp->getTheta(m_momentum);
    driftT = m_cdcgp->getDriftTime(driftLength, layer, leftRight, alpha, theta);
    //    std::cout <<"alpha,theta,driftT= " << alpha <<" "<< theta <<" "<< driftT << std::endl;
  }
 
  if (addTof) {
    driftT += m_flightTime; // in ns
  }
 
  if (addDelay) {
    //calculate signal propagation length in the wire
    CDCGeometryPar::EWirePosition set = m_align ? CDCGeometryPar::c_Aligned : CDCGeometryPar::c_Base;
    B2Vector3D backWirePos = m_cdcgp->wireBackwardPosition(m_wireID, set);
 
    double propLength = (m_posWire - backWirePos).Mag();
    //    if (m_cdcgp->getSenseWireZposMode() == 1) {
    //TODO: replace the following with cached reference
    //    std::cout << m_gcp->getInstance().getSenseWireZposMode() << std::endl;
    if (m_gcp->getSenseWireZposMode() == 1) {
      const unsigned short layer = m_wireID.getICLayer();
      propLength += m_cdcgp->getBwdDeltaZ(layer);
    }
    //    B2DEBUG(29, "Propagation in wire length: " << propLength);
 
    if (m_useSimpleDigitization) {
      driftT += (propLength / Unit::cm) * m_propSpeedInv;
 
#if defined(CDC_DEBUG)
      cout << "pseedinv= " << m_propSpeedInv << endl;
#endif
    } else {
      const unsigned short layer = m_wireID.getICLayer();
      driftT += (propLength / Unit::cm) * m_cdcgp->getPropSpeedInv(layer);
#if defined(CDC_DEBUG)
      cout << "layer,pseedinv= " << layer << " " << m_cdcgp->getPropSpeedInv(layer) << endl;
#endif
    }
  }
 
  return driftT;
}

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getPositiveT0()

double getPositiveT0 ( const WireID & wid )

private

Modify t0 for negative-t0 case.

Definition at line 1422 of file CDCDigitizerModule.cc.

{
  double t0 = m_cdcgp->getT0(wid);
  if (t0 <= 0 && m_treatNegT0WiresAsGood) t0 = m_cdcgp->getMeanT0();
  //  B2DEBUG(m_debugLevel, m_cdcgp->getT0(wid) <<" "<< m_cdcgp->getMeanT0() <<" "<< t0);
  return t0;
}

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getSemiTotalGain() [1/2]

double getSemiTotalGain ( const WireID & wireID ) const

inlineprivate

Return semi-total gain of the specified wire.

Parameters

wireID Wire id.

Returns: gain

Definition at line 161 of file CDCDigitizerModule.h.

    {
      return m_semiTotalGain[wireID.getICLayer()][wireID.getIWire()];
    }

◆ getSemiTotalGain() [2/2]

double getSemiTotalGain	(	int	clayer,
		int	cell
	)		const

inlineprivate

Return semi-total gain of the specified wire.

Parameters

clayer	layer no. (0-56)
cell	cell no.

Returns: gain

Definition at line 151 of file CDCDigitizerModule.h.

    {
      return m_semiTotalGain[clayer][cell];
    }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize variables, print info, and start CPU clock.

Reimplemented from Module.

Definition at line 179 of file CDCDigitizerModule.cc.

{
  m_simHits.isRequired(m_inputCDCSimHitsName);
  m_simClockState.isOptional();
 
  // Register the arrays in the DataStore, that are to be added in this module.
  m_cdcHits.registerInDataStore(m_outputCDCHitsName);
  m_simHits.registerRelationTo(m_cdcHits);
  m_mcParticles.registerRelationTo(m_cdcHits);
  m_mcParticles.registerRelationTo(m_cdcHits, DataStore::c_Event, DataStore::c_WriteOut, m_OptionalFirstMCParticlesToHitsName);
  m_mcParticles.registerRelationTo(m_cdcHits, DataStore::c_Event, DataStore::c_WriteOut, m_OptionalAllMCParticlesToHitsName);
 
  // Arrays for trigger.
  m_cdcHits4Trg.registerInDataStore(m_outputCDCHitsName4Trg);
  m_simHits.registerRelationTo(m_cdcHits4Trg);
  m_mcParticles.registerRelationTo(m_cdcHits4Trg);
 
  m_cdcgp = &(CDCGeometryPar::Instance());
  CDCGeometryPar& cdcgp = *m_cdcgp;
  m_tdcBinWidth  = cdcgp.getTdcBinWidth();
  m_tdcBinWidthInv = 1. / m_tdcBinWidth;
  m_tdcResol     = m_tdcBinWidth / sqrt(12.);
  m_driftV       = cdcgp.getNominalDriftV();
  m_driftVInv    = 1. / m_driftV;
  m_propSpeedInv = 1. / cdcgp.getNominalPropSpeed();
  m_gcp = &(CDCGeoControlPar::getInstance());
  m_totalFudgeFactor  = m_cdcgp->getFudgeFactorForSigma(2);
  m_totalFudgeFactor *= m_addFudgeFactorForSigma;
  B2DEBUG(m_debugLevel, "totalFugeF in Digi= " << m_totalFudgeFactor);
  /*
      m_fraction = 1.0;
      m_resolution1 = cdcgp.getNominalSpaceResol();
      m_resolution2 = 0.;
      m_mean1 = 0.;
      m_mean2 = 0.;
  */
 
  if (m_useDB4FEE) {
    m_fEElectronicsFromDB = new DBArray<CDCFEElectronics>;
    if ((*m_fEElectronicsFromDB).isValid()) {
      (*m_fEElectronicsFromDB).addCallback(this, &CDCDigitizerModule::setFEElectronics);
      setFEElectronics();
    } else {
      B2FATAL("CDCDigitizer:: CDCFEElectronics not valid !");
    }
  }
 
  /*
  if (m_useDB4EDepToADC) {
    m_eDepToADCConversionsFromDB = new DBObjPtr<CDCEDepToADCConversions>;
    if ((*m_eDepToADCConversionsFromDB).isValid()) {
      (*m_eDepToADCConversionsFromDB).addCallback(this, &CDCDigitizerModule::setEDepToADCConversions);
      setEDepToADCConversions();
    } else {
      B2FATAL("CDCDigitizer:: CDCEDepToADCConversions not valid !");
    }
  }
  */
 
  if (m_useDB4RunGain) {
    m_runGainFromDB = new DBObjPtr<CDCDedxRunGain>;
    if ((*m_runGainFromDB).isValid()) {
      (*m_runGainFromDB).addCallback(this, &CDCDigitizerModule::setSemiTotalGain);
    } else {
      B2FATAL("CDCDedxRunGain invalid!");
    }
 
    m_gain0FromDB = new DBObjPtr<CDCDedxScaleFactor>;
    if ((*m_gain0FromDB).isValid()) {
      (*m_gain0FromDB).addCallback(this, &CDCDigitizerModule::setSemiTotalGain);
    } else {
      B2FATAL("CDCDedxScaleFactor invalid!");
    }
 
    m_wireGainFromDB = new DBObjPtr<CDCDedxWireGain>;
    if ((*m_wireGainFromDB).isValid()) {
      (*m_wireGainFromDB).addCallback(this, &CDCDigitizerModule::setSemiTotalGain);
      setSemiTotalGain();
    } else {
      B2FATAL("CDCDedxWireGain invalid!");
    }
  }
 
  if (m_addXTalk) {
    m_xTalkFromDB = new DBObjPtr<CDCCrossTalkLibrary>;
    if ((*m_xTalkFromDB).isValid()) {
    } else {
      B2FATAL("CDCCrossTalkLibrary invalid!");
    }
  }
 
  m_corrToThresholdFromDB = new DBObjPtr<CDCCorrToThresholds>;
  if ((*m_corrToThresholdFromDB).isValid()) {
  } else {
    B2FATAL("CDCCorrToThresholds invalid!");
  }
 
#if defined(CDC_DEBUG)
  cout << " " << endl;
  cout << "CDCDigitizer initialize" << endl;
  //  cout << "m_tdcOffset= " <<  m_tdcOffset << endl;
  cout << "m_tdcBinWidth= " <<  m_tdcBinWidth << endl;
  cout << "m_tdcResol= " <<  m_tdcResol << endl;
  cout << "m_driftV= " <<  m_driftV << endl;
  cout << "m_driftVInv= " <<  m_driftVInv << endl;
  cout << "m_propSpeedInv= " <<  m_propSpeedInv << endl;
  /*
    cout << "m_fraction= " <<  m_fraction << endl;
    cout << "m_resolution1= " <<  m_resolution1 << endl;
    cout << "m_resolution2= " <<  m_resolution2 << endl;
    cout << "m_mean1= " <<  m_mean1 << endl;
    cout << "m_mean2= " <<  m_mean2 << endl;
  */
#endif
 
  if (m_useDB4EDepToADC) {
    ushort firstLayerOffset = m_cdcgp->getOffsetOfFirstLayer();
    if (m_cdcgp->getEDepToADCMainFactor(firstLayerOffset, 0) == 0.) {
      B2FATAL("CDCEDepToADCConversion payloads are unavailable!");
    }
  }
 
  // Set timing sim. mode
  if (m_useDB4FEE) {
    if (m_synchronization) { // syncronization
      m_tSimMode = 0;
    } else {
      if (m_randomization) { // radomization
        m_tSimMode = 1;
      } else {
        m_tSimMode = 2; // old sim.
      }
    }
  } else {
    m_tSimMode = 3; // old sim. w/o relying on fee db
  }
  B2DEBUG(m_debugLevel, "timing sim. mode= " << m_tSimMode);
  if (m_tSimMode < 0 || m_tSimMode > 3) B2FATAL("invalid timing sim. mode= " << m_tSimMode);
}

◆ makeSignalsAfterShapers()

void makeSignalsAfterShapers	(	const WireID &	wid,
		double	edep,
		double	dx,
		double	costh,
		unsigned short &	adcCount,
		double &	convFactorForThreshold
	)

private

Function to write ADC-count and conversion factor for threshold.

Parameters

wid	wire id.
edep	energy deposit (GeV).
dx	step length (cm).
costh	cos(theta) of particle.
adcCount	ADC-count.
convFactorForThreshold	conversion factor needed for threshold setting.

Definition at line 1039 of file CDCDigitizerModule.cc.

{
  static double conv00  = (100.0 / 3.2); //keV -> coun (original from some test beam results)
  convFactorForThreshold = conv00;
  adcCount = 0;
  if (dEinGeV <= 0. || dx <= 0.) return;
 
  const unsigned short layer = wid.getICLayer();
  const unsigned short cell  = wid.getIWire();
  double dEInkeV = dEinGeV / Unit::keV;
 
  double conv = conv00;
  if (m_spaceChargeEffect) {
    if (m_useDB4EDepToADC) {
      conv = m_cdcgp->getEDepToADCConvFactor(layer, cell, dEInkeV, dx, costh);
      double conv0 = m_cdcgp->getEDepToADCMainFactor(layer, cell, costh);
      convFactorForThreshold = (conv0 + m_degOfSPEOnThreshold * (conv - conv0));
    }
  } else {
    if (m_useDB4EDepToADC) conv = m_cdcgp->getEDepToADCMainFactor(layer, cell, costh);
    convFactorForThreshold = conv;
  }
 
  if (convFactorForThreshold > 0.) {
    convFactorForThreshold *= getSemiTotalGain(layer, cell);
  } else {
    convFactorForThreshold = conv00;
  }
 
  if (m_gasGainSmearing) {
    const int nElectrons = std::round(dEInkeV / m_effWForGasGainSmearing);
    double relGain = 0;
    if (20 <= nElectrons) {
      relGain = std::max(0., gRandom->Gaus(1., sqrt(1. / (nElectrons * (1. + m_thetaOfPolya)))));
    } else if (1 <= nElectrons) {
      for (int i = 1; i <= nElectrons; ++i) {
        relGain += Polya();
      }
      relGain /= nElectrons;
    } else {
      relGain = 1;
    }
    conv *= relGain;
  }
 
  if (m_extraADCSmearing) {
    conv *= max(0., gRandom->Gaus(1., m_cdcgp->getEDepToADCSigma(layer, cell)));
  }
 
  conv *= getSemiTotalGain(layer, cell);
 
  //The ADCcount is obtained by rounding-up (measured voltage)/bin in real ADC. This is true both for pedestal and signal voltages, so the pedestal-subtracted ADCcount (simulated here) is rounded.
  adcCount = static_cast<unsigned short>(std::round(conv * dEInkeV));
  return;
}

◆ Polya()

double Polya ( double xmax = 10 )

private

Generate random number according to Polya distribution.

Parameters

xmax	max of no. generated

Returns: random no.

Definition at line 1097 of file CDCDigitizerModule.cc.

{
  double x  = 0;
  double y  = 1;
  double fx = 0;
  double urndm[2];
  static double ymax = pow(m_thetaOfPolya, m_thetaOfPolya) * exp(-m_thetaOfPolya);
  while (y > fx) {
    gRandom->RndmArray(2, urndm);
    x = xmax * urndm[0];
    double a = (1 + m_thetaOfPolya) * x;
    fx = pow(a, m_thetaOfPolya) * exp(-a);
    y = ymax * urndm[1];
  }
  return x;
}

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

◆ setFEElectronics()

void setFEElectronics ( )

private

Set FEE parameters (from DB)

Definition at line 1116 of file CDCDigitizerModule.cc.

{
  const double& off   = m_tdcThresholdOffset;
  const double& gA    = m_analogGain;
  const double& gD    = m_digitalGain;
  const double& adcBW = m_adcBinWidth;
  const double convF  = gA / gD / adcBW;
  const double el1TrgLatency = m_cdcgp->getMeanT0(); // ns
  B2DEBUG(m_debugLevel, "L1TRGLatency= " << el1TrgLatency);
  const double c = 32. * m_tdcBinWidth;
 
  if (!m_fEElectronicsFromDB) B2FATAL("No FEEElectronics dbobject!");
  const CDCFEElectronics& fp = *((*m_fEElectronicsFromDB)[0]);
  int mode = (fp.getBoardID() == -1) ? 1 : 0;
  int iNBoards = static_cast<int>(c_nBoards);
 
  //set typical values for all channels first if mode=1
  if (mode == 1) {
    for (int bdi = 1; bdi < iNBoards; ++bdi) {
      m_uprEdgeOfTimeWindow[bdi] = el1TrgLatency - c * (fp.getTrgDelay() + 1);
      if (m_uprEdgeOfTimeWindow[bdi] < 0.) B2FATAL("CDCDigitizer: Upper edge of time window < 0!");
      m_lowEdgeOfTimeWindow[bdi] = m_uprEdgeOfTimeWindow[bdi] - c * (fp.getWidthOfTimeWindow() + 1);
      if (m_lowEdgeOfTimeWindow[bdi] > 0.) B2FATAL("CDCDigitizer: Lower edge of time window > 0!");
      m_adcThresh[bdi] = fp.getADCThresh();
      m_tdcThresh[bdi] = convF * (off - fp.getTDCThreshInMV());
      m_widthOfTimeWindowInCount[bdi] = fp.getWidthOfTimeWindow() + 1;
      m_trgDelayInCount  [bdi] = fp.getTrgDelay();
    }
  }
 
  //ovewrite    values for specific channels if mode=1
  //set typical values for all channels if mode=0
  for (const auto& fpp : (*m_fEElectronicsFromDB)) {
    int bdi = fpp.getBoardID();
    if (mode == 0 && bdi ==  0) continue; //bdi=0 is dummy (not used)
    if (mode == 1 && bdi == -1) continue; //skip typical case
    if (bdi < 0 || bdi >= iNBoards) B2FATAL("CDCDigitizer:: Invalid no. of FEE board!");
    m_uprEdgeOfTimeWindow[bdi] = el1TrgLatency - c * (fpp.getTrgDelay() + 1);
    if (m_uprEdgeOfTimeWindow[bdi] < 0.) B2FATAL("CDCDigitizer: Upper edge of time window < 0!");
    m_lowEdgeOfTimeWindow[bdi] = m_uprEdgeOfTimeWindow[bdi] - c * (fpp.getWidthOfTimeWindow() + 1);
    if (m_lowEdgeOfTimeWindow[bdi] > 0.) B2FATAL("CDCDigitizer: Lower edge of time window > 0!");
    m_adcThresh[bdi] = fpp.getADCThresh();
    m_tdcThresh[bdi] = convF * (off - fpp.getTDCThreshInMV());
    m_widthOfTimeWindowInCount[bdi] = fpp.getWidthOfTimeWindow() + 1;
    m_trgDelayInCount  [bdi] = fpp.getTrgDelay();
  }
 
  //debug
  B2DEBUG(m_debugLevel, "mode= " << mode);
  for (int bdi = 1; bdi < iNBoards; ++bdi) {
    B2DEBUG(m_debugLevel, bdi << " " << m_lowEdgeOfTimeWindow[bdi] << " " << m_uprEdgeOfTimeWindow[bdi] << " " << m_adcThresh[bdi] <<
            " " <<
            m_tdcThresh[bdi]);
  }
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setSemiTotalGain()

void setSemiTotalGain ( )

private

Set semi-total gain (from DB)

Definition at line 1173 of file CDCDigitizerModule.cc.

{
  B2DEBUG(m_debugLevel, " ");
 
  //read individual wire gains
  const int nLyrs = c_maxNSenseLayers;
  B2DEBUG(m_debugLevel, "nLyrs= " << nLyrs);
  int nGoodL[nLyrs] = {};
  float  wgL[nLyrs] = {};
  int nGoodSL[c_nSuperLayers] = {};
  float  wgSL[c_nSuperLayers] = {};
  int nGoodAll = 0;
  float  wgAll = 0;
  int iw = -1;
  for (int lyr = 0; lyr < nLyrs; ++lyr) {
    int nWs = m_cdcgp->nWiresInLayer(lyr);
    for (int w = 0; w < nWs; ++w) {
      ++iw;
      float wg = (*m_wireGainFromDB)->getWireGain(iw);
      m_semiTotalGain[lyr][w] = wg;
      if (wg > 0) {
        ++nGoodL[lyr];
        wgL[lyr] += wg;
        WireID wid(lyr, w);
        ++nGoodSL[wid.getISuperLayer()];
        wgSL[wid.getISuperLayer()] += wg;
        ++nGoodAll;
        wgAll += wg;
      }
    }
  }
 
  //calculate mean gain per layer
  for (int lyr = 0; lyr < nLyrs; ++lyr) {
    if (nGoodL[lyr] > 0) wgL[lyr] /= nGoodL[lyr];
    B2DEBUG(m_debugLevel, "lyr,ngood,gain= " << lyr << " " << nGoodL[lyr] << " " << wgL[lyr]);
  }
  //calculate mean gain per superlayer
  for (unsigned int sl = 0; sl < c_nSuperLayers; ++sl) {
    if (nGoodSL[sl] > 0) wgSL[sl] /= nGoodSL[sl];
    B2DEBUG(m_debugLevel, "slyr,ngood,gain= " << sl << " " << nGoodSL[sl] << " " << wgSL[sl]);
  }
 
 
  //calculate mean gain over all wires
  if (nGoodAll > 0) {
    wgAll /= nGoodAll;
  } else {
    B2FATAL("No good wires !");
  }
  B2DEBUG(m_debugLevel, "ngoodAll,gain= " << nGoodAll << " " << wgAll);
 
  //set gain also for bad/dead wires (bad/dead in terms of dE/dx pid)
  for (int lyr = 0; lyr < nLyrs; ++lyr) {
    int nWs = m_cdcgp->nWiresInLayer(lyr);
    for (int w = 0; w < nWs; ++w) {
      if (m_semiTotalGain[lyr][w] <= 0) {
        if (wgL[lyr] > 0) {
          m_semiTotalGain[lyr][w] = wgL[lyr];
        } else {
          WireID wid(lyr, w);
          m_semiTotalGain[lyr][w] = wgSL[wid.getISuperLayer()];
        }
      }
    }
  }
 
  //check if all gains > 0
  for (int lyr = 0; lyr < nLyrs; ++lyr) {
    int nWs = m_cdcgp->nWiresInLayer(lyr);
    for (int w = 0; w < nWs; ++w) {
      if (m_semiTotalGain[lyr][w] <= 0) {
        B2WARNING("Gain for lyr and wire " << lyr << " " << w << "not > 0. Strange! Replace it with " << wgAll << ".");
        m_semiTotalGain[lyr][w] = wgAll;
      }
    }
  }
 
//multiply common factor for all wires
  m_runGain = (*m_runGainFromDB)->getRunGain();
  double cgain = (*m_gain0FromDB)->getScaleFactor();
  B2DEBUG(m_debugLevel, "runGain, sf= " << m_runGain << " " << cgain);
  cgain *= m_runGain * m_overallGainFactor;
  for (int lyr = 0; lyr < nLyrs; ++lyr) {
    int nWs = m_cdcgp->nWiresInLayer(lyr);
    for (int w = 0; w < nWs; ++w) {
      m_semiTotalGain[lyr][w] *= cgain;
      B2DEBUG(m_debugLevel, "lyr,wire,gain= " << lyr << " " << w << " " << m_semiTotalGain[lyr][w]);
    }
  }
}

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

◆ smearDriftLength()

double smearDriftLength	(	double	driftLength,
		double	dDdt
	)

private

Method used to smear the drift length.

Parameters

driftLength	The value of drift length.
dDdt	dD/dt (drift velocity).

Returns: Drift length after smearing.

Definition at line 882 of file CDCDigitizerModule.cc.

{
  double mean = 0.;
  double resolution;
 
  if (m_useSimpleDigitization) {
    if (gRandom->Uniform() <= m_fraction) {
      mean = m_mean1;
      resolution = m_resolution1;
    } else {
      mean = m_mean2;
      resolution = m_resolution2;
    }
  } else {
    const unsigned short leftRight = m_posFlag;
    double alpha = m_cdcgp->getAlpha(m_posWire, m_momentum);
    double theta = m_cdcgp->getTheta(m_momentum);
    resolution = m_cdcgp->getSigma(driftLength, m_wireID.getICLayer(), leftRight, alpha, theta);
    resolution *= m_totalFudgeFactor;
  }
 
  //subtract resol. due to digitization, which'll be added later in the digitization
 
  double diff = resolution - dDdt * m_tdcResol;
  if (diff > 0.) {
    resolution = sqrt(diff * (resolution + dDdt * m_tdcResol));
  } else {
    resolution = 0.;
  }
 
#if defined(CDC_DEBUG)
  cout << " " << endl;
  cout << "CDCDigitizerModule::smearDriftLength" << endl;
  cout << "tdcResol= " << m_tdcResol << endl;
  cout << "dDdt,resolution= " << dDdt << " " << resolution << endl;
#endif
 
  // Smear drift length
  double newDL = gRandom->Gaus(driftLength + mean, resolution);
  while (newDL <= 0.) newDL = gRandom->Gaus(driftLength + mean, resolution);
  //  cout << "totalFugeF in Digi= " << m_totalFudgeFactor << endl;
  return newDL;
}

◆ terminate()

void terminate ( void )

inlineoverridevirtual

Terminate func.

Reimplemented from Module.

Definition at line 70 of file CDCDigitizerModule.h.

    {
      if (m_fEElectronicsFromDB) delete m_fEElectronicsFromDB;
      //      if (m_eDepToADCConversionsFromDB) delete m_eDepToADCConversionsFromDB;
      if (m_runGainFromDB) delete m_runGainFromDB;
      if (m_gain0FromDB) delete m_gain0FromDB;
      if (m_wireGainFromDB) delete m_wireGainFromDB;
      if (m_xTalkFromDB) delete m_xTalkFromDB;
      if (m_corrToThresholdFromDB) delete m_corrToThresholdFromDB;
    };

Member Data Documentation

◆ m_aCDCSimHit

CDCSimHit* m_aCDCSimHit

private

Pointer to CDCSimHit.

Definition at line 206 of file CDCDigitizerModule.h.

◆ m_adcBinWidth

double m_adcBinWidth

private

ADC bin width (mV)

Definition at line 227 of file CDCDigitizerModule.h.

◆ m_adcThresh

float m_adcThresh[c_nBoards] = {0}

private

Threshold for FADC.

Definition at line 262 of file CDCDigitizerModule.h.

◆ m_adcThreshold

int m_adcThreshold

private

Threshold for ADC in unit of count.

Definition at line 197 of file CDCDigitizerModule.h.

◆ m_addFudgeFactorForSigma

double m_addFudgeFactorForSigma

private

additional fudge factor for space resol.

Definition at line 229 of file CDCDigitizerModule.h.

◆ m_addInWirePropagationDelay

bool m_addInWirePropagationDelay

private

A switch used to control adding propagation delay into the total drift time or not.

Definition at line 244 of file CDCDigitizerModule.h.

◆ m_addInWirePropagationDelay4Bg

bool m_addInWirePropagationDelay4Bg

private

A switch used to control adding propagation delay into the total drift time or not for beam bg.

Definition at line 246 of file CDCDigitizerModule.h.

◆ m_addTimeOfFlight

bool m_addTimeOfFlight

private

A switch used to control adding time of flight into the total drift time or not.

Definition at line 245 of file CDCDigitizerModule.h.

◆ m_addTimeOfFlight4Bg

bool m_addTimeOfFlight4Bg

private

A switch used to control adding time of flight into the total drift time or not for beam bg.

Definition at line 247 of file CDCDigitizerModule.h.

◆ m_addTimeWalk

bool m_addTimeWalk

private

A switch used to control adding time-walk delay into the total drift time or not.

Definition at line 243 of file CDCDigitizerModule.h.

◆ m_addXTalk

bool m_addXTalk

private

Flag to switch on/off crosstalk.

Definition at line 275 of file CDCDigitizerModule.h.

◆ m_align

bool m_align

private

A switch to control alignment.

Definition at line 250 of file CDCDigitizerModule.h.

◆ m_analogGain

double m_analogGain

private

analog gain (V/pC)

Definition at line 225 of file CDCDigitizerModule.h.

◆ m_boardID

unsigned short m_boardID = 0

private

FEE board ID.

Definition at line 209 of file CDCDigitizerModule.h.

◆ m_cdcgp

CDC::CDCGeometryPar* m_cdcgp

private

Cached Pointer to CDCGeometryPar.

Definition at line 204 of file CDCDigitizerModule.h.

◆ m_cdcHits

StoreArray<CDCHit> m_cdcHits

private

CDCHit array.

Definition at line 174 of file CDCDigitizerModule.h.

◆ m_cdcHits4Trg

StoreArray<CDCHit> m_cdcHits4Trg

private

CDCHit4trg array.

Definition at line 175 of file CDCDigitizerModule.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_correctForWireSag

bool m_correctForWireSag

private

A switch to control wire sag.

Definition at line 251 of file CDCDigitizerModule.h.

◆ m_corrToThresholdFromDB

DBObjPtr<CDCCorrToThresholds>* m_corrToThresholdFromDB = nullptr

private

Pointer to threshold correction from DB.

Definition at line 281 of file CDCDigitizerModule.h.

◆ m_debugLevel

int m_debugLevel

private

Debug level.

Definition at line 278 of file CDCDigitizerModule.h.

◆ m_debugLevel4XTalk

int m_debugLevel4XTalk

private

Debug level for crosstalk.

Definition at line 279 of file CDCDigitizerModule.h.

◆ m_degOfSPEOnThreshold

double m_degOfSPEOnThreshold = 0

private

Degree of space charge effect on timing threshold.

Definition at line 240 of file CDCDigitizerModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_digitalGain

double m_digitalGain

private

digital gain (V/pC)

Definition at line 226 of file CDCDigitizerModule.h.

◆ m_doSmearing

bool m_doSmearing

private

A switch to control drift length smearing.

Definition at line 242 of file CDCDigitizerModule.h.

◆ m_driftLength

double m_driftLength

private

drift length of this hit

Definition at line 213 of file CDCDigitizerModule.h.

◆ m_driftV

double m_driftV

private

Nominal drift velocity (in cm/ns)

Definition at line 220 of file CDCDigitizerModule.h.

◆ m_driftVInv

double m_driftVInv

private

m_driftV^-1 (in ns/cm)

Definition at line 221 of file CDCDigitizerModule.h.

◆ m_eDepInGasMode

int m_eDepInGasMode

private

Mode for extracting dE(gas) from dE(gas+wire)

Definition at line 196 of file CDCDigitizerModule.h.

◆ m_effWForGasGainSmearing

double m_effWForGasGainSmearing = 0.0266

private

Effective energy (keV) for one electron prod.

for gas gain smearing

Definition at line 233 of file CDCDigitizerModule.h.

◆ m_extraADCSmearing

bool m_extraADCSmearing = false

private

Switch for extra ADC smearing.

Definition at line 235 of file CDCDigitizerModule.h.

◆ m_fEElectronicsFromDB

DBArray<CDCFEElectronics>* m_fEElectronicsFromDB = nullptr

private

Pointer to FE electronics params.

from DB.

Definition at line 258 of file CDCDigitizerModule.h.

◆ m_flightTime

double m_flightTime

private

flight time of this hit

Definition at line 214 of file CDCDigitizerModule.h.

◆ m_fraction

double m_fraction

private

Fraction of the first Gaussian used to smear drift length.

Definition at line 189 of file CDCDigitizerModule.h.

◆ m_gain0FromDB

DBObjPtr<CDCDedxScaleFactor>* m_gain0FromDB = nullptr

private

Pointer to overall gain factor from DB.

Definition at line 270 of file CDCDigitizerModule.h.

◆ m_gasGainSmearing

bool m_gasGainSmearing = true

private

Switch for gas gain smearing.

Definition at line 232 of file CDCDigitizerModule.h.

◆ m_gcp

CDC::CDCGeoControlPar* m_gcp

private

Cached pointer to CDCGeoControlPar.

Definition at line 205 of file CDCDigitizerModule.h.

◆ m_globalTime

double m_globalTime

private

global time of this hit

Definition at line 215 of file CDCDigitizerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_includeEarlyXTalks

bool m_includeEarlyXTalks

private

Flag to switch on/off xtalks earlier than the hit.

Definition at line 277 of file CDCDigitizerModule.h.

◆ m_inputCDCSimHitsName

std::string m_inputCDCSimHitsName

private

Input array name.

Definition at line 177 of file CDCDigitizerModule.h.

◆ m_issue2ndHitWarning

bool m_issue2ndHitWarning

private

Flag to switch on/off a warning on the 2nd TDC hit.

Definition at line 276 of file CDCDigitizerModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_lowEdgeOfTimeWindow

float m_lowEdgeOfTimeWindow[c_nBoards] = {0}

private

Lower edge of time-window.

Definition at line 259 of file CDCDigitizerModule.h.

◆ m_matchAllMCParticles

bool m_matchAllMCParticles

private

A switch to match all particles to a hit, regardless whether they produced a hit or not.

Definition at line 254 of file CDCDigitizerModule.h.

◆ m_matchFirstMCParticles

bool m_matchFirstMCParticles

private

A switch to match first three MCParticles, not just the one with smallest drift time.

Definition at line 253 of file CDCDigitizerModule.h.

◆ m_mcParticles

StoreArray<MCParticle> m_mcParticles

private

Set edep-to-ADC conversion params.

(from DB) MCParticle array

Definition at line 172 of file CDCDigitizerModule.h.

◆ m_MCParticlesToSimHitsName

std::string m_MCParticlesToSimHitsName

private

Relation for origin of incoming SimHits.

Definition at line 181 of file CDCDigitizerModule.h.

◆ m_mean1

double m_mean1

private

Mean value of the first Gaussian used to smear drift length.

Definition at line 190 of file CDCDigitizerModule.h.

◆ m_mean2

double m_mean2

private

Mean value of the second Gaussian used to smear drift length.

Definition at line 192 of file CDCDigitizerModule.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_momentum

B2Vector3D m_momentum

private

3-momentum of this hit

Definition at line 212 of file CDCDigitizerModule.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_offsetForTriggerBin

int m_offsetForTriggerBin = 1

private

Input to getCDCTriggerBin(offset)

Definition at line 287 of file CDCDigitizerModule.h.

◆ m_OptionalAllMCParticlesToHitsName

std::string m_OptionalAllMCParticlesToHitsName

private

Relation name for optional matching of all MCParticles.

Definition at line 185 of file CDCDigitizerModule.h.

◆ m_OptionalFirstMCParticlesToHitsName

std::string m_OptionalFirstMCParticlesToHitsName

private

Relation name for optional matching of up to first three MCParticles.

Definition at line 184 of file CDCDigitizerModule.h.

◆ m_output2ndHit

bool m_output2ndHit

private

A switch to output 2nd hit.

Definition at line 249 of file CDCDigitizerModule.h.

◆ m_outputCDCHitsName

std::string m_outputCDCHitsName

private

Output array name.

Definition at line 178 of file CDCDigitizerModule.h.

◆ m_outputCDCHitsName4Trg

std::string m_outputCDCHitsName4Trg

private

Output array name for trigger.

Definition at line 179 of file CDCDigitizerModule.h.

◆ m_outputNegativeDriftTime

bool m_outputNegativeDriftTime

private

A switch to output negative drift time to CDCHit.

Definition at line 248 of file CDCDigitizerModule.h.

◆ m_overallGainFactor

double m_overallGainFactor = 1.

private

Overall gain factor.

Definition at line 239 of file CDCDigitizerModule.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_posFlag

unsigned short m_posFlag

private

left or right flag of this hit

Definition at line 208 of file CDCDigitizerModule.h.

◆ m_posTrack

B2Vector3D m_posTrack

private

track position of this hit

Definition at line 211 of file CDCDigitizerModule.h.

◆ m_posWire

B2Vector3D m_posWire

private

wire position of this hit

Definition at line 210 of file CDCDigitizerModule.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_propSpeedInv

double m_propSpeedInv

private

Inv.

of nominal signal propagation speed in a wire (in ns/cm)

Definition at line 222 of file CDCDigitizerModule.h.

◆ m_randomization

bool m_randomization = true

private

Flag to switch on/off timing randomization.

Definition at line 285 of file CDCDigitizerModule.h.

◆ m_resolution1

double m_resolution1

private

Resolution of the first Gaussian used to smear drift length.

Definition at line 191 of file CDCDigitizerModule.h.

◆ m_resolution2

double m_resolution2

private

Resolution of the second Gaussian used to smear drift length.

Definition at line 193 of file CDCDigitizerModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_runGain

double m_runGain = 1.

private

run gain.

Definition at line 237 of file CDCDigitizerModule.h.

◆ m_runGainFromDB

DBObjPtr<CDCDedxRunGain>* m_runGainFromDB = nullptr

private

Pointer to run gain from DB.

Definition at line 269 of file CDCDigitizerModule.h.

◆ m_semiTotalGain

float m_semiTotalGain[c_maxNSenseLayers][c_maxNDriftCells] = {{}}

private

total gain per wire

Definition at line 238 of file CDCDigitizerModule.h.

◆ m_shiftOfTimeWindowIn32Count

int m_shiftOfTimeWindowIn32Count = 153

private

Shift of time window for synchronization in 32count.

Definition at line 289 of file CDCDigitizerModule.h.

◆ m_simClockState

StoreObjPtr<SimClockState> m_simClockState

private

generated hardware clock state

Definition at line 283 of file CDCDigitizerModule.h.

◆ m_simHits

StoreArray<CDCSimHit> m_simHits

private

CDCSimHit array.

Definition at line 173 of file CDCDigitizerModule.h.

◆ m_SimHitsTOCDCHitsName

std::string m_SimHitsTOCDCHitsName

private

Relation for outgoing CDCHits.

Definition at line 182 of file CDCDigitizerModule.h.

◆ m_spaceChargeEffect

bool m_spaceChargeEffect

private

Space charge effect.

Definition at line 267 of file CDCDigitizerModule.h.

◆ m_synchronization

bool m_synchronization = true

private

Flag to switch on/off timing synchronization.

Definition at line 284 of file CDCDigitizerModule.h.

◆ m_tdcBinWidth

double m_tdcBinWidth

private

Width of a TDC bin (in ns)

Definition at line 217 of file CDCDigitizerModule.h.

◆ m_tdcBinWidthInv

double m_tdcBinWidthInv

private

m_tdcBinWidth^-1 (in ns^-1)

Definition at line 218 of file CDCDigitizerModule.h.

◆ m_tdcResol

double m_tdcResol

private

TDC resolution (in ns)

Definition at line 219 of file CDCDigitizerModule.h.

◆ m_tdcThresh

float m_tdcThresh[c_nBoards] = {0}

private

Threshold for timing-signal.

Definition at line 261 of file CDCDigitizerModule.h.

◆ m_tdcThreshold4Inner

double m_tdcThreshold4Inner

private

TDC threshold for inner layers in unit of eV.

Definition at line 195 of file CDCDigitizerModule.h.

◆ m_tdcThreshold4Outer

double m_tdcThreshold4Outer

private

TDC threshold for outer layers in unit of eV.

Definition at line 194 of file CDCDigitizerModule.h.

◆ m_tdcThresholdOffset

double m_tdcThresholdOffset

private

Offset for TDC(digital) threshold (mV)

Definition at line 224 of file CDCDigitizerModule.h.

◆ m_thetaOfPolya

double m_thetaOfPolya = 0.5

private

theta of Polya function for gas gain smearing

Definition at line 234 of file CDCDigitizerModule.h.

◆ m_tMaxInner

double m_tMaxInner

private

Upper edge of time window in ns for the inner layers.

Definition at line 200 of file CDCDigitizerModule.h.

◆ m_tMaxOuter

double m_tMaxOuter

private

Upper edge of time window in ns for the outer layers.

Definition at line 199 of file CDCDigitizerModule.h.

◆ m_tMin

double m_tMin

private

Lower edge of time window in ns.

Definition at line 198 of file CDCDigitizerModule.h.

◆ m_totalFudgeFactor

double m_totalFudgeFactor = 1.

private

total fudge factor for space resol.

Definition at line 230 of file CDCDigitizerModule.h.

◆ m_treatNegT0WiresAsGood

bool m_treatNegT0WiresAsGood

private

A switch for negative-t0 wires.

Definition at line 252 of file CDCDigitizerModule.h.

◆ m_trgDelayInCount

unsigned short m_trgDelayInCount[c_nBoards] = {0}

private

Trigger delay in frontend electronics in count.

Definition at line 290 of file CDCDigitizerModule.h.

◆ m_trgTimingOffsetInCount

int m_trgTimingOffsetInCount = 4

private

Trigger timing offset in unit of count.

Definition at line 288 of file CDCDigitizerModule.h.

◆ m_trigTimeJitter

double m_trigTimeJitter

private

Magnitude of trigger timing jitter (ns).

Definition at line 202 of file CDCDigitizerModule.h.

◆ m_tSimMode

int m_tSimMode = 0

private

Timing simulation mode.

Definition at line 286 of file CDCDigitizerModule.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_uprEdgeOfTimeWindow

float m_uprEdgeOfTimeWindow[c_nBoards] = {0}

private

Upper edge of time-window.

Definition at line 260 of file CDCDigitizerModule.h.

◆ m_useDB4EDepToADC

bool m_useDB4EDepToADC

private

Fetch edep-to-ADC conversion params.

from DB

Definition at line 265 of file CDCDigitizerModule.h.

◆ m_useDB4FEE

bool m_useDB4FEE

private

Fetch FEE params from DB.

Definition at line 257 of file CDCDigitizerModule.h.

◆ m_useDB4RunGain

bool m_useDB4RunGain

private

Fetch run gain from DB.

Definition at line 266 of file CDCDigitizerModule.h.

◆ m_useSimpleDigitization

bool m_useSimpleDigitization

private

Use float Gaussian Smearing instead of proper digitization.

Definition at line 187 of file CDCDigitizerModule.h.

◆ m_widthOfTimeWindowInCount

unsigned short m_widthOfTimeWindowInCount[c_nBoards] = {0}

private

Width of time window.

Definition at line 263 of file CDCDigitizerModule.h.

◆ m_wireGainFromDB

DBObjPtr<CDCDedxWireGain>* m_wireGainFromDB = nullptr

private

Pointer to wire gain from DB.

Definition at line 271 of file CDCDigitizerModule.h.

◆ m_wireID

WireID m_wireID

private

WireID of this hit.

Definition at line 207 of file CDCDigitizerModule.h.

◆ m_xTalkFromDB

DBObjPtr<CDCCrossTalkLibrary>* m_xTalkFromDB = nullptr

private

Pointer to cross-talk from DB.

Definition at line 280 of file CDCDigitizerModule.h.

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

cdc/modules/cdcDigitizer/include/CDCDigitizerModule.h
cdc/modules/cdcDigitizer/src/CDCDigitizerModule.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ CDCDigitizerModule()

Member Function Documentation

◆ addXTalk()

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getdDdt()

◆ getDescription()

◆ getDriftTime()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getPositiveT0()

◆ getReturnValue()

◆ getSemiTotalGain() [1/2]

◆ getSemiTotalGain() [2/2]

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ makeSignalsAfterShapers()

◆ Polya()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setFEElectronics()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setSemiTotalGain()

◆ setType()

◆ smearDriftLength()

◆ terminate()

Member Data Documentation

◆ m_aCDCSimHit

◆ m_adcBinWidth

◆ m_adcThresh