Belle II Software  release-05-01-25
SVDDigitizerModule Class Reference

The SVD Digitizer module. More...

#include <SVDDigitizerModule.h>

Inheritance diagram for SVDDigitizerModule:
Collaboration diagram for SVDDigitizerModule:

Public Types

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

Public Member Functions

 SVDDigitizerModule ()
 Constructor. More...
 
void processHit ()
 Process one SVDSimHit by dividing the step in smaller steps and drifting the charge.
 
void driftCharge (const TVector3 &position, double carriers, SVD::SensorInfo::CarrierType carrierType)
 Drift the charge inside the silicon. More...
 
double addNoise (double charge, double noise)
 Calculate the noise contribution to one strip with given charge. More...
 
void saveDigits ()
 Save digits to the DataStore Saves samples of generated waveforms.
 
void saveWaveforms ()
 Save waveforms to the statistics file. More...
 
void saveSignals ()
 Save signals to a root-delimited file (to be analyzed in Python). More...
 
virtual void initialize () override
 Initialize the module and check module parameters.
 
virtual void beginRun () override
 Initialize the list of existing SVD Sensors.
 
virtual void event () override
 Digitize one event.
 
virtual void terminate () override
 Terminate the module.
 
virtual std::vector< std::string > getFileNames (__attribute__((unused)) bool outputFiles)
 Return a list of output filenames for this modules. 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...
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level. More...
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module. More...
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module. More...
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module. More...
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More...
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished. More...
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module. More...
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter. More...
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module. More...
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module. More...
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters. More...
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python. More...
 
virtual void def_beginRun ()
 Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
 
virtual void def_event ()
 Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
 
virtual void def_endRun ()
 This method can receive that the current run ends as a call from the Python side. More...
 
virtual void def_terminate ()
 Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
 
void setDescription (const std::string &description)
 Sets the description of the module. More...
 
void setType (const std::string &type)
 Set the module type. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
 Adds a new parameter to the module. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module. More...
 
void setReturnValue (int value)
 Sets the return value for this module as integer. More...
 
void setReturnValue (bool value)
 Sets the return value for this module as bool. More...
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Protected Attributes

std::string m_storeMCParticlesName = ""
 Name of the collection for the MCParticles.
 
std::string m_storeSimHitsName = ""
 Name of the collection for the SVDSimhits.
 
std::string m_storeTrueHitsName = ""
 Name of the collection for the SVDTrueHits.
 
std::string m_relMCParticleSimHitName = ""
 Name of the relation between MCParticles and SVDSimHits.
 
std::string m_relTrueHitSimHitName = ""
 Name of the relation between SVDTrueHits and SVDSimHits.
 
std::string m_storeShaperDigitsName = ""
 Name of the collection for the SVDShaperDigits.
 
std::string m_relShaperDigitMCParticleName = ""
 Name of the relation between SVDShaperDigits and MCParticles.
 
std::string m_relShaperDigitTrueHitName = ""
 Name of the relation between SVDShaperDigits and SVDTrueHits.
 
std::string m_svdEventInfoName = "SVDEventInfoSim"
 Name of the SVDEventInfo object.
 
double m_segmentLength = 0.020
 Max. More...
 
double m_widthOfDiffusCloud = 3.0
 Width of diffusion cloud for simple drift model (in sigmas)
 
bool m_applyPoisson = true
 Whether or not to apply poisson fluctuation of charge.
 
bool m_applyNoise = false
 Whether or not to apply Gaussian noise.
 
double m_SNAdjacent = 3.0
 Zero-suppression cut.
 
bool m_roundZS = true
 Round ZS cut to nearest ADU.
 
unsigned short m_nSamplesOverZS = 1
 Keek digit if at least m_nSamplesOverZS are over threshold.
 
double m_noiseFraction = 0.01
 (derived from SNAdjacent) Fraction of noisy strips per sensor.
 
double m_shapingTime = 250.0
 Shaping time of the APV25 shapers.
 
double m_samplingTime = 16000. / 509.
 Interval between two waveform samples (30 ns).
 
bool m_randomizeEventTimes = false
 Randomize event times? If set to true, event times will be randomized uniformly from m_minTimeFrame to m_maxTimeFrame.
 
float m_minTimeFrame = -300
 Low edge of randomization time frame.
 
float m_maxTimeFrame = 150
 High edge of randomization time frame.
 
