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

Plot each event with ROI and Pixels. More...

#include <PXDEventPlotModule.h>

Inheritance diagram for PXDEventPlotModule:
Collaboration diagram for PXDEventPlotModule:

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

 PXDEventPlotModule ()
 Constructor defining the parameters.
 
virtual std::vector< std::string > getFileNames (__attribute__((unused)) 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...
 
virtual void terminate ()
 This method is called at the end of the event processing. 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.
 

Private Member Functions

void initialize () override final
 Initialize the Module. More...
 
void event () override final
 This method is the core of the module. More...
 
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

VXD::GeoCachem_vxdGeometry
 the geometry
 
std::string m_storeRawHitsName
 PXDRawHits StoreArray name.
 
bool m_gateModeFlag {false}
 Flag for creating extra GM plots.
 
StoreObjPtr< EventMetaDatam_eventMetaData
 Event Metadata StorePtr.
 
StoreObjPtr< PXDDAQStatusm_storeDAQEvtStats
 Input array for DAQ Status.
 
StoreArray< PXDRawHitm_storeRawHits
 Storearray for raw pixels

 
StoreArray< RawFTSWm_rawTTD
 Input array for DAQ Status.
 
TCanvas * m_c {}
 list of canvases
 
std::map< VxdID, TH2F * > m_histos
 map for plots per modules
 
std::map< VxdID, TH2F * > m_histos_gm
 map for plots per modules with gm+
 
std::map< VxdID, TH2F * > m_histos_gm2
 map for plots per modules with gm-
 
TLine * m_l1 {}
 
TLine * m_l2 {}
 
TLine * m_l3 {}
 Lines to guide the eye in plots/canvases.
 
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

Plot each event with ROI and Pixels.

Definition at line 47 of file PXDEventPlotModule.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.

Member Function Documentation

◆ beginRun()

virtual void beginRun ( )
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.

Reimplemented in DQMHistAnalysisPXDTrackChargeModule, DQMHistOutputToEPICSModule, DQMHistInjectionModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisTrackingModule, PXDDigitizerModule, ECLDQMInjectionModule, PXDGatedModeDQMModule, PXDDAQDQMModule, PXDInjectionDQMModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, SVDDQMInjectionModule, PXDDQMEfficiencySelftrackModule, DQMHistComparitorModule, PXDDQMEfficiencyModule, PyModule, PXDGatedDHCDQMModule, PXDROIFinderAnalysisModule, AlignDQMModule, SVDDQMExpressRecoModule, DQMHistAnalysisInputRootFileModule, SVDDQMClustersOnTrackModule, SVDUnpackerDQMModule, TrackDQMModule, PXDTrackClusterDQMModule, PXDRawDQMModule, PXDclusterFilterModule, PXDdigiFilterModule, DQMHistAnalysisPXDERModule, PXDDQMCorrModule, PXDDQMExpressRecoModule, PXDROIDQMModule, PXDDQMClustersModule, DelayDQMModule, VXDDQMExpressRecoModule, vxdDigitMaskingModule, PXDRawDQMCorrModule, DQMHistAnalysisIPModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisExampleFlagsModule, V0ObjectsDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGGRLUnpackerModule, TRGCDCETFUnpackerModule, MaterialScanModule, TOPUnpackerModule, B2BIIConvertMdstModule, ECLWaveformFitModule, 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 >, SVDBackgroundModule, TOPTimeBaseCalibratorModule, TOPTBCComparatorModule, B2BIIFixMdstModule, ECLChargedPIDModule, SVDDigitizerModule, ARICHNtupleModule, ECLDigitizerModule, BeamBkgTagSetterModule, PXDBackgroundModule, ParticleKinematicFitterModule, ECLShowerShapeModule, TOPGainEfficiencyCalculatorModule, SoftwareTriggerModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, KLMClustersReconstructorModule, OpticalGunModule, SegmentNetworkProducerModule, TagVertexModule, CDCDedxValidationModule, TOPDQMModule, KLMDQMModule, CDCDQMModule, TOPDigitizerModule, TOPLaserHitSelectorModule, BKLMDigitAnalyzerModule, TOPModuleT0CalibratorModule, DQMHistAnalysisTRGGDLModule, GearboxModule, KLMUnpackerModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, ParticleVertexFitterModule, DQMHistAnalysisKLMModule, ECLCRFinderModule, KLMReconstructorModule, SVDUnpackerModule, TOPRawDigitConverterModule, DQMHistAnalysisCDCMonObjModule, ECLDigitizerPureCsIModule, ECLLocalRunCalibratorModule, KLMDigitizerModule, CDCCRTestModule, EKLMDataCheckerModule, TOPReconstructorModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, ECLDataAnalysisModule, KLMPackerModule, FullSimModule, TOPChannelMaskerModule, TRGGDLUnpackerModule, HLTDQM2ZMQModule, ECLShowerCorrectorModule, MdstPIDModule, SVDCoGTimeEstimatorModule, ARICHDigitizerModule, ARICHDQMModule, BelleMCOutputModule, CsIDigitizerModule, DQMHistAnalysisARICHModule, ECLDQMModule, TOPAlignerModule, ARICHFillHitsModule, ARICHPackerModule, ARICHReconstructorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, CDCCosmicAnalysisModule, ECLSplitterN1Module, PXDPerformanceModule, TOPPDFCheckerModule, ARICHRelateModule, CsIStudyModule, CDCPackerModule, DQMHistAnalysisMiraBelleModule, ECLDigitCalibratorModule, TOPPDFDebuggerModule, ARICHUnpackerModule, BKLMSimHistogrammerModule, SVDROIFinderAnalysisModule, VXDTFTrainingDataCollectorModule, ARICHMCParticlesModule, ARICHRateCalModule, CDCUnpackerModule, TOPBackgroundModule, TOPTimeRecalibratorModule, TrackFinderMCTruthRecoTracksModule, ReprocessorModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, EclDisplayModule, EvtGenDecayModule, EKLMADCModule, SVDDQMHitTimeModule, TOPDoublePulseGeneratorModule, SVDROIFinderModule, TRGCDCT3DConverterModule, TRGGRLMatchModule, BGOverlayExecutorModule, DQMHistAnalysisECLModule, ECLLocalMaximumFinderModule, SVDPackerModule, TOPBunchFinderModule, VXDSimpleClusterizerModule, ARICHRawUnpackerModule, NtuplePhase1_v6Module, TpcDigitizerModule, ExportGeometryModule, SoftwareTriggerHLTDQMModule, KLMClusterEfficiencyModule, CDCDedxDQMModule, SVDLocalCalibrationsMonitorModule, SVDPerformanceModule, TOPCalPulseGeneratorModule, TOPNtupleModule, TOPPackerModule, TOPWaveformFeatureExtractorModule, ExtModule, MCTrackCandClassifierModule, MuidModule, SPTCmomentumSeedRetrieverModule, TrackFinderVXDAnalizerModule, TRGTOPDQMModule, BeamBkgGeneratorModule, DQMHistAnalysisInputPVSrvModule, ECLClusterPSDModule, EventInfoPrinterModule, BKLMTrackingModule, KLMExpertModule, SVDOccupancyAnalysisModule, TOPInterimFENtupleModule, TOPMCTrackMakerModule, BGOverlayInputModule, CDCRecoTrackFilterModule, ECLBackgroundModule, ECLDQMEXTENDEDModule, EvtGenInputModule, OverrideGenerationFlagsModule, MCMatcherKLMClustersModule, PIDNtupleModule, SVDDataFormatCheckModule, SPTCvirtualIPRemoverModule, HitXPModule, arichBtestModule, BgoStudyModule, CsiStudy_v2Module, FANGSDigitizerModule, MicrotpcStudyModule, PlumeDigitizerModule, DQMHistAnalysisARICHMonObjModule, PXDClustersFromTracksModule, EventT0DQMModule, TOPXTalkChargeShareSetterModule, PXDROIFinderModule, VXDQualityEstimatorMVAModule, AnalysisPhase1StudyModule, DosiStudyModule, He3tubeStudyModule, ECLCovarianceMatrixModule, ECLFinalizerModule, ECLSplitterN2Module, KKGenInputModule, BKLMAnaModule, SVDLocalCalibrationsCheckModule, SVDClusterEvaluationTrueInfoModule, TOPTriggerDigitizerModule, TrackingPerformanceEvaluationModule, SecMapTrainerVXDTFModule, TRGECLRawdataAnalysisModule, TRGTOPUnpackerModule, BgoDigitizerModule, CsiDigitizer_v2Module, DosiDigitizerModule, TPCStudyModule, PinDigitizerModule, ECLShowerCalibratorModule, MVAExpertModule, MVAMultipleExpertsModule, SVDLatencyCalibrationModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, EffPlotsModule, SecMapTrainerBaseModule, He3DigitizerModule, DQMHistAnalysisMonObjModule, DQMHistSnapshotsModule, ECLUnpackerModule, MCMatcherECLClustersModule, KlongValidationModule, TOPCosmicT0FinderModule, TrackQualityEstimatorMVAModule, BeamabortStudyModule, ClawStudyModule, ClawsStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisHLTMonObjModule, IPDQMExpressRecoModule, PXDRawDQMChipsModule, SVDClusterCalibrationsMonitorModule, SVDMissingAPVsClusterCreatorModule, SectorMapBootstrapModule, CurlTaggerModule, BeamDigitizerModule, ECLPackerModule, EventLimiterModule, RandomBarrierModule, V0findingPerformanceEvaluationModule, DQMHistDeltaHistoModule, StatisticsSummaryModule, MVAPrototypeModule, DataWriterModule, SVDClusterFilterModule, SVDMaxStripTTreeModule, SVDShaperDigitsFromTracksModule, SVD3SamplesEmulatorModule, QualityEstimatorVXDModule, VXDQETrainingDataCollectorModule, MCMatcherTRGECLModule, TRGGDLModule, EventKinematicsModule, ClawDigitizerModule, ClawsDigitizerModule, ECLHitDebugModule, SubEventModule, SVDCoGTimeCalibrationsMonitorModule, SVDHotStripFinderModule, TOPLaserCalibratorModule, BeamSpotMonitorModule, TrackQETrainingDataCollectorModule, CDCTriggerNeuroDQMModule, TRGECLModule, FANGSStudyModule, QcsmonitorDigitizerModule, DQMHistAnalysisTOPModule, TOPChannelT0MCModule, B2BIIConvertBeamParamsModule, ProgressModule, TRGECLFAMModule, B2BIIMdstInputModule, CsiModule, CreateFieldMapModule, TRGGRLModule, DQMHistAnalysisSVDOnMiraBelleModule, Convert2RawDetModule, TRGGRLProjectsModule, TRGCDCModule, DQMHistAnalysisOutputMonObjModule, CosmicsAlignmentValidationModule, TRGCDCTSStreamModule, VXDMisalignmentModule, TreeFitterModule, DQMHistAnalysisInputModule, SwitchDataStoreModule, TRGECLQAMModule, TRGECLTimingCalModule, IoVDependentConditionModule, StatisticsTimingHLTDQMModule, PhysicsObjectsMiraBelleModule, KLMTriggerModule, cdcDQM7Module, DQMHistAnalysisInputSrvModule, SeqRootOutputModule, DQMHistAnalysisEventT0Module, DQMHistAnalysisSVDGeneralModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, HistoModule, TxModule, TRGGRLDQMModule, TRGGDLDQMModule, DQMHistAnalysisOutputNSMModule, DQMHistAnalysisPlotOnlyModule, DQMHistAnalysisSVDEfficiencyModule, RxModule, svdDumpModule, B2BIIMCParticlesMonitorModule, DQMHistAnalysisExampleModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisOutputFileModule, MCV0MatcherModule, TRGECLDQMModule, DQMHistAnalysisOutputModule, HistoManagerModule, SeqRootInputModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGGDLSummaryModule, PhysicsObjectsDQMModule, TRGCDCTSFDQMModule, TRGGDLDSTModule, CalibrationCollectorModule, DQMHistAnalysisHLTModule, CDCTriggerUnpackerModule, 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, Rbuf2DsModule, TxSocketModule, DqmHistoManagerModule, Ds2RawModule, Ds2RawFileModule, Ds2RbufModule, StorageSerializerModule, GetEventFromSocketModule, ReceiveEventModule, ElapsedTimeModule, GenRawSendModule, MonitorDataCOPPERModule, RxSocketModule, CertifyParallelModule, SeqRootMergerModule, DAQPerfModule, MonitorDataModule, TrackAnaModule, and PartialSeqRootReaderModule.

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

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

◆ event()

void event ( )
finaloverrideprivatevirtual

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

This method can be implemented by subclasses.

auto isher = it.GetIsHER(0);// TODO, differentiate HER and LER GM

Reimplemented from Module.

Definition at line 71 of file PXDEventPlotModule.cc.

72 {
73  unsigned int evtNr = m_eventMetaData->getEvent();
74  unsigned int evtRun = m_eventMetaData->getRun();
75 
76  for (auto h : m_histos) {
77  if (h.second) h.second->Reset();
78  }
79 
80  std::map <VxdID, bool> cm_map;
81  bool cm_flag = false;
82  for (auto& pkt : *m_storeDAQEvtStats) {
83  for (auto& dhc : pkt) {
84  for (auto& dhe : dhc) {
85  for (auto cm = dhe.cm_begin(); cm < dhe.cm_end(); ++cm) {
86  // uint8_t, uint16_t, uint8_t ; tuple of Chip ID (2 bit), Row (10 bit), Common Mode (6 bit)
87  if (std::get<2>(*cm) == 63) {
88  m_histos[dhe.getSensorID()]->Fill(std::get<1>(*cm), 252 + std::get<0>(*cm), std::get<2>(*cm));
89  cm_flag = true;
90  cm_map[dhe.getSensorID()] = true;
91  }
92  }
93  }
94  }
95  }
96 
97 // if( !cm_flag ) return;
98 
99  int tinj = -1, rgate = -1;
100  for (auto& it : m_rawTTD) {
101  // get last injection time
102  auto difference = it.GetTimeSinceLastInjection(0);
103  // check time overflow, too long ago
104  if (difference != 0x7FFFFFFF) {
106  float diff2 = difference / (508.877 / 4.); // 127MHz clock ticks to us, inexact rounding
107  int bunch_trg = it.GetBunchNumber(0);
108  int time_inj = it.GetTimeSinceLastInjection(0);
109  int bunch_inj = (bunch_trg - time_inj) % 1280;
110  if (bunch_inj < 0) bunch_inj += 1280;
111  rgate = bunch_inj / (1280. / 96.); // 0-96 ?
112  tinj = diff2;
113  }
114  break;
115  }
116 
117  for (auto& pix : m_storeRawHits) {
118  if (m_histos[pix.getSensorID()]) {
119  m_histos[pix.getSensorID()]->Fill(pix.getRow(), pix.getColumn(), pix.getCharge());
120  }
121  if (m_gateModeFlag) {
122  if (m_histos_gm[pix.getSensorID()]) {
123  int v = int(pix.getVCellID()) - rgate * 4;
124  if (v < 0) v += 768; // work only for inner modules
125  m_histos_gm[pix.getSensorID()]->Fill(v, pix.getColumn(), pix.getCharge());
126  }
127  if (m_histos_gm2[pix.getSensorID()]) {
128  int v = int(pix.getVCellID()) + rgate * 4;
129  if (v >= 768) v -= 768; // work only for outer modules
130  m_histos_gm2[pix.getSensorID()]->Fill(v, pix.getColumn(), pix.getCharge());
131  }
132  }
133  }
134 
135  string canvasname;
136  canvasname = std::string(Form("Run_%d_Evt_%d", evtRun, evtNr));
137 
138  gStyle->SetPalette(55);
139  gStyle->SetOptStat(0);
140 
141  {
142  m_c->Clear();
143  m_c->Divide(4, 5);
144  m_c->cd(0);
145  if (cm_flag) {
146  m_c->Pad()->SetFrameLineColor(kRed);
147  m_c->Pad()->SetFrameBorderSize(4);
148  m_c->Pad()->SetFrameBorderMode(4);
149  m_c->SetFrameLineColor(kRed);
150  m_c->SetFrameBorderSize(4);
151  m_c->SetFrameBorderMode(4);
152  }
153  int i = 1;
154 
155  for (auto h : m_histos) {
156  m_c->cd(i++);
157  if (h.second) {
158  string abc = string(h.first);
159  auto dhe = (*m_storeDAQEvtStats).findDHE(h.first);
160  if (dhe) {
161 
162  auto tg = dhe->getTriggerGate();
163  auto fn = dhe->getFrameNr();
164  auto err = dhe->getEndErrorInfo();
165 
166  abc += Form(" ERR: $%X TG: %d FN: %d IN: %d GA: %d", err, tg, fn, tinj, rgate);
167  for (auto itdhp = dhe->cbegin(); itdhp != dhe->cend(); ++itdhp) {
168  abc += Form("(%d) %d ", itdhp->getChipID(), itdhp->getFrameNr());
169  }
170  if (err != 0) {
171  m_c->Pad()->SetFillColor(kYellow);
172  }
173  if (cm_map[h.first]) {
174  m_c->Pad()->SetFillColor(kRed);
175  m_c->Pad()->SetFrameFillColor(kWhite);
176  }
177  }
178  h.second->SetTitle(abc.data());
179  h.second->Draw("colz");
180  m_l1->Draw();
181  m_l2->Draw();
182  m_l3->Draw();
183  }
184  }
185  m_c->cd(0);
186  m_c->Print((canvasname + ".png").data());
187  m_c->Print((canvasname + ".pdf").data());
188  m_c->Print((canvasname + ".root").data());
189  }
190  if (m_gateModeFlag) {
191  m_c->Clear();
192  m_c->Divide(4, 5);
193  m_c->cd(0);
194  if (cm_flag) {
195  m_c->Pad()->SetFrameLineColor(kRed);
196  m_c->Pad()->SetFrameBorderSize(4);
197  m_c->Pad()->SetFrameBorderMode(4);
198  m_c->SetFrameLineColor(kRed);
199  m_c->SetFrameBorderSize(4);
200  m_c->SetFrameBorderMode(4);
201  }
202  int i = 1;
203 
204  for (auto h : m_histos_gm) {
205  m_c->cd(i++);
206  if (h.second) {
207  string abc = string(h.first);
208  auto dhe = (*m_storeDAQEvtStats).findDHE(h.first);
209  if (dhe) {
210 
211  auto tg = dhe->getTriggerGate();
212  auto fn = dhe->getFrameNr();
213  auto err = dhe->getEndErrorInfo();
214 
215  abc += Form(" ERR: $%X TG: %d FN: %d IN: %d GA: %d", err, tg, fn, tinj, rgate);
216  for (auto itdhp = dhe->cbegin(); itdhp != dhe->cend(); ++itdhp) {
217  abc += Form("(%d) %d ", itdhp->getChipID(), itdhp->getFrameNr());
218  }
219  if (err != 0) {
220  m_c->Pad()->SetFillColor(kYellow);
221  }
222  if (cm_map[h.first]) {
223  m_c->Pad()->SetFillColor(kRed);
224  m_c->Pad()->SetFrameFillColor(kWhite);
225  }
226  }
227  h.second->SetTitle(abc.data());
228  h.second->Draw("colz");
229  m_l1->Draw();
230  m_l2->Draw();
231  m_l3->Draw();
232  }
233  }
234  m_c->cd(0);
235  m_c->Print((canvasname + "_gm.png").data());
236  m_c->Print((canvasname + "_gm.pdf").data());
237  m_c->Print((canvasname + "_gm.root").data());
238  }
239  if (m_gateModeFlag) {
240  m_c->Clear();
241  m_c->Divide(4, 5);
242  m_c->cd(0);
243  if (cm_flag) {
244  m_c->Pad()->SetFrameLineColor(kRed);
245  m_c->Pad()->SetFrameBorderSize(4);
246  m_c->Pad()->SetFrameBorderMode(4);
247  m_c->SetFrameLineColor(kRed);
248  m_c->SetFrameBorderSize(4);
249  m_c->SetFrameBorderMode(4);
250  }
251  int i = 1;
252 
253  for (auto h : m_histos_gm2) {
254  m_c->cd(i++);
255  if (h.second) {
256  string abc = string(h.first);
257  auto dhe = (*m_storeDAQEvtStats).findDHE(h.first);
258  if (dhe) {
259 
260  auto tg = dhe->getTriggerGate();
261  auto fn = dhe->getFrameNr();
262  auto err = dhe->getEndErrorInfo();
263 
264  abc += Form(" ERR: $%X TG: %d FN: %d IN: %d GA: %d", err, tg, fn, tinj, rgate);
265  for (auto itdhp = dhe->cbegin(); itdhp != dhe->cend(); ++itdhp) {
266  abc += Form("(%d) %d ", itdhp->getChipID(), itdhp->getFrameNr());
267  }
268  if (err != 0) {
269  m_c->Pad()->SetFillColor(kYellow);
270  }
271  if (cm_map[h.first]) {
272  m_c->Pad()->SetFillColor(kRed);
273  m_c->Pad()->SetFrameFillColor(kWhite);
274  }
275  }
276  h.second->SetTitle(abc.data());
277  h.second->Draw("colz");
278  m_l1->Draw();
279  m_l2->Draw();
280  m_l3->Draw();
281  }
282  }
283  m_c->cd(0);
284  m_c->Print((canvasname + "_gm2.png").data());
285  m_c->Print((canvasname + "_gm2.pdf").data());
286  m_c->Print((canvasname + "_gm2.root").data());
287  }
288 }

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

◆ initialize()

void initialize ( )
finaloverrideprivatevirtual

Initialize the Module.

This method is called once before the actual event processing starts. Use this method to initialize variables, open files etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 40 of file PXDEventPlotModule.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.

◆ terminate()

virtual void terminate ( )
inlinevirtualinherited

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

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented in ROIDQMModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistOutputToEPICSModule, DQMHistInjectionModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PyModule, PXDDQMEfficiencyNtupleSelftrackModule, DQMHistComparitorModule, PXDDQMEfficiencyNtupleModule, DQMHistAnalysisInputRootFileModule, PXDROIFinderAnalysisModule, ROISenderModule, PXDUnpackerModule, PXDUnpackerOTModule, PXDPackerErrModule, PXDPackerModule, SVDDQMExpressRecoModule, DQMHistAnalysisPXDERModule, SVDDQMClustersOnTrackModule, PXDReadRawONSENModule, PXDReadRawBonnDAQMatchedModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisIPModule, PXDReadRawBonnDAQModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisExampleFlagsModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGGRLUnpackerModule, TRGCDCETFUnpackerModule, CDCTriggerUnpackerModule, 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 >, SpacePoint2TrueHitConnectorModule, ECLWaveformFitModule, TOPTimeBaseCalibratorModule, B2BIIConvertMdstModule, TOPTBCComparatorModule, ECLChargedPIDModule, SVDBackgroundModule, B2BIIFixMdstModule, ARICHNtupleModule, ParticleLoaderModule, BeamBkgTagSetterModule, ECLDigitizerModule, SVDDigitizerModule, CDCTriggerHoughETFModule, TOPGainEfficiencyCalculatorModule, CDCTrigger2DFinderModule, OpticalGunModule, ARICHDigitizerModule, KLMClustersReconstructorModule, CDCDedxValidationModule, ParticleKinematicFitterModule, TOPDQMModule, ECLShowerShapeModule, CDCDQMModule, TOPLaserHitSelectorModule, KLMDQMModule, PXDBackgroundModule, TOPModuleT0CalibratorModule, DQMHistAnalysisTRGGDLModule, CDCDedxPIDModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, TOPReconstructorModule, DATCONTrackingModule, BKLMDigitAnalyzerModule, TOPRawDigitConverterModule, ARICHFillHitsModule, DQMHistAnalysisCDCMonObjModule, KLMUnpackerModule, DQMHistAnalysisKLMModule, KLMReconstructorModule, ARICHReconstructorModule, CDCCRTestModule, KLMDigitizerModule, SoftwareTriggerModule, EKLMDataCheckerModule, TOPPDFDebuggerModule, ARICHDQMModule, DQMHistAnalysisARICHModule, KLMPackerModule, MdstPIDModule, FullSimModule, TOPAlignerModule, TOPBackgroundModule, ARICHPackerModule, BeamBkgMixerModule, ECLDigitizerPureCsIModule, TOPPDFCheckerModule, ARICHRelateModule, BelleMCOutputModule, BeamBkgHitRateMonitorModule, CDCPackerModule, DQMHistAnalysisMiraBelleModule, GFTC2SPTCConverterModule, ARICHUnpackerModule, ECLCRFinderModule, ARICHMCParticlesModule, ARICHRateCalModule, CDCUnpackerModule, CsIDigitizerModule, TOPDoublePulseGeneratorModule, SVDROIFinderAnalysisModule, BGOverlayExecutorModule, CDCCosmicAnalysisModule, ECLDataAnalysisModule, EclDisplayModule, VXDDedxPIDModule, ARICHRawUnpackerModule, NtuplePhase1_v6Module, ECLChargedPIDDataAnalysisValidationModule, ECLShowerCorrectorModule, EvtGenDecayModule, EKLMADCModule, HitLevelInfoWriterModule, SVDCoGTimeEstimatorModule, TOPCalPulseGeneratorModule, TOPNtupleModule, TOPPackerModule, TOPWaveformFeatureExtractorModule, SVDROIFinderModule, ParticleWeightingLookUpCreatorModule, BeamBkgGeneratorModule, RootOutputModule, TOPInterimFENtupleModule, TOPMCTrackMakerModule, BGOverlayInputModule, CsIStudyModule, ECLDigitCalibratorModule, ECLSplitterN1Module, ProfileModule, KLMClusterEfficiencyModule, PIDNtupleModule, VXDTFTrainingDataCollectorModule, arichBtestModule, CDCDigitizerModule, TpcDigitizerModule, ECLDQMModule, OverrideGenerationFlagsModule, BKLMSimHistogrammerModule, MCMatcherKLMClustersModule, DQMHistAnalysisARICHMonObjModule, PXDPerformanceModule, TOPBunchFinderModule, TOPTriggerDigitizerModule, TrackFinderVXDAnalizerModule, FlavorTaggerInfoFillerModule, HLTDQM2ZMQModule, ECLChargedPIDDataAnalysisModule, FragmentationModule, TOPCosmicT0FinderModule, TRGGRLMatchModule, ReprocessorModule, FANGSDigitizerModule, CDCRecoTrackFilterModule, IPDQMExpressRecoModule, ECLLocalMaximumFinderModule, CDCDedxCorrectionModule, CDCDedxDQMModule, DQMHistAnalysisMonObjModule, ECLClusterPSDModule, ExtModule, MCTrackCandClassifierModule, MuidModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisHLTMonObjModule, BKLMTrackingModule, SVDROIFinderAnalysisDataModule, HitXPModule, DQMHistAnalysisECLModule, ECLBackgroundModule, BabayagaNLOInputModule, EventT0DQMModule, SVDDataFormatCheckModule, TOPLaserCalibratorModule, SecMapTrainerVXDTFModule, arichToNtupleModule, BgoStudyModule, CsiStudy_v2Module, MicrotpcStudyModule, PlumeDigitizerModule, PXDClustersFromTracksModule, SVDClusterEvaluationTrueInfoModule, TOPXTalkChargeShareSetterModule, SecMapTrainerBaseModule, SegmentNetworkAnalyzerModule, TRGGDLUnpackerModule, TRGTOPDQMModule, AnalysisPhase1StudyModule, DosiStudyModule, He3tubeStudyModule, ECLCovarianceMatrixModule, ECLFinalizerModule, ECLSplitterN2Module, MCMatcherECLClustersModule, RootInputModule, BKLMAnaModule, MVAExpertModule, MVAMultipleExpertsModule, KLMExpertModule, SVDHotStripFinderModule, TOPChannelT0MCModule, NoKickCutsEvalModule, TRGECLRawdataAnalysisModule, TRGTOPUnpackerModule, TPCStudyModule, ECLDQMEXTENDEDModule, ECLShowerCalibratorModule, ECLTrackClusterMatchingModule, PhokharaInputModule, CDCDedxSkimCDSTModule, SVDPackerModule, CurlingTrackCandSplitterModule, SpacePointCreatorTestModule, MLSegmentNetworkProducerModule, BgoDigitizerModule, CsiDigitizer_v2Module, DosiDigitizerModule, PinDigitizerModule, HLTDs2ZMQModule, TeeggInputModule, KlongValidationModule, SVDPerformanceModule, MCMatcherTRGECLModule, ParticleStatsModule, BeamabortStudyModule, ClawStudyModule, ClawsStudyModule, PindiodeStudyModule, QcsmonitorStudyModule, DQMHistAnalysisInputPVSrvModule, ECLHitDebugModule, AsyncWrapper, HepMCOutputModule, KKGenInputModule, CombinedPIDPerformanceModule, SVDOccupancyAnalysisModule, SVDSpacePointCreatorModule, TrackingPerformanceEvaluationModule, CurlTaggerModule, BHWideInputModule, PXDSpacePointCreatorModule, CDCDedxSkimModule, EffPlotsModule, CDCTriggerTSFFirmwareModule, ParticleMCDecayStringModule, VariablesToNtupleModule, BeamDigitizerModule, He3DigitizerModule, CDCCrossTalkAdderModule, ECLUnpackerModule, BBBremInputModule, GeneratedVertexDisplacerModule, KoralWInputModule, DataWriterModule, FullSimTimingModule, SVDCrossTalkFinderModule, SVDClusterFilterModule, SVDShaperDigitsFromTracksModule, SVD3SamplesEmulatorModule, RT2SPTCConverterModule, FastBDTClassifierTrainingModule, TRGGDLModule, EventKinematicsModule, CDCInitialT0DeterminationModule, DisplayModule, SVDChannelMappingModule, SVDClusterQualityEstimatorCalibrationModule, SVDSpacePointQICalibrationModule, ROIReadTestModule, TRGCDCT3DConverterModule, TRGECLModule, CosmicsAlignmentValidationModule, ClawDigitizerModule, ClawsDigitizerModule, FANGSStudyModule, ECLPackerModule, ECLTRGInformationModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, V0findingPerformanceEvaluationModule, RemoveParticlesNotInListsModule, QcsmonitorDigitizerModule, DQMHistSnapshotsModule, ECLFillCellIdMappingModule, HepMCInputModule, HepevtOutputModule, RemoveMCParticlesModule, SVDChargeSharingAnalysisModule, VXDQETrainingDataCollectorModule, CsiModule, AafhInputModule, BeamSpotMonitorModule, TrackQETrainingDataCollectorModule, TRGGRLModule, VariablesToHistogramModule, ECLTrackClusterMatchingParametrizationExpertModule, RandomBarrierModule, CRYInputModule, MasterClassModule, GenfitVisModule, SPTCRefereeModule, FillTrackFitNtupleModule, TRGGRLProjectsModule, DQMHistDeltaHistoModule, GeneratorPreselectionModule, TCConvertersTestModule, TRGCDCModule, TRGECLFAMModule, VariablesToEventBasedTreeModule, B2BIIMdstInputModule, SubEventModule, TrepsInputModule, CDCDedxScanModule, CDCTriggerNeuroDQMModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisTOPModule, ECLCompressBGOverlayModule, ECLMatchingPerformanceExpertModule, TRGCDCTSStreamModule, ParticleMassUpdaterModule, SkimFilterModule, SVDClusterQualityEstimatorModule, MCV0MatcherModule, ECLDigiStudyModule, TrackFilterModule, EclCovMatrixNtupleModule, Convert2RawDetModule, TOPRingPlotterModule, PhaseSpaceAnalysisModule, TreeFitterModule, TRGECLQAMModule, TRGECLTimingCalModule, DQMHistAnalysisOutputMonObjModule, SoftwareTriggerResultPrinterModule, SVDMaxStripTTreeModule, FastBDTClassifierAnalyzerModule, VXDMisalignmentModule, StandardTrackingPerformanceModule, cdcDQM7Module, DQMHistAnalysisInputModule, SwitchDataStoreModule, DQMHistAnalysisEventT0Module, ECLTrackClusterMatchingPerformanceModule, HistoModule, ZMQRxOutputModule, ZMQTxInputModule, SPTC2GFTCConverterModule, TRGGRLDQMModule, PhysicsObjectsMiraBelleModule, ZMQRxWorkerModule, SPTC2RTConverterModule, TRGGDLDQMModule, KLMTriggerModule, DQMHistAnalysisInputSrvModule, ProgressBarModule, SeqRootOutputModule, GeometryModule, CDCTriggerTSFModule, DQMHistAnalysisSVDGeneralModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, TxModule, SVDPerformanceTTreeModule, CDCTriggerNeuroTrainerModule, B2BIIMCParticlesMonitorModule, ZMQTxWorkerModule, Root2BinaryModule, ScanCDCGeoModule, DQMHistAnalysisOutputNSMModule, DQMHistAnalysisPlotOnlyModule, DQMHistAnalysisSVDEfficiencyModule, RxModule, svdDumpModule, TRGECLDQMModule, GRLNeuroTrainerModule, DQMHistAnalysisExampleModule, DQMHistAnalysisOutputRelayMsgModule, CheckErrorEventModule, DQMHistAnalysisOutputFileModule, TRGCDCT2DDQMModule, StudyMaterialEffectsModule, TRGCDCT3DDQMModule, TRGGDLSummaryModule, DQMHistAnalysisOutputModule, HistoManagerModule, SeqRootInputModule, TRGCDCTSFDQMModule, TRGGDLDSTModule, PhysicsObjectsDQMModule, CollectorTestModule, CalibrationCollectorModule, ARICHBackgroundModule, EvReductionModule, Raw2DsModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, RawInputModule, StorageDeserializerModule, TRGECLUnpackerModule, SerializerModule, FastRbuf2DsModule, Ds2SampleModule, DeSerializerPXDModule, GenRawSendModule, DeSerializerModule, Rbuf2RbufModule, Rbuf2DsModule, TxSocketModule, DqmHistoManagerModule, Ds2RawModule, Ds2RawFileModule, Ds2RbufModule, Root2RawModule, StorageSerializerModule, GetEventFromSocketModule, ReceiveEventModule, ElapsedTimeModule, MonitorDataCOPPERModule, RxSocketModule, CertifyParallelModule, SeqRootMergerModule, DAQPerfModule, MonitorDataModule, TrackAnaModule, and PartialSeqRootReaderModule.

Definition at line 178 of file Module.h.


The documentation for this class was generated from the following files:
Belle2::PXD::PXDEventPlotModule::m_storeRawHits
StoreArray< PXDRawHit > m_storeRawHits
Storearray for raw pixels
Definition: PXDEventPlotModule.h:72
Belle2::PXD::PXDEventPlotModule::m_eventMetaData
StoreObjPtr< EventMetaData > m_eventMetaData
Event Metadata StorePtr.
Definition: PXDEventPlotModule.h:66
Belle2::PXD::PXDEventPlotModule::m_l3
TLine * m_l3
Lines to guide the eye in plots/canvases.
Definition: PXDEventPlotModule.h:82
Belle2::PXD::PXDEventPlotModule::m_rawTTD
StoreArray< RawFTSW > m_rawTTD
Input array for DAQ Status.
Definition: PXDEventPlotModule.h:75
Belle2::PXD::PXDEventPlotModule::m_gateModeFlag
bool m_gateModeFlag
Flag for creating extra GM plots.
Definition: PXDEventPlotModule.h:64
Belle2::PXD::PXDEventPlotModule::m_histos
std::map< VxdID, TH2F * > m_histos
map for plots per modules
Definition: PXDEventPlotModule.h:78
Belle2::PXD::PXDEventPlotModule::m_histos_gm
std::map< VxdID, TH2F * > m_histos_gm
map for plots per modules with gm+
Definition: PXDEventPlotModule.h:79
Belle2::PXD::PXDEventPlotModule::m_histos_gm2
std::map< VxdID, TH2F * > m_histos_gm2
map for plots per modules with gm-
Definition: PXDEventPlotModule.h:80
Belle2::PXD::PXDEventPlotModule::m_storeDAQEvtStats
StoreObjPtr< PXDDAQStatus > m_storeDAQEvtStats
Input array for DAQ Status.
Definition: PXDEventPlotModule.h:69
Belle2::PXD::PXDEventPlotModule::m_c
TCanvas * m_c
list of canvases
Definition: PXDEventPlotModule.h:77