Belle II Software  release-05-02-19
DQMHistInjectionModule Class Reference

DQM Histogram Analysis for PXD Efficiency. More...

#include <DQMHistInjection.h>

Inheritance diagram for DQMHistInjectionModule:
Collaboration diagram for DQMHistInjectionModule:

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

 DQMHistInjectionModule ()
 Constructor.
 
 ~DQMHistInjectionModule ()
 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...
 
void cleanPVs (void)
 Clean up PVs.
 
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_useEpics
 whether to use EPICs
 
TH1F * m_hInjectionLERPXD = nullptr
 PXD Hits.
 
TCanvas * m_cInjectionLERPXD = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERPXDOcc = nullptr
 PXD Occ norm.
 
TCanvas * m_cInjectionLERPXDOcc = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERSVD = nullptr
 SVD Hits.
 
TCanvas * m_cInjectionLERSVD = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERSVDOcc = nullptr
 SVD Occ norm.
 
TCanvas * m_cInjectionLERSVDOcc = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERECL = nullptr
 ECL Hits.
 
TCanvas * m_cInjectionLERECL = nullptr
 Final Canvas.
 
TH1F * m_hBurstLERECL = nullptr
 ECL Bursts.
 
TCanvas * m_cBurstLERECL = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERTOP = nullptr
 TOP Occ.
 
TCanvas * m_cInjectionLERTOP = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERARICH = nullptr
 ARICH Occ.
 
TCanvas * m_cInjectionLERARICH = nullptr
 Final Canvas.
 
TH1F * m_hInjectionLERKLM = nullptr
 KLM occupancy after LER injection.
 
TCanvas * m_cInjectionLERKLM = nullptr
 Canvas for KLM occupancy after LER injection.
 
TH1F * m_hInjectionHERPXD = nullptr
 PXD Hits.
 
TCanvas * m_cInjectionHERPXD = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERPXDOcc = nullptr
 PXD Occ norm.
 
TCanvas * m_cInjectionHERPXDOcc = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERSVD = nullptr
 SVD Hits.
 
TCanvas * m_cInjectionHERSVD = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERSVDOcc = nullptr
 SVD Occ norm.
 
TCanvas * m_cInjectionHERSVDOcc = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERECL = nullptr
 ECL Hits.
 
TCanvas * m_cInjectionHERECL = nullptr
 Final Canvas.
 
TH1F * m_hBurstHERECL = nullptr
 ECL Bursts.
 
TCanvas * m_cBurstHERECL = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERTOP = nullptr
 TOP Occ.
 
TCanvas * m_cInjectionHERTOP = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERARICH = nullptr
 ARICH Occ.
 
TCanvas * m_cInjectionHERARICH = nullptr
 Final Canvas.
 
TH1F * m_hInjectionHERKLM = nullptr
 KLM occupancy after HER injection.
 
