Belle II Software  release-06-00-14
DQMHistAnalysisPXDDAQModule Class Reference

DQM Histogram Analysis for PXD DAQ. More...

#include <DQMHistAnalysisPXDDAQ.h>

Inheritance diagram for DQMHistAnalysisPXDDAQModule:
Collaboration diagram for DQMHistAnalysisPXDDAQModule:

Public Types

enum  EParamType {
  c_ParamINT ,
  c_ParamFLOAT ,
  c_ParamTEXT
}
 The enumeration types for the module parameters. More...
 
typedef std::map< std::string, EParamTypeParamTypeList
 The type of list of module parameter types.
 
typedef std::map< std::string, int > IntValueList
 The type of list of integer module parameter.
 
typedef std::map< std::string, float > FloatValueList
 The type of list of float module parameter.
 
typedef std::map< std::string, std::string > TextList
 The type of list of string module parameter.
 
typedef std::map< std::string, TH1 * > HistList
 The type of list of histograms.
 
typedef std::map< std::string, MonitoringObject * > MonObjList
 The type of list of MonitoringObjects.
 
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

 DQMHistAnalysisPXDDAQModule ()
 Constructor.
 
 ~DQMHistAnalysisPXDDAQModule ()
 Destructor.
 
TCanvas * find_canvas (TString cname)
 Find canvas by name. More...
 