float m_currentEventTime = 0.0
 Current event time. More...
 
double m_startSampling = -2.0
 Time window start. More...
 
std::string m_rootFilename = ""
 Name of the ROOT filename to output statistics.
 
bool m_storeWaveforms = false
 Store waveform data in the reporting file?
 
std::string m_signalsList = ""
 Name of the tab-delimited listing of signals.
 
Sensors m_sensors
 Structure containing signals in all existing sensors.
 
const SVDSimHitm_currentHit = nullptr
 Pointer to the SVDSimhit currently digitized.
 
int m_currentParticle = -1
 Index of the particle which caused the current hit.
 
int m_currentTrueHit = -1
 Index of the TrueHit the current hit belongs to.
 
Sensorm_currentSensor = NULL
 Pointer to the sensor in which the current hit occurred.
 
const SensorInfom_currentSensorInfo = nullptr
 Pointer to the SensorInfo of the current sensor.
 
double m_currentTime = 0
 Time of the current SimHit. More...
 
double m_sensorThickness = 0.03
 Thickness of current sensor (read from m_currentSensorInfo).
 
double m_depletionVoltage = 40
 The depletion voltage of the Silicon sensor.
 
double m_biasVoltage = 100
 The bias voltage on the sensor.
 
double m_backplaneCapacitanceU = 0.1
 The backplane capacitanceU wrt. More...
 
double m_interstripCapacitanceU = 0.7
 The interstrip capacitanceU for the sensor.
 
double m_couplingCapacitanceU = 15
 The coupling capacitanceU for the sensor.
 
double m_backplaneCapacitanceV = 0.4
 The backplane capacitanceV wrt. More...
 
double m_interstripCapacitanceV = 0.7
 The interstrip capacitanceV for the sensor.
 
double m_couplingCapacitanceV = 30
 The coupling capacitanceV for the sensor.
 
double m_elNoiseU = 500
 ADU equivalent charge for u-strips. More...
 
double m_elNoiseV = 500
 Electronic noise for v-strips.
 
SVDFADCMaskedStrips m_MaskedStr
 FADC masked strip payload.
 
DBObjPtr< PayloadFilem_mapping
 channel mapping payload
 
std::unique_ptr< SVDOnlineToOfflineMapm_map
 channel mapping map
 
TFile * m_rootFile = nullptr
 Pointer to the ROOT filename for statistics.
 
TH1D * m_histChargeSharing_u = nullptr
 Histogram showing the charge sharing + diffusion in u (r-phi).
 
TH1D * m_histChargeSharing_v = nullptr
 Histogram showing the charge sharing + diffusion in v (z).
 
TH1D * m_histMobility_e = nullptr
 Histogram showing the mobility of e-.
 
TH1D * m_histMobility_h = nullptr
 Histogram showing the mobility of h.
 
TH1D * m_histVelocity_e = nullptr
 Histogram showing the velocity of e-.
 
TH1D * m_histVelocity_h = nullptr
 Histogram showing the velocity of h.
 
TH1D * m_histDistanceToPlane_e = nullptr
 Histogram showing the distance to plane for e.
 
TH1D * m_histDistanceToPlane_h = nullptr
 Histogram showing the distance to plane for h.
 
TH1D * m_histDriftTime_e = nullptr
 Histogram showing the drift time of e.
 
TH1D * m_histDriftTime_h = nullptr
 Histogram showing the drift time of h.
 
TH1D * m_histLorentz_u = nullptr
 Histogram showing the Lorentz angles in u (r-phi).
 
TH1D * m_histLorentz_v = nullptr
 Histogram showing the Lorentz angles in v (z).
 
TH1D * m_signalDist_u = nullptr
 Histogram showing the distribution of digit signals in u (r-phi).
 
TH1D * m_signalDist_v = nullptr
 Histogram showing the distribution of digit signals in v (z).
 
TTree * m_waveTree = nullptr
 Tree for waveform storage.
 

Static Protected Attributes

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

Private Member Functions

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

Private Attributes

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

Detailed Description

The SVD Digitizer module.

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

Definition at line 59 of file SVDDigitizerModule.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 79 of file Module.h.

Constructor & Destructor Documentation

◆ SVDDigitizerModule()

Constructor.


Definition at line 60 of file SVDDigitizerModule.cc.

