Belle II Software development
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
DQMHistAnalysisTRGModule Class Referencefinal
Packages » dqm | Modules » dqm modules

DQM Trigger Histogram code and example. More...

#include <DQMHistAnalysisTRG.h>

Inheritance diagram for DQMHistAnalysisTRGModule:
DQMHistAnalysisModule Module PathElement

Public Types

enum  EStatus {
  c_StatusTooFew = 0 ,
  c_StatusDefault = 1 ,
  c_StatusGood = 2 ,
  c_StatusWarning = 3 ,
  c_StatusError = 4
}
 Status flag of histogram/canvas. More...
 
enum  EStatusColor {
  c_ColorTooFew = kGray ,
  c_ColorDefault = kWhite ,
  c_ColorGood = kGreen ,
  c_ColorWarning = kYellow ,
  c_ColorError = kRed
}
 Status colors of histogram/canvas (corresponding to status) More...
 
enum  ERefScaling {
  c_RefScaleNone = 0 ,
  c_RefScaleEntries = 1 ,
  c_RefScaleMax = 2
}
 Reference plot scaling type. More...
 
typedef std::map< std::string, HistObject > HistList
 The type of list of histograms.
 
typedef std::map< std::string, MonitoringObject > MonObjList
 The type of list of MonitoringObjects.
 
typedef std::map< std::string, HistDelta > DeltaList
 The type of list of delta settings and histograms.
 
typedef std::map< std::string, bool > CanvasUpdatedList
 The type of list of canvas updated status.
 
typedef std::map< std::string, RefHistObject > RefList
 The type of list of references.
 
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

 DQMHistAnalysisTRGModule ()
 Constructor.
 
TH1 * findHistInCanvas (const std::string &hname, TCanvas **canvas=nullptr)
 Find histogram in corresponding canvas.
 
TH1 * getDelta (const std::string &fullname, int n=0, bool onlyIfUpdated=true)
 Get Delta histogram.
 
TH1 * getDelta (const std::string &dirname, const std::string &histname, int n=0, bool onlyIfUpdated=true)
 Get Delta histogram.
 
int registerEpicsPV (const std::string &pvname, const std::string &keyname="")
 EPICS related Functions.
 
int registerExternalEpicsPV (const std::string &pvname, const std::string &keyname="")
 Register a PV with its name and a key name.
 
void setEpicsPV (const std::string &keyname, double value)
 Write value to a EPICS PV.
 
void setEpicsPV (const std::string &keyname, int value)
 Write value to a EPICS PV.
 
void setEpicsPV (int index, double value)
 Write value to a EPICS PV.
 
void setEpicsPV (int index, int value)
 Write value to a EPICS PV.
 
void setEpicsStringPV (const std::string &keyname, const std::string &value)
 Write string to a EPICS PV.
 
void setEpicsStringPV (int index, const std::string &value)
 Write string to a EPICS PV.
 
double getEpicsPV (const std::string &keyname)
 Read value from a EPICS PV.
 
double getEpicsPV (int index)
 Read value from a EPICS PV.
 
std::string getEpicsStringPV (const std::string &keyname, bool &status)
 Read value from a EPICS PV.
 
std::string getEpicsStringPV (int index, bool &status)
 Read value from a EPICS PV.
 
int updateEpicsPVs (float timeout)
 Update all EPICS PV (flush to network)
 
chid getEpicsPVChID (const std::string &keyname)
 Get EPICS PV Channel Id.
 
chid getEpicsPVChID (int index)
 Get EPICS PV Channel Id.
 
bool requestLimitsFromEpicsPVs (chid id, double &lowerAlarm, double &lowerWarn, double &upperWarn, double &upperAlarm)
 Get Alarm Limits from EPICS PV.
 
bool requestLimitsFromEpicsPVs (const std::string &keyname, double &lowerAlarm, double &lowerWarn, double &upperWarn, double &upperAlarm)
 Get Alarm Limits from EPICS PV.
 
bool requestLimitsFromEpicsPVs (int index, double &lowerAlarm, double &lowerWarn, double &upperWarn, double &upperAlarm)
 Get Alarm Limits from EPICS PV.
 
void cleanupEpicsPVs (void)
 Unsubscribe from EPICS PVs on terminate.
 
void CheckEpicsError (int state, const std::string &message, const std::string &name)
 check the return status and check PV in case of error
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
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.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
LogConfig & getLogConfig ()
 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.
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module.
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module.
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module.
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleCondition * getCondition () 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.
 
std::shared_ptr< Path > getConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished.
 
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.
 
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 ModuleParamList & getParamList () const
 Return module param list.
 
template<typename T>
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter.
 
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.
 
std::shared_ptr< PathElement > clone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static double getThreshold (const TH1 *hist, const double lower_bound, const double widthFraction=0.01)
 A utility function to find the location of the tail of histograms.
 
static void clearlist (void)
 Clear all static global lists.
 
static HistList & getHistList ()
 Get the list of the histograms.
 
static MonObjList & getMonObjList ()
 Get the list of MonitoringObjects.
 
static const DeltaList & getDeltaList ()
 Get the list of the delta histograms.
 
static const CanvasUpdatedList & getCanvasUpdatedList ()
 Get the list of the canvas update status.
 
static const std::string & getRunType (void)
 Get the list of the reference histograms.
 
static int getEventProcessed (void)
 Get the number of processed events.
 
static void setRunType (const std::string &t)
 Set the Run Type.
 
static void setEventProcessed (int e)
 Set the number of processed events.
 
static TCanvas * findCanvas (TString cname)
 Find canvas by name.
 
static TH1 * findHist (const std::string &histname, bool onlyIfUpdated=false)
 Get histogram from list (no other search).
 
static TH1 * findHist (const std::string &dirname, const std::string &histname, bool onlyIfUpdated=false)
 Find histogram.
 
static TH1 * findRefHist (const std::string &histname, ERefScaling scaling=ERefScaling::c_RefScaleNone, const TH1 *hist=nullptr)
 Get referencehistogram from list (no other search).
 
static TH1 * findRefHist (const std::string &dirname, const std::string &histname, ERefScaling scaling=ERefScaling::c_RefScaleNone, const TH1 *hist=nullptr)
 Find reference histogram.
 
static TH1 * scaleReference (ERefScaling scaling, const TH1 *hist, TH1 *ref)
 Using the original and reference, create scaled version.
 