TCanvas * m_cInjectionHERKLM = nullptr
 Canvas for KLM occupancy after HER injection.
 
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 28 of file DQMHistInjection.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, DQMHistAnalysisSVDDoseModule, 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< CKFToSVDSeedFindlet >, FindletModule< CKFToCDCFindlet >, 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< TrackFinderCosmics >, FindletModule< SuperClusterCreator >, FindletModule< HitBasedT0Extractor >, 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< TrackQualityEstimator >, FindletModule< CKFToPXDFindlet >, 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, KLMDQMModule, TOPDQMModule, CDCDQMModule, TOPLaserHitSelectorModule, TOPModuleT0CalibratorModule, DQMHistAnalysisKLMModule, DQMHistAnalysisTRGGDLModule, BKLMDigitAnalyzerModule, TOPChannelT0CalibratorModule, TOPCommonT0CalibratorModule, KLMUnpackerModule, TOPRawDigitConverterModule, TOPReconstructorModule, ARICHFillHitsModule, DQMHistAnalysisCDCMonObjModule, KLMReconstructorModule, CDCCRTestModule, KLMDigitizerModule, ECLDigitizerPureCsIModule, EKLMDataCheckerModule, ARICHReconstructorModule, ECLLocalRunCalibratorModule, KLMPackerModule, MdstPIDModule, FullSimModule, ARICHDQMModule, CDCUnpackerModule, DQMHistAnalysisARICHModule, ECLCRFinderModule, TOPAlignerModule, TOPPDFDebuggerModule, ARICHPackerModule, BelleMCOutputModule, BeamBkgMixerModule, CDCPackerModule, TOPBackgroundModule, TOPPDFCheckerModule, ARICHRelateModule, BeamBkgHitRateMonitorModule, CsIDigitizerModule, DQMHistAnalysisMiraBelleModule, ARICHUnpackerModule, 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, ECLDQMEXTENDEDModule, 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, 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, ECLUnpackerModule, SVDClusterCalibrationsMonitorModule, TOPChannelT0MCModule, EffPlotsModule, CurlTaggerModule, BeamDigitizerModule, He3DigitizerModule, 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, TRGGDLDQMModule, DQMHistAnalysisOutputMonObjModule, TRGECLQAMModule, TRGECLTimingCalModule, MCV0MatcherModule, DQMHistAnalysisInputModule, cdcDQM7Module, SwitchDataStoreModule, PhysicsObjectsMiraBelleModule, HistoModule, TRGGRLDQMModule, KLMTriggerModule, DQMHistAnalysisEventT0Module, DQMHistAnalysisInputSrvModule, SeqRootOutputModule, 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.

Reimplemented from Module.

Definition at line 160 of file DQMHistInjection.cc.