60  : Module(),
62 {
63  //Set module properties
64  setDescription("Create SVDShaperDigits from SVDSimHits");
66 
67  // Define module parameters
68 
69  // 1. Collections
70  addParam("MCParticles", m_storeMCParticlesName,
71  "MCParticle collection name", m_storeMCParticlesName);
72  addParam("SimHits", m_storeSimHitsName, "SimHit collection name",
74  addParam("TrueHits", m_storeTrueHitsName, "TrueHit collection name",
76  addParam("ShaperDigits", m_storeShaperDigitsName, "ShaperDigits collection name", m_storeShaperDigitsName);
77  addParam("SVDEventInfo", m_svdEventInfoName, "SVDEventInfo name", m_svdEventInfoName);
78 
79  // 2. Physics
80  addParam("SegmentLength", m_segmentLength,
81  "Maximum segment length (in millimeters)", m_segmentLength);
82  addParam("WidthOfDiffusCloud", m_widthOfDiffusCloud,
83  "Integration range of charge cloud in sigmas", m_widthOfDiffusCloud);
84 
85  // 3. Noise
86  addParam("PoissonSmearing", m_applyPoisson,
87  "Apply Poisson smearing on chargelets", m_applyPoisson);
88  addParam("ElectronicEffects", m_applyNoise, "Generate noise digits",
89  m_applyNoise);
90  addParam("ZeroSuppressionCut", m_SNAdjacent,
91  "Zero suppression cut in sigmas of strip noise", m_SNAdjacent);
92  addParam("FADCmode", m_roundZS,
93  "FADC mode: if true, ZS cut is rounded to nearest ADU ", m_roundZS);
94  addParam("numberOfSamples", m_nSamplesOverZS,
95  "Keep digit if numberOfSamples or more samples are over ZS threshold",
97 
98  // 4. Timing
99  addParam("APVShapingTime", m_shapingTime, "APV25 shpaing time in ns",
100  m_shapingTime);
101  addParam("ADCSamplingTime", m_samplingTime,
102  "Interval between ADC samples in ns", m_samplingTime);
103  addParam("StartSampling", m_startSampling,
104  "Start of the sampling window, in ns", m_startSampling);
105  addParam("RandomizeEventTimes", m_randomizeEventTimes,
106  "Randomize event times over a frame interval", m_randomizeEventTimes);
107  addParam("TimeFrameLow", m_minTimeFrame,
108  "Left edge of event time randomization window, ns", m_minTimeFrame);
109  addParam("TimeFrameHigh", m_maxTimeFrame,
110  "Right edge of event time randomization window, ns", m_maxTimeFrame);
111 
112  // 5. Reporting
113  addParam("statisticsFilename", m_rootFilename,
114  "ROOT Filename for statistics generation. If filename is empty, no statistics will be produced",
116  addParam("storeWaveforms", m_storeWaveforms,
117  "Store waveforms in a TTree in the statistics file.", m_storeWaveforms);
118  addParam("signalsList", m_signalsList,
119  "Store signals (time/charge/tau) in a tab-delimited file",
120  m_signalsList);
121 }

Member Function Documentation

◆ addNoise()

double addNoise ( double  charge,
double  noise 
)

Calculate the noise contribution to one strip with given charge.

Parameters
chargethe original charge on the strip
noisethe standard RMS noise on the strip
Returns
the new charge of the strip.

Definition at line 637 of file SVDDigitizerModule.cc.

◆ 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 181 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 441 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 422 of file Module.h.

◆ driftCharge()

void driftCharge ( const TVector3 &  position,
double  carriers,
SVD::SensorInfo::CarrierType  carrierType 
)

Drift the charge inside the silicon.

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

Parameters
positionstart position of the charge
electronsnumber of electrons and holes to drift
carrierTypeelectrons or holes

Definition at line 445 of file SVDDigitizerModule.cc.

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Reimplemented in DQMHistAnalysisPXDTrackChargeModule, DQMHistOutputToEPICSModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisPXDChargeModule, PyModule, DQMHistComparitorModule, TrackSetEvaluatorHopfieldNNDEVModule, DQMHistAnalysisInputRootFileModule, AlignDQMModule, SVDUnpackerDQMModule, DQMHistAnalysisPXDERModule, vxdDigitMaskingModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisExampleFlagsModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGGRLUnpackerModule, TRGCDCETFUnpackerModule, TOPUnpackerModule, FindletModule< AFindlet >, FindletModule< FacetCreator >, FindletModule< TrackFinderAutomaton >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialStraightTrackFinder >, FindletModule< SegmentLinker >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentOrienter >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< CKFToSVDFindlet >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackRejecter >, FindletModule< SegmentCreatorMCTruth >, FindletModule< HitBasedT0Extractor >, FindletModule< TrackFinderCosmics >, FindletModule< SuperClusterCreator >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< TrackExporter >, FindletModule< ClusterPreparer >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< AxialTrackFinderHough >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackFinder >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< SegmentPairCreator >, FindletModule< HitReclaimer >, FindletModule< CKFToPXDFindlet >, FindletModule< TrackQualityEstimator >, FindletModule< StereoHitFinder >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< SegmentFitter >, FindletModule< SegmentRejecter >, FindletModule< WireHitPreparer >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTrackCombiner >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleStereoHitFinder >, FindletModule< TrackCombiner >, FindletModule< AxialSegmentPairCreator >, FindletModule< WireHitBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFindlet >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< TrackQualityAsserter >, FindletModule< WireHitCreator >, ECLWaveformFitModule, B2BIIConvertMdstModule, TOPTimeBaseCalibratorModule, TOPTBCComparatorModule, ECLChargedPIDModule, SVDBackgroundModule, ARICHNtupleModule, ECLDigitizerModule, BeamBkgTagSetterModule, TOPGainEfficiencyCalculatorModule, ECLShowerShapeModule, KLMClustersReconstructorModule, OpticalGunModule, ParticleKinematicFitterModule, PXDBackgroundModule, CDCDedxValidationModule, ARICHDigitizerModule, TOPDQMModule, CDCDQMModule, KLMDQMModule, TOPLaserHitSelectorModule, TOPModuleT0CalibratorModule, DQMHistAnalysisTRGGDLModule, BKLMDigitAnalyzerModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, KLMUnpackerModule, TOPRawDigitConverterModule, TOPReconstructorModule, ARICHFillHitsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisKLMModule, KLMReconstructorModule, CDCCRTestModule, KLMDigitizerModule, ECLDigitizerPureCsIModule, EKLMDataCheckerModule, ARICHReconstructorModule, ECLLocalRunCalibratorModule, KLMPackerModule, MdstPIDModule, FullSimModule, ARICHDQMModule, DQMHistAnalysisARICHModule, ECLCRFinderModule, TOPAlignerModule, TOPPDFDebuggerModule, ARICHPackerModule, BelleMCOutputModule, BeamBkgMixerModule, CDCPackerModule, TOPBackgroundModule, TOPPDFCheckerModule, ARICHRelateModule, BeamBkgHitRateMonitorModule, CsIDigitizerModule, DQMHistAnalysisMiraBelleModule, ARICHUnpackerModule, CDCUnpackerModule, ARICHMCParticlesModule, ARICHRateCalModule, CDCCosmicAnalysisModule, ECLShowerCorrectorModule, SVDCoGTimeEstimatorModule, SVDUnpackerModule, SVDROIFinderAnalysisModule, ECLDataAnalysisModule, EclDisplayModule, TOPDoublePulseGeneratorModule, TOPWaveformQualityPlotterModule, BGOverlayExecutorModule, ECLChargedPIDDataAnalysisValidationModule, ECLDigitCalibratorModule, ECLSplitterN1Module, EvtGenDecayModule, EKLMADCModule, SVDROIFinderModule, TRGGDLUnpackerModule, ARICHRawUnpackerModule, NtuplePhase1_v6Module, ECLDQMModule, TOPCalPulseGeneratorModule, TOPNtupleModule, TOPPackerModule, TOPWaveformFeatureExtractorModule, TrackFinderMCTruthRecoTracksModule, VXDTFTrainingDataCollectorModule, BeamBkgGeneratorModule, EventInfoPrinterModule, BKLMSimHistogrammerModule, KLMClusterEfficiencyModule, PXDPerformanceModule, TOPInterimFENtupleModule, TOPMCTrackMakerModule, VXDSimpleClusterizerModule, BGOverlayInputModule, TpcDigitizerModule, PIDNtupleModule, SPTCvirtualIPRemoverModule, arichBtestModule, ReprocessorModule, CsIStudyModule, ECLChargedPIDDataAnalysisModule, OverrideGenerationFlagsModule, MCMatcherKLMClustersModule, PrintDataModule, SPTCmomentumSeedRetrieverModule, TrackFinderVXDAnalizerModule, TRGGRLMatchModule, DQMHistAnalysisARICHMonObjModule, ECLLocalMaximumFinderModule, CDCDedxDQMModule, FANGSDigitizerModule, CDCRecoTrackFilterModule, ECLClusterPSDModule, SVDLocalCalibrationsMonitorModule, TOPTriggerDigitizerModule, ExtModule, MCTrackCandClassifierModule, MuidModule, HLTDQM2ZMQModule, DQMHistAnalysisECLModule, IPDQMExpressRecoModule, BKLMTrackingModule, TOPCosmicT0FinderModule, HitXPModule, TRGCDCT3DConverterModule, DQMHistAnalysisMonObjModule, ECLBackgroundModule, EventT0DQMModule, SVDDataFormatCheckModule, TRGTOPDQMModule, BgoStudyModule, CsiStudy_v2Module, MicrotpcStudyModule, PlumeDigitizerModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisHLTMonObjModule, PXDClustersFromTracksModule, SVDPackerModule, SVDClusterEvaluationTrueInfoModule, TOPXTalkChargeShareSetterModule, SecMapTrainerVXDTFModule, AnalysisPhase1StudyModule, DosiStudyModule, He3tubeStudyModule, ECLCovarianceMatrixModule, ECLDQMEXTENDEDModule, ECLFinalizerModule, ECLSplitterN2Module, MCMatcherECLClustersModule, BKLMAnaModule, SVDHotStripFinderModule, SVDPerformanceModule, SecMapTrainerBaseModule, NoKickCutsEvalModule, TRGECLRawdataAnalysisModule, TRGTOPUnpackerModule, BgoDigitizerModule, CsiDigitizer_v2Module, DosiDigitizerModule, TPCStudyModule, PinDigitizerModule, HLTDs2ZMQModule, DQMHistAnalysisInputPVSrvModule, ECLShowerCalibratorModule, SVDLatencyCalibrationModule, SVDOccupancyAnalysisModule, TOPLaserCalibratorModule, PXDROIFinderModule, KlongValidationModule, TrackingPerformanceEvaluationModule, MCMatcherTRGECLModule, BeamabortStudyModule, ClawStudyModule, ClawsStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, ECLHitDebugModule, SVDClusterCalibrationsMonitorModule, TOPChannelT0MCModule, EffPlotsModule, CurlTaggerModule, BeamDigitizerModule, He3DigitizerModule, ECLUnpackerModule, StatisticsSummaryModule, DataWriterModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterFilterModule, SVDShaperDigitsFromTracksModule, SVD3SamplesEmulatorModule, RT2SPTCConverterModule, SVDROIDQMModule, TRGGDLModule, EventKinematicsModule, ClawDigitizerModule, ClawsDigitizerModule, DQMHistSnapshotsModule, ECLPackerModule, PrintEventRateModule, SVDCoGTimeCalibrationsMonitorModule, V0findingPerformanceEvaluationModule, TRGECLModule, CosmicsAlignmentValidationModule, FANGSStudyModule, QcsmonitorDigitizerModule, SectorMapBootstrapModule, CsiModule, DQMHistDeltaHistoModule, RandomBarrierModule, TRGGRLModule, GenfitVisModule, CDCTriggerNeuroDQMModule, TRGECLFAMModule, TRGGRLProjectsModule, B2BIIMdstInputModule, DQMHistAnalysisTOPModule, SubEventModule, TRGCDCModule, DQMHistAnalysisSVDOnMiraBelleModule, TRGCDCTSStreamModule, Convert2RawDetModule, DQMHistAnalysisOutputMonObjModule, TRGECLQAMModule, TRGECLTimingCalModule, MCV0MatcherModule, DQMHistAnalysisInputModule, cdcDQM7Module, SwitchDataStoreModule, PhysicsObjectsMiraBelleModule, HistoModule, TRGGRLDQMModule, KLMTriggerModule, DQMHistAnalysisEventT0Module, DQMHistAnalysisInputSrvModule, SeqRootOutputModule, TRGGDLDQMModule, DQMHistAnalysisSVDGeneralModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, TxModule, B2BIIMCParticlesMonitorModule, DQMHistAnalysisOutputNSMModule, DQMHistAnalysisPlotOnlyModule, DQMHistAnalysisSVDEfficiencyModule, RxModule, Root2BinaryModule, DQMHistAnalysisExampleModule, DQMHistAnalysisOutputRelayMsgModule, svdDumpModule, TRGECLDQMModule, DQMHistAnalysisOutputFileModule, TRGCDCT2DDQMModule, DQMHistAnalysisOutputModule, SeqRootInputModule, TRGCDCT3DDQMModule, TRGGDLSummaryModule, HistoManagerModule, TRGCDCTSFDQMModule, TRGGDLDSTModule, PhysicsObjectsDQMModule, CalibrationCollectorModule, ARICHBackgroundModule, TRGECLUnpackerModule, EvReductionModule, Raw2DsModule, RawInputModule, StorageDeserializerModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, SerializerModule, FastRbuf2DsModule, Ds2SampleModule, DeSerializerPXDModule, Rbuf2RbufModule, GenRawSendModule, Rbuf2DsModule, TxSocketModule, Ds2RawModule, Ds2RawFileModule, DqmHistoManagerModule, Ds2RbufModule, StorageSerializerModule, GetEventFromSocketModule, ReceiveEventModule, ElapsedTimeModule, MonitorDataCOPPERModule, Root2RawModule, RxSocketModule, CertifyParallelModule, SeqRootMergerModule, DAQPerfModule, MonitorDataModule, TrackAnaModule, and PartialSeqRootReaderModule.

Definition at line 168 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 98 of file Module.cc.

◆ 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 135 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 115 of file Module.cc.

◆ getFileNames()

virtual std::vector<std::string> getFileNames ( __attribute__((unused)) 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.

Definition at line 136 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 189 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 281 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 383 of file Module.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 162 of file Module.cc.

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 87 of file Module.cc.

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 92 of file Module.cc.

◆ if_value()

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

Add a condition to the module.

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

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

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

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 81 of file Module.cc.

◆ saveSignals()

void saveSignals ( )

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

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

Definition at line 889 of file SVDDigitizerModule.cc.

◆ saveWaveforms()

void saveWaveforms ( )

Save waveforms to the statistics file.

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

Definition at line 851 of file SVDDigitizerModule.cc.

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 216 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 75 of file Module.cc.

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

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

Definition at line 216 of file Module.h.

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 236 of file Module.cc.

◆ setParamPythonDict()

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

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

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

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 229 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 222 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 50 of file Module.cc.

Member Data Documentation

◆ m_backplaneCapacitanceU

double m_backplaneCapacitanceU = 0.1
protected

The backplane capacitanceU wrt.

the strips.

Definition at line 207 of file SVDDigitizerModule.h.

◆ m_backplaneCapacitanceV

double m_backplaneCapacitanceV = 0.4
protected

The backplane capacitanceV wrt.

the strips.

Definition at line 213 of file SVDDigitizerModule.h.

◆ m_currentEventTime

float m_currentEventTime = 0.0
protected

Current event time.

This is what gets randomized if m_randomizeEventTimes is true.

Definition at line 167 of file SVDDigitizerModule.h.

◆ m_currentTime

double m_currentTime = 0
protected

Time of the current SimHit.

Definition at line 199 of file SVDDigitizerModule.h.

◆ m_elNoiseU

double m_elNoiseU = 500
protected

ADU equivalent charge for u-strips.

ADU equivalent charge for v-strips. Electronic noise for u-strips.

Definition at line 223 of file SVDDigitizerModule.h.

◆ m_segmentLength

double m_segmentLength = 0.020
protected

Max.

Segment length to use for charge drifting

Definition at line 132 of file SVDDigitizerModule.h.

◆ m_startSampling

double m_startSampling = -2.0
protected

Time window start.

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

Definition at line 173 of file SVDDigitizerModule.h.


The documentation for this class was generated from the following files:
Belle2::SVD::SVDDigitizerModule::m_segmentLength
double m_segmentLength
Max.
Definition: SVDDigitizerModule.h:132
Belle2::SVD::SVDDigitizerModule::m_mapping
DBObjPtr< PayloadFile > m_mapping
channel mapping payload
Definition: SVDDigitizerModule.h:230
Belle2::SVD::SVDDigitizerModule::m_applyPoisson
bool m_applyPoisson
Whether or not to apply poisson fluctuation of charge.
Definition: SVDDigitizerModule.h:138
Belle2::SVD::SVDDigitizerModule::m_storeWaveforms
bool m_storeWaveforms
Store waveform data in the reporting file?
Definition: SVDDigitizerModule.h:179
Belle2::SVD::SVDDigitizerModule::m_roundZS
bool m_roundZS
Round ZS cut to nearest ADU.
Definition: SVDDigitizerModule.h:144
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:216
Belle2::Module::c_ParallelProcessingCertified
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:82
Belle2::SVD::SVDDigitizerModule::m_rootFilename
std::string m_rootFilename
Name of the ROOT filename to output statistics.
Definition: SVDDigitizerModule.h:177
Belle2::SVD::SVDDigitizerModule::m_samplingTime
double m_samplingTime
Interval between two waveform samples (30 ns).
Definition: SVDDigitizerModule.h:154
Belle2::SVD::SVDDigitizerModule::m_randomizeEventTimes
bool m_randomizeEventTimes
Randomize event times? If set to true, event times will be randomized uniformly from m_minTimeFrame t...
Definition: SVDDigitizerModule.h:159
Belle2::SVD::SVDDigitizerModule::m_svdEventInfoName
std::string m_svdEventInfoName
Name of the SVDEventInfo object.
Definition: SVDDigitizerModule.h:128
Belle2::SVD::SVDDigitizerModule::m_storeSimHitsName
std::string m_storeSimHitsName
Name of the collection for the SVDSimhits.
Definition: SVDDigitizerModule.h:114
Belle2::Module::setPropertyFlags
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:210
Belle2::SVD::SVDDigitizerModule::m_xmlFileName
static std::string m_xmlFileName
< channel mapping xml filename
Definition: SVDDigitizerModule.h:229
Belle2::SVD::SVDDigitizerModule::m_storeShaperDigitsName
std::string m_storeShaperDigitsName
Name of the collection for the SVDShaperDigits.
Definition: SVDDigitizerModule.h:122
Belle2::SVD::SVDDigitizerModule::m_storeMCParticlesName
std::string m_storeMCParticlesName
Name of the collection for the MCParticles.
Definition: SVDDigitizerModule.h:112
Belle2::SVD::SVDDigitizerModule::m_signalsList
std::string m_signalsList
Name of the tab-delimited listing of signals.
Definition: SVDDigitizerModule.h:181
Belle2::SVD::SVDDigitizerModule::m_startSampling
double m_startSampling
Time window start.
Definition: SVDDigitizerModule.h:173
Belle2::SVD::SVDDigitizerModule::m_SNAdjacent
double m_SNAdjacent
Zero-suppression cut.
Definition: SVDDigitizerModule.h:142
Belle2::Module::Module
Module()
Constructor.
Definition: Module.cc:32
Belle2::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:562
Belle2::SVD::SVDDigitizerModule::m_shapingTime
double m_shapingTime
Shaping time of the APV25 shapers.
Definition: SVDDigitizerModule.h:152
Belle2::SVD::SVDDigitizerModule::m_maxTimeFrame
float m_maxTimeFrame
High edge of randomization time frame.
Definition: SVDDigitizerModule.h:163
Belle2::SVD::SVDDigitizerModule::m_nSamplesOverZS
unsigned short m_nSamplesOverZS
Keek digit if at least m_nSamplesOverZS are over threshold.
Definition: SVDDigitizerModule.h:146
Belle2::SVD::SVDDigitizerModule::m_applyNoise
bool m_applyNoise
Whether or not to apply Gaussian noise.
Definition: SVDDigitizerModule.h:140
Belle2::SVD::SVDDigitizerModule::m_minTimeFrame
float m_minTimeFrame
Low edge of randomization time frame.
Definition: SVDDigitizerModule.h:161
Belle2::SVD::SVDDigitizerModule::m_storeTrueHitsName
std::string m_storeTrueHitsName
Name of the collection for the SVDTrueHits.
Definition: SVDDigitizerModule.h:116
Belle2::SVD::SVDDigitizerModule::m_widthOfDiffusCloud
double m_widthOfDiffusCloud
Width of diffusion cloud for simple drift model (in sigmas)
Definition: SVDDigitizerModule.h:134