static TH1 * findHistInFile (TFile *file, const std::string &histname)
 Find histogram in specific TFile (e.g.
 
static MonitoringObject * findMonitoringObject (const std::string &objName)
 Find MonitoringObject.
 
static double getSigma68 (TH1 *h)
 Helper function to compute half of the central interval covering 68% of a distribution.
 
static bool addHist (const std::string &dirname, const std::string &histname, TH1 *h)
 Add histogram.
 
static void addRefHist (const std::string &dirname, TH1 *hist)
 Add reference histogram.
 
static MonitoringObject * getMonitoringObject (const std::string &name)
 Get MonitoringObject with given name (new object is created if non-existing)
 
static void clearCanvases (void)
 Clear content of all Canvases.
 
static void initHistListBeforeEvent (void)
 Reset the list of histograms.
 
static void clearHistList (void)
 Clears the list of histograms.
 
static void clearRefList (void)
 Clears the list of ref histograms.
 
static void resetDeltaList (void)
 Reset Delta.
 
static void addDeltaPar (const std::string &dirname, const std::string &histname, HistDelta::EDeltaType t, int p, unsigned int a=1)
 Add Delta histogram parameters.
 
static bool hasDeltaPar (const std::string &dirname, const std::string &histname)
 Check if Delta histogram parameters exist for histogram.
 
static void UpdateCanvas (const std::string &name, bool updated=true)
 Mark canvas as updated (or not)
 
static void UpdateCanvas (TCanvas *canvas, bool updated=true)
 Mark canvas as updated (or not)
 
static void ExtractRunType (std::vector< TH1 * > &hs)
 Extract Run Type from histogram title, called from input module.
 
static void ExtractNEvent (std::vector< TH1 * > &hs)
 Extract event processed from daq histogram, called from input module.
 
static void setUseEpics (bool flag)
 Setter for EPICS usage.
 
static void setUseEpicsReadOnly (bool flag)
 Setter EPICS flag in read only mode.
 
static bool getUseEpics (void)
 Getter for EPICS usage.
 
static bool getUseEpicsReadOnly (void)
 Getter EPICS flag in read only mode.
 
static std::string & getPVPrefix (void)
 get global prefix for EPICS PVs
 
static void setPVPrefix (const std::string &prefix)
 set global prefix for EPICS PVs
 
static EStatus makeStatus (bool enough, bool warn_flag, bool error_flag)
 Helper function to judge the status for coloring and EPICS.
 
static void colorizeCanvas (TCanvas *canvas, EStatus status)
 Helper function for Canvas colorization.
 
static EStatusColor getStatusColor (EStatus status)
 Return color for canvas state.
 
static void checkPVStatus (void)
 Check the status of all PVs and report if disconnected or not found.
 
static void printPVStatus (chid pv, bool onlyError=true)
 check the status of a PVs and report if disconnected or not found
 
static void CheckEpicsError (int state, const std::string &message, chid id)
 check the return status and check PV in case of error
 
static std::vector< std::string > StringSplit (const std::string &s, const char delim)
 Helper function for string token split.
 
static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Static Public Attributes

static DeltaList s_deltaList
 The list of Delta Histograms and settings.
 

Protected Member Functions

virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python.
 
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.
 
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.
 
void setType (const std::string &type)
 Set the module type.
 
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.
 
template<typename T>
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module.
 
void setReturnValue (int value)
 Sets the return value for this module as integer.
 
void setReturnValue (bool value)
 Sets the return value for this module as bool.
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

void initialize (void) override final
 Initializer.
 
void beginRun (void) override final
 Called when entering a new run.
 
void endRun (void) override final
 Called when run ends.
 
void event (void) override final
 This method is called for each event.
 
void terminate (void) override final
 This method is called at the end of the event processing.
 
void doHistAnalysis ()
 Do the actual processing.
 
int registerEpicsPVwithPrefix (const std::string &prefix, const std::string &pvname, const std::string &keyname="")
 Register a PV with its name and a key name.
 
std::list< ModulePtr > getModules () 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.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

std::string m_pvPrefix
 prefix for EPICS PVs
 
TCanvas * m_canvas = nullptr
 Final Canvas.
 
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< ModuleCondition > m_conditions
 Module condition, only non-null if set.
 

Static Private Attributes

static HistList s_histList
 The list of Histograms.
 
static MonObjList s_monObjList
 The list of MonitoringObjects.
 
static CanvasUpdatedList s_canvasUpdatedList
 The list of canvas updated status.
 
static RefList s_refList
 The list of references.
 
static int s_eventProcessed = 0
 Number of Events processed to fill histograms.
 
static std::string s_runType = ""
 The Run type.
 
static bool m_useEpics = false
 Flag if to use EPICS do not set by yourself, use EpicsEnable module to set.
 
static bool m_epicsReadOnly
 Flag if to use EPICS in ReadOnly mode (for reading limits) do not set by yourself, use EpicsEnable module to set.
 
static std::string m_PVPrefix = "TEST:"
 The Prefix for EPICS PVs.
 

Detailed Description

DQM Trigger Histogram code and example.

Definition at line 26 of file DQMHistAnalysisTRG.h.

Member Typedef Documentation

◆ CanvasUpdatedList

typedef std::map<std::string, bool> CanvasUpdatedList
inherited

The type of list of canvas updated status.

Definition at line 91 of file DQMHistAnalysis.h.

◆ DeltaList

typedef std::map<std::string, HistDelta> DeltaList
inherited

The type of list of delta settings and histograms.

Definition at line 86 of file DQMHistAnalysis.h.

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

◆ HistList

typedef std::map<std::string, HistObject> HistList
inherited

The type of list of histograms.

Definition at line 77 of file DQMHistAnalysis.h.

◆ MonObjList

typedef std::map<std::string, MonitoringObject> MonObjList
inherited

The type of list of MonitoringObjects.

Definition at line 81 of file DQMHistAnalysis.h.

◆ RefList

typedef std::map<std::string, RefHistObject> RefList
inherited

The type of list of references.

Definition at line 96 of file DQMHistAnalysis.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
Belle2::ProcType::c_Output
@ c_Output
Output Process.
Definition ProcHelper.h:19
Belle2::ProcType::c_Input
@ c_Input
Input Process.
Definition ProcHelper.h:17

◆ ERefScaling

enum ERefScaling
inherited

Reference plot scaling type.

Enumerator
c_RefScaleNone 

no scaling

c_RefScaleEntries 

to number of entries (integral)

c_RefScaleMax 

to maximum (bin entry)

Definition at line 68 of file DQMHistAnalysis.h.

68 {
69 c_RefScaleNone = 0,
70 c_RefScaleEntries = 1,
71 c_RefScaleMax = 2
72 };

◆ EStatus

enum EStatus
inherited

Status flag of histogram/canvas.

Enumerator
c_StatusTooFew 

Not enough entries/event to judge.

c_StatusDefault 

default for non-coloring

c_StatusGood 

Analysis result: Good.

c_StatusWarning 

Analysis result: Warning, there may be minor issues.

c_StatusError 

Analysis result: Severe issue found.

Definition at line 46 of file DQMHistAnalysis.h.

46 {
47 c_StatusTooFew = 0,
48 c_StatusDefault = 1,
49 c_StatusGood = 2,
50 c_StatusWarning = 3,
51 c_StatusError = 4
52 };

◆ EStatusColor

enum EStatusColor
inherited

Status colors of histogram/canvas (corresponding to status)

Enumerator
c_ColorTooFew 

Not enough entries/event to judge.

c_ColorDefault 

default for non-coloring

c_ColorGood 

Analysis result: Good.

c_ColorWarning 

Analysis result: Warning, there may be minor issues.

c_ColorError 

Analysis result: Severe issue found.

Definition at line 57 of file DQMHistAnalysis.h.

57 {
58 c_ColorTooFew = kGray,
59 c_ColorDefault = kWhite,
60 c_ColorGood = kGreen,
61 c_ColorWarning = kYellow,
62 c_ColorError = kRed
63 };

Constructor & Destructor Documentation

◆ DQMHistAnalysisTRGModule()

DQMHistAnalysisTRGModule ( )

Constructor.

Definition at line 30 of file DQMHistAnalysisTRG.cc.

31 : DQMHistAnalysisModule()
32{
33 // This module CAN NOT be run in parallel!
34
35 // Parameter definition
36 addParam("PVPrefix", m_pvPrefix, "PV Prefix", std::string("TRG:"));
37 B2DEBUG(1, "DQMHistAnalysisTRGModule: Constructor done.");
38
39}
Belle2::DQMHistAnalysisModule::DQMHistAnalysisModule
DQMHistAnalysisModule()
Constructor / Destructor.
Definition DQMHistAnalysis.cc:44
Belle2::DQMHistAnalysisTRGModule::m_pvPrefix
std::string m_pvPrefix
prefix for EPICS PVs
Definition DQMHistAnalysisTRG.h:77
Belle2::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition Module.h:559

Member Function Documentation

◆ addDeltaPar()

void addDeltaPar ( const std::string & dirname,
const std::string & histname,
HistDelta::EDeltaType t,
int p,
unsigned int a = 1 )
staticinherited

Add Delta histogram parameters.

Parameters
dirnamedirectory
histnamename of histogram
ttype of delta histogramming
pnumerical parameter depending on type, e.g. number of entries
aamount of histograms in the past

Definition at line 95 of file DQMHistAnalysis.cc.

97{
98 std::string fullname;
99 if (dirname.size() > 0) {
100 fullname = dirname + "/" + histname;
101 } else {
102 fullname = histname;
103 }
104 s_deltaList[fullname].set(t, p, a);
105}
Belle2::DQMHistAnalysisModule::s_deltaList
static DeltaList s_deltaList
The list of Delta Histograms and settings.
Definition DQMHistAnalysis.h:118

◆ addHist()

bool 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.
Returns
histogram was updated flag

Definition at line 59 of file DQMHistAnalysis.cc.

60{
61 std::string fullname;
62 if (dirname.size() > 0) {
63 fullname = dirname + "/" + histname;
64 } else {
65 fullname = histname;
66 }
67
68 if (s_histList[fullname].update(h)) {
69 // only if histogram changed, check if delta histogram update needed
70 auto it = s_deltaList.find(fullname);
71 if (it != s_deltaList.end()) {
72 B2DEBUG(20, "Found Delta" << fullname);
73 it->second.update(h); // update
74 }
75 return true; // histogram changed
76 }
77
78 return false; // histogram didn't change
79}
Belle2::DQMHistAnalysisModule::s_histList
static HistList s_histList
The list of Histograms.
Definition DQMHistAnalysis.h:108

◆ addRefHist()

void addRefHist ( const std::string & dirname,
TH1 * hist )
staticinherited

Add reference histogram.

Parameters
dirnameThe name of the directory.
histThe TH1 pointer for the reference.

Definition at line 81 of file DQMHistAnalysis.cc.

82{
83 string histname = hist->GetName();
84 std::string name = dirname + "/" + histname;
85 auto& n = s_refList[name];
86 n.m_orghist_name = name;
87 n.m_refhist_name = "ref/" + name;
88 hist->SetName((n.m_refhist_name).c_str());
89 hist->SetDirectory(0);
90 n.setRefHist(hist); // transfer ownership!
91 n.setRefCopy(nullptr);
92 n.setCanvas(nullptr);
93}
Belle2::DQMHistAnalysisModule::s_refList
static RefList s_refList
The list of references.
Definition DQMHistAnalysis.h:129

◆ beginRun()

void beginRun ( void )
finaloverrideprivatevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 263 of file DQMHistAnalysisTRG.cc.

264{
265 B2DEBUG(1, "DQMHistAnalysisTRGModule: beginRun called.");
266}

◆ CheckEpicsError() [1/2]

void CheckEpicsError ( int state,
const std::string & message,
chid id = nullptr )
staticinherited

check the return status and check PV in case of error

Parameters
statereturn state of epics function
messagemessage to print out
idthe chid of the affected PV

Definition at line 807 of file DQMHistAnalysis.cc.

808{
809 if (state != ECA_NORMAL) {
810 std::string name;
811 if (id) name = ca_name(id);
812 B2WARNING(message << ": " << name);
813 printPVStatus(id, false);
814 }
815}
Belle2::DQMHistAnalysisModule::printPVStatus
static void printPVStatus(chid pv, bool onlyError=true)
check the status of a PVs and report if disconnected or not found
Definition DQMHistAnalysis.cc:773

◆ CheckEpicsError() [2/2]

void CheckEpicsError ( int state,
const std::string & message,
const std::string & name )
inherited

check the return status and check PV in case of error

Parameters
statereturn state of epics function
messagemessage to print out
namethe (key)name of the affected PV

Definition at line 799 of file DQMHistAnalysis.cc.

800{
801 if (state != ECA_NORMAL) {
802 B2WARNING(message << ": " << name);
803 printPVStatus(m_epicsNameToChID[name], false);
804 }
805}

◆ checkPVStatus()

void checkPVStatus ( void )
staticinherited

Check the status of all PVs and report if disconnected or not found.

Definition at line 763 of file DQMHistAnalysis.cc.

764{
765 B2INFO("Check PV Connections");
766
767 for (const auto& it : m_epicsChID) {
768 printPVStatus(it);
769 }
770 B2INFO("Check PVs done");
771}

◆ cleanupEpicsPVs()

void cleanupEpicsPVs ( void )
inherited

Unsubscribe from EPICS PVs on terminate.

Definition at line 644 of file DQMHistAnalysis.cc.

645{
646 // this should be called in terminate function of analysis modules
647#ifdef _BELLE2_EPICS
648 if (getUseEpics()) {
649 for (auto& it : m_epicsChID) CheckEpicsError(ca_clear_channel(it), "ca_clear_channel failure", it);
650 updateEpicsPVs(5.0);
651 // Make sure we clean up both afterwards!
652 m_epicsChID.clear();
653 m_epicsNameToChID.clear();
654 }
655#endif
656}
Belle2::DQMHistAnalysisModule::getUseEpics
static bool getUseEpics(void)
Getter for EPICS usage.
Definition DQMHistAnalysis.h:593
Belle2::DQMHistAnalysisModule::CheckEpicsError
void CheckEpicsError(int state, const std::string &message, const std::string &name)
check the return status and check PV in case of error
Definition DQMHistAnalysis.cc:799
Belle2::DQMHistAnalysisModule::updateEpicsPVs
int updateEpicsPVs(float timeout)
Update all EPICS PV (flush to network)
Definition DQMHistAnalysis.cc:631

◆ clearCanvases()

void clearCanvases ( void )
staticinherited

Clear content of all Canvases.

Definition at line 309 of file DQMHistAnalysis.cc.

310{
311 TIter nextckey(gROOT->GetListOfCanvases());
312 TObject* cobj = nullptr;
313
314 while ((cobj = dynamic_cast<TObject*>(nextckey()))) {
315 if (cobj->IsA()->InheritsFrom("TCanvas")) {
316 TCanvas* cnv = dynamic_cast<TCanvas*>(cobj);
317 cnv->Clear();
318 DQMHistAnalysisModule::colorizeCanvas(cnv, c_StatusDefault);
319 }
320 }
321}
Belle2::DQMHistAnalysisModule::colorizeCanvas
static void colorizeCanvas(TCanvas *canvas, EStatus status)
Helper function for Canvas colorization.
Definition DQMHistAnalysis.cc:750
Belle2::DQMHistAnalysisModule::c_StatusDefault
@ c_StatusDefault
default for non-coloring
Definition DQMHistAnalysis.h:48

◆ clearHistList()

void clearHistList ( void )
staticinherited

Clears the list of histograms.

Definition at line 337 of file DQMHistAnalysis.cc.

338{
339 s_histList.clear();
340}

◆ clearlist()

void clearlist ( void )
staticinherited

Clear all static global lists.

Definition at line 50 of file DQMHistAnalysis.cc.

51{
52 s_histList.clear();
53 s_refList.clear();
54// s_monObjList;
55 s_deltaList.clear();
56 s_canvasUpdatedList.clear();
57}
Belle2::DQMHistAnalysisModule::s_canvasUpdatedList
static CanvasUpdatedList s_canvasUpdatedList
The list of canvas updated status.
Definition DQMHistAnalysis.h:124

◆ clearRefList()

void clearRefList ( void )
staticinherited

Clears the list of ref histograms.

Definition at line 342 of file DQMHistAnalysis.cc.

343{
344 s_refList.clear();
345}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

180{
181 ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
Belle2::ModuleManager::registerModule
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
Definition ModuleManager.cc:80
Belle2::ModuleManager::Instance
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
Definition ModuleManager.cc:24
Belle2::ModuleParamList::setParameters
void setParameters(const ModuleParamList &params)
Set values for parameters from other parameter list.
Definition ModuleParamList.cc:86
Belle2::Module::getParamList
const ModuleParamList & getParamList() const
Return module param list.
Definition Module.h:362
Belle2::Module::getName
const std::string & getName() const
Returns the name of the module.
Definition Module.h:186
Belle2::Module::getType
const std::string & getType() const
Returns the type of the module (i.e.
Definition Module.cc:41
Belle2::Module::m_propertyFlags
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition Module.h:511
Belle2::Module::m_moduleParamList
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition Module.h:515
Belle2::Module::setName
void setName(const std::string &name)
Set the name of the module.
Definition Module.h:213
Belle2::Module::m_logConfig
LogConfig m_logConfig
The log system configuration of the module.
Definition Module.h:513
Belle2::Module::m_conditions
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition Module.h:520
Belle2::Module::m_package
std::string m_package
Package this module is found in (may be empty).
Definition Module.h:509
Belle2::ModulePtr
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition Module.h:43

◆ colorizeCanvas()

void colorizeCanvas ( TCanvas * canvas,
EStatus status )
staticinherited

Helper function for Canvas colorization.

Parameters
canvasCanvas to change
statusstatus to color

Definition at line 750 of file DQMHistAnalysis.cc.

751{
752 if (!canvas) return;
753 auto color = DQMHistAnalysisModule::getStatusColor(stat);
754
755 canvas->Pad()->SetFillColor(color);
756
757 canvas->Pad()->SetFrameFillColor(10); // White (kWhite is not used since it results in transparent!)
758 canvas->Pad()->SetFrameFillStyle(1001);// White
759 canvas->Pad()->Modified();
760 canvas->Pad()->Update();
761}
Belle2::DQMHistAnalysisModule::getStatusColor
static EStatusColor getStatusColor(EStatus status)
Return color for canvas state.
Definition DQMHistAnalysis.cc:723

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ beginRun(); }

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

438{ endRun(); }

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

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

419{ initialize(); }

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

444{ terminate(); }

◆ doHistAnalysis()

void doHistAnalysis ( )
private

Do the actual processing.

Definition at line 279 of file DQMHistAnalysisTRG.cc.

280{
281 m_canvas->Clear();
282 m_canvas->cd(0);
283
284 bool m_IsPhysicsRun = (getRunType() == "physics") || (getRunType() == "cosmic") || (getRunType() == "debug");
285 if (m_IsPhysicsRun == true) {
286
287 //update comL1-GDLL1
288 auto hist_comL1_GDLL1 = getDelta("TRGGDL", "hGDL_gdlL1TocomL1_all", 0, true);// only if updated
289 if (hist_comL1_GDLL1) {
290 double comL1_GDLL1_mean = 0.0;
291 hist_comL1_GDLL1->Draw();
292 comL1_GDLL1_mean = hist_comL1_GDLL1->GetMean();
293 B2DEBUG(1, "comL1_GDLL1_mean:" << comL1_GDLL1_mean);
294 setEpicsPV("comL1_GDLL1_mean", comL1_GDLL1_mean);
295 }
296
297 //update ECLTRG timing
298 auto hist = getDelta("EventT0DQMdir", "m_histEventT0_TOP_hadron_L1_ECLTRG", 0, true);// only if updated
299 if (hist) {
300 double ECLTRG_timing_mean = 0.0;
301 hist->Draw();
302 ECLTRG_timing_mean = hist->GetMean();
303 B2DEBUG(1, "ECLTRG_timing_mean:" << ECLTRG_timing_mean);
304 setEpicsPV("ECLTRG_timing_mean", ECLTRG_timing_mean);
305 }
306
307
308 //update CDCTRG timing
309 auto histCDCTRG = getDelta("EventT0DQMdir", "m_histEventT0_TOP_hadron_L1_CDCTRG", 0, true);// only if updated
310 if (histCDCTRG) {
311 double CDCTRG_timing_mean = 0.0;
312 histCDCTRG->Draw();
313 CDCTRG_timing_mean = histCDCTRG->GetMean();
314 B2DEBUG(1, "CDCTRG_timing_mean:" << CDCTRG_timing_mean);
315 setEpicsPV("CDCTRG_timing_mean", CDCTRG_timing_mean);
316 }
317
318 //update TOPTRG timing
319 auto histTOPTRG = getDelta("EventT0DQMdir", "m_histEventT0_TOP_hadron_L1_TOPTRG", 0, true);// only if updated
320 if (histTOPTRG) {
321 double TOPTRG_timing_mean = 0.0;
322 histTOPTRG->Draw();
323 TOPTRG_timing_mean = histTOPTRG->GetMean();
324 B2DEBUG(1, "TOPTRG_timing_mean:" << TOPTRG_timing_mean);
325 setEpicsPV("TOPTRG_timing_mean", TOPTRG_timing_mean);
326 }
327
328// update ECLTRG peak
329 auto hist_ECLTRG_peak = getDelta("TRGGRL", "h_ECLL1", 0, true);// only if updated
330 if (hist_ECLTRG_peak) {
331// TH1F* hist_ECLTRG_clone = (TH1F*)hist_ECLTRG_peak->Clone();//Clone the histogram.
332 double ECLTRG_peak = 0.0;
333 hist_ECLTRG_peak->Draw();
334// int bin_ECLTRG_peak = hist_ECLTRG_peak->GetMaximumBin();
335// ECLTRG_peak = hist_ECLTRG_peak->GetXaxis()->GetBinCenter(bin_ECLTRG_peak);
336 ECLTRG_peak = hist_ECLTRG_peak->GetMean();
337
338 /*
339 while(ECLTRG_peak<-1310){
340 hist_ECLTRG_clone->SetBinContent(bin_ECLTRG_peak, 0);
341 bin_ECLTRG_peak = hist_ECLTRG_clone->GetMaximumBin();
342 ECLTRG_peak = hist_ECLTRG_clone->GetXaxis()->GetBinCenter(bin_ECLTRG_peak);
343 }
344 */
345
346 B2DEBUG(1, "ECLTRG_peak:" << ECLTRG_peak);
347 setEpicsPV("ECLTRG_peak", ECLTRG_peak);
348// delete hist_ECLTRG_clone;
349 }
350
351// update ECLTRG deadch
352 auto hist_ECLTRG_deadch = getDelta("TRG", "h_TCId", 0, true);// only if updated
353 if (hist_ECLTRG_deadch) {
354 hist_ECLTRG_deadch->Draw();
355 int numberOfBins = hist_ECLTRG_deadch->GetNbinsX();
356 double average = 0;
357 for (int i = 80; i < 512; i++) {
358 average += hist_ECLTRG_deadch->GetBinContent(i);
359 }
360 average = 1.0 * average / (512 - 80);
361 int ECLTRG_deadch = 0;
362// for (int i = 2; i <= numberOfBins - 1; i++) {
363// if (hist_ECLTRG_deadch->GetBinContent(i) <= 0.01 * hist_ECLTRG_deadch->GetMaximum()) { ECLTRG_deadch += 1; }
364// }
365 for (int i = 2; i <= numberOfBins - 1; i++) {
366 if (hist_ECLTRG_deadch->GetBinContent(i) <= 0.01 * average) { ECLTRG_deadch += 1; }
367 }
368 B2DEBUG(1, "ECLTRG_deadch:" << ECLTRG_deadch);
369 setEpicsPV("ECLTRG_deadch", ECLTRG_deadch);
370 }
371
372// update TOPTRG deadch
373 auto hist_TOPTRG_deadch = getDelta("TRGGRL", "h_slot_TOP", 0, true);// only if updated
374 if (hist_TOPTRG_deadch) {
375 hist_TOPTRG_deadch->Draw();
376 int numberOfBins = hist_TOPTRG_deadch->GetNbinsX();
377 int TOPTRG_deadch = 0;
378 for (int i = 2; i <= numberOfBins - 1; i++) {
379 if (hist_TOPTRG_deadch->GetBinContent(i) <= 0.01 * hist_TOPTRG_deadch->GetMaximum()) { TOPTRG_deadch += 1; }
380 }
381 B2DEBUG(1, "TOPTRG_deadch:" << TOPTRG_deadch);
382 setEpicsPV("TOPTRG_deadch", TOPTRG_deadch);
383 }
384
385// m_canvas_CDCTRG_2D_peak->Clear();
386// m_canvas_CDCTRG_2D_peak->cd(0);
387// update CDCTRG 2D peak
388 auto hist_CDCTRG_2D_peak = getDelta("TRGGRL", "h_CDCL1", 0, true);// only if updated
389 if (hist_CDCTRG_2D_peak) {
390 double CDCTRG_2D_peak = 0.0;
391 hist_CDCTRG_2D_peak->Draw();
392 int bin_CDCTRG_2D_peak = hist_CDCTRG_2D_peak->GetMaximumBin();
393 CDCTRG_2D_peak = hist_CDCTRG_2D_peak->GetXaxis()->GetBinCenter(bin_CDCTRG_2D_peak);
394 B2DEBUG(1, "CDCTRG_2D_peak:" << CDCTRG_2D_peak);
395 setEpicsPV("CDCTRG_2D_peak", CDCTRG_2D_peak);
396
397 }
398
399// update CDCTRG NN peak
400 auto hist_NN_peak = getDelta("TRGGRL", "h_CDCNNL1", 0, true);// only if updated
401 if (hist_NN_peak) {
402 double NN_peak = 0.0;
403 hist_NN_peak->Draw();
404 int bin_NN_peak = hist_NN_peak->GetMaximumBin();
405 NN_peak = hist_NN_peak->GetXaxis()->GetBinCenter(bin_NN_peak);
406 B2DEBUG(1, "NN_peak:" << NN_peak);
407 setEpicsPV("NN_peak", NN_peak);
408
409 }
410
411// update CDCTRG TSF
412 auto hist_CDCTRG_TSF_peak = getDelta("TRGGRL", "h_TSFL1", 0, true);// only if updated
413 if (hist_CDCTRG_TSF_peak) {
414 double CDCTRG_TSF_peak = 0.0;
415 hist_CDCTRG_TSF_peak->Draw();
416 int bin_CDCTRG_TSF_peak = hist_CDCTRG_TSF_peak->GetMaximumBin();
417 CDCTRG_TSF_peak = hist_CDCTRG_TSF_peak->GetXaxis()->GetBinCenter(bin_CDCTRG_TSF_peak);
418 B2DEBUG(1, "CDCTRG_TSF_peak:" << CDCTRG_TSF_peak);
419 setEpicsPV("CDCTRG_TSF_peak", CDCTRG_TSF_peak);
420
421 }
422
423// update CDCTRG deadch
424 auto hist_CDCTRG_deadch = getDelta("TRGCDCTNN", "NeuroHWInTSID", 0, true);// only if updated
425 if (hist_CDCTRG_deadch) {
426 hist_CDCTRG_deadch->Draw();
427 int numberOfBins = hist_CDCTRG_deadch->GetNbinsX();
428// int YMax = hist_CDCTRG_deadch->GetBinContent(hist_CDCTRG_deadch->GetMaximumBin());
429 int CDCTRG_deadch = 0;
430 for (int i = 3; i <= numberOfBins; i++) {
431 if (hist_CDCTRG_deadch->GetBinContent(i) <= 0.01 * hist_CDCTRG_deadch->GetMaximum()) {CDCTRG_deadch += 1;}
432// if (hist_CDCTRG_deadch->GetBinContent(i) <= 0) {CDCTRG_deadch += 1;}
433 }
434 B2DEBUG(1, "CDCTRG_deadch:" << CDCTRG_deadch);
435 setEpicsPV("CDCTRG_deadch", CDCTRG_deadch);
436 }
437
438// update KLMTRG
439 auto hist_KLMTRG_peak = getDelta("TRGGRL", "h_KLML1", 0, true);// only if updated
440 if (hist_KLMTRG_peak) {
441 double KLMTRG_peak = 0.0;
442 hist_KLMTRG_peak->Draw();
443 int bin_KLMTRG_peak = hist_KLMTRG_peak->GetMaximumBin();
444 KLMTRG_peak = hist_KLMTRG_peak->GetXaxis()->GetBinCenter(bin_KLMTRG_peak);
445 B2DEBUG(1, "KLMTRG_peak:" << KLMTRG_peak);
446 setEpicsPV("KLMTRG_peak", KLMTRG_peak);
447
448 }
449
450// update TOPTRG
451 auto hist_TOPTRG_peak = getDelta("TRGGRL", "h_TOPL1", 0, true);// only if updated
452 if (hist_TOPTRG_peak) {
453 double TOPTRG_peak = 0.0;
454 hist_TOPTRG_peak->Draw();
455 int bin_TOPTRG_peak = hist_TOPTRG_peak->GetMaximumBin();
456 TOPTRG_peak = hist_TOPTRG_peak->GetXaxis()->GetBinCenter(bin_TOPTRG_peak);
457 B2DEBUG(1, "TOPTRG_peak:" << TOPTRG_peak);
458 setEpicsPV("TOPTRG_peak", TOPTRG_peak);
459
460 }
461
462// update ecltiming_cdctiming
463 auto hist_ecltiming_cdctiming = getDelta("TRGGDL", "hGDL_ns_cdcToecl_all", 0, true);// only if updated
464 if (hist_ecltiming_cdctiming) {
465 double ecltiming_cdctiming = 0.0;
466 hist_ecltiming_cdctiming->Draw();
467 int bin_ecltiming_cdctiming = hist_ecltiming_cdctiming->GetMaximumBin();
468 ecltiming_cdctiming = hist_ecltiming_cdctiming->GetXaxis()->GetBinCenter(bin_ecltiming_cdctiming);
469 B2DEBUG(1, "ecltiming_cdctiming:" << ecltiming_cdctiming);
470 setEpicsPV("ecltiming_cdctiming", ecltiming_cdctiming);//Peak
471 }
472
473// update toptiming_ecltiming
474 auto hist_toptiming_ecltiming = getDelta("TRGGDL", "hGDL_ns_topToecl_all", 0, true);// only if updated
475 if (hist_toptiming_ecltiming) {
476 double toptiming_ecltiming = 0.0;
477 hist_toptiming_ecltiming->Draw();
478 int bin_toptiming_ecltiming = hist_toptiming_ecltiming->GetMaximumBin();
479 toptiming_ecltiming = hist_toptiming_ecltiming->GetXaxis()->GetBinCenter(bin_toptiming_ecltiming);
480 B2DEBUG(1, "toptiming_ecltiming:" << toptiming_ecltiming);
481 setEpicsPV("toptiming_ecltiming", toptiming_ecltiming);//Peak
482 }
483
484// update toptiming_cdctiming
485 auto hist_toptiming_cdctiming = getDelta("TRGGDL", "hGDL_ns_topTocdc_all", 0, true);// only if updated
486 if (hist_toptiming_cdctiming) {
487 double toptiming_cdctiming = 0.0;
488 hist_toptiming_cdctiming->Draw();
489 int bin_toptiming_cdctiming = hist_toptiming_cdctiming->GetMaximumBin();
490 toptiming_cdctiming = hist_toptiming_cdctiming->GetXaxis()->GetBinCenter(bin_toptiming_cdctiming);
491 B2DEBUG(1, "toptiming_cdctiming:" << toptiming_cdctiming);
492 setEpicsPV("toptiming_cdctiming", toptiming_cdctiming);//Peak
493 }
494
495// update gdll1_ecltiming
496 auto hist_gdll1_ecltiming = getDelta("TRGGDL", "hGDL_eclTogdlL1_all", 0, true);// only if updated
497 if (hist_gdll1_ecltiming) {
498 double gdll1_ecltiming = 0.0;
499 hist_gdll1_ecltiming->Draw();
500 int bin_gdll1_ecltiming = hist_gdll1_ecltiming->GetMaximumBin();
501 gdll1_ecltiming = hist_gdll1_ecltiming->GetXaxis()->GetBinCenter(bin_gdll1_ecltiming);
502 B2DEBUG(1, "gdll1_ecltiming:" << gdll1_ecltiming);
503 setEpicsPV("gdll1_ecltiming", gdll1_ecltiming);//Peak
504 }
505
506// update gdll1_cdctiming
507 auto hist_gdll1_cdctiming = getDelta("TRGGDL", "hGDL_cdcTogdlL1_all", 0, true);// only if updated
508 if (hist_gdll1_cdctiming) {
509 double gdll1_cdctiming = 0.0;
510 hist_gdll1_cdctiming->Draw();
511 int bin_gdll1_cdctiming = hist_gdll1_cdctiming->GetMaximumBin();
512 gdll1_cdctiming = hist_gdll1_cdctiming->GetXaxis()->GetBinCenter(bin_gdll1_cdctiming);
513 B2DEBUG(1, "gdll1_cdctiming:" << gdll1_cdctiming);
514 setEpicsPV("gdll1_cdctiming", gdll1_cdctiming);//Peak
515 }
516
517// update gdll1_toptiming
518 auto hist_gdll1_toptiming = getDelta("TRGGDL", "hGDL_topTogdlL1_all", 0, true);// only if updated
519 if (hist_gdll1_toptiming) {
520 double gdll1_toptiming = 0.0;
521 hist_gdll1_toptiming->Draw();
522 int bin_gdll1_toptiming = hist_gdll1_toptiming->GetMaximumBin();
523 gdll1_toptiming = hist_gdll1_toptiming->GetXaxis()->GetBinCenter(bin_gdll1_toptiming);
524 B2DEBUG(1, "gdll1_toptiming:" << gdll1_toptiming);
525 setEpicsPV("gdll1_toptiming", gdll1_toptiming);//Peak
526 }
527
528// update barrel_klm_latency
529 auto hist_barrel_klm_latency = getDelta("TRGGDL", "hGDL_itd_klm_hit_rise_all", 0, true);// only if updated
530 if (hist_barrel_klm_latency) {
531 double barrel_klm_latency = 0.0;
532 hist_barrel_klm_latency->Draw();
533 int bin_barrel_klm_latency = hist_barrel_klm_latency->GetMaximumBin();
534 barrel_klm_latency = hist_barrel_klm_latency->GetXaxis()->GetBinCenter(bin_barrel_klm_latency);
535 B2DEBUG(1, "barrel_klm_latency:" << barrel_klm_latency);
536 setEpicsPV("barrel_klm_latency", barrel_klm_latency);//Peak
537 }
538
539// update endcap_klm_latency
540 auto hist_endcap_klm_latency = getDelta("TRGGDL", "hGDL_itd_eklm_hit_rise_all", 0, true);// only if updated
541 if (hist_endcap_klm_latency) {
542 double endcap_klm_latency = 0.0;
543 hist_endcap_klm_latency->Draw();
544 int bin_endcap_klm_latency = hist_endcap_klm_latency->GetMaximumBin();
545 endcap_klm_latency = hist_endcap_klm_latency->GetXaxis()->GetBinCenter(bin_endcap_klm_latency);
546 B2DEBUG(1, "endcap_klm_latency:" << endcap_klm_latency);
547 setEpicsPV("endcap_klm_latency", endcap_klm_latency);//Peak
548 }
549
550 bool m_IsPhysicsRun_ratio = (getRunType() == "physics");
551 if (m_IsPhysicsRun_ratio == true) {
552
553 //Ratios
554 auto hist_software_trigger = getDelta("softwaretrigger", "skim", 0, true);// only if updated
555
556 if (hist_software_trigger) {
557 hist_software_trigger->Draw();
558 // update #hadronb2/#bhabha_all
559 if (hist_software_trigger->GetBinContent(
560 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all")) != 0) {
561 double hadronb2_over_bhabha_all = 0.0;
562 hadronb2_over_bhabha_all = hist_software_trigger->GetBinContent(
563 hist_software_trigger->GetXaxis()->FindBin("accept_hadronb2")) / hist_software_trigger->GetBinContent(
564 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all"));
565
566 B2DEBUG(1, "hadronb2_over_bhabha_all:" << hadronb2_over_bhabha_all);
567 setEpicsPV("hadronb2_over_bhabha_all", hadronb2_over_bhabha_all);
568 }
569 // update #mumu2trk/#bhabha_all
570 if (hist_software_trigger->GetBinContent(
571 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all")) != 0) {
572 double mumu2trk_over_bhabha_all = 0.0;
573 mumu2trk_over_bhabha_all = hist_software_trigger->GetBinContent(
574 hist_software_trigger->GetXaxis()->FindBin("accept_mumu_2trk")) / hist_software_trigger->GetBinContent(
575 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all"));
576 B2DEBUG(1, "mumu2trk_over_bhabha_all:" << mumu2trk_over_bhabha_all);
577 setEpicsPV("mumu2trk_over_bhabha_all", mumu2trk_over_bhabha_all);
578 }
579 // update #hadronb2/#bhabha_trk_ecl
580 if (hist_software_trigger->GetBinContent(
581 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl")) != 0) {
582 double hadronb2_over_bhabha_trk_ecl = 0.0;
583 hadronb2_over_bhabha_trk_ecl = hist_software_trigger->GetBinContent(
584 hist_software_trigger->GetXaxis()->FindBin("accept_hadronb2")) / hist_software_trigger->GetBinContent(
585 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl"));
586
587 B2DEBUG(1, "hadronb2_over_bhabha_trk_ecl:" << hadronb2_over_bhabha_trk_ecl);
588 setEpicsPV("hadronb2_over_bhabha_trk_ecl", hadronb2_over_bhabha_trk_ecl);
589 }
590 // update #mumu2trk/#bhabha_trk_ecl
591 if (hist_software_trigger->GetBinContent(
592 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl")) != 0) {
593 double mumu2trk_over_bhabha_trk_ecl = 0.0;
594 mumu2trk_over_bhabha_trk_ecl = hist_software_trigger->GetBinContent(
595 hist_software_trigger->GetXaxis()->FindBin("accept_mumu_2trk")) / hist_software_trigger->GetBinContent(
596 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl"));
597 B2DEBUG(1, "mumu2trk_over_bhabha_trk_ecl:" << mumu2trk_over_bhabha_trk_ecl);
598 setEpicsPV("mumu2trk_over_bhabha_trk_ecl", mumu2trk_over_bhabha_trk_ecl);
599 }
600 // update #hadronb2/#mumu2trk
601 if (hist_software_trigger->GetBinContent(
602 hist_software_trigger->GetXaxis()->FindBin("accept_mumu_2trk")) != 0) {
603 double hadronb2_over_mumu2trk = 0.0;
604 hadronb2_over_mumu2trk = hist_software_trigger->GetBinContent(
605 hist_software_trigger->GetXaxis()->FindBin("accept_hadronb2")) / hist_software_trigger->GetBinContent(
606 hist_software_trigger->GetXaxis()->FindBin("accept_mumu_2trk"));
607 B2DEBUG(1, "hadronb2_over_mumu2trk:" << hadronb2_over_mumu2trk);
608 setEpicsPV("hadronb2_over_mumu2trk", hadronb2_over_mumu2trk);
609 }
610 // update #mumu_tight/#bhabha_all
611 if (hist_software_trigger->GetBinContent(
612 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all")) != 0) {
613 double mumu_tight_over_bhabha_all = 0.0;
614 mumu_tight_over_bhabha_all = hist_software_trigger->GetBinContent(
615 hist_software_trigger->GetXaxis()->FindBin("accept_mumutight")) / hist_software_trigger->GetBinContent(
616 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all"));
617 B2DEBUG(1, "mumu_tight_over_bhabha_all:" << mumu_tight_over_bhabha_all);
618 setEpicsPV("mumu_tight_over_bhabha_all", mumu_tight_over_bhabha_all);
619 }
620 // update #gammagamma/#bhabha_all
621
622 if (hist_software_trigger->GetBinContent(
623 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all")) != 0) {
624 double gammagamma_over_bhabha_all = 0.0;
625 gammagamma_over_bhabha_all = hist_software_trigger->GetBinContent(
626 hist_software_trigger->GetXaxis()->FindBin("accept_gamma_gamma")) /
627 hist_software_trigger->GetBinContent(
628 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all"));
629 B2DEBUG(1, "gammagamma_over_bhabha_all:" << gammagamma_over_bhabha_all);
630 setEpicsPV("gammagamma_over_bhabha_all", gammagamma_over_bhabha_all);
631 }
632 // update #tautau2trk/#bhabha_all
633
634 if (hist_software_trigger->GetBinContent(
635 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all")) != 0) {
636 double tautau2trk_over_bhabha_all = 0.0;
637 tautau2trk_over_bhabha_all = hist_software_trigger->GetBinContent(
638 hist_software_trigger->GetXaxis()->FindBin("accept_tau_2trk")) / hist_software_trigger->GetBinContent(
639 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all"));
640 B2DEBUG(1, "tautau2trk_over_bhabha_all:" << tautau2trk_over_bhabha_all);
641 setEpicsPV("tautau2trk_over_bhabha_all", tautau2trk_over_bhabha_all);
642 }
643 // update #hadron/#bhabha_all
644 if (hist_software_trigger->GetBinContent(
645 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all")) != 0) {
646 double hadron_over_bhabha_all = 0.0;
647 hadron_over_bhabha_all = hist_software_trigger->GetBinContent(
648 hist_software_trigger->GetXaxis()->FindBin("accept_hadron")) / hist_software_trigger->GetBinContent(
649 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_all"));
650 B2DEBUG(1, "hadron_over_bhabha_all:" << hadron_over_bhabha_all);
651 setEpicsPV("hadron_over_bhabha_all", hadron_over_bhabha_all);
652 }
653 // update #mumu_tight/#bhabha_trk_ecl
654 if (hist_software_trigger->GetBinContent(
655 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl")) != 0) {
656 double mumu_tight_over_bhabha_trk_ecl = 0.0;
657 mumu_tight_over_bhabha_trk_ecl = hist_software_trigger->GetBinContent(
658 hist_software_trigger->GetXaxis()->FindBin("accept_mumutight")) / hist_software_trigger->GetBinContent(
659 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl"));
660 B2DEBUG(1, "mumu_tight_over_bhabha_trk_ecl:" << mumu_tight_over_bhabha_trk_ecl);
661 setEpicsPV("mumu_tight_over_bhabha_trk_ecl", mumu_tight_over_bhabha_trk_ecl);
662 }
663 // update #gammagamma/#bhabha_trk_ecl
664 if (hist_software_trigger->GetBinContent(
665 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl")) != 0) {
666 double gammagamma_over_bhabha_trk_ecl = 0.0;
667 gammagamma_over_bhabha_trk_ecl = hist_software_trigger->GetBinContent(
668 hist_software_trigger->GetXaxis()->FindBin("accept_gamma_gamma")) /
669 hist_software_trigger->GetBinContent(
670 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl"));
671 B2DEBUG(1, "gammagamma_over_bhabha_trk_ecl:" << gammagamma_over_bhabha_trk_ecl);
672 setEpicsPV("gammagamma_over_bhabha_trk_ecl", gammagamma_over_bhabha_trk_ecl);
673 }
674 // update #tautau2trk/#bhabha_trk_ecl
675
676 if (hist_software_trigger->GetBinContent(
677 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl")) != 0) {
678 double tautau2trk_over_bhabha_trk_ecl = 0.0;
679 tautau2trk_over_bhabha_trk_ecl = hist_software_trigger->GetBinContent(
680 hist_software_trigger->GetXaxis()->FindBin("accept_tau_2trk")) / hist_software_trigger->GetBinContent(
681 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl"));
682 B2DEBUG(1, "tautau2trk_over_bhabha_trk_ecl:" << tautau2trk_over_bhabha_trk_ecl);
683 setEpicsPV("tautau2trk_over_bhabha_trk_ecl", tautau2trk_over_bhabha_trk_ecl);
684 }
685 // update #hadron/#bhabha_trk_ecl
686
687 if (hist_software_trigger->GetBinContent(
688 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl")) != 0) {
689 double hadron_over_bhabha_trk_ecl = 0.0;
690 hadron_over_bhabha_trk_ecl = hist_software_trigger->GetBinContent(
691 hist_software_trigger->GetXaxis()->FindBin("accept_hadron")) / hist_software_trigger->GetBinContent(
692 hist_software_trigger->GetXaxis()->FindBin("accept_bhabha_trk_ecl"));
693 B2DEBUG(1, "hadron_over_bhabha_trk_ecl:" << hadron_over_bhabha_trk_ecl);
694 setEpicsPV("hadron_over_bhabha_trk_ecl", hadron_over_bhabha_trk_ecl);
695 }
696
697 }
698
699 }
700
701 auto hist_nTSFHits_total = getDelta("TRGGRL", "h_wirecnt_sum", 0, true);
702 if (hist_nTSFHits_total) {
703 double mean = hist_nTSFHits_total->GetMean();
704 B2DEBUG(1, "CDCTRG_meanTSFHits_total:" << mean);
705 setEpicsPV("CDCTRG_meanTSFHits_total", mean);
706 }
707
708 auto hist_nTSFHits_clean = getDelta("TRGGRL", "h_wirecnt_sum_clean", 0, true);
709 if (hist_nTSFHits_clean) {
710 double mean = hist_nTSFHits_clean->GetMean();
711 B2DEBUG(1, "CDCTRG_meanTSFHits_clean:" << mean);
712 setEpicsPV("CDCTRG_meanTSFHits_clean", mean);
713
714 double tail = getThreshold(hist_nTSFHits_clean, 0.5, 0.02);
715 B2DEBUG(1, "CDCTRG_tailTSFHits_clean:" << tail);
716 setEpicsPV("CDCTRG_tailTSFHits_clean", tail);
717 }
718
719 auto hist_nTSFHits_injHER = getDelta("TRGGRL", "h_wirecnt_sum_injHER", 0, true);
720 if (hist_nTSFHits_injHER) {
721 double mean = hist_nTSFHits_injHER->GetMean();
722 B2DEBUG(1, "CDCTRG_meanTSFHits_injHER:" << mean);
723 setEpicsPV("CDCTRG_meanTSFHits_injHER", mean);
724 }
725
726 auto hist_nTSFHits_injLER = getDelta("TRGGRL", "h_wirecnt_sum_injLER", 0, true);
727 if (hist_nTSFHits_injLER) {
728 double mean = hist_nTSFHits_injLER->GetMean();
729 B2DEBUG(1, "CDCTRG_meanTSFHits_injLER:" << mean);
730 setEpicsPV("CDCTRG_meanTSFHits_injLER", mean);
731 }
732
733 auto hist_nTC_total = getDelta("TRG", "h_n_TChit_event_clkgrp", 0, true);
734 if (hist_nTC_total) {
735 double mean = hist_nTC_total->GetMean();
736 B2DEBUG(1, "ECLTRG_meanTC_total:" << mean);
737 setEpicsPV("ECLTRG_meanTC_total", mean);
738 }
739
740 auto hist_nTC_clean = getDelta("TRG", "h_n_TChit_clean_clkgrp", 0, true);
741 if (hist_nTC_clean) {
742 double mean = hist_nTC_clean->GetMean();
743 B2DEBUG(1, "ECLTRG_meanTC_clean:" << mean);
744 setEpicsPV("ECLTRG_meanTC_clean", mean);
745
746 double tail = getThreshold(hist_nTC_clean, 0.5);
747 B2DEBUG(1, "ECLTRG_tailTC_clean:" << tail);
748 setEpicsPV("ECLTRG_tailTC_clean", tail);
749 }
750
751 auto hist_nTC_injHER = getDelta("TRG", "h_n_TChit_injHER_clkgrp", 0, true);
752 if (hist_nTC_injHER) {
753 double mean = hist_nTC_injHER->GetMean();
754 B2DEBUG(1, "ECLTRG_meanTC_injHER:" << mean);
755 setEpicsPV("ECLTRG_meanTC_injHER", mean);
756 }
757
758 auto hist_nTC_injLER = getDelta("TRG", "h_n_TChit_injLER_clkgrp", 0, true);
759 if (hist_nTC_injLER) {
760 double mean = hist_nTC_injLER->GetMean();
761 B2DEBUG(1, "ECLTRG_meanTC_injLER:" << mean);
762 setEpicsPV("ECLTRG_meanTC_injLER", mean);
763 }
764
765 auto hist_nTC_FWD_total = getDelta("TRG", "h_n_TChit_FWD_event_clkgrp", 0, true);
766 if (hist_nTC_FWD_total) {
767 double mean = hist_nTC_FWD_total->GetMean();
768 B2DEBUG(1, "ECLTRG_meanTC_FWD_total:" << mean);
769 setEpicsPV("ECLTRG_meanTC_FWD_total", mean);
770 }
771
772 auto hist_nTC_FWD_clean = getDelta("TRG", "h_n_TChit_FWD_clean_clkgrp", 0, true);
773 if (hist_nTC_FWD_clean) {
774 double mean = hist_nTC_FWD_clean->GetMean();
775 B2DEBUG(1, "ECLTRG_meanTC_FWD_clean:" << mean);
776 setEpicsPV("ECLTRG_meanTC_FWD_clean", mean);
777
778 double tail = getThreshold(hist_nTC_FWD_clean, 0.5);
779 B2DEBUG(1, "ECLTRG_tailTC_FWD_clean:" << tail);
780 setEpicsPV("ECLTRG_tailTC_FWD_clean", tail);
781 }
782
783 auto hist_nTC_FWD_injHER = getDelta("TRG", "h_n_TChit_FWD_injHER_clkgrp", 0, true);
784 if (hist_nTC_FWD_injHER) {
785 double mean = hist_nTC_FWD_injHER->GetMean();
786 B2DEBUG(1, "ECLTRG_meanTC_FWD_injHER:" << mean);
787 setEpicsPV("ECLTRG_meanTC_FWD_injHER", mean);
788 }
789
790 auto hist_nTC_FWD_injLER = getDelta("TRG", "h_n_TChit_FWD_injLER_clkgrp", 0, true);
791 if (hist_nTC_FWD_injLER) {
792 double mean = hist_nTC_FWD_injLER->GetMean();
793 B2DEBUG(1, "ECLTRG_meanTC_FWD_injLER:" << mean);
794 setEpicsPV("ECLTRG_meanTC_FWD_injLER", mean);
795 }
796
797 auto hist_nTC_BRL_total = getDelta("TRG", "h_n_TChit_BRL_event_clkgrp", 0, true);
798 if (hist_nTC_BRL_total) {
799 double mean = hist_nTC_BRL_total->GetMean();
800 B2DEBUG(1, "ECLTRG_meanTC_BRL_total:" << mean);
801 setEpicsPV("ECLTRG_meanTC_BRL_total", mean);
802 }
803
804 auto hist_nTC_BRL_clean = getDelta("TRG", "h_n_TChit_BRL_clean_clkgrp", 0, true);
805 if (hist_nTC_BRL_clean) {
806 double mean = hist_nTC_BRL_clean->GetMean();
807 B2DEBUG(1, "ECLTRG_meanTC_BRL_clean:" << mean);
808 setEpicsPV("ECLTRG_meanTC_BRL_clean", mean);
809
810 double tail = getThreshold(hist_nTC_BRL_clean, 0.5);
811 B2DEBUG(1, "ECLTRG_tailTC_BRL_clean:" << tail);
812 setEpicsPV("ECLTRG_tailTC_BRL_clean", tail);
813 }
814
815 auto hist_nTC_BRL_injHER = getDelta("TRG", "h_n_TChit_BRL_injHER_clkgrp", 0, true);
816 if (hist_nTC_BRL_injHER) {
817 double mean = hist_nTC_BRL_injHER->GetMean();
818 B2DEBUG(1, "ECLTRG_meanTC_BRL_injHER:" << mean);
819 setEpicsPV("ECLTRG_meanTC_BRL_injHER", mean);
820 }
821
822 auto hist_nTC_BRL_injLER = getDelta("TRG", "h_n_TChit_BRL_injLER_clkgrp", 0, true);
823 if (hist_nTC_BRL_injLER) {
824 double mean = hist_nTC_BRL_injLER->GetMean();
825 B2DEBUG(1, "ECLTRG_meanTC_BRL_injLER:" << mean);
826 setEpicsPV("ECLTRG_meanTC_BRL_injLER", mean);
827 }
828
829 auto hist_nTC_BWD_total = getDelta("TRG", "h_n_TChit_BWD_event_clkgrp", 0, true);
830 if (hist_nTC_BWD_total) {
831 double mean = hist_nTC_BWD_total->GetMean();
832 B2DEBUG(1, "ECLTRG_meanTC_BWD_total:" << mean);
833 setEpicsPV("ECLTRG_meanTC_BWD_total", mean);
834 }
835
836 auto hist_nTC_BWD_clean = getDelta("TRG", "h_n_TChit_BWD_clean_clkgrp", 0, true);
837 if (hist_nTC_BWD_clean) {
838 double mean = hist_nTC_BWD_clean->GetMean();
839 B2DEBUG(1, "ECLTRG_meanTC_BWD_clean:" << mean);
840 setEpicsPV("ECLTRG_meanTC_BWD_clean", mean);
841
842 double tail = getThreshold(hist_nTC_BWD_clean, 0.5);
843 B2DEBUG(1, "ECLTRG_tailTC_BWD_clean:" << tail);
844 setEpicsPV("ECLTRG_tailTC_BWD_clean", tail);
845 }
846
847 auto hist_nTC_BWD_injHER = getDelta("TRG", "h_n_TChit_BWD_injHER_clkgrp", 0, true);
848 if (hist_nTC_BWD_injHER) {
849 double mean = hist_nTC_BWD_injHER->GetMean();
850 B2DEBUG(1, "ECLTRG_meanTC_BWD_injHER:" << mean);
851 setEpicsPV("ECLTRG_meanTC_BWD_injHER", mean);
852 }
853
854 auto hist_nTC_BWD_injLER = getDelta("TRG", "h_n_TChit_BWD_injLER_clkgrp", 0, true);
855 if (hist_nTC_BWD_injLER) {
856 double mean = hist_nTC_BWD_injLER->GetMean();
857 B2DEBUG(1, "ECLTRG_meanTC_BWD_injLER:" << mean);
858 setEpicsPV("ECLTRG_meanTC_BWD_injLER", mean);
859 }
860
861
862 // Tag canvas as updated ONLY if things have changed.
863 UpdateCanvas(m_canvas->GetName(), hist != nullptr);
864
865 // this if left over from jsroot, may not be needed anymore (to check)
866 m_canvas->Update();
867 }
868
869}
Belle2::DQMHistAnalysisModule::UpdateCanvas
static void UpdateCanvas(const std::string &name, bool updated=true)
Mark canvas as updated (or not)
Definition DQMHistAnalysis.cc:354
Belle2::DQMHistAnalysisModule::getRunType
static const std::string & getRunType(void)
Get the list of the reference histograms.
Definition DQMHistAnalysis.h:215
Belle2::DQMHistAnalysisModule::getDelta
TH1 * getDelta(const std::string &fullname, int n=0, bool onlyIfUpdated=true)
Get Delta histogram.
Definition DQMHistAnalysis.cc:129
Belle2::DQMHistAnalysisModule::setEpicsPV
void setEpicsPV(const std::string &keyname, double value)
Write value to a EPICS PV.
Definition DQMHistAnalysis.cc:426
Belle2::DQMHistAnalysisTRGModule::getThreshold
static double getThreshold(const TH1 *hist, const double lower_bound, const double widthFraction=0.01)
A utility function to find the location of the tail of histograms.
Definition DQMHistAnalysisTRG.cc:877

◆ endRun()

void endRun ( void )
finaloverrideprivatevirtual

Called when run ends.

Reimplemented from Module.

Definition at line 268 of file DQMHistAnalysisTRG.cc.

269{
270 B2DEBUG(1, "DQMHistAnalysisTRGModule: endRun called.");
271}

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition Module.h:518
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition Module.h:517

◆ event()

void event ( void )
finaloverrideprivatevirtual

This method is called for each event.

Reimplemented from Module.

Definition at line 273 of file DQMHistAnalysisTRG.cc.

274{
275 B2DEBUG(1, "DQMHistAnalysisTRGModule: event called.");
276 doHistAnalysis();
277}
Belle2::DQMHistAnalysisTRGModule::doHistAnalysis
void doHistAnalysis()
Do the actual processing.
Definition DQMHistAnalysisTRG.cc:279

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional paths */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
350 .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
351 .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
352 .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
353 .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
354 .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
355 .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
491 &Module::setLogConfig)
Belle2::ModuleCondition::c_GE
@ c_GE
Greater or equal than: ">=".
Definition ModuleCondition.h:35
Belle2::ModuleCondition::c_SE
@ c_SE
Smaller or equal than: "<=".
Definition ModuleCondition.h:36
Belle2::ModuleCondition::c_GT
@ c_GT
Greater than: ">".
Definition ModuleCondition.h:33
Belle2::ModuleCondition::c_NE
@ c_NE
Not equal: "!=".
Definition ModuleCondition.h:38
Belle2::ModuleCondition::c_EQ
@ c_EQ
Equal: "=" or "==".
Definition ModuleCondition.h:37
Belle2::ModuleCondition::c_ST
@ c_ST
Smaller than: "<".
Definition ModuleCondition.h:34
Belle2::Module::if_value
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition Module.cc:79
Belle2::Module::if_true
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition Module.cc:90
Belle2::Module::Module
Module()
Constructor.
Definition Module.cc:30
Belle2::Module::setReturnValue
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition Module.cc:220
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition Module.h:78
Belle2::Module::c_ParallelProcessingCertified
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition Module.h:80
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition Module.h:83
Belle2::Module::if_false
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition Module.cc:85
Belle2::Module::EAfterConditionPath
ModuleCondition::EAfterConditionPath EAfterConditionPath
Forward the EAfterConditionPath definition from the ModuleCondition.
Definition Module.h:88

◆ ExtractNEvent()

void ExtractNEvent ( std::vector< TH1 * > & hs)
staticinherited

Extract event processed from daq histogram, called from input module.

Definition at line 376 of file DQMHistAnalysis.cc.

377{
378 s_eventProcessed = 0;
379 for (size_t i = 0; i < hs.size(); i++) {
380 if (hs[i]->GetName() == std::string("DAQ/Nevent")) {
381 s_eventProcessed = hs[i]->GetEntries();
382 return;
383 }
384 }
385 B2ERROR("ExtractEvent: Histogram \"DAQ/Nevent\" missing");
386}
Belle2::DQMHistAnalysisModule::s_eventProcessed
static int s_eventProcessed
Number of Events processed to fill histograms.
Definition DQMHistAnalysis.h:138

◆ ExtractRunType()

void ExtractRunType ( std::vector< TH1 * > & hs)
staticinherited

Extract Run Type from histogram title, called from input module.

Definition at line 364 of file DQMHistAnalysis.cc.

365{
366 s_runType = "";
367 for (size_t i = 0; i < hs.size(); i++) {
368 if (hs[i]->GetName() == std::string("DQMInfo/rtype")) {
369 s_runType = hs[i]->GetTitle();
370 return;
371 }
372 }
373 B2ERROR("ExtractRunType: Histogram \"DQMInfo/rtype\" missing");
374}
Belle2::DQMHistAnalysisModule::s_runType
static std::string s_runType
The Run type.
Definition DQMHistAnalysis.h:143

◆ findCanvas()

TCanvas * findCanvas ( TString cname)
staticinherited

Find canvas by name.

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

Definition at line 146 of file DQMHistAnalysis.cc.

147{
148 TIter nextkey(gROOT->GetListOfCanvases());
149 TObject* obj{};
150
151 while ((obj = dynamic_cast<TObject*>(nextkey()))) {
152 if (obj->IsA()->InheritsFrom("TCanvas")) {
153 if (obj->GetName() == canvas_name)
154 return dynamic_cast<TCanvas*>(obj);
155 }
156 }
157 return nullptr;
158}

◆ findHist() [1/2]

TH1 * findHist ( const std::string & dirname,
const std::string & histname,
bool onlyIfUpdated = false )
staticinherited

Find histogram.

Parameters
dirnameThe name of the directory.
histnameThe name of the histogram.
onlyIfUpdatedreq only updated hists, return nullptr otherwise
Returns
The found histogram, or nullptr if not found.

Definition at line 174 of file DQMHistAnalysis.cc.

175{
176 if (dirname.size() > 0) {
177 return findHist(dirname + "/" + histname, updated);
178 }
179 return findHist(histname, updated);
180}
Belle2::DQMHistAnalysisModule::findHist
static TH1 * findHist(const std::string &histname, bool onlyIfUpdated=false)
Get histogram from list (no other search).
Definition DQMHistAnalysis.cc:160

◆ findHist() [2/2]

TH1 * findHist ( const std::string & histname,
bool onlyIfUpdated = false )
staticinherited

Get histogram from list (no other search).

Parameters
histnameThe name of the histogram (incl dir).
onlyIfUpdatedreq only updated hists, return nullptr otherwise
Returns
The found histogram, or nullptr if not found.

Definition at line 160 of file DQMHistAnalysis.cc.

161{
162 if (s_histList.find(histname) != s_histList.end()) {
163 if (was_updated && !s_histList[histname].isUpdated()) return nullptr;
164 if (s_histList[histname].getHist()) {
165 return s_histList[histname].getHist();
166 } else {
167 B2ERROR("Histogram " << histname << " in histogram list but nullptr.");
168 }
169 }
170 B2INFO("Histogram " << histname << " not in list.");
171 return nullptr;
172}

◆ findHistInCanvas()

TH1 * findHistInCanvas ( const std::string & hname,
TCanvas ** canvas = nullptr )
inherited

Find histogram in corresponding canvas.

Parameters
hnameName of the histogram (dir+name)
canvasptr to specific canvas ptr or nullptr
Returns
The pointer to the histogram, or nullptr if not found.

Definition at line 228 of file DQMHistAnalysis.cc.

229{
230 TCanvas* cnv = nullptr;
231 // try to get canvas from outside
232 if (cobj) cnv = *cobj;
233 // if no canvas search for it
234 if (cnv == nullptr) {
235 // parse the dir+histo name and create the corresponding canvas name
236 auto s = StringSplit(histo_name, '/');
237 if (s.size() != 2) {
238 B2ERROR("findHistInCanvas: histoname not valid (missing dir?), should be 'dirname/histname': " << histo_name);
239 return nullptr;
240 }
241 auto dirname = s.at(0);
242 auto hname = s.at(1);
243 std::string canvas_name = dirname + "/c_" + hname;
244 cnv = findCanvas(canvas_name);
245 // set canvas pointer for outside
246 if (cnv && cobj) *cobj = cnv;
247 }
248
249 // get histogram pointer
250 if (cnv != nullptr) {
251 TIter nextkey(cnv->GetListOfPrimitives());
252 TObject* obj{};
253 while ((obj = dynamic_cast<TObject*>(nextkey()))) {
254 if (obj->IsA()->InheritsFrom("TH1")) {
255 if (obj->GetName() == histo_name)
256 return dynamic_cast<TH1*>(obj);
257 }
258 }
259 }
260 return nullptr;
261}
Belle2::DQMHistAnalysisModule::findCanvas
static TCanvas * findCanvas(TString cname)
Find canvas by name.
Definition DQMHistAnalysis.cc:146
Belle2::DQMHistAnalysisModule::StringSplit
static std::vector< std::string > StringSplit(const std::string &s, const char delim)
Helper function for string token split.
Definition DQMHistAnalysis.cc:302

◆ findHistInFile()

TH1 * findHistInFile ( TFile * file,
const std::string & histname )
staticinherited

Find histogram in specific TFile (e.g.

ref file).

Parameters
fileThe TFile to search.
histnameThe name of the histogram, can incl directory
Returns
The found histogram, or nullptr if not found.

Definition at line 263 of file DQMHistAnalysis.cc.

264{
265 // find histogram by name in file, histname CAN contain directory!
266 // will return nullptr if file is zeroptr, not found or not correct type
267 if (file && file->IsOpen()) {
268 auto obj = file->Get(histname.data());
269 if (obj != nullptr) {
270 // check class type
271 if (obj->IsA()->InheritsFrom("TH1")) {
272 B2DEBUG(20, "Histogram " << histname << " found in file");
273 return dynamic_cast<TH1*>(obj);
274 } else {
275 B2INFO("Found Object " << histname << " in file is not a histogram");
276 }
277 } else {
278 B2INFO("Histogram " << histname << " not found in file");
279 }
280 }
281 return nullptr;
282}

◆ 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 284 of file DQMHistAnalysis.cc.

285{
286 if (s_monObjList.find(objName) != s_monObjList.end()) {
287 return &s_monObjList[objName];
288 }
289 B2INFO("MonitoringObject " << objName << " not in memfile.");
290 return nullptr;
291}
Belle2::DQMHistAnalysisModule::s_monObjList
static MonObjList s_monObjList
The list of MonitoringObjects.
Definition DQMHistAnalysis.h:112

◆ findRefHist() [1/2]

TH1 * findRefHist ( const std::string & dirname,
const std::string & histname,
ERefScaling scaling = ERefScaling::c_RefScaleNone,
const TH1 * hist = nullptr )
staticinherited

Find reference histogram.

Parameters
dirnameThe name of the directory.
histnameThe name of the histogram.
scalingenum what scaling to use
histhistogram to scale to
Returns
The found histogram, or nullptr if not found.

Definition at line 219 of file DQMHistAnalysis.cc.

221{
222 if (dirname.size() > 0) {
223 return findRefHist(dirname + "/" + histname, scaling, hist);
224 }
225 return findRefHist(histname, scaling, hist);
226}
Belle2::DQMHistAnalysisModule::findRefHist
static TH1 * findRefHist(const std::string &histname, ERefScaling scaling=ERefScaling::c_RefScaleNone, const TH1 *hist=nullptr)
Get referencehistogram from list (no other search).
Definition DQMHistAnalysis.cc:208

◆ findRefHist() [2/2]

TH1 * findRefHist ( const std::string & histname,
ERefScaling scaling = ERefScaling::c_RefScaleNone,
const TH1 * hist = nullptr )
staticinherited

Get referencehistogram from list (no other search).

Parameters
histnameThe name of the histogram (incl dir).
scalingenum what scaling to use
histhistogram to scale to
Returns
The found histogram, or nullptr if not found.

Definition at line 208 of file DQMHistAnalysis.cc.

209{
210 if (s_refList.find(histname) != s_refList.end()) {
211 // get a copy of the reference which we can modify
212 // (it is still owned and managed by the framework)
213 // then do the scaling
214 return scaleReference(scaling, hist, s_refList[histname].getReference());
215 }
216 return nullptr;
217}
Belle2::DQMHistAnalysisModule::scaleReference
static TH1 * scaleReference(ERefScaling scaling, const TH1 *hist, TH1 *ref)
Using the original and reference, create scaled version.
Definition DQMHistAnalysis.cc:182

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const
inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const
inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

324 {
325 return m_conditions;
326 }

◆ getCanvasUpdatedList()

static const CanvasUpdatedList & getCanvasUpdatedList ( )
inlinestaticinherited

Get the list of the canvas update status.

Returns
The list of the canvases.

Definition at line 202 of file DQMHistAnalysis.h.

202{ return s_canvasUpdatedList;};

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 313 of file Module.h.

314 {
315 if (m_conditions.empty()) {
316 return nullptr;
317 } else {
318 return &m_conditions.front();
319 }
320 }

◆ getConditionPath()

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

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

Definition at line 113 of file Module.cc.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
Belle2::PathPtr
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition Path.h:35

◆ getDelta() [1/2]

TH1 * getDelta ( const std::string & dirname,
const std::string & histname,
int n = 0,
bool onlyIfUpdated = true )
inherited

Get Delta histogram.

Parameters
dirnamedirectory
histnamename of histogram
nindex of delta histogram, 0 is most recent one
onlyIfUpdatedreq only updated deltas, return nullptr otherwise
Returns
delta histogram or nullptr

Definition at line 118 of file DQMHistAnalysis.cc.

119{
120 std::string fullname;
121 if (dirname.size() > 0) {
122 fullname = dirname + "/" + histname;
123 } else {
124 fullname = histname;
125 }
126 return getDelta(fullname, n, onlyIfUpdated);
127}

◆ getDelta() [2/2]

TH1 * getDelta ( const std::string & fullname,
int n = 0,
bool onlyIfUpdated = true )
inherited

Get Delta histogram.

Parameters
fullnamedirectory+name of histogram
nindex of delta histogram, 0 is most recent one
onlyIfUpdatedreq only updated deltas, return nullptr otherwise
Returns
delta histogram or nullptr

Definition at line 129 of file DQMHistAnalysis.cc.

130{
131 auto it = s_deltaList.find(fullname);
132 if (it != s_deltaList.end()) {
133 return it->second.getDelta(n, onlyIfUpdated);
134 }
135 B2WARNING("Delta hist " << fullname << " not found");
136 return nullptr;
137}

◆ getDeltaList()

static const DeltaList & getDeltaList ( )
inlinestaticinherited

Get the list of the delta histograms.

Returns
The list of the delta histograms.

Definition at line 196 of file DQMHistAnalysis.h.

196{ return s_deltaList;};

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

201{return m_description;}

◆ getEpicsPV() [1/2]

double getEpicsPV ( const std::string & keyname)
inherited

Read value from a EPICS PV.

Parameters
keynamekey name (or full PV name) of PV
Returns
value or NAN if not existing

Definition at line 507 of file DQMHistAnalysis.cc.

508{
509 double value{NAN};
510 if (!m_useEpics) return value;
511#ifdef _BELLE2_EPICS
512 if (m_epicsNameToChID[keyname] == nullptr) {
513 B2ERROR("Epics PV " << keyname << " not registered!");
514 return value;
515 }
516 // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
517 // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
518 // outstanding get requests are not automatically reissued following reconnect.
519 auto r = ca_get(DBR_DOUBLE, m_epicsNameToChID[keyname], (void*)&value);
520 if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
521 if (r == ECA_NORMAL) {
522 return value;
523 } else {
524 CheckEpicsError(r, "Read PV failed in ca_get or ca_pend_io failure", keyname);
525 }
526#endif
527 return NAN;
528}
Belle2::DQMHistAnalysisModule::m_useEpics
static bool m_useEpics
Flag if to use EPICS do not set by yourself, use EpicsEnable module to set.
Definition DQMHistAnalysis.h:149

◆ getEpicsPV() [2/2]

double getEpicsPV ( int index)
inherited

Read value from a EPICS PV.

Parameters
indexindex of PV
Returns
value or NAN if not existing

Definition at line 530 of file DQMHistAnalysis.cc.

531{
532 double value{NAN};
533 if (!m_useEpics) return value;
534#ifdef _BELLE2_EPICS
535 if (index < 0 || index >= (int)m_epicsChID.size()) {
536 B2ERROR("Epics PV with " << index << " not registered!");
537 return value;
538 }
539 // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
540 // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
541 // outstanding get requests are not automatically reissued following reconnect.
542 auto r = ca_get(DBR_DOUBLE, m_epicsChID[index], (void*)&value);
543 if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
544 if (r == ECA_NORMAL) {
545 return value;
546 } else {
547 CheckEpicsError(r, "Read PV failed in ca_get or ca_pend_io failure", m_epicsChID[index]);
548 }
549#endif
550 return NAN;
551}

◆ getEpicsPVChID() [1/2]

chid getEpicsPVChID ( const std::string & keyname)
inherited

Get EPICS PV Channel Id.

Parameters
keynamekey name (or full PV name) of PV
Returns
Channel ID is written on success, otherwise nullptr

Definition at line 603 of file DQMHistAnalysis.cc.

604{
605#ifdef _BELLE2_EPICS
606 if (m_useEpics) {
607 if (m_epicsNameToChID[keyname] != nullptr) {
608 return m_epicsNameToChID[keyname];
609 } else {
610 B2ERROR("Epics PV " << keyname << " not registered!");
611 }
612 }
613#endif
614 return nullptr;
615}

◆ getEpicsPVChID() [2/2]

chid getEpicsPVChID ( int index)
inherited

Get EPICS PV Channel Id.

Parameters
indexindex of PV
Returns
Channel ID is written on success, otherwise nullptr

Definition at line 617 of file DQMHistAnalysis.cc.

618{
619#ifdef _BELLE2_EPICS
620 if (m_useEpics) {
621 if (index >= 0 && index < (int)m_epicsChID.size()) {
622 return m_epicsChID[index];
623 } else {
624 B2ERROR("Epics PV with " << index << " not registered!");
625 }
626 }
627#endif
628 return nullptr;
629}

◆ getEpicsStringPV() [1/2]

std::string getEpicsStringPV ( const std::string & keyname,
bool & status )
inherited

Read value from a EPICS PV.

Parameters
keynamekey name (or full PV name) of PV
statusreturn status (true on success)
Returns
string value (empty string if non existing)

Definition at line 553 of file DQMHistAnalysis.cc.

554{
555 status = false;
556 char value[40] = "";
557 if (!m_useEpics) return std::string(value);
558#ifdef _BELLE2_EPICS
559 if (m_epicsNameToChID[keyname] == nullptr) {
560 B2ERROR("Epics PV " << keyname << " not registered!");
561 return std::string(value);
562 }
563 // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
564 // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
565 // outstanding get requests are not automatically reissued following reconnect.
566 auto r = ca_get(DBR_STRING, m_epicsNameToChID[keyname], value);
567 if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
568 if (r == ECA_NORMAL) {
569 status = true;
570 return std::string(value);
571 } else {
572 CheckEpicsError(r, "Read PV (string) failed in ca_get or ca_pend_io failure", keyname);
573 }
574#endif
575 return std::string(value);
576}

◆ getEpicsStringPV() [2/2]

std::string getEpicsStringPV ( int index,
bool & status )
inherited

Read value from a EPICS PV.

Parameters
indexindex of PV
statusreturn status (true on success)
Returns
string value (empty string if non existing)

Definition at line 578 of file DQMHistAnalysis.cc.

579{
580 status = false;
581 char value[40] = "";
582 if (!m_useEpics) return std::string(value);
583#ifdef _BELLE2_EPICS
584 if (index < 0 || index >= (int)m_epicsChID.size()) {
585 B2ERROR("Epics PV with " << index << " not registered!");
586 return std::string(value);
587 }
588 // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
589 // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
590 // outstanding get requests are not automatically reissued following reconnect.
591 auto r = ca_get(DBR_STRING, m_epicsChID[index], value);
592 if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
593 if (r == ECA_NORMAL) {
594 status = true;
595 return std::string(value);
596 } else {
597 CheckEpicsError(r, "Read PV (string) failed in ca_get or ca_pend_io failure", m_epicsChID[index]);
598 }
599#endif
600 return std::string(value);
601}

◆ getEventProcessed()

static int getEventProcessed ( void )
inlinestaticinherited

Get the number of processed events.

(Attention, asynch histogram updates!)

Returns
Processed events.

Definition at line 221 of file DQMHistAnalysis.h.

221{ return s_eventProcessed;};

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

134 {
135 return std::vector<std::string>();
136 }

◆ getHistList()

static HistList & getHistList ( )
inlinestaticinherited

Get the list of the histograms.

Returns
The list of the histograms.

Definition at line 184 of file DQMHistAnalysis.h.

184{ return s_histList;};

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

505{ return std::list<ModulePtr>(); }

◆ getMonitoringObject()

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

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

Parameters
namename of MonitoringObject to get
Returns
The MonitoringObject

Definition at line 139 of file DQMHistAnalysis.cc.

140{
141 auto obj = &s_monObjList[objName];
142 obj->SetName(objName.c_str());
143 return obj;
144}

◆ getMonObjList()

static MonObjList & getMonObjList ( )
inlinestaticinherited

Get the list of MonitoringObjects.

Returns
The list of the MonitoringObjects.

Definition at line 190 of file DQMHistAnalysis.h.

190{ return s_monObjList;};

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

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

280{
281 return m_moduleParamList.getParamInfoListPython();
282}
Belle2::ModuleParamList::getParamInfoListPython
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
Definition ModuleParamList.cc:64

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getPVPrefix()

static std::string & getPVPrefix ( void )
inlinestaticinherited

get global prefix for EPICS PVs

Returns
prefix in use

Definition at line 610 of file DQMHistAnalysis.h.

610{return m_PVPrefix;};

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

380{ return m_returnValue; }

◆ getRunType()

static const std::string & getRunType ( void )
inlinestaticinherited

Get the list of the reference histograms.

Returns
The list of the reference histograms. Get the Run Type.
Run type string.

Definition at line 215 of file DQMHistAnalysis.h.

215{ return s_runType;};

◆ getSigma68()

double getSigma68 ( TH1 * h)
staticinherited

Helper function to compute half of the central interval covering 68% of a distribution.

This quantity is an alternative to the standard deviation.

Parameters
hhistogram
Returns
Half of the central interval covering 68% of a distribution.

Definition at line 293 of file DQMHistAnalysis.cc.

294{
295 double probs[2] = {0.16, 1 - 0.16};
296 double quant[2] = {0, 0};
297 h->GetQuantiles(2, quant, probs);
298 const double sigma68 = (-quant[0] + quant[1]) / 2;
299 return sigma68;
300}

◆ getStatusColor()

DQMHistAnalysisModule::EStatusColor getStatusColor ( EStatus status)
staticinherited

Return color for canvas state.

Parameters
statuscanvas status
Returns
alarm color

Definition at line 723 of file DQMHistAnalysis.cc.

724{
725 // white color is the default, if no colorize
726 EStatusColor color = c_ColorDefault;
727 switch (stat) {
728 case c_StatusTooFew:
729 color = c_ColorTooFew; // Magenta or Gray
730 break;
731 case c_StatusDefault:
732 color = c_ColorDefault; // default no colors
733 break;
734 case c_StatusGood:
735 color = c_ColorGood; // Good
736 break;
737 case c_StatusWarning:
738 color = c_ColorWarning; // Warning
739 break;
740 case c_StatusError:
741 color = c_ColorError; // Severe
742 break;
743 default:
744 color = c_ColorDefault; // default no colors
745 break;
746 }
747 return color;
748}
Belle2::DQMHistAnalysisModule::EStatusColor
EStatusColor
Status colors of histogram/canvas (corresponding to status)
Definition DQMHistAnalysis.h:57
Belle2::DQMHistAnalysisModule::c_ColorWarning
@ c_ColorWarning
Analysis result: Warning, there may be minor issues.
Definition DQMHistAnalysis.h:61
Belle2::DQMHistAnalysisModule::c_ColorError
@ c_ColorError
Analysis result: Severe issue found.
Definition DQMHistAnalysis.h:62
Belle2::DQMHistAnalysisModule::c_ColorTooFew
@ c_ColorTooFew
Not enough entries/event to judge.
Definition DQMHistAnalysis.h:58
Belle2::DQMHistAnalysisModule::c_ColorGood
@ c_ColorGood
Analysis result: Good.
Definition DQMHistAnalysis.h:60
Belle2::DQMHistAnalysisModule::c_ColorDefault
@ c_ColorDefault
default for non-coloring
Definition DQMHistAnalysis.h:59
Belle2::DQMHistAnalysisModule::c_StatusTooFew
@ c_StatusTooFew
Not enough entries/event to judge.
Definition DQMHistAnalysis.h:47
Belle2::DQMHistAnalysisModule::c_StatusError
@ c_StatusError
Analysis result: Severe issue found.
Definition DQMHistAnalysis.h:51
Belle2::DQMHistAnalysisModule::c_StatusWarning
@ c_StatusWarning
Analysis result: Warning, there may be minor issues.
Definition DQMHistAnalysis.h:50
Belle2::DQMHistAnalysisModule::c_StatusGood
@ c_StatusGood
Analysis result: Good.
Definition DQMHistAnalysis.h:49

◆ getThreshold()

double getThreshold ( const TH1 * hist,
const double lower_bound,
const double widthFraction = 0.01 )
static

A utility function to find the location of the tail of histograms.

Definition at line 877 of file DQMHistAnalysisTRG.cc.

878{
879 if (hist == nullptr) return 0.;
880
881 double movsum = 0;
882 int nbins = hist->GetNbinsX();
883 int width = nbins * widthFraction;
884 int num = 0;
885
886 if (width <= 1) width = 2;
887
888 int meanbin = hist->GetXaxis()->FindBin(hist->GetMean());
889
890 for (int i = meanbin - 1; 1 <= i && i <= meanbin - width; i--) {
891 num++;
892 movsum += hist->GetBinContent(i);
893 }
894
895 for (int i = meanbin; i < nbins; i++) {
896 int binIdx = i + 1;
897
898 if (num < width) {
899 movsum += hist->GetBinContent(binIdx);
900 num++;
901 } else {
902 movsum += hist->GetBinContent(binIdx);
903 movsum -= hist->GetBinContent(binIdx - width);
904 }
905
906 if (movsum / num < lower_bound) {
907 return hist->GetBinCenter(binIdx);
908 }
909 }
910 return hist->GetXaxis()->GetBinCenter(nbins);
911}

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
Belle2::Module::m_type
std::string m_type
The type of the module, saved as a string.
Definition Module.h:508

◆ getUseEpics()

static bool getUseEpics ( void )
inlinestaticinherited

Getter for EPICS usage.

Returns
flag is in use

Definition at line 593 of file DQMHistAnalysis.h.

593{return m_useEpics;};

◆ getUseEpicsReadOnly()

static bool getUseEpicsReadOnly ( void )
inlinestaticinherited

Getter EPICS flag in read only mode.

Returns
flag if read only

Definition at line 599 of file DQMHistAnalysis.h.

599{return m_epicsReadOnly;};

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 310 of file Module.h.

310{ return not m_conditions.empty(); };

◆ hasDeltaPar()

bool hasDeltaPar ( const std::string & dirname,
const std::string & histname )
staticinherited

Check if Delta histogram parameters exist for histogram.

Parameters
dirnamedirectory
histnamename of histogram
Returns
true if parameters have been set already

Definition at line 107 of file DQMHistAnalysis.cc.

108{
109 std::string fullname;
110 if (dirname.size() > 0) {
111 fullname = dirname + "/" + histname;
112 } else {
113 fullname = histname;
114 }
115 return s_deltaList.find(fullname) != s_deltaList.end(); // contains() if we switch to C++20
116}

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

Return true if this module has a valid return value set.

Definition at line 377 of file Module.h.

377{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

167{
168 auto missing = m_moduleParamList.getUnsetForcedParams();
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
Belle2::ModuleParamList::getUnsetForcedParams
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.
Definition ModuleParamList.cc:54

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

86{
87 if_value("<1", path, afterConditionPath);
88}

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

91{
92 if_value(">=1", path, afterConditionPath);
93}

◆ 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://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

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

Definition at line 79 of file Module.cc.

80{
81 m_conditions.emplace_back(expression, path, afterConditionPath);
82}

◆ initHistListBeforeEvent()

void initHistListBeforeEvent ( void )
staticinherited

Reset the list of histograms.

Definition at line 323 of file DQMHistAnalysis.cc.

324{
325 for (auto& it : s_histList) {
326 // attention, we must use reference, otherwise we work on a copy
327 it.second.resetBeforeEvent();
328 }
329 for (auto& it : s_deltaList) {
330 // attention, we must use reference, otherwise we work on a copy
331 it.second.setNotUpdated();
332 }
333
334 s_canvasUpdatedList.clear();
335}

◆ initialize()

void initialize ( void )
finaloverrideprivatevirtual

Initializer.

Reimplemented from Module.

Definition at line 41 of file DQMHistAnalysisTRG.cc.

42{
43 B2DEBUG(1, "DQMHistAnalysisTRGModule: initialized.");
44
45 gROOT->cd();
46 m_canvas = new TCanvas("TRG/c_Test");
47 //comL1-GDLL1
48 addDeltaPar("TRGGDL", "hGDL_gdlL1TocomL1_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
49 registerEpicsPV(m_pvPrefix + "comL1_GDLL1_mean", "comL1_GDLL1_mean");
50
51 //ECLTRG timing
52 addDeltaPar("EventT0DQMdir", "m_histEventT0_TOP_hadron_L1_ECLTRG", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
53 registerEpicsPV(m_pvPrefix + "ECLTRG_timing_mean", "ECLTRG_timing_mean");
54
55 //CDCTRG event timing
56 addDeltaPar("EventT0DQMdir", "m_histEventT0_TOP_hadron_L1_CDCTRG", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
57 registerEpicsPV(m_pvPrefix + "CDCTRG_timing_mean", "CDCTRG_timing_mean");
58
59 //TOPTRG event timing
60 addDeltaPar("EventT0DQMdir", "m_histEventT0_TOP_hadron_L1_TOPTRG", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
61 registerEpicsPV(m_pvPrefix + "TOPTRG_timing_mean", "TOPTRG_timing_mean");
62
63 //ECLTRG_peak
64 addDeltaPar("TRGGRL", "h_ECLL1", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
65 registerEpicsPV(m_pvPrefix + "ECLTRG_peak", "ECLTRG_peak");
66
67
68 //CDCTRG_2D_peak
69 addDeltaPar("TRGGRL", "h_CDCL1", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
70 registerEpicsPV(m_pvPrefix + "CDCTRG_2D_peak", "CDCTRG_2D_peak");
71
72
73 //NN_peak
74 addDeltaPar("TRGGRL", "h_CDCNNL1", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
75 registerEpicsPV(m_pvPrefix + "NN_peak", "NN_peak");
76
77 //CDCTRG_TSF_peak
78 addDeltaPar("TRGGRL", "h_TSFL1", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
79 registerEpicsPV(m_pvPrefix + "CDCTRG_TSF_peak", "CDCTRG_TSF_peak");
80
81 //KLMTRG_peak
82 addDeltaPar("TRGGRL", "h_KLML1", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
83 registerEpicsPV(m_pvPrefix + "KLMTRG_peak", "KLMTRG_peak");
84
85 //TOPTRG_peak
86 addDeltaPar("TRGGRL", "h_TOPL1", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
87 registerEpicsPV(m_pvPrefix + "TOPTRG_peak", "TOPTRG_peak");
88
89 //CDCTRG nTSFHits total
90 addDeltaPar("TRGGRL", "h_wirecnt_sum", HistDelta::c_Entries, 1000, 1);
91 registerEpicsPV(m_pvPrefix + "CDCTRG_meanTSFHits_total", "CDCTRG_meanTSFHits_total");
92
93 //CDCTRG nTSFHits Injection BG Clean region
94 addDeltaPar("TRGGRL", "h_wirecnt_sum_clean", HistDelta::c_Entries, 1000, 1);
95 registerEpicsPV(m_pvPrefix + "CDCTRG_meanTSFHits_clean", "CDCTRG_meanTSFHits_clean"); // Mean value for the distribution of N(TSF)
96 registerEpicsPV(m_pvPrefix + "CDCTRG_tailTSFHits_clean",
97 "CDCTRG_tailTSFHits_clean"); // Tail position for the distribution of N(TSF)
98
99 //CDCTRG nTSFHits HER Injection region
100 addDeltaPar("TRGGRL", "h_wirecnt_sum_injHER", HistDelta::c_Entries, 1000, 1);
101 registerEpicsPV(m_pvPrefix + "CDCTRG_meanTSFHits_injHER", "CDCTRG_meanTSFHits_injHER");
102
103 //CDCTRG nTSFHits LER Injection region
104 addDeltaPar("TRGGRL", "h_wirecnt_sum_injLER", HistDelta::c_Entries, 1000, 1);
105 registerEpicsPV(m_pvPrefix + "CDCTRG_meanTSFHits_injLER", "CDCTRG_meanTSFHits_injLER");
106
107 //ecl timing –cdc timing
108 addDeltaPar("TRGGDL", "hGDL_ns_cdcToecl_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
109 registerEpicsPV(m_pvPrefix + "ecltiming_cdctiming", "ecltiming_cdctiming");
110
111 //top timing – ecl timing
112 addDeltaPar("TRGGDL", "hGDL_ns_topToecl_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
113 registerEpicsPV(m_pvPrefix + "toptiming_ecltiming", "toptiming_ecltiming");
114
115 // top timing – cdc timing
116 addDeltaPar("TRGGDL", "hGDL_ns_topTocdc_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
117 registerEpicsPV(m_pvPrefix + "toptiming_cdctiming", "toptiming_cdctiming");
118
119 // gdll1-ecl timing
120 addDeltaPar("TRGGDL", "hGDL_eclTogdlL1_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
121 registerEpicsPV(m_pvPrefix + "gdll1_ecltiming", "gdll1_ecltiming");
122
123 //gdll1-cdctiming
124 addDeltaPar("TRGGDL", "hGDL_cdcTogdlL1_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
125 registerEpicsPV(m_pvPrefix + "gdll1_cdctiming", "gdll1_cdctiming");
126
127 //gdll1-toptiming
128 addDeltaPar("TRGGDL", "hGDL_topTogdlL1_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
129 registerEpicsPV(m_pvPrefix + "gdll1_toptiming", "gdll1_toptiming");
130
131 //barrel klm latency
132 addDeltaPar("TRGGDL", "hGDL_itd_klm_hit_rise_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
133 registerEpicsPV(m_pvPrefix + "barrel_klm_latency", "barrel_klm_latency");
134
135 //endcap klm latency
136 addDeltaPar("TRGGDL", "hGDL_itd_eklm_hit_rise_all", HistDelta::c_Entries, 1000, 1); // update each 1000 entries
137 registerEpicsPV(m_pvPrefix + "endcap_klm_latency", "endcap_klm_latency");
138
139 //hadronb2_over_bhabha_all
140 addDeltaPar("softwaretrigger", "skim", HistDelta::c_Entries, 1000000, 1); // update each 1000000 entries
141 registerEpicsPV(m_pvPrefix + "hadronb2_over_bhabha_all", "hadronb2_over_bhabha_all");
142
143 //mumu2trk_over_bhabha_all
144 registerEpicsPV(m_pvPrefix + "mumu2trk_over_bhabha_all", "mumu2trk_over_bhabha_all");
145
146 //hadronb2_over_mumu2trk
147 registerEpicsPV(m_pvPrefix + "hadronb2_over_mumu2trk", "hadronb2_over_mumu2trk");
148
149 //ECLTRG_deadch
150 addDeltaPar("TRG", "h_TCId", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
151 registerEpicsPV(m_pvPrefix + "ECLTRG_deadch", "ECLTRG_deadch");
152
153 //ECLTRG N(TC) total
154 addDeltaPar("TRG", "h_n_TChit_event_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
155 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_total", "ECLTRG_meanTC_total");
156
157 //ECLTRG N(TC) clean
158 addDeltaPar("TRG", "h_n_TChit_clean_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
159 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_clean", "ECLTRG_meanTC_clean"); // Mean value for the distribution of N(TC)
160 registerEpicsPV(m_pvPrefix + "ECLTRG_tailTC_clean", "ECLTRG_tailTC_clean"); // Tail position for the distribution of N(TC)
161
162 //ECLTRG N(TC) HER Injection region
163 addDeltaPar("TRG", "h_n_TChit_injHER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
164 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_injHER", "ECLTRG_meanTC_injHER");
165
166 //ECLTRG N(TC) LER Injection region
167 addDeltaPar("TRG", "h_n_TChit_injLER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
168 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_injLER", "ECLTRG_meanTC_injLER");
169
170 //ECLTRG N(TC) total from the forward endcap
171 addDeltaPar("TRG", "h_n_TChit_FWD_event_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
172 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_FWD_total", "ECLTRG_meanTC_FWD_total");
173
174 //ECLTRG N(TC) clean from the forward endcap
175 addDeltaPar("TRG", "h_n_TChit_FWD_clean_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
176 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_FWD_clean",
177 "ECLTRG_meanTC_FWD_clean"); // Mean value for the distribution of N(TC) from the forward
178 registerEpicsPV(m_pvPrefix + "ECLTRG_tailTC_FWD_clean",
179 "ECLTRG_tailTC_FWD_clean"); // Tail position for the distribution of N(TC) from the forward
180
181 //ECLTRG N(TC) HER Injection region from the forward endcap
182 addDeltaPar("TRG", "h_n_TChit_FWD_injHER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
183 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_FWD_injHER", "ECLTRG_meanTC_FWD_injHER");
184
185 //ECLTRG N(TC) LER Injection region from the forward endcap
186 addDeltaPar("TRG", "h_n_TChit_FWD_injLER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
187 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_FWD_injLER", "ECLTRG_meanTC_FWD_injLER");
188
189 //ECLTRG N(TC) total from the barrel
190 addDeltaPar("TRG", "h_n_TChit_BRL_event_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
191 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BRL_total", "ECLTRG_meanTC_BRL_total");
192
193 //ECLTRG N(TC) clean from the barrel
194 addDeltaPar("TRG", "h_n_TChit_BRL_clean_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
195 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BRL_clean",
196 "ECLTRG_meanTC_BRL_clean"); // Mean value for the distribution of N(TC) from the barrel
197 registerEpicsPV(m_pvPrefix + "ECLTRG_tailTC_BRL_clean",
198 "ECLTRG_tailTC_BRL_clean"); // Tail position for the distribution of N(TC) from the barrel
199
200 //ECLTRG N(TC) HER Injection region from the barrel
201 addDeltaPar("TRG", "h_n_TChit_BRL_injHER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
202 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BRL_injHER", "ECLTRG_meanTC_BRL_injHER");
203
204 //ECLTRG N(TC) LER Injection region from the barrel
205 addDeltaPar("TRG", "h_n_TChit_BRL_injLER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
206 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BRL_injLER", "ECLTRG_meanTC_BRL_injLER");
207
208 //ECLTRG N(TC) total from the backward endcap
209 addDeltaPar("TRG", "h_n_TChit_BWD_event_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
210 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BWD_total", "ECLTRG_meanTC_BWD_total");
211
212 //ECLTRG N(TC) clean from the backward endcap
213 addDeltaPar("TRG", "h_n_TChit_BWD_clean_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
214 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BWD_clean",
215 "ECLTRG_meanTC_BWD_clean"); // Mean value for the distribution of N(TC) from the backward
216 registerEpicsPV(m_pvPrefix + "ECLTRG_tailTC_BWD_clean",
217 "ECLTRG_tailTC_BWD_clean"); // Tail position for the distribution of N(TC) from the backward
218
219 //ECLTRG N(TC) HER Injection region from the backward endcap
220 addDeltaPar("TRG", "h_n_TChit_BWD_injHER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
221 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BWD_injHER", "ECLTRG_meanTC_BWD_injHER");
222
223 //ECLTRG N(TC) LER Injection region from the backward endcap
224 addDeltaPar("TRG", "h_n_TChit_BWD_injLER_clkgrp", HistDelta::c_Entries, 10000, 1); // update each 10000 entries
225 registerEpicsPV(m_pvPrefix + "ECLTRG_meanTC_BWD_injLER", "ECLTRG_meanTC_BWD_injLER");
226
227 //CDCTRG_deadch
228// m_canvas_CDCTRG_deadch = new TCanvas("CDCTRG_deadch");
229 addDeltaPar("TRGCDCTNN", "NeuroHWInTSID", HistDelta::c_Entries, 100000, 1); // update each 100000 entries
230 registerEpicsPV(m_pvPrefix + "CDCTRG_deadch", "CDCTRG_deadch");
231
232 //hadronb2_over_bhabha_trk_ecl
233 registerEpicsPV(m_pvPrefix + "hadronb2_over_bhabha_trk_ecl", "hadronb2_over_bhabha_trk_ecl");
234
235 //mumu2trk_over_bhabha_trk_ecl
236 registerEpicsPV(m_pvPrefix + "mumu2trk_over_bhabha_trk_ecl", "mumu2trk_over_bhabha_trk_ecl");
237
238 //mumu_tight_over_bhabha_all
239 registerEpicsPV(m_pvPrefix + "mumu_tight_over_bhabha_all", "mumu_tight_over_bhabha_all");
240
241 //gammagamma_over_bhabha_all
242 registerEpicsPV(m_pvPrefix + "gammagamma_over_bhabha_all", "gammagamma_over_bhabha_all");
243
244 //tautau2trk_over_bhabha_all
245 registerEpicsPV(m_pvPrefix + "tautau2trk_over_bhabha_all", "tautau2trk_over_bhabha_all");
246
247 //hadron_over_bhabha_all
248 registerEpicsPV(m_pvPrefix + "hadron_over_bhabha_all", "hadron_over_bhabha_all");
249
250 //mumu_tight_over_bhabha_trk_ecl
251 registerEpicsPV(m_pvPrefix + "mumu_tight_over_bhabha_trk_ecl", "mumu_tight_over_bhabha_trk_ecl");
252
253 //gammagamma_over_bhabha_trk_ecl
254 registerEpicsPV(m_pvPrefix + "gammagamma_over_bhabha_trk_ecl", "gammagamma_over_bhabha_trk_ecl");
255
256 //tautau2trk_over_bhabha_trk_ecl
257 registerEpicsPV(m_pvPrefix + "tautau2trk_over_bhabha_trk_ecl", "tautau2trk_over_bhabha_trk_ecl");
258
259 //hadron_over_bhabha_trk_ecl
260 registerEpicsPV(m_pvPrefix + "hadron_over_bhabha_trk_ecl", "hadron_over_bhabha_trk_ecl");
261}
Belle2::DQMHistAnalysisModule::registerEpicsPV
int registerEpicsPV(const std::string &pvname, const std::string &keyname="")
EPICS related Functions.
Definition DQMHistAnalysis.cc:388
Belle2::DQMHistAnalysisModule::addDeltaPar
static void addDeltaPar(const std::string &dirname, const std::string &histname, HistDelta::EDeltaType t, int p, unsigned int a=1)
Add Delta histogram parameters.
Definition DQMHistAnalysis.cc:95

◆ makeStatus()

DQMHistAnalysisModule::EStatus makeStatus ( bool enough,
bool warn_flag,
bool error_flag )
staticinherited

Helper function to judge the status for coloring and EPICS.

Parameters
enoughenough events for judging
warn_flagoutside of expected range
error_flagoutside of warning range
Returns
the status

Definition at line 705 of file DQMHistAnalysis.cc.

706{
707 // white color is the default, if no colorize
708 if (!enough) {
709 return (c_StatusTooFew);
710 } else {
711 if (error_flag) {
712 return (c_StatusError);
713 } else if (warn_flag) {
714 return (c_StatusWarning);
715 } else {
716 return (c_StatusGood);
717 }
718 }
719
720 return (c_StatusDefault); // default, but should not be reached
721}

◆ printPVStatus()

void printPVStatus ( chid pv,
bool onlyError = true )
staticinherited

check the status of a PVs and report if disconnected or not found

Parameters
pvthe chid of the PV to check
onlyErrorprint only if in error condition (default)

Definition at line 773 of file DQMHistAnalysis.cc.

774{
775 if (pv == nullptr) {
776 B2WARNING("PV chid was nullptr");
777 return;
778 }
779 auto state = ca_state(pv);
780 switch (state) {
781 case cs_never_conn: /* valid chid, server not found or unavailable */
782 B2WARNING("Channel never connected " << ca_name(pv));
783 break;
784 case cs_prev_conn: /* valid chid, previously connected to server */
785 B2WARNING("Channel was connected, but now is not " << ca_name(pv));
786 break;
787 case cs_closed: /* channel deleted by user */
788 B2WARNING("Channel deleted already " << ca_name(pv));
789 break;
790 case cs_conn: /* valid chid, connected to server */
791 if (!onlyError) B2INFO("Channel connected and OK " << ca_name(pv));
792 break;
793 default:
794 B2WARNING("Undefined status for channel " << ca_name(pv));
795 break;
796 }
797}

◆ registerEpicsPV()

int registerEpicsPV ( const std::string & pvname,
const std::string & keyname = "" )
inherited

EPICS related Functions.

Register a PV with its name and a key name

Parameters
pvnamefull PV name
keynamekey name for easier access
Returns
an index which can be used to access the PV instead of key name, -1 if failure

Definition at line 388 of file DQMHistAnalysis.cc.

389{
390 return registerEpicsPVwithPrefix(m_PVPrefix, pvname, keyname);
391}
Belle2::DQMHistAnalysisModule::m_PVPrefix
static std::string m_PVPrefix
The Prefix for EPICS PVs.
Definition DQMHistAnalysis.h:160
Belle2::DQMHistAnalysisModule::registerEpicsPVwithPrefix
int registerEpicsPVwithPrefix(const std::string &prefix, const std::string &pvname, const std::string &keyname="")
Register a PV with its name and a key name.
Definition DQMHistAnalysis.cc:398

◆ registerEpicsPVwithPrefix()

int registerEpicsPVwithPrefix ( const std::string & prefix,
const std::string & pvname,
const std::string & keyname = "" )
privateinherited

Register a PV with its name and a key name.

Parameters
prefixprefix to PV name
pvnamefull PV name without prefix
keynamekey name for easier access
Returns
an index which can be used to access the PV instead of key name, -1 if failure

Definition at line 398 of file DQMHistAnalysis.cc.

400{
401 if (!m_useEpics) return -1;
402#ifdef _BELLE2_EPICS
403 if (m_epicsNameToChID[pvname] != nullptr) {
404 B2ERROR("Epics PV " << pvname << " already registered!");
405 return -1;
406 }
407 if (keyname != "" && m_epicsNameToChID[keyname] != nullptr) {
408 B2ERROR("Epics PV with key " << keyname << " already registered!");
409 return -1;
410 }
411
412 m_epicsChID.emplace_back();
413 auto ptr = &m_epicsChID.back();
414 if (!ca_current_context()) SEVCHK(ca_context_create(ca_disable_preemptive_callback), "ca_context_create");
415 // the subscribed name includes the prefix, the map below does *not*
416 CheckEpicsError(ca_create_channel((prefix + pvname).data(), NULL, NULL, 10, ptr), "ca_create_channel failure", pvname);
417
418 m_epicsNameToChID[pvname] = *ptr;
419 if (keyname != "") m_epicsNameToChID[keyname] = *ptr;
420 return m_epicsChID.size() - 1; // return index to last added item
421#else
422 return -1;
423#endif
424}

◆ registerExternalEpicsPV()

int registerExternalEpicsPV ( const std::string & pvname,
const std::string & keyname = "" )
inherited

Register a PV with its name and a key name.

Parameters
pvnamefull PV name
keynamekey name for easier access
Returns
an index which can be used to access the PV instead of key name, -1 if failure

Definition at line 393 of file DQMHistAnalysis.cc.

394{
395 return registerEpicsPVwithPrefix(std::string(""), pvname, keyname);
396}

◆ requestLimitsFromEpicsPVs() [1/3]

bool requestLimitsFromEpicsPVs ( chid id,
double & lowerAlarm,
double & lowerWarn,
double & upperWarn,
double & upperAlarm )
inherited

Get Alarm Limits from EPICS PV.

Parameters
idChannel ID
&lowerAlarmreturn low Alarm limit (lolo) if set, not changed otherwise
&lowerWarnreturn low Warning limit (low) if set, not changed otherwise
&upperWarnreturn upper Warning limit (high) if set, not changed otherwise
&upperAlarmreturn upper Alarm limit (hihi) if set, not changed otherwise
Returns
true if limits could be read (even if there are none set)

Definition at line 670 of file DQMHistAnalysis.cc.

672{
673 // get warn and error limit only if pv exists
674 // overwrite only if limit is defined (not NaN)
675 // user should initialize with NaN before calling, unless
676 // some "default" values should be set otherwise
677 if (pv != nullptr) {
678 struct dbr_ctrl_double tPvData;
679 // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
680 // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
681 // outstanding get requests are not automatically reissued following reconnect.
682 auto r = ca_get(DBR_CTRL_DOUBLE, pv, &tPvData);
683 if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
684 if (r == ECA_NORMAL) {
685 if (!std::isnan(tPvData.lower_alarm_limit)) {
686 lowerAlarm = tPvData.lower_alarm_limit;
687 }
688 if (!std::isnan(tPvData.lower_warning_limit)) {
689 lowerWarn = tPvData.lower_warning_limit;
690 }
691 if (!std::isnan(tPvData.upper_warning_limit)) {
692 upperWarn = tPvData.upper_warning_limit;
693 }
694 if (!std::isnan(tPvData.upper_alarm_limit)) {
695 upperAlarm = tPvData.upper_alarm_limit;
696 }
697 return true;
698 } else {
699 CheckEpicsError(r, "Reading PV Limits failed in ca_get or ca_pend_io failure", pv);
700 }
701 }
702 return false;
703}

◆ requestLimitsFromEpicsPVs() [2/3]

bool requestLimitsFromEpicsPVs ( const std::string & keyname,
double & lowerAlarm,
double & lowerWarn,
double & upperWarn,
double & upperAlarm )
inherited

Get Alarm Limits from EPICS PV.

Parameters
keynamekey name (or full PV name) of PV
&lowerAlarmreturn low Alarm limit (lolo) if set, not changed otherwise
&lowerWarnreturn low Warning limit (low) if set, not changed otherwise
&upperWarnreturn upper Warning limit (high) if set, not changed otherwise
&upperAlarmreturn upper Alarm limit (hihi) if set, not changed otherwise
Returns
true if limits could be read (even if there are none set)

Definition at line 658 of file DQMHistAnalysis.cc.

660{
661 return requestLimitsFromEpicsPVs(getEpicsPVChID(name), lowerAlarm, lowerWarn, upperWarn, upperAlarm);
662}
Belle2::DQMHistAnalysisModule::getEpicsPVChID
chid getEpicsPVChID(const std::string &keyname)
Get EPICS PV Channel Id.
Definition DQMHistAnalysis.cc:603
Belle2::DQMHistAnalysisModule::requestLimitsFromEpicsPVs
bool requestLimitsFromEpicsPVs(chid id, double &lowerAlarm, double &lowerWarn, double &upperWarn, double &upperAlarm)
Get Alarm Limits from EPICS PV.
Definition DQMHistAnalysis.cc:670

◆ requestLimitsFromEpicsPVs() [3/3]

bool requestLimitsFromEpicsPVs ( int index,
double & lowerAlarm,
double & lowerWarn,
double & upperWarn,
double & upperAlarm )
inherited

Get Alarm Limits from EPICS PV.

Parameters
indexindex of PV
&lowerAlarmreturn low Alarm limit (lolo) if set, not changed otherwise
&lowerWarnreturn low Warning limit (low) if set, not changed otherwise
&upperWarnreturn upper Warning limit (high) if set, not changed otherwise
&upperAlarmreturn upper Alarm limit (hihi) if set, not changed otherwise
Returns
true if limits could be read (even if there are none set)

Definition at line 664 of file DQMHistAnalysis.cc.

666{
667 return requestLimitsFromEpicsPVs(getEpicsPVChID(index), lowerAlarm, lowerWarn, upperWarn, upperAlarm);
668}

◆ resetDeltaList()

void resetDeltaList ( void )
staticinherited

Reset Delta.

Definition at line 347 of file DQMHistAnalysis.cc.

348{
349 for (auto& d : s_deltaList) {
350 d.second.reset();
351 }
352}

◆ scaleReference()

TH1 * scaleReference ( ERefScaling scaling,
const TH1 * hist,
TH1 * ref )
staticinherited

Using the original and reference, create scaled version.

Parameters
scalingscaling algorithm
histpointer to histogram
refpointer to reference
Returns
scaled reference

Definition at line 182 of file DQMHistAnalysis.cc.

183{
184 // if hist/ref is nullptr, nothing to do
185 if (!hist || !ref)
186 return ref;
187
188 switch (scaling) {
189 // default: do nothing
190 case ERefScaling::c_RefScaleNone: //do nothing
191 break;
192 case ERefScaling::c_RefScaleEntries: // Integral
193 // only if we have entries in reference
194 if (hist->Integral() != 0 and ref->Integral() != 0) {
195 ref->Scale(hist->Integral() / ref->Integral());
196 }
197 break;
198 case ERefScaling::c_RefScaleMax: // Maximum
199 // only if we have entries in reference
200 if (hist->GetMaximum() != 0 and ref->GetMaximum() != 0) {
201 ref->Scale(hist->GetMaximum() / ref->GetMaximum());
202 }
203 break;
204 }
205 return ref;
206}
Belle2::DQMHistAnalysisModule::c_RefScaleEntries
@ c_RefScaleEntries
to number of entries (integral)
Definition DQMHistAnalysis.h:70
Belle2::DQMHistAnalysisModule::c_RefScaleMax
@ c_RefScaleMax
to maximum (bin entry)
Definition DQMHistAnalysis.h:71

◆ setAbortLevel()

void setAbortLevel ( int abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition LogConfig.h:26
Belle2::LogConfig::setAbortLevel
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
Belle2::LogConfig::setDebugLevel
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition LogConfig.h:98

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}
Belle2::Module::m_description
std::string m_description
The description of the module.
Definition Module.h:510

◆ setEpicsPV() [1/4]

void setEpicsPV ( const std::string & keyname,
double value )
inherited

Write value to a EPICS PV.

Parameters
keynamekey name (or full PV name) of PV
valuevalue to write

Definition at line 426 of file DQMHistAnalysis.cc.

427{
428 if (!m_useEpics || m_epicsReadOnly) return;
429#ifdef _BELLE2_EPICS
430 if (m_epicsNameToChID[keyname] == nullptr) {
431 B2ERROR("Epics PV " << keyname << " not registered!");
432 return;
433 }
434 CheckEpicsError(ca_put(DBR_DOUBLE, m_epicsNameToChID[keyname], (void*)&value), "ca_set failure", keyname);
435#endif
436}
Belle2::DQMHistAnalysisModule::m_epicsReadOnly
static bool m_epicsReadOnly
Flag if to use EPICS in ReadOnly mode (for reading limits) do not set by yourself,...
Definition DQMHistAnalysis.h:155

◆ setEpicsPV() [2/4]

void setEpicsPV ( const std::string & keyname,
int value )
inherited

Write value to a EPICS PV.

Parameters
keynamekey name (or full PV name) of PV
valuevalue to write

Definition at line 438 of file DQMHistAnalysis.cc.

439{
440 if (!m_useEpics || m_epicsReadOnly) return;
441#ifdef _BELLE2_EPICS
442 if (m_epicsNameToChID[keyname] == nullptr) {
443 B2ERROR("Epics PV " << keyname << " not registered!");
444 return;
445 }
446 CheckEpicsError(ca_put(DBR_SHORT, m_epicsNameToChID[keyname], (void*)&value), "ca_set failure", keyname);
447#endif
448}

◆ setEpicsPV() [3/4]

void setEpicsPV ( int index,
double value )
inherited

Write value to a EPICS PV.

Parameters
indexindex of PV
valuevalue to write

Definition at line 468 of file DQMHistAnalysis.cc.

469{
470 if (!m_useEpics || m_epicsReadOnly) return;
471#ifdef _BELLE2_EPICS
472 if (index < 0 || index >= (int)m_epicsChID.size()) {
473 B2ERROR("Epics PV with " << index << " not registered!");
474 return;
475 }
476 CheckEpicsError(ca_put(DBR_DOUBLE, m_epicsChID[index], (void*)&value), "ca_set failure", m_epicsChID[index]);
477#endif
478}

◆ setEpicsPV() [4/4]

void setEpicsPV ( int index,
int value )
inherited

Write value to a EPICS PV.

Parameters
indexindex of PV
valuevalue to write

Definition at line 480 of file DQMHistAnalysis.cc.

481{
482 if (!m_useEpics || m_epicsReadOnly) return;
483#ifdef _BELLE2_EPICS
484 if (index < 0 || index >= (int)m_epicsChID.size()) {
485 B2ERROR("Epics PV with " << index << " not registered!");
486 return;
487 }
488 CheckEpicsError(ca_put(DBR_SHORT, m_epicsChID[index], (void*)&value), "ca_set failure", m_epicsChID[index]);
489#endif
490}

◆ setEpicsStringPV() [1/2]

void setEpicsStringPV ( const std::string & keyname,
const std::string & value )
inherited

Write string to a EPICS PV.

Parameters
keynamekey name (or full PV name) of PV
valuestring to write

Definition at line 450 of file DQMHistAnalysis.cc.

451{
452 if (!m_useEpics || m_epicsReadOnly) return;
453#ifdef _BELLE2_EPICS
454 if (m_epicsNameToChID[keyname] == nullptr) {
455 B2ERROR("Epics PV " << keyname << " not registered!");
456 return;
457 }
458 if (value.length() > 40) {
459 B2ERROR("Epics string PV " << keyname << " too long (>40 characters)!");
460 return;
461 }
462 char text[40];
463 strcpy(text, value.c_str());
464 CheckEpicsError(ca_put(DBR_STRING, m_epicsNameToChID[keyname], text), "ca_set failure", keyname);
465#endif
466}

◆ setEpicsStringPV() [2/2]

void setEpicsStringPV ( int index,
const std::string & value )
inherited

Write string to a EPICS PV.

Parameters
indexindex of PV
valuestring to write

Definition at line 492 of file DQMHistAnalysis.cc.

493{
494 if (!m_useEpics || m_epicsReadOnly) return;
495#ifdef _BELLE2_EPICS
496 if (index < 0 || index >= (int)m_epicsChID.size()) {
497 B2ERROR("Epics PV with " << index << " not registered!");
498 return;
499 }
500 char text[41];
501 strncpy(text, value.c_str(), 40);
502 text[40] = 0;
503 CheckEpicsError(ca_put(DBR_STRING, m_epicsChID[index], text), "ca_set failure", m_epicsChID[index]);
504#endif
505}

◆ setEventProcessed()

static void setEventProcessed ( int e)
inlinestaticinherited

Set the number of processed events.

(Attention, asynch histogram updates!)

e Processed events.

Definition at line 233 of file DQMHistAnalysis.h.

233{s_eventProcessed = e;};

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig)
inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int logLevel,
unsigned int logInfo )
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
Belle2::LogConfig::setLogInfo
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
Belle2::LogConfig::setLogLevel
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition LogConfig.cc:25

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

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
239 m_moduleParamList.setParamPython(name, pyObj);
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Belle2::LogSystem::updateModule
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition LogSystem.h:200
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition LogSystem.cc:28
Belle2::Module::getLogConfig
LogConfig & getLogConfig()
Returns the log system configuration.
Definition Module.h:224
Belle2::Module::m_name
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition Module.h:507
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition ModuleParamList.templateDetails.h:104

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
Belle2::Module::setParamPython
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setPVPrefix()

static void setPVPrefix ( const std::string & prefix)
inlinestaticinherited

set global prefix for EPICS PVs

Parameters
prefixPrefix to set

Definition at line 616 of file DQMHistAnalysis.h.

616{ m_PVPrefix = prefix;};

◆ setReturnValue() [1/2]

void setReturnValue ( bool value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ setReturnValue() [2/2]

void setReturnValue ( int value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ setRunType()

static void setRunType ( const std::string & t)
inlinestaticinherited

Set the Run Type.

t Run type string.

Definition at line 227 of file DQMHistAnalysis.h.

227{s_runType = t;};

◆ setType()

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

Set the module type.

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

Definition at line 48 of file Module.cc.

49{
50 if (!m_type.empty())
51 B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
52 m_type = type;
53}

◆ setUseEpics()

static void setUseEpics ( bool flag)
inlinestaticinherited

Setter for EPICS usage.

Parameters
flagset in use

Definition at line 581 of file DQMHistAnalysis.h.

581{m_useEpics = flag;};

◆ setUseEpicsReadOnly()

static void setUseEpicsReadOnly ( bool flag)
inlinestaticinherited

Setter EPICS flag in read only mode.

Parameters
flagset read only

Definition at line 587 of file DQMHistAnalysis.h.

587{m_epicsReadOnly = flag;};

◆ StringSplit()

std::vector< std::string > StringSplit ( const std::string & s,
const char delim )
staticinherited

Helper function for string token split.

Parameters
sString to split
delimdelimiter
Returns
vector of strings

Definition at line 302 of file DQMHistAnalysis.cc.

303{
304 std::vector <std::string> out;
305 boost::split(out, in, [delim](char c) {return c == delim;});
306 return out;
307}

◆ terminate()

void terminate ( void )
finaloverrideprivatevirtual

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

Reimplemented from Module.

Definition at line 871 of file DQMHistAnalysisTRG.cc.

872{
873 B2DEBUG(1, "DQMHistAnalysisTRGModule: terminate called");
874}

◆ UpdateCanvas() [1/2]

void UpdateCanvas ( const std::string & name,
bool updated = true )
staticinherited

Mark canvas as updated (or not)

Parameters
namename of Canvas
updatedwas updated

Definition at line 354 of file DQMHistAnalysis.cc.

355{
356 s_canvasUpdatedList[name] = updated;
357}

◆ UpdateCanvas() [2/2]

void UpdateCanvas ( TCanvas * canvas,
bool updated = true )
staticinherited

Mark canvas as updated (or not)

Parameters
canvasCanvas from which to take the name for update
updatedwas updated

Definition at line 359 of file DQMHistAnalysis.cc.

360{
361 if (c) UpdateCanvas(c->GetName(), updated);
362}

◆ updateEpicsPVs()

int updateEpicsPVs ( float timeout)
inherited

Update all EPICS PV (flush to network)

Parameters
timeoutmaximum time until timeout in s
Returns
status of ca_pend_io

Definition at line 631 of file DQMHistAnalysis.cc.

632{
633 int state = ECA_NORMAL;
634 if (!m_useEpics) return state;
635#ifdef _BELLE2_EPICS
636 if (wait > 0.) {
637 state = ca_pend_io(wait);
638 SEVCHK(state, "ca_pend_io failure");
639 }
640#endif
641 return state;
642}

Member Data Documentation

◆ m_canvas

TCanvas* m_canvas = nullptr
private

Final Canvas.

Definition at line 80 of file DQMHistAnalysisTRG.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_epicsReadOnly

bool m_epicsReadOnly
staticprivateinherited
Initial value:
=
false

Flag if to use EPICS in ReadOnly mode (for reading limits) do not set by yourself, use EpicsEnable module to set.

Definition at line 155 of file DQMHistAnalysis.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_name

std::string m_name
privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 507 of file Module.h.

◆ m_package

std::string m_package
privateinherited

Package this module is found in (may be empty).

Definition at line 509 of file Module.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 511 of file Module.h.

◆ m_PVPrefix

std::string m_PVPrefix = "TEST:"
staticprivateinherited

The Prefix for EPICS PVs.

Definition at line 160 of file DQMHistAnalysis.h.

◆ m_pvPrefix

std::string m_pvPrefix
private

prefix for EPICS PVs

Definition at line 77 of file DQMHistAnalysisTRG.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_useEpics

bool m_useEpics = false
staticprivateinherited

Flag if to use EPICS do not set by yourself, use EpicsEnable module to set.

Definition at line 149 of file DQMHistAnalysis.h.

◆ s_canvasUpdatedList

DQMHistAnalysisModule::CanvasUpdatedList s_canvasUpdatedList
staticprivateinherited

The list of canvas updated status.

Definition at line 124 of file DQMHistAnalysis.h.

◆ s_deltaList

DQMHistAnalysisModule::DeltaList s_deltaList
staticinherited

The list of Delta Histograms and settings.

Definition at line 118 of file DQMHistAnalysis.h.

◆ s_eventProcessed

int s_eventProcessed = 0
inlinestaticprivateinherited

Number of Events processed to fill histograms.

Attention: histograms are updates asynchronously Thus the number for a specific histogram may be lower or higher. If you need precise number, you must fill it in the histogram itself (e.g. underflow bin)

Definition at line 138 of file DQMHistAnalysis.h.

◆ s_histList

DQMHistAnalysisModule::HistList s_histList
staticprivateinherited

The list of Histograms.

Definition at line 108 of file DQMHistAnalysis.h.

◆ s_monObjList

DQMHistAnalysisModule::MonObjList s_monObjList
staticprivateinherited

The list of MonitoringObjects.

Definition at line 112 of file DQMHistAnalysis.h.

◆ s_refList

DQMHistAnalysisModule::RefList s_refList
staticprivateinherited

The list of references.

Definition at line 129 of file DQMHistAnalysis.h.

◆ s_runType

std::string s_runType = ""
inlinestaticprivateinherited

The Run type.

Definition at line 143 of file DQMHistAnalysis.h.

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