161 {
162  TH1* Hits = nullptr, *Triggers = nullptr;
163  TString locationHits = "";
164  TString locationTriggers = "";
165  //PXD
166  m_histogramDirectoryName = "PXDINJ";
167 
168  locationHits = "PXDOccInjLER";
169  if (m_histogramDirectoryName != "") {
170  locationHits = m_histogramDirectoryName + "/" + locationHits;
171  }
172  Hits = (TH1*)findHist(locationHits.Data());
173  locationTriggers = "PXDEOccInjLER";
174  if (m_histogramDirectoryName != "") {
175  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
176  }
177  Triggers = (TH1*)findHist(locationTriggers.Data());
178 
179  //Finding only one of them should only happen in very strange situations...
180  //m_nodes[0].histo = Triggers;
181  if (Hits && Triggers) {
182  m_hInjectionLERPXD->Divide(Hits, Triggers);
183  m_hInjectionLERPXDOcc->Divide(Hits, Triggers, 100, 768 * 250); // to percent
184  }
185 
186  m_cInjectionLERPXD->Clear();
187  m_cInjectionLERPXD->cd(0);
188  m_hInjectionLERPXD->Draw("hist");
189 
190  m_cInjectionLERPXDOcc->Clear();
191  m_cInjectionLERPXDOcc->cd(0);
192  m_hInjectionLERPXDOcc->Draw("hist");
193 
194  locationHits = "PXDOccInjHER";
195  if (m_histogramDirectoryName != "") {
196  locationHits = m_histogramDirectoryName + "/" + locationHits;
197  }
198  Hits = (TH1*)findHist(locationHits.Data());
199  locationTriggers = "PXDEOccInjHER";
200  if (m_histogramDirectoryName != "") {
201  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
202  }
203  Triggers = (TH1*)findHist(locationTriggers.Data());
204 
205  //Finding only one of them should only happen in very strange situations...
206  //m_nodes[3].histo = Triggers;
207  if (Hits && Triggers) {
208  m_hInjectionHERPXD->Divide(Hits, Triggers);
209  m_hInjectionHERPXDOcc->Divide(Hits, Triggers, 100, 768 * 250); // to percent
210  }
211 
212  m_cInjectionHERPXD->Clear();
213  m_cInjectionHERPXD->cd(0);
214  m_hInjectionHERPXD->Draw("hist");
215 
216  m_cInjectionHERPXDOcc->Clear();
217  m_cInjectionHERPXDOcc->cd(0);
218  m_hInjectionHERPXDOcc->Draw("hist");
219 
220  //SVD
221  m_histogramDirectoryName = "SVDInjection";
222 
223  locationHits = "SVDOccInjLER";
224  if (m_histogramDirectoryName != "") {
225  locationHits = m_histogramDirectoryName + "/" + locationHits;
226  }
227  Hits = (TH1*)findHist(locationHits.Data());
228  locationTriggers = "SVDTrgOccInjLER";
229  if (m_histogramDirectoryName != "") {
230  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
231  }
232  Triggers = (TH1*)findHist(locationTriggers.Data());
233 
234  //Finding only one of them should only happen in very strange situations...
235  //m_nodes[0].histo = Triggers;
236  if (Hits && Triggers) {
237  m_hInjectionLERSVD->Divide(Hits, Triggers);
238  m_hInjectionLERSVDOcc->Divide(Hits, Triggers, 100, 768 * 7 * 2); // to percent (L3V has 768 strips * 2 * 7 sides)
239  }
240 
241  m_cInjectionLERSVD->Clear();
242  m_cInjectionLERSVD->cd(0);
243  m_hInjectionLERSVD->Draw("hist");
244 
245  m_cInjectionLERSVDOcc->Clear();
246  m_cInjectionLERSVDOcc->cd(0);
247  m_hInjectionLERSVDOcc->Draw("hist");
248 
249  locationHits = "SVDOccInjHER";
250  if (m_histogramDirectoryName != "") {
251  locationHits = m_histogramDirectoryName + "/" + locationHits;
252  }
253  Hits = (TH1*)findHist(locationHits.Data());
254  locationTriggers = "SVDTrgOccInjHER";
255  if (m_histogramDirectoryName != "") {
256  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
257  }
258  Triggers = (TH1*)findHist(locationTriggers.Data());
259 
260  //Finding only one of them should only happen in very strange situations...
261  //m_nodes[3].histo = Triggers;
262  if (Hits && Triggers) {
263  m_hInjectionHERSVD->Divide(Hits, Triggers);
264  m_hInjectionHERSVDOcc->Divide(Hits, Triggers, 100, 768 * 2 * 7); // to percent (L3V has 768 strips * 2 * 7 sides)
265  }
266 
267  m_cInjectionHERSVD->Clear();
268  m_cInjectionHERSVD->cd(0);
269  m_hInjectionHERSVD->Draw("hist");
270 
271  m_cInjectionHERSVDOcc->Clear();
272  m_cInjectionHERSVDOcc->cd(0);
273  m_hInjectionHERSVDOcc->Draw("hist");
274 
275 
276  //ECL
277  m_histogramDirectoryName = "ECLINJ";
278 
279  locationHits = "ECLHitsInjLER";
280  if (m_histogramDirectoryName != "") {
281  locationHits = m_histogramDirectoryName + "/" + locationHits;
282  }
283  Hits = (TH1*)findHist(locationHits.Data());
284  locationTriggers = "ECLEHitsInjLER";
285  if (m_histogramDirectoryName != "") {
286  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
287  }
288  Triggers = (TH1*)findHist(locationTriggers.Data());
289 
290  //Finding only one of them should only happen in very strange situations...
291 #ifdef _BELLE2_EPICS
292  if (m_useEpics) {
293  m_nodes[0].histo = Triggers;
294  }
295 #endif
296  if (Hits && Triggers) {
297  m_hInjectionLERECL->Divide(Hits, Triggers);
298  }
299 
300  m_cInjectionLERECL->Clear();
301  m_cInjectionLERECL->cd(0);
302  m_hInjectionLERECL->Draw("hist");
303 
304  locationHits = "ECLHitsInjHER";
305  if (m_histogramDirectoryName != "") {
306  locationHits = m_histogramDirectoryName + "/" + locationHits;
307  }
308  Hits = (TH1*)findHist(locationHits.Data());
309  locationTriggers = "ECLEHitsInjHER";
310  if (m_histogramDirectoryName != "") {
311  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
312  }
313  Triggers = (TH1*)findHist(locationTriggers.Data());
314 
315  //Finding only one of them should only happen in very strange situations...
316 #ifdef _BELLE2_EPICS
317  if (m_useEpics) {
318  m_nodes[3].histo = Triggers;
319  }
320 #endif
321  if (Hits && Triggers) {
322  m_hInjectionHERECL->Divide(Hits, Triggers);
323  }
324 
325  m_cInjectionHERECL->Clear();
326  m_cInjectionHERECL->cd(0);
327  m_hInjectionHERECL->Draw("hist");
328 // =====
329  locationHits = "ECLBurstsInjLER";
330  if (m_histogramDirectoryName != "") {
331  locationHits = m_histogramDirectoryName + "/" + locationHits;
332  }
333  Hits = (TH1*)findHist(locationHits.Data());
334  locationTriggers = "ECLEBurstsInjLER";
335  if (m_histogramDirectoryName != "") {
336  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
337  }
338  Triggers = (TH1*)findHist(locationTriggers.Data());
339 
340  if (Hits && Triggers) {
341  m_hBurstLERECL->Divide(Hits, Triggers);
342  }
343 
344  m_cBurstLERECL->Clear();
345  m_cBurstLERECL->cd(0);
346  m_hBurstLERECL->Draw("hist");
347 // =====
348 
349  locationHits = "ECLBurstsInjHER";
350  if (m_histogramDirectoryName != "") {
351  locationHits = m_histogramDirectoryName + "/" + locationHits;
352  }
353  Hits = (TH1*)findHist(locationHits.Data());
354  locationTriggers = "ECLEBurstsInjHER";
355  if (m_histogramDirectoryName != "") {
356  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
357  }
358  Triggers = (TH1*)findHist(locationTriggers.Data());
359 
360  if (Hits && Triggers) {
361  m_hBurstHERECL->Divide(Hits, Triggers);
362  }
363 
364  m_cBurstHERECL->Clear();
365  m_cBurstHERECL->cd(0);
366  m_hBurstHERECL->Draw("hist");
367 // =====
368 
369 
370  //TOP
371  m_histogramDirectoryName = "TOP";
372 
373  locationHits = "TOPOccInjLER";
374  if (m_histogramDirectoryName != "") {
375  locationHits = m_histogramDirectoryName + "/" + locationHits;
376  }
377  Hits = (TH1*)findHist(locationHits.Data());
378  locationTriggers = "TOPEOccInjLER";
379  if (m_histogramDirectoryName != "") {
380  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
381  }
382  Triggers = (TH1*)findHist(locationTriggers.Data());
383 
384  if (Hits && Triggers) {
385  m_hInjectionLERTOP->Divide(Hits, Triggers, 100, 8192);
386  }
387 
388  m_cInjectionLERTOP->Clear();
389  m_cInjectionLERTOP->cd(0);
390  m_hInjectionLERTOP->Draw("hist");
391 
392  locationHits = "TOPOccInjHER";
393  if (m_histogramDirectoryName != "") {
394  locationHits = m_histogramDirectoryName + "/" + locationHits;
395  }
396  Hits = (TH1*)findHist(locationHits.Data());
397  locationTriggers = "TOPEOccInjHER";
398  if (m_histogramDirectoryName != "") {
399  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
400  }
401  Triggers = (TH1*)findHist(locationTriggers.Data());
402 
403  if (Hits && Triggers) {
404  m_hInjectionHERTOP->Divide(Hits, Triggers, 100, 8192);
405  }
406 
407  m_cInjectionHERTOP->Clear();
408  m_cInjectionHERTOP->cd(0);
409  m_hInjectionHERTOP->Draw("hist");
410 
411 
412 
413  //ARICH
414  m_histogramDirectoryName = "ARICH";
415 
416  locationHits = "ARICHOccInjLER";
417  if (m_histogramDirectoryName != "") {
418  locationHits = m_histogramDirectoryName + "/" + locationHits;
419  }
420  Hits = (TH1*)findHist(locationHits.Data());
421  locationTriggers = "ARICHEOccInjLER";
422  if (m_histogramDirectoryName != "") {
423  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
424  }
425  Triggers = (TH1*)findHist(locationTriggers.Data());
426 
427  if (Hits && Triggers) {
428  m_hInjectionLERARICH->Divide(Hits, Triggers);
429  }
430 
431  m_cInjectionLERARICH->Clear();
432  m_cInjectionLERARICH->cd(0);
433  m_hInjectionLERARICH->Draw("hist");
434 
435  locationHits = "ARICHOccInjHER";
436  if (m_histogramDirectoryName != "") {
437  locationHits = m_histogramDirectoryName + "/" + locationHits;
438  }
439  Hits = (TH1*)findHist(locationHits.Data());
440  locationTriggers = "ARICHEOccInjHER";
441  if (m_histogramDirectoryName != "") {
442  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
443  }
444  Triggers = (TH1*)findHist(locationTriggers.Data());
445 
446  if (Hits && Triggers) {
447  m_hInjectionHERARICH->Divide(Hits, Triggers);
448  }
449 
450  m_cInjectionHERARICH->Clear();
451  m_cInjectionHERARICH->cd(0);
452  m_hInjectionHERARICH->Draw("hist");
453 
454  // KLM
455  m_histogramDirectoryName = "KLM";
456 
457  locationHits = "KLMOccInjLER";
458  if (m_histogramDirectoryName != "") {
459  locationHits = m_histogramDirectoryName + "/" + locationHits;
460  }
461  Hits = (TH1*)findHist(locationHits.Data());
462  locationTriggers = "KLMTrigInjLER";
463  if (m_histogramDirectoryName != "") {
464  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
465  }
466  Triggers = (TH1*)findHist(locationTriggers.Data());
467 
468  if (Hits && Triggers) {
469  m_hInjectionLERKLM->Divide(Hits, Triggers, 100, KLMElementNumbers::getTotalChannelNumber());
470  }
471 
472  m_cInjectionLERKLM->Clear();
473  m_cInjectionLERKLM->cd(0);
474  m_hInjectionLERKLM->Draw("hist");
475 
476  locationHits = "KLMOccInjHER";
477  if (m_histogramDirectoryName != "") {
478  locationHits = m_histogramDirectoryName + "/" + locationHits;
479  }
480  Hits = (TH1*)findHist(locationHits.Data());
481  locationTriggers = "KLMTrigInjHER";
482  if (m_histogramDirectoryName != "") {
483  locationTriggers = m_histogramDirectoryName + "/" + locationTriggers;
484  }
485  Triggers = (TH1*)findHist(locationTriggers.Data());
486 
487  if (Hits && Triggers) {
488  m_hInjectionHERKLM->Divide(Hits, Triggers, 100, KLMElementNumbers::getTotalChannelNumber());
489  }
490 
491  m_cInjectionHERKLM->Clear();
492  m_cInjectionHERKLM->cd(0);
493  m_hInjectionHERKLM->Draw("hist");
494 
495 #ifdef _BELLE2_EPICS
496  if (m_useEpics) {
497  for (auto& m : m_nodes) {
498  if (!m.mychid) continue;
499  int length = m.data.size();
500  if (length != int(ca_element_count(m.mychid)) && int(ca_element_count(m.mychid)) > 0) {
501  // FIXME, unclear why this is needed to prevent crashes on new run?
502  m.data.resize(int(ca_element_count(m.mychid)), 0.0);
503  length = m.data.size();
504  }
505  if (m.histo && m.histo->GetNcells() > 2 && length > 0 && length == int(ca_element_count(m.mychid))) {
506  // If bin count doesnt match, we loose bins but otherwise ca_array_put will complain
507  // We fill up the array with ZEROs otherwise
508  if (m.histo->GetDimension() == 1) {
509  int i = 0;
510  int nx = m.histo->GetNbinsX() + 1;
511  for (int x = 1; x < nx && i < length ; x++) {
512  m.data[i++] = m.histo->GetBinContent(x);
513  }
514 
515  } else if (m.histo->GetDimension() == 2) {
516  int i = 0;
517  int nx = m.histo->GetNbinsX() + 1;
518  int ny = m.histo->GetNbinsY() + 1;
519  for (int y = 1; y < ny && i < length; y++) {
520  for (int x = 1; x < nx && i < length ; x++) {
521  m.data[i++] = m.histo->GetBinContent(x, y);
522  }
523  }
524  }
525  SEVCHK(ca_array_put(DBR_DOUBLE, length, m.mychid, (void*)m.data.data()), "ca_put failure");
526  } else {
527  B2DEBUG(99, "Inj " << ca_name(m.mychid) << " , " << m.histo << " , " << (m.histo ? m.histo->GetNcells() : 0) << " , " << length <<
528  " , "
529  <<
530  ca_element_count(m.mychid));
531  }
532  }
533  SEVCHK(ca_pend_io(5.0), "ca_pend_io failure");
534  }
535 #endif
536 }