virtual std::vector< std::string > getFileNames (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 const HistListgetHistList ()
 Get the list of the histograms. More...
 
static const MonObjListgetMonObjList ()
 Get the list of MonitoringObjects. More...
 
static TH1 * findHist (const std::string &histname)
 Find histogram. More...
 
static TH1 * findHist (const std::string &dirname, const std::string &histname)
 Find histogram. More...
 
static TH1 * findHist (const TDirectory *histdir, const TString &histname)
 Find histogram. More...
 
static MonitoringObjectfindMonitoringObject (const std::string &objName)
 Find MonitoringObject. More...
 
static void setIntValue (const std::string &parname, int vint)
 Set the integer value of the parameter. More...
 
static void setFloatValue (const std::string &parname, float vfloat)
 Set the float value of the parameter. More...
 
static void setText (const std::string &parname, const std::string &text)
 Set the string value of the parameter. More...
 
static void addHist (const std::string &dirname, const std::string &histname, TH1 *h)
 Add histogram. More...
 
static MonitoringObjectgetMonitoringObject (const std::string &histname)
 Get MonitoringObject with given name (new object is created if non-existing) More...
 
static void resetHist ()
 Clear and reset the list of histograms.
 
static HistListgetHists ()
 Get the list of histograms. More...
 
static ParamTypeListgetParNames ()
 Get the list of the names and types of the parameters. More...
 
static IntValueListgetIntValues ()
 Get the list of integer parameters. More...
 
static FloatValueListgetFloatValues ()
 Get the list of float parameters. More...
 
static TextListgetTexts ()
 Get the list of string parameters. More...
 
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 (void) override final
 Module functions to be called from main process.
 
void beginRun (void) override final
 Module functions to be called from event process.
 
void event (void) override final
 This method is the core of the module. More...
 
void terminate (void) override final
 This method is called at the end of the event processing. 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

std::string m_histogramDirectoryName
 name of histogram directory
 
std::string m_pvPrefix
 prefix for EPICS PVs
 
TH1 * m_hDAQError = nullptr
 Histogram covering all error types.
 
TH2F * m_hMissingDHC = nullptr
 Histogram covering all DHC modules.
 
TH2F * m_hMissingDHE = nullptr
 Histogram covering all DHE modules.
 
TH1F * m_hMissingDHP = nullptr
 Histogram covering all modules*DHP.
 
TH1F * m_hStatistic = nullptr
 Histogram covering stat.
 
TCanvas * m_cDAQError = nullptr
 Final Canvas.
 
TCanvas * m_cMissingDHC = nullptr
 Final Canvas.
 
TCanvas * m_cMissingDHE = nullptr
 Final Canvas.
 
TCanvas * m_cMissingDHP = nullptr
 Final Canvas.
 
TCanvas * m_cStatistic = nullptr
 Final Canvas.
 
MonitoringObjectm_monObj {}
 Monitoring Object.
 
bool m_useEpics
 flag if to export to EPICS
 
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.
 

Static Private Attributes

static ParamTypeList g_parname
 The list of module parameter types.
 
static IntValueList g_vint
 The list of integer module parameter.
 
static FloatValueList g_vfloat
 The list of float module parameter.
 
static TextList g_text
 The list of string module parameter.
 
static HistList g_hist
 The list of histograms.
 
static MonObjList g_monObj
 The list of MonitoringObjects.
 

Detailed Description

DQM Histogram Analysis for PXD DAQ.

Definition at line 33 of file DQMHistAnalysisPXDDAQ.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

◆ EParamType

enum EParamType
inherited

The enumeration types for the module parameters.

Enumerator
c_ParamINT 

The integer type for module parameter.

c_ParamFLOAT 

The float type for module parameter.

c_ParamTEXT 

The string type for module parameter.

Definition at line 37 of file DQMHistAnalysis.h.

Member Function Documentation

◆ addHist()

void addHist ( const std::string &  dirname,
const std::string &  histname,
TH1 *  h 
)
staticinherited

Add histogram.

Parameters
dirnameThe name of the directory.
histnameThe name of the histogram.
hThe TH1 pointer for the histogram.

Definition at line 64 of file DQMHistAnalysis.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 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ endRun()

virtual void endRun ( void  )
inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

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

Definition at line 166 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

◆ event()

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

Reimplemented from Module.

Definition at line 110 of file DQMHistAnalysisPXDDAQ.cc.

111 {
112 // double data = 0.0;
113  if (m_cMissingDHP == nullptr || m_cMissingDHE == nullptr || m_cMissingDHC == nullptr
114  || m_cStatistic == nullptr) return; // we could assume this
115 
116  m_cDAQError->Clear();
117  m_cMissingDHP->Clear();
118  m_cMissingDHE->Clear();
119  m_cMissingDHC->Clear();
120  m_cStatistic->Clear();
121 
122 
123  {
124  std::string name = "PXDDAQError";
125 
126  if (m_hDAQError) { delete m_hDAQError; m_hDAQError = nullptr;}
127 
128  TH1* hh1 = findHist(name);
129  if (hh1 == NULL) {
130  hh1 = findHist(m_histogramDirectoryName, name);
131  }
132  m_cDAQError->cd();
133  if (hh1) {
134  m_hDAQError = (TH1F*)hh1->DrawClone("text");
135  m_hDAQError->SetName("hPXDDAQError");
136  m_hDAQError->SetTitle("PXD Fraction of DAQ Errors");
137  if (m_hDAQError->GetBinContent(0)) {
138  m_hDAQError->Scale(1.0 / m_hDAQError->GetBinContent(0));
139  }
140  m_hDAQError->Draw("text,hist");
141  }
142  }
143  {
144  // DHC histogram
145  std::string name = "PXDDAQDHCError";
146 
147  TH1* hh1 = findHist(name);
148  if (hh1 == NULL) {
149  hh1 = findHist(m_histogramDirectoryName, name);
150  }
151  m_cMissingDHC->cd();
152  if (hh1) {
153  auto events = hh1->GetBinContent(hh1->GetBin(-1, -1));
154  // first, we have to relate the per-DHC overflow (DHC object count) to the overall overflow (event count)
155  // second, we have to relate the "fake data" DHC bin to the per-DHC overflow (DHC object count)
156  m_hMissingDHC->Reset();
157  for (int i = 0; i < 16; i++) {
158  auto dhecount = hh1->GetBinContent(hh1->GetBin(i, -1));
159  if (events > 0) m_hMissingDHC->Fill((double)i, 0.0, 1.0 - dhecount / events);
160  // c_FAKE_NO_DATA_TRIG = 1ull << 29,
161  if (dhecount > 0) m_hMissingDHC->Fill((double)i, 1.0, hh1->GetBinContent(hh1->GetBin(i, 29) / dhecount));
162  }
163  m_hMissingDHC->Draw("text");
164  }
165  }
166 
167  {
168  // DHE histogram
169  std::string name = "PXDDAQDHEError";
170 
171  TH1* hh1 = findHist(name);
172  if (hh1 == NULL) {
173  hh1 = findHist(m_histogramDirectoryName, name);
174  }
175  m_cMissingDHE->cd();
176  if (hh1) {
177  auto events = hh1->GetBinContent(hh1->GetBin(-1, -1));
178  // first, we have to relate the per-DHE overflow (DHE object count) to the overall overflow (event count)
179  // second, we have to relate the "fake data" DHE bin to the per-DHE overflow (DHE object count)
180  m_hMissingDHE->Reset();
181  for (int i = 0; i < 64; i++) {
182  auto dhecount = hh1->GetBinContent(hh1->GetBin(i, -1));
183  if (events > 0) m_hMissingDHE->Fill((double)i, 0.0, 1.0 - dhecount / events);
184  // c_FAKE_NO_DATA_TRIG = 1ull << 29,
185  if (dhecount > 0) m_hMissingDHE->Fill((double)i, 1.0, hh1->GetBinContent(hh1->GetBin(i, 29) / dhecount));
186  }
187  m_hMissingDHE->Draw("text");
188  }
189  }
190 
191  {
192  // DHP histogram
193  if (m_hMissingDHP) { delete m_hMissingDHP; m_hMissingDHP = nullptr;}
194 
195  std::string name = "PXDDAQDHPDataMissing";
196 
197  TH1* hh1 = findHist(name);
198  if (hh1 == NULL) {
199  hh1 = findHist(m_histogramDirectoryName, name);
200  }
201  m_cMissingDHP->cd();
202  if (hh1) {
203  m_hMissingDHP = (TH1F*)hh1->DrawClone("text");
204  if (m_hMissingDHP->GetBinContent(0)) {
205  m_hMissingDHP->Scale(1.0 / m_hMissingDHP->GetBinContent(0));
206  m_hMissingDHP->Draw("text");
207  }
208  }
209  // double data = m_hMissingDHP->Max???;
210  //
211  // m_monObj->setVariable("missingDHPFraction", data);
212  //
213  m_cMissingDHP->Modified();
214  m_cMissingDHP->Update();
215  }
216 
217  double data_HLTRej = 0.0;
218  double data_Trunc = 0.0;
219  double data_HER_Trunc = 0.0;
220  double data_LER_Trunc = 0.0;
221  double data_CM63 = 0.0;
222  double data_HER_CM63 = 0.0;
223  double data_LER_CM63 = 0.0;
224  double data_HER_CM63_1ms = 0.0;
225  double data_LER_CM63_1ms = 0.0;
226  double data_HER_Trunc_1ms = 0.0;
227  double data_LER_Trunc_1ms = 0.0;
228  double data_MissFrame = 0.0;
229  double data_Timeout = 0.0;
230  double data_LinkDown = 0.0;
231  double data_Mismatch = 0.0;
232  double data_HER_Miss = 0.0;
233  double data_LER_Miss = 0.0;
234  double data_HER_Miss_1ms = 0.0;
235  double data_LER_Miss_1ms = 0.0;
236  double data_unused = 0.0;
237 
238  // Stat histogram
239  if (m_hStatistic) { delete m_hStatistic; m_hStatistic = nullptr;}
240 
241  std::string name = "PXDDAQStat";
242 
243  TH1* hh1 = findHist(name);
244  if (hh1 == NULL) {
245  hh1 = findHist(m_histogramDirectoryName, name);
246  }
247  m_cStatistic->cd();
248  if (hh1) {
249  m_hStatistic = (TH1F*)hh1->DrawClone("text");
250  if (m_hStatistic->GetBinContent(0)) {
251  m_hStatistic->Scale(1.0 / m_hStatistic->GetBinContent(0));
252  m_hStatistic->Draw("text");
253  }
254  double scale = hh1->GetBinContent(0);// underflow is event counter
255  if (scale != 0.0) scale = 1.0 / scale; // just avoid dive by zero
256  data_HLTRej = hh1->GetBinContent(1 + 0) * scale;
257  data_Trunc = hh1->GetBinContent(1 + 1) * scale;
258  data_HER_Trunc = hh1->GetBinContent(1 + 2) * scale;
259  data_LER_Trunc = hh1->GetBinContent(1 + 3) * scale;
260  data_CM63 = hh1->GetBinContent(1 + 4) * scale;
261  data_HER_CM63 = hh1->GetBinContent(1 + 5) * scale;
262  data_LER_CM63 = hh1->GetBinContent(1 + 6) * scale;
263  data_HER_CM63_1ms = hh1->GetBinContent(1 + 7) * scale;
264  data_LER_CM63_1ms = hh1->GetBinContent(1 + 8) * scale;
265  data_HER_Trunc_1ms = hh1->GetBinContent(1 + 9) * scale;
266  data_LER_Trunc_1ms = hh1->GetBinContent(1 + 10) * scale;
267  data_MissFrame = hh1->GetBinContent(1 + 11) * scale;
268  data_Timeout = hh1->GetBinContent(1 + 12) * scale;
269  data_LinkDown = hh1->GetBinContent(1 + 13) * scale;
270  data_Mismatch = hh1->GetBinContent(1 + 14) * scale;
271  data_HER_Miss = hh1->GetBinContent(1 + 15) * scale;
272  data_LER_Miss = hh1->GetBinContent(1 + 16) * scale;
273  data_HER_Miss_1ms = hh1->GetBinContent(1 + 17) * scale;
274  data_LER_Miss_1ms = hh1->GetBinContent(1 + 18) * scale;
275  data_unused = hh1->GetBinContent(1 + 19) * scale;
276  }
277 
278  m_monObj->setVariable("HLTReject", data_HLTRej);
279  m_monObj->setVariable("Trunc", data_Trunc);
280  m_monObj->setVariable("HER_Trunc", data_HER_Trunc);
281  m_monObj->setVariable("LER_Trunc", data_LER_Trunc);
282  m_monObj->setVariable("CM63", data_CM63);
283  m_monObj->setVariable("HER_CM63", data_HER_CM63);
284  m_monObj->setVariable("LER_CM63", data_LER_CM63);
285  m_monObj->setVariable("HER_CM63_1ms", data_HER_CM63_1ms);
286  m_monObj->setVariable("LER_CM63_1ms", data_LER_CM63_1ms);
287  m_monObj->setVariable("HER_Trunc_1ms", data_HER_Trunc_1ms);
288  m_monObj->setVariable("LER_Trunc_1ms", data_LER_Trunc_1ms);
289  m_monObj->setVariable("MissFrame", data_MissFrame);
290  m_monObj->setVariable("Timeout", data_Timeout);
291  m_monObj->setVariable("LinkDown", data_LinkDown);
292  m_monObj->setVariable("Mismatch", data_Mismatch);
293  m_monObj->setVariable("HER_Miss", data_HER_Miss);
294  m_monObj->setVariable("LER_Miss", data_LER_Miss);
295  m_monObj->setVariable("HER_Miss_1ms", data_HER_Miss_1ms);
296  m_monObj->setVariable("LER_Miss_1ms", data_LER_Miss_1ms);
297 
298  m_cStatistic->Modified();
299  m_cStatistic->Update();
300 
301 #ifdef _BELLE2_EPICS
302  if (m_useEpics) {
303  SEVCHK(ca_put(DBR_DOUBLE, mychid[0], (void*)&data_HLTRej), "ca_set failure");
304  SEVCHK(ca_put(DBR_DOUBLE, mychid[1], (void*)&data_Trunc), "ca_set failure");
305  SEVCHK(ca_put(DBR_DOUBLE, mychid[2], (void*)&data_HER_Trunc), "ca_set failure");
306  SEVCHK(ca_put(DBR_DOUBLE, mychid[3], (void*)&data_LER_Trunc), "ca_set failure");
307  SEVCHK(ca_put(DBR_DOUBLE, mychid[4], (void*)&data_CM63), "ca_set failure");
308  SEVCHK(ca_put(DBR_DOUBLE, mychid[5], (void*)&data_HER_CM63), "ca_set failure");
309  SEVCHK(ca_put(DBR_DOUBLE, mychid[6], (void*)&data_LER_CM63), "ca_set failure");
310  SEVCHK(ca_put(DBR_DOUBLE, mychid[7], (void*)&data_HER_CM63_1ms), "ca_set failure");
311  SEVCHK(ca_put(DBR_DOUBLE, mychid[8], (void*)&data_LER_CM63_1ms), "ca_set failure");
312  SEVCHK(ca_put(DBR_DOUBLE, mychid[9], (void*)&data_HER_Trunc_1ms), "ca_set failure");
313  SEVCHK(ca_put(DBR_DOUBLE, mychid[10], (void*)&data_LER_Trunc_1ms), "ca_set failure");
314  SEVCHK(ca_put(DBR_DOUBLE, mychid[11], (void*)&data_MissFrame), "ca_set failure");
315  SEVCHK(ca_put(DBR_DOUBLE, mychid[12], (void*)&data_Timeout), "ca_set failure");
316  SEVCHK(ca_put(DBR_DOUBLE, mychid[13], (void*)&data_LinkDown), "ca_set failure");
317  SEVCHK(ca_put(DBR_DOUBLE, mychid[14], (void*)&data_Mismatch), "ca_set failure");
318  SEVCHK(ca_put(DBR_DOUBLE, mychid[15], (void*)&data_HER_Miss), "ca_set failure");
319  SEVCHK(ca_put(DBR_DOUBLE, mychid[16], (void*)&data_LER_Miss), "ca_set failure");
320  SEVCHK(ca_put(DBR_DOUBLE, mychid[17], (void*)&data_HER_Miss_1ms), "ca_set failure");
321  SEVCHK(ca_put(DBR_DOUBLE, mychid[18], (void*)&data_LER_Miss_1ms), "ca_set failure");
322  SEVCHK(ca_put(DBR_DOUBLE, mychid[19], (void*)&data_unused), "ca_set failure");
323  // write out
324  SEVCHK(ca_pend_io(5.0), "ca_pend_io failure");
325  }
326 #endif
327 }
static TH1 * findHist(const std::string &histname)
Find histogram.
MonitoringObject * m_monObj
Monitoring Object.
std::string m_histogramDirectoryName
name of histogram directory
TH1F * m_hStatistic
Histogram covering stat.
TH2F * m_hMissingDHC
Histogram covering all DHC modules.
TH1 * m_hDAQError
Histogram covering all error types.
bool m_useEpics
flag if to export to EPICS
TH1F * m_hMissingDHP
Histogram covering all modules*DHP.
TH2F * m_hMissingDHE
Histogram covering all DHE modules.
void setVariable(const std::string &var, float val, float upErr=-1., float dwErr=-1)
set value to float variable (new variable is made if not yet existing)

◆ find_canvas()

TCanvas * find_canvas ( TString  cname)
inherited

Find canvas by name.

Parameters
cnameName of the canvas
Returns
The pointer to the canvas, or nullptr if not found.

Definition at line 50 of file DQMHistAnalysis.cc.

◆ findHist() [1/3]

TH1 * findHist ( const std::string &  dirname,
const std::string &  histname 
)
staticinherited

Find histogram.

Parameters
dirnameThe name of the directory.
histnameThe name of the histogram.
Returns
The found histogram, or nullptr if not found.

Definition at line 148 of file DQMHistAnalysis.cc.

◆ findHist() [2/3]

TH1 * findHist ( const std::string &  histname)
staticinherited

Find histogram.

Parameters
histnameThe name of the histogram.
Returns
The found histogram, or nullptr if not found.

Definition at line 101 of file DQMHistAnalysis.cc.

◆ findHist() [3/3]

TH1 * findHist ( const TDirectory *  histdir,
const TString &  histname 
)
staticinherited

Find histogram.

Parameters
histdirThe TDirectory of the directory.
histnameThe name of the histogram.
Returns
The found histogram, or nullptr if not found.

Definition at line 157 of file DQMHistAnalysis.cc.

◆ findMonitoringObject()

MonitoringObject * findMonitoringObject ( const std::string &  objName)
staticinherited

Find MonitoringObject.

Parameters
objNameThe name of the MonitoringObject.
Returns
The found MonitoringObject, or nullptr if not found.

Definition at line 171 of file DQMHistAnalysis.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 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

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


Definition at line 113 of file Module.cc.

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getFloatValues()

static FloatValueList& getFloatValues ( )
inlinestaticinherited

Get the list of float parameters.

Returns
The list of float parameters.

Definition at line 210 of file DQMHistAnalysis.h.

◆ getHistList()

const DQMHistAnalysisModule::HistList & getHistList ( )
staticinherited

Get the list of the histograms.

Returns
The list of the histograms.

Definition at line 90 of file DQMHistAnalysis.cc.

◆ getHists()

static HistList& getHists ( )
inlinestaticinherited

Get the list of histograms.

Returns
The list of histograms.

Definition at line 195 of file DQMHistAnalysis.h.

◆ getIntValues()

static IntValueList& getIntValues ( )
inlinestaticinherited

Get the list of integer parameters.

Returns
The list of integer parameters.

Definition at line 205 of file DQMHistAnalysis.h.

◆ getMonitoringObject()

MonitoringObject * getMonitoringObject ( const std::string &  histname)
staticinherited

Get MonitoringObject with given name (new object is created if non-existing)

Parameters
histnamename of MonitoringObject to get

Definition at line 73 of file DQMHistAnalysis.cc.

◆ getMonObjList()

const DQMHistAnalysisModule::MonObjList & getMonObjList ( )
staticinherited

Get the list of MonitoringObjects.

Returns
The list of the MonitoringObjects.

Definition at line 95 of file DQMHistAnalysis.cc.

◆ getName()

const std::string& getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getParNames()

static ParamTypeList& getParNames ( )
inlinestaticinherited

Get the list of the names and types of the parameters.

Returns
The list of the names and types of the parameters.

Definition at line 200 of file DQMHistAnalysis.h.

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getTexts()

static TextList& getTexts ( )
inlinestaticinherited

Get the list of string parameters.

Returns
The list of string parameters.

Definition at line 215 of file DQMHistAnalysis.h.

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

Add a condition to the module.

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

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

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

Parameters
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 79 of file Module.cc.

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

◆ setFloatValue()

void setFloatValue ( const std::string &  parname,
float  vfloat 
)
staticinherited

Set the float value of the parameter.

Parameters
parnameThe name of the parameter.
vfloatThe value to be set.

Definition at line 199 of file DQMHistAnalysis.cc.

◆ setIntValue()

void setIntValue ( const std::string &  parname,
int  vint 
)
staticinherited

Set the integer value of the parameter.

Parameters
parnameThe name of the parameter.
vintThe value to be set.

Definition at line 187 of file DQMHistAnalysis.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 73 of file Module.cc.

◆ setName()

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

Set the name of the module.

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

Definition at line 214 of file Module.h.

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

◆ setText()

void setText ( const std::string &  parname,
const std::string &  text 
)
staticinherited

Set the string value of the parameter.

Parameters
parnameThe name of the parameter.
textThe value to be set.

Definition at line 211 of file DQMHistAnalysis.cc.

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

◆ terminate()

void terminate ( void  )
finaloverrideprivatevirtual

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 from Module.

Definition at line 329 of file DQMHistAnalysisPXDDAQ.cc.


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