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

#include <CDCDigitizerModule.h>

Inheritance diagram for CDCDigitizerModule:

Collaboration diagram for CDCDigitizerModule:

[legend]

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

void	terminate () override
	Terminate func.

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

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

virtual void	endRun ()
	This method is called if the current run ends. More...

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	makeSignalsAfterShapers (const WireID &wid, double edep, double dx, double costh, unsigned short &adcCount, double &convFactorForThreshold)
	Function to make signals after shapers. More...

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

void	setFEElectronics ()
	Set FEE parameters (from DB)

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

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

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

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

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

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

Private Attributes
StoreArray< MCParticle >	m_mcParticles
	Set edep-to-ADC conversion params. More...

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

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.

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 Gassian used to smear drift length.

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

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

double	m_resolution2
	Resolution of the second Gassian 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.

TVector3	m_posWire
	wire position of this hit

TVector3	m_posTrack
	track position of this hit

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

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 = false
	Swtich for gas gain smearing.

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

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

bool	m_extraADCSmearing = false
	Swtich for extra ADC smearing.

double	m_runGain = 1.
	run gain.

float	m_semiTotalGain [MAX_N_SLAYERS][MAX_N_SCELLS] = {{}}
	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_useDB4FEE
	Fetch FEE params from DB.

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

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

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

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

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

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

bool	m_useDB4EDepToADC
	Fetch edep-to-ADC conversion params. More...

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.

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

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 [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 53 of file CDCDigitizerModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

Member Function Documentation

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

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

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

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

◆ event()

void event ( void )

overridevirtual

Actual digitization of all hits in the CDC.

The digitized hits are written into the DataStore.

Reimplemented from Module.

Definition at line 299 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;
  
   // 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 < 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();
     //    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;
  
     TVector3 bwpAlign = m_cdcgp->wireBackwardPosition(m_wireID, CDCGeometryPar::c_Aligned);
     TVector3 fwpAlign = m_cdcgp->wireForwardPosition(m_wireID, CDCGeometryPar::c_Aligned);
  
     TVector3 bwp = m_cdcgp->wireBackwardPosition(m_wireID);
     TVector3 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 TVector3 L = 5. * m_momentum.Unit(); //(cm) tentative
       TVector3 posIn  = m_posTrack - L;
       TVector3 posOut = m_posTrack + L;
       TVector3 posTrack = m_posTrack;
       TVector3 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
     // M. Uchida 2012.08.31
     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;
     }
     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 TVector3 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 (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 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;
     }
   }
   */
 }

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ 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 825 of file CDCDigitizerModule.cc.

◆ 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 871 of file CDCDigitizerModule.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

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

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

◆ makeSignalsAfterShapers()

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

private

Function to make signals after shapers.

Parameters

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

Returns: ADC-count and conversion factor for threshold.

Definition at line 937 of file CDCDigitizerModule.cc.

◆ Polya()

double Polya ( double xmax = 10 )

private

Generate randum number according to Polya distribution.

Parameters

xmax	max of no. generated

Returns: randum no.

Definition at line 994 of file CDCDigitizerModule.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

◆ 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 780 of file CDCDigitizerModule.cc.

Member Data Documentation

◆ m_effWForGasGainSmearing

double m_effWForGasGainSmearing = 0.0266

private

Effective energy (keV) for one electron prod.

for gas gain smearing

Definition at line 230 of file CDCDigitizerModule.h.

◆ m_fEElectronicsFromDB

DBArray<CDCFEElectronics>* m_fEElectronicsFromDB = nullptr

private

Pointer to FE electronics params.

from DB.

Definition at line 253 of file CDCDigitizerModule.h.

◆ m_inputCDCSimHitsName

std::string m_inputCDCSimHitsName

private

Input array name.

Definition at line 177 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_propSpeedInv

double m_propSpeedInv

private

Inv.

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

Definition at line 219 of file CDCDigitizerModule.h.

◆ m_useDB4EDepToADC

bool m_useDB4EDepToADC

private

Fetch edep-to-ADC conversion params.

from DB

Definition at line 260 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 Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getdDdt()

◆ getDriftTime()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getSemiTotalGain() [1/2]

◆ getSemiTotalGain() [2/2]

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ makeSignalsAfterShapers()

◆ Polya()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ smearDriftLength()

Member Data Documentation

◆ m_effWForGasGainSmearing

◆ m_fEElectronicsFromDB

◆ m_inputCDCSimHitsName

◆ m_mcParticles

◆ m_propSpeedInv

◆ m_useDB4EDepToADC