◆ 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 559 of file DQMHistInjection.cc.


The documentation for this class was generated from the following files:
Belle2::DQMHistInjectionModule::m_cInjectionLERSVD
TCanvas * m_cInjectionLERSVD
Final Canvas.
Definition: DQMHistInjection.h:79
Belle2::DQMHistInjectionModule::m_cInjectionHERARICH
TCanvas * m_cInjectionHERARICH
Final Canvas.
Definition: DQMHistInjection.h:135
Belle2::DQMHistInjectionModule::m_hInjectionLERSVD
TH1F * m_hInjectionLERSVD
SVD Hits.
Definition: DQMHistInjection.h:77
Belle2::DQMHistInjectionModule::m_cInjectionLERKLM
TCanvas * m_cInjectionLERKLM
Canvas for KLM occupancy after LER injection.
Definition: DQMHistInjection.h:103
Belle2::DQMHistInjectionModule::m_hBurstHERECL
TH1F * m_hBurstHERECL
ECL Bursts.
Definition: DQMHistInjection.h:125
Belle2::DQMHistInjectionModule::m_hInjectionHERPXDOcc
TH1F * m_hInjectionHERPXDOcc
PXD Occ norm.
Definition: DQMHistInjection.h:109
Belle2::DQMHistInjectionModule::m_hBurstLERECL
TH1F * m_hBurstLERECL
ECL Bursts.
Definition: DQMHistInjection.h:89
Belle2::DQMHistInjectionModule::m_cInjectionHERSVDOcc
TCanvas * m_cInjectionHERSVDOcc
Final Canvas.
Definition: DQMHistInjection.h:119
Belle2::DQMHistInjectionModule::m_useEpics
bool m_useEpics
whether to use EPICs
Definition: DQMHistInjection.h:62
Belle2::DQMHistInjectionModule::m_hInjectionLERTOP
TH1F * m_hInjectionLERTOP
TOP Occ.
Definition: DQMHistInjection.h:93
Belle2::DQMHistInjectionModule::m_cInjectionHERECL
TCanvas * m_cInjectionHERECL
Final Canvas.
Definition: DQMHistInjection.h:123
Belle2::DQMHistInjectionModule::m_cInjectionLERECL
TCanvas * m_cInjectionLERECL
Final Canvas.
Definition: DQMHistInjection.h:87
Belle2::DQMHistInjectionModule::m_hInjectionLERKLM
TH1F * m_hInjectionLERKLM
KLM occupancy after LER injection.
Definition: DQMHistInjection.h:101
Belle2::DQMHistInjectionModule::m_cInjectionHERSVD
TCanvas * m_cInjectionHERSVD
Final Canvas.
Definition: DQMHistInjection.h:115
Belle2::DQMHistInjectionModule::m_hInjectionHERKLM
TH1F * m_hInjectionHERKLM
KLM occupancy after HER injection.
Definition: DQMHistInjection.h:137
Belle2::DQMHistAnalysisModule::findHist
static TH1 * findHist(const std::string &histname)
Find histogram.
Definition: DQMHistAnalysis.cc:83
Belle2::DQMHistInjectionModule::m_cInjectionHERTOP
TCanvas * m_cInjectionHERTOP
Final Canvas.
Definition: DQMHistInjection.h:131
Belle2::DQMHistInjectionModule::m_hInjectionLERECL
TH1F * m_hInjectionLERECL
ECL Hits.
Definition: DQMHistInjection.h:85
Belle2::DQMHistInjectionModule::m_hInjectionHERECL
TH1F * m_hInjectionHERECL
ECL Hits.
Definition: DQMHistInjection.h:121
Belle2::DQMHistInjectionModule::m_hInjectionLERARICH
TH1F * m_hInjectionLERARICH
ARICH Occ.
Definition: DQMHistInjection.h:97
Belle2::DQMHistInjectionModule::m_hInjectionLERPXD
TH1F * m_hInjectionLERPXD
PXD Hits.
Definition: DQMHistInjection.h:69
Belle2::DQMHistInjectionModule::m_hInjectionLERPXDOcc
TH1F * m_hInjectionLERPXDOcc
PXD Occ norm.
Definition: DQMHistInjection.h:73
Belle2::DQMHistInjectionModule::m_cInjectionLERSVDOcc
TCanvas * m_cInjectionLERSVDOcc
Final Canvas.
Definition: DQMHistInjection.h:83
Belle2::DQMHistInjectionModule::m_cInjectionLERPXDOcc
TCanvas * m_cInjectionLERPXDOcc
Final Canvas.
Definition: DQMHistInjection.h:75
Belle2::DQMHistInjectionModule::m_hInjectionHERPXD
TH1F * m_hInjectionHERPXD
PXD Hits.
Definition: DQMHistInjection.h:105
Belle2::DQMHistInjectionModule::m_cInjectionHERPXD
TCanvas * m_cInjectionHERPXD
Final Canvas.
Definition: DQMHistInjection.h:107
Belle2::DQMHistInjectionModule::m_hInjectionHERARICH
TH1F * m_hInjectionHERARICH
ARICH Occ.
Definition: DQMHistInjection.h:133
Belle2::DQMHistInjectionModule::m_hInjectionHERSVD
TH1F * m_hInjectionHERSVD
SVD Hits.
Definition: DQMHistInjection.h:113
Belle2::DQMHistInjectionModule::m_hInjectionHERSVDOcc
TH1F * m_hInjectionHERSVDOcc
SVD Occ norm.
Definition: DQMHistInjection.h:117
Belle2::DQMHistInjectionModule::m_hInjectionLERSVDOcc
TH1F * m_hInjectionLERSVDOcc
SVD Occ norm.
Definition: DQMHistInjection.h:81
Belle2::DQMHistInjectionModule::m_cInjectionHERPXDOcc
TCanvas * m_cInjectionHERPXDOcc
Final Canvas.
Definition: DQMHistInjection.h:111
Belle2::DQMHistInjectionModule::m_cBurstLERECL
TCanvas * m_cBurstLERECL
Final Canvas.
Definition: DQMHistInjection.h:91
Belle2::DQMHistInjectionModule::m_cInjectionLERPXD
TCanvas * m_cInjectionLERPXD
Final Canvas.
Definition: DQMHistInjection.h:71
Belle2::DQMHistInjectionModule::m_cInjectionHERKLM
TCanvas * m_cInjectionHERKLM
Canvas for KLM occupancy after HER injection.
Definition: DQMHistInjection.h:139
Belle2::DQMHistInjectionModule::m_hInjectionHERTOP
TH1F * m_hInjectionHERTOP
TOP Occ.
Definition: DQMHistInjection.h:129
Belle2::DQMHistInjectionModule::m_cBurstHERECL
TCanvas * m_cBurstHERECL
Final Canvas.
Definition: DQMHistInjection.h:127
Belle2::DQMHistInjectionModule::m_cInjectionLERARICH
TCanvas * m_cInjectionLERARICH
Final Canvas.
Definition: DQMHistInjection.h:99
Belle2::KLMElementNumbers::getTotalChannelNumber
static constexpr int getTotalChannelNumber()
Get total number of channels.
Definition: KLMElementNumbers.h:274
Belle2::DQMHistInjectionModule::m_cInjectionLERTOP
TCanvas * m_cInjectionLERTOP
Final Canvas.
Definition: DQMHistInjection.h:95
Belle2::DQMHistInjectionModule::m_histogramDirectoryName
std::string m_histogramDirectoryName
name of histogram directory
Definition: DQMHistInjection.h:58