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

DQM Histogram Analysis for PXD Efficiency. More...

#include <DQMHistAnalysisPXDEff.h>

Inheritance diagram for DQMHistAnalysisPXDEffModule:
Collaboration diagram for DQMHistAnalysisPXDEffModule:

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

 DQMHistAnalysisPXDEffModule ()
 Constructor.
 
 ~DQMHistAnalysisPXDEffModule ()
 Destructor.
 
virtual std::vector< std::string > getFileNames (__attribute__((unused)) bool outputFiles)
 Return a list of output filenames for this modules. More...
 
virtual void endRun ()
 This method is called if the current run ends. More...
 
const std::string & getName () const
 Returns the name of the module. More...
 
const std::string & getType () const
 Returns the type of the module (i.e. More...
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module. More...
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties. More...
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level. More...
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module. More...
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module. More...
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module. More...
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More...
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished. More...
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module. More...
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter. More...
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module. More...
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module. More...
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters. More...
 

Static Public Member Functions

static 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
 
bool m_singleHists
 Flag to trigger creation of additional histograms.
 
int m_u_bins
 u binning for 2d plots
 
int m_v_bins
 v binning for 2d plots
 
double m_confidence
 confidence level for error bars
 
double m_warnlevel
 warn level for alarm
 
double m_errorlevel
 error level for alarm
 
int m_minEntries = 1000
 Update entry intervall.
 
std::vector< VxdIDm_PXDModules
 IDs of all PXD Modules to iterate over.
 
std::map< VxdID, TEfficiency * > m_hEffModules
 Individual efficiency for each module, 2d histogram.
 
std::map< VxdID, TCanvas * > m_cEffModules
 Individual efficiency for each module, canvas.
 
TEfficiency * m_hEffAll = nullptr
 One bin for each module in the geometry.
 
TCanvas * m_cEffAll = nullptr
 Final Canvas.
 
TH1 * m_hEffAllLastTotal = nullptr
 TH1, last state, total.
 
TH1 * m_hEffAllLastPassed = nullptr
 TH1, last state, passed.
 
TEfficiency * m_hEffAllUpdate = nullptr
 Efficiency, last state, updated.
 
TCanvas * m_cEffAllUpdate = nullptr
 Final Canvas for Update.
 
TLine * m_line_warn {}
 TLine object for warning limit.
 
TLine * m_line_error {}
 TLine object for error error.
 
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 Efficiency.

Definition at line 29 of file DQMHistAnalysisPXDEff.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.

◆ 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 33 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 46 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 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 ( 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.

TODO: one value per module, and please change to the "delta" instead of integral

FIXME: absolute numbers or relative numbers and what is the acceptable limit?

check for val > 0.0) { would exclude all zero efficient modules!!!

check for val > 0.0) { would exclude all zero efficient modules!!!

we wont use "white" =1 in this module

Reimplemented from Module.

Definition at line 219 of file DQMHistAnalysisPXDEff.cc.

220 {
221 
222  //Save the pointers to create the summary hists later
223  std::map<VxdID, TH1*> mapHits;
224  std::map<VxdID, TH1*> mapMatches;
225 
226  //Count how many of each type of histogram there are for the averaging
227  //std::map<std::string, int> typeCounter;
228 
229  for (unsigned int i = 1; i <= m_PXDModules.size(); i++) {
230  VxdID& aPXDModule = m_PXDModules[i - 1];
231 
232  TString buff = (std::string)aPXDModule;
233  buff.ReplaceAll(".", "_");
234 
235  TH1* Hits, *Matches;
236  TString locationHits = "track_hits_" + buff;
237  if (m_histogramDirectoryName != "") {
238  locationHits = m_histogramDirectoryName + "/" + locationHits;
239  }
240  Hits = (TH1*)findHist(locationHits.Data());
241  TString locationMatches = "matched_cluster_" + buff;
242  if (m_histogramDirectoryName != "") {
243  locationMatches = m_histogramDirectoryName + "/" + locationMatches;
244  }
245  Matches = (TH1*)findHist(locationMatches.Data());
246 
247  //Finding only one of them should only happen in very strange situations...
248  if (Hits == nullptr || Matches == nullptr) {
249  B2ERROR("Missing histogram for sensor " << aPXDModule);
250  mapHits[aPXDModule] = nullptr;
251  mapMatches[aPXDModule] = nullptr;
252  } else {
253  mapHits[aPXDModule] = Hits;
254  mapMatches[aPXDModule] = Matches;
255  if (m_singleHists) {
256  if (m_cEffModules[aPXDModule] && m_hEffModules[aPXDModule]) {// this check creates them with a nullptr ..bad
257  m_hEffModules[aPXDModule]->SetTotalHistogram(*Hits, "f");
258  m_hEffModules[aPXDModule]->SetPassedHistogram(*Matches, "f");
259 
260  m_cEffModules[aPXDModule]->cd();
261  m_hEffModules[aPXDModule]->Draw("colz");
262  m_cEffModules[aPXDModule]->Modified();
263  m_cEffModules[aPXDModule]->Update();
264  }
265  }
266  }
267  }//One-Module histos finished
268 
269  double stat_data = 0;
270  bool error_flag = false;
271  bool warn_flag = false;
272  double all = 0.0;
273 
274  double imatch = 0.0, ihit = 0.0;
275  int ieff = 0;
276 
277  std::map <VxdID, bool> updated{}; // init to false
278  for (unsigned int i = 0; i < m_PXDModules.size(); i++) {
279  VxdID& aModule = m_PXDModules[i];
280  int j = i + 1;
281 
282  if (mapHits[aModule] == nullptr || mapMatches[aModule] == nullptr) {
283  m_hEffAll->SetPassedEvents(j, 0); // order, otherwise it might happen that SetTotalEvents is NOT filling the value!
284  m_hEffAll->SetTotalEvents(j, 0);
285  } else {
286  double nmatch = mapMatches[aModule]->Integral(); // GetEntries()?
287  double nhit = mapHits[aModule]->Integral();
288  if (nmatch > 10 && nhit > 10) { // could be zero, too
289  imatch += nmatch;
290  ihit += nhit;
291  ieff++; // only count in modules working
292  double var_e = nmatch / nhit; // can never be zero
293  if (j == 6) continue; // workaround for 1.3.2 module
294  m_monObj->setVariable(Form("efficiency_%d_%d_%d", aModule.getLayerNumber(), aModule.getLadderNumber(), aModule.getSensorNumber()),
295  var_e);
296  }
297 
299  all += ihit;
300  m_hEffAll->SetPassedEvents(j, 0); // otherwise it might happen that SetTotalEvents is NOT filling the value!
301  m_hEffAll->SetTotalEvents(j, nhit);
302  m_hEffAll->SetPassedEvents(j, nmatch);
303 
304  if (nhit < m_minEntries) {
305  // update the first entries directly (short runs)
306  m_hEffAllUpdate->SetPassedEvents(j, 0); // otherwise it might happen that SetTotalEvents is NOT filling the value!
307  m_hEffAllUpdate->SetTotalEvents(j, nhit);
308  m_hEffAllUpdate->SetPassedEvents(j, nmatch);
309  m_hEffAllLastTotal->SetBinContent(j, nhit);
310  m_hEffAllLastPassed->SetBinContent(j, nmatch);
311  updated[aModule] = true;
312  } else if (nhit - m_hEffAllLastTotal->GetBinContent(j) > m_minEntries) {
313  m_hEffAllUpdate->SetPassedEvents(j, 0); // otherwise it might happen that SetTotalEvents is NOT filling the value!
314  m_hEffAllUpdate->SetTotalEvents(j, nhit - m_hEffAllLastTotal->GetBinContent(j));
315  m_hEffAllUpdate->SetPassedEvents(j, nmatch - m_hEffAllLastPassed->GetBinContent(j));
316  m_hEffAllLastTotal->SetBinContent(j, nhit);
317  m_hEffAllLastPassed->SetBinContent(j, nmatch);
318  updated[aModule] = true;
319  }
320 
321  if (j == 6) continue; // workaround for 1.3.2 module
322 
323  // get the errors and check for limits for each bin seperately ...
325 
326  error_flag |= (ihit > 10)
327  && (m_hEffAll->GetEfficiency(j) + m_hEffAll->GetEfficiencyErrorUp(j) < m_errorlevel); // error if upper error value is below limit
328  warn_flag |= (ihit > 10)
329  && (m_hEffAll->GetEfficiency(j) + m_hEffAll->GetEfficiencyErrorUp(j) < m_warnlevel); // (and not only the actual eff value)
330  }
331  }
332 
333  {
334  m_cEffAll->cd();
335  m_cEffAll->cd(0);
336  m_hEffAll->Paint("AP");
337  m_cEffAll->Clear();
338  m_cEffAll->cd(0);
339 
340  auto gr = m_hEffAll->GetPaintedGraph();
341  if (gr) {
342  double scale_min = 1.0;
343  for (int i = 0; i < gr->GetN(); i++) {
344  gr->SetPointEXhigh(i, 0.);
345  gr->SetPointEXlow(i, 0.);
346  // this has to be done first, as it will recalc Min/Max and destroy axis
347  Double_t x, y;
348  gr->GetPoint(i, x, y);
349  gr->SetPoint(i, x - 0.01, y); // workaround for jsroot bug (fixed upstream)
350  auto val = y - gr->GetErrorYlow(i); // Error is relative to value
351  if (i != 5) { // exclude 1.3.2
353  if (scale_min > val) scale_min = val;
354  }
355  }
356  if (scale_min == 1.0) scale_min = 0.0;
357  if (scale_min > 0.9) scale_min = 0.9;
358  gr->SetMinimum(0);
359  gr->SetMaximum(m_PXDModules.size());
360  auto ay = gr->GetYaxis();
361  if (ay) ay->SetRangeUser(scale_min, 1.0);
362  auto ax = gr->GetXaxis();
363  if (ax) {
364  ax->Set(m_PXDModules.size(), 0, m_PXDModules.size());
365  for (unsigned int i = 0; i < m_PXDModules.size(); i++) {
366  TString ModuleName = (std::string)m_PXDModules[i];
367  ax->SetBinLabel(i + 1, ModuleName);
368  }
369  }
370 
371  gr->SetLineColor(4);
372  gr->SetLineWidth(2);
373  gr->SetMarkerStyle(8);
374 
375  gr->Draw("AP");
376 
377  auto tt = new TLatex(5.5, scale_min, " 1.3.2 Module is excluded, please ignore");
378  tt->SetTextAngle(90);// Rotated
379  tt->SetTextAlign(12);// Centered
380  tt->Draw();
381 
382  if (all < 100.) {
383  m_cEffAll->Pad()->SetFillColor(kGray);// Magenta or Gray
384  } else {
385  if (error_flag) {
386  m_cEffAll->Pad()->SetFillColor(kRed);// Red
387  } else if (warn_flag) {
388  m_cEffAll->Pad()->SetFillColor(kYellow);// Yellow
389  } else {
390  m_cEffAll->Pad()->SetFillColor(kGreen);// Green
391  // m_cEffAll->Pad()->SetFillColor(kWhite);// White
392  }
393  }
394 
395  m_cEffAll->Pad()->SetFrameFillColor(kWhite - 1); // White
396  m_cEffAll->Pad()->SetFrameFillStyle(1001);// White
397  m_cEffAll->Pad()->Modified();
398  m_cEffAll->Pad()->Update();
399  m_line_warn->Draw();
400  m_line_error->Draw();
401  }
402 
403  m_cEffAll->Modified();
404  m_cEffAll->Update();
405  }
406 
407  {
408  m_cEffAllUpdate->cd();
409  m_hEffAllUpdate->Paint("AP");
410  m_cEffAllUpdate->Clear();
411  m_cEffAllUpdate->cd(0);
412 
413  auto gr = m_hEffAllUpdate->GetPaintedGraph();
414  auto gr3 = (TGraphAsymmErrors*) m_hEffAll->GetPaintedGraph()->Clone();
415  if (gr3) {
416  for (int i = 0; i < gr3->GetN(); i++) {
417  Double_t x, y;
418  gr3->GetPoint(i, x, y);
419  gr3->SetPoint(i, x + 0.2, y);
420  }
421  }
422 
423  double scale_min = 1.0;
424  if (gr) {
425  for (int i = 0; i < gr->GetN(); i++) {
426  gr->SetPointEXhigh(i, 0.);
427  gr->SetPointEXlow(i, 0.);
428  // this has to be done first, as it will recalc Min/Max and destroy axis
429  Double_t x, y;
430  gr->GetPoint(i, x, y);
431  gr->SetPoint(i, x - 0.2, y); // shift a bit if in same plot
432  auto val = y - gr->GetErrorYlow(i); // Error is relative to value
433  if (i != 5) { // exclude 1.3.2
435  if (scale_min > val) scale_min = val;
436  }
437  }
438  if (scale_min == 1.0) scale_min = 0.0;
439  if (scale_min > 0.9) scale_min = 0.9;
440  gr->SetMinimum(0);
441  gr->SetMaximum(m_PXDModules.size());
442  auto ay = gr->GetYaxis();
443  if (ay) ay->SetRangeUser(scale_min, 1.0);
444  auto ax = gr->GetXaxis();
445  if (ax) {
446  ax->Set(m_PXDModules.size() , 0, m_PXDModules.size());
447  for (unsigned int i = 0; i < m_PXDModules.size(); i++) {
448  TString ModuleName = (std::string)m_PXDModules[i];
449  ax->SetBinLabel(i + 1, ModuleName);
450  }
451  }
452 #ifdef _BELLE2_EPICS
453  if (m_useEpics) {
454  for (unsigned int i = 0; i < m_PXDModules.size(); i++) {
455  if (updated[m_PXDModules[i]]) {
456  Double_t x, y;// we assume that double and Double_t are same!
457  gr->GetPoint(i, x, y);
458  auto& my = mychid_eff[m_PXDModules[i]];// as the same array as above, we assume it exists
459  // we should only write if it was updated!
460  SEVCHK(ca_put(DBR_DOUBLE, my, (void*)&y), "ca_set failure");
461  }
462  }
463  }
464 #endif
465  gr->SetLineColor(kBlack);
466  gr->SetLineWidth(3);
467  gr->SetMarkerStyle(33);
468  } else scale_min = 0.0;
469  if (gr) gr->Draw("AP");
470  if (gr3) gr3->Draw("P");
471  auto tt = new TLatex(5.5, scale_min, "1.3.2 Module is excluded, please ignore");
472  tt->SetTextSize(0.035);
473  tt->SetTextAngle(90);// Rotated
474  tt->SetTextAlign(12);// Centered
475  tt->Draw();
476 
477  if (all < 100.) {
478  m_cEffAllUpdate->Pad()->SetFillColor(kGray);// Magenta or Gray
479  stat_data = 0.;
480  } else {
481  if (error_flag) {
482  m_cEffAllUpdate->Pad()->SetFillColor(kRed);// Red
483  stat_data = 4.;
484  } else if (warn_flag) {
485  m_cEffAllUpdate->Pad()->SetFillColor(kYellow);// Yellow
486  stat_data = 3.;
487  } else {
488  m_cEffAllUpdate->Pad()->SetFillColor(kGreen);// Green
489  stat_data = 2.;
491  // m_cEffAllUpdate->Pad()->SetFillColor(kWhite);// White
492  }
493  }
494  m_cEffAllUpdate->Pad()->SetFrameFillColor(kWhite - 1); // White
495  m_cEffAllUpdate->Pad()->SetFrameFillStyle(1001);// White
496  m_cEffAllUpdate->Pad()->Modified();
497  m_cEffAllUpdate->Pad()->Update();
498  m_line_warn->Draw();
499  m_line_error->Draw();
500  }
501  m_cEffAllUpdate->Modified();
502  m_cEffAllUpdate->Update();
503 
504 
505  double var_efficiency = ihit > 0 ? imatch / ihit : 0.0;
506  m_monObj->setVariable("efficiency", var_efficiency);
507  m_monObj->setVariable("nmodules", ieff);
508 
509 #ifdef _BELLE2_EPICS
510  if (m_useEpics) {
511  SEVCHK(ca_put(DBR_DOUBLE, mychid_status[0], (void*)&stat_data), "ca_set failure");
512  // only update if statistics is reasonable, we dont want "0" drops between runs!
513  if (stat_data != 0) SEVCHK(ca_put(DBR_DOUBLE, mychid_status[1], (void*)&var_efficiency), "ca_set failure");
514  SEVCHK(ca_pend_io(5.0), "ca_pend_io failure");
515  }
516 #endif
517 }

◆ 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 130 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 83 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 139 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 153 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 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.

◆ getFloatValues()

static FloatValueList& getFloatValues ( )
inlinestaticinherited

Get the list of float parameters.

Returns
The list of float parameters.

Definition at line 199 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 72 of file DQMHistAnalysis.cc.

◆ getHists()

static HistList& getHists ( )
inlinestaticinherited

Get the list of histograms.

Returns
The list of histograms.

Definition at line 184 of file DQMHistAnalysis.h.

◆ getIntValues()

static IntValueList& getIntValues ( )
inlinestaticinherited

Get the list of integer parameters.

Returns
The list of integer parameters.

Definition at line 194 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
objNamename of MonitoringObject to get

Definition at line 55 of file DQMHistAnalysis.cc.

◆ getMonObjList()

const DQMHistAnalysisModule::MonObjList & getMonObjList ( )
staticinherited

Get the list of MonitoringObjects.

Returns
The list of the MonitoringObjects.

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

◆ 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 189 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 383 of file Module.h.

◆ getTexts()

static TextList& getTexts ( )
inlinestaticinherited

Get the list of string parameters.

Returns
The list of string parameters.

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

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

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

◆ 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 193 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 50 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 519 of file DQMHistAnalysisPXDEff.cc.


The documentation for this class was generated from the following files:
Belle2::DQMHistAnalysisPXDEffModule::m_line_error
TLine * m_line_error
TLine object for error error.
Definition: DQMHistAnalysisPXDEff.h:93
Belle2::VxdID
Class to uniquely identify a any structure of the PXD and SVD.
Definition: VxdID.h:43
Belle2::VxdID::getLadderNumber
baseType getLadderNumber() const
Get the ladder id.
Definition: VxdID.h:108
Belle2::DQMHistAnalysisPXDEffModule::m_cEffModules
std::map< VxdID, TCanvas * > m_cEffModules
Individual efficiency for each module, canvas.
Definition: DQMHistAnalysisPXDEff.h:74
Belle2::DQMHistAnalysisPXDEffModule::m_PXDModules
std::vector< VxdID > m_PXDModules
IDs of all PXD Modules to iterate over.
Definition: DQMHistAnalysisPXDEff.h:69
Belle2::DQMHistAnalysisModule::findHist
static TH1 * findHist(const std::string &histname)
Find histogram.
Definition: DQMHistAnalysis.cc:83
Belle2::DQMHistAnalysisPXDEffModule::m_hEffAllUpdate
TEfficiency * m_hEffAllUpdate
Efficiency, last state, updated.
Definition: DQMHistAnalysisPXDEff.h:85
Belle2::DQMHistAnalysisPXDEffModule::m_histogramDirectoryName
std::string m_histogramDirectoryName
name of histogram directory
Definition: DQMHistAnalysisPXDEff.h:50
Belle2::DQMHistAnalysisPXDEffModule::m_useEpics
bool m_useEpics
flag if to export to EPICS
Definition: DQMHistAnalysisPXDEff.h:99
Belle2::DQMHistAnalysisPXDEffModule::m_hEffAllLastTotal
TH1 * m_hEffAllLastTotal
TH1, last state, total.
Definition: DQMHistAnalysisPXDEff.h:81
Belle2::DQMHistAnalysisPXDEffModule::m_hEffAll
TEfficiency * m_hEffAll
One bin for each module in the geometry.
Definition: DQMHistAnalysisPXDEff.h:77
Belle2::DQMHistAnalysisPXDEffModule::m_hEffModules
std::map< VxdID, TEfficiency * > m_hEffModules
Individual efficiency for each module, 2d histogram.
Definition: DQMHistAnalysisPXDEff.h:72
Belle2::DQMHistAnalysisPXDEffModule::m_line_warn
TLine * m_line_warn
TLine object for warning limit.
Definition: DQMHistAnalysisPXDEff.h:91
Belle2::MonitoringObject::setVariable
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)
Definition: MonitoringObject.h:134
Belle2::VxdID::getSensorNumber
baseType getSensorNumber() const
Get the sensor id.
Definition: VxdID.h:110
Belle2::DQMHistAnalysisPXDEffModule::m_warnlevel
double m_warnlevel
warn level for alarm
Definition: DQMHistAnalysisPXDEff.h:62
Belle2::DQMHistAnalysisPXDEffModule::m_cEffAllUpdate
TCanvas * m_cEffAllUpdate
Final Canvas for Update.
Definition: DQMHistAnalysisPXDEff.h:87
Belle2::DQMHistAnalysisPXDEffModule::m_cEffAll
TCanvas * m_cEffAll
Final Canvas.
Definition: DQMHistAnalysisPXDEff.h:79
Belle2::DQMHistAnalysisPXDEffModule::m_minEntries
int m_minEntries
Update entry intervall.
Definition: DQMHistAnalysisPXDEff.h:66
Belle2::DQMHistAnalysisPXDEffModule::m_hEffAllLastPassed
TH1 * m_hEffAllLastPassed
TH1, last state, passed.
Definition: DQMHistAnalysisPXDEff.h:83
Belle2::DQMHistAnalysisPXDEffModule::m_errorlevel
double m_errorlevel
error level for alarm
Definition: DQMHistAnalysisPXDEff.h:64
Belle2::VxdID::getLayerNumber
baseType getLayerNumber() const
Get the layer id.
Definition: VxdID.h:106
Belle2::DQMHistAnalysisPXDEffModule::m_singleHists
bool m_singleHists
Flag to trigger creation of additional histograms.
Definition: DQMHistAnalysisPXDEff.h:54
Belle2::DQMHistAnalysisPXDEffModule::m_monObj
MonitoringObject * m_monObj
Monitoring Object.
Definition: DQMHistAnalysisPXDEff.h:96