Class to read histograms from a root file for offline testing of analysis modules. More...

#include <DQMHistAnalysisInputRootFile.h>

Inheritance diagram for DQMHistAnalysisInputRootFileModule:

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
	DQMHistAnalysisInputRootFileModule ()
	Constructor.

void	clearlist (void)
	Clear all static global lists.

void	setRunType (std::string &t)
	Set the Run Type.

void	setEventProcessed (int e)
	Set the number of processed events.

TCanvas *	findCanvas (TString cname)
	Find canvas by name.

TH1 *	findHistInCanvas (const std::string &hname, TCanvas **canvas=nullptr)
	Find histogram in corresponding canvas.

double	getSigma68 (TH1 *h) const
	Helper function to compute half of the central interval covering 68% of a distribution.

void	addRefHist (const std::string &dirname, TH1 *hist)
	Add reference histogram.

void	clearCanvases (void)
	Clear content of all Canvases.

void	resetDeltaList (void)
	Reset Delta.

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.

void	addDeltaPar (const std::string &dirname, const std::string &histname, HistDelta::EDeltaType t, int p, unsigned int a=1)
	Add Delta histogram parameters.

bool	hasDeltaPar (const std::string &dirname, const std::string &histname)
	Check if Delta histogram parameters exist for histogram.

void	UpdateCanvas (std::string name, bool updated=true)
	Mark canvas as updated (or not)

void	UpdateCanvas (TCanvas *canvas, bool updated=true)
	Mark canvas as updated (or not)

void	ExtractRunType (std::vector< TH1 * > &hs)
	Extract Run Type from histogram title, called from input module.

void	ExtractNEvent (std::vector< TH1 * > &hs)
	Extract event processed from daq histogram, called from input module.

int	registerEpicsPV (std::string pvname, std::string keyname="")
	EPICS related Functions.

int	registerExternalEpicsPV (std::string pvname, std::string keyname="")
	Register a PV with its name and a key name.

void	setEpicsPV (std::string keyname, double value)
	Write value to a EPICS PV.

void	setEpicsPV (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 (std::string keyname, std::string value)
	Write string to a EPICS PV.

void	setEpicsStringPV (int index, std::string value)
	Write string to a EPICS PV.

double	getEpicsPV (std::string keyname)
	Read value from a EPICS PV.

double	getEpicsPV (int index)
	Read value from a EPICS PV.

std::string	getEpicsStringPV (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 (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 (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	setUseEpics (bool flag)
	Setter for EPICS usage.

void	setUseEpicsReadOnly (bool flag)
	Setter EPICS flag in read only mode.

bool	getUseEpics (void)
	Getter for EPICS usage.

bool	getUseEpicsReadOnly (void)
	Getter EPICS flag in read only mode.

void	cleanupEpicsPVs (void)
	Unsubscribe from EPICS PVs on terminate.

std::string &	getPVPrefix (void)
	get global Prefix for EPICS PVs

void	setPVPrefix (std::string &prefix)
	set global Prefix for EPICS PVs

EStatus	makeStatus (bool enough, bool warn_flag, bool error_flag)
	Helper function to judge the status for coloring and EPICS.

void	colorizeCanvas (TCanvas *canvas, EStatus status)
	Helper function for Canvas colorization.

EStatusColor	getStatusColor (EStatus status)
	Return color for canvas state.

void	checkPVStatus (void)
	Check the status of all PVs and report if disconnected or not found.

void	printPVStatus (chid pv, bool onlyError=true)
	check the status of a PVs and report if disconnected or not found

void	CheckEpicsError (int state, const std::string &message, const std::string &name)
	check the return status and check PV in case of error

void	CheckEpicsError (int state, const std::string &message, chid id)
	check the return status and check PV in case of error

std::vector< std::string >	StringSplit (const std::string &s, const char delim)
	Helper function for string token split.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.

virtual void	endRun ()
	This method is called if the current run ends.

virtual void	terminate ()
	This method is called at the end of the event processing.

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 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 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 bool	addHist (const std::string &dirname, const std::string &histname, TH1 *h)
	Add histogram.

static MonitoringObject *	getMonitoringObject (const std::string &name)
	Get MonitoringObject with given name (new object is created if non-existing)

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	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 () override final
	Initialize the module.

void	beginRun () override final
	Called when entering a new run.

void	event () override final
	Event processor.

void	addToHistList (std::vector< TH1 * > &inputHistList, std::string dirname, TKey *key)
	Read histogram from key and add to list vector.

bool	hnamePatternMatch (std::string pattern, std::string text)
	Pattern match for histogram name.

int	registerEpicsPVwithPrefix (std::string prefix, std::string pvname, 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::vector< std::string >	m_fileList
	The list of names of the input root file.

TFile *	m_file = nullptr
	The TFile object for the input file.

bool	m_enable_run_info
	Whether to enable the run info to be displayed.

TCanvas *	m_c_info {nullptr}
	The canvas hold the basic DQM info.

StoreObjPtr< EventMetaData >	m_eventMetaDataPtr
	Global EventMetaData for run number and event number.

std::vector< std::string >	m_histograms
	List of histogram name patterns to process.

int	m_expno = 0
	Exp number.

int	m_count = 0
	Event number.

std::string	m_runType
	Run Type Override.

int	m_fillNEvent = 0
	Filled event number.

std::vector< int >	m_eventsList
	List of total number of events for each run.

std::vector< int >	m_runList
	List of runs.

unsigned int	m_interval = 0
	Time between two events in second.

unsigned int	m_run_idx = 0
	Index in the list of runs, events and files.

TH1F *	m_h_expno {nullptr}
	emulated histogram from runcontrol, expno

TH1F *	m_h_runno {nullptr}
	emulated histogram from runcontrol, runno

TH1F *	m_h_rtype {nullptr}
	emulated histogram from runcontrol, runtype

TH1F *	m_h_fillNEvent {nullptr}
	emulated histogram from daq, nevent

int	m_lastRun {-1}
	last run

int	m_lastExp {-1}
	last exp

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

Class to read histograms from a root file for offline testing of analysis modules.

Definition at line 32 of file DQMHistAnalysisInputRootFile.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.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

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

                     {
      c_RefScaleNone = 0, 
      c_RefScaleEntries = 1, 
      c_RefScaleMax = 2 
    };

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

                 {
      c_StatusTooFew = 0, 
      c_StatusDefault = 1, 
      c_StatusGood = 2, 
      c_StatusWarning = 3, 
      c_StatusError = 4 
    };

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

                      {
      c_ColorTooFew = kGray, 
      c_ColorDefault = kWhite, 
      c_ColorGood = kGreen, 
      c_ColorWarning = kYellow, 
      c_ColorError = kRed 
    };

Constructor & Destructor Documentation

◆ DQMHistAnalysisInputRootFileModule()

DQMHistAnalysisInputRootFileModule ( )

Constructor.

Definition at line 35 of file DQMHistAnalysisInputRootFile.cc.

  : DQMHistAnalysisModule()
{
  //Parameter definition
  addParam("FileList", m_fileList, "List of input files", std::vector<std::string> {"input_histo.root"});
  addParam("SelectHistograms", m_histograms, "List of histogram name patterns, empty for all. Support wildcard matching (* and ?).",
           std::vector<std::string>());
  addParam("EventsList", m_eventsList, "Number of events for each run", std::vector<int>());
  addParam("Experiment", m_expno, "Experiment Nr override", 0);
  addParam("RunList", m_runList, "Run Number List", std::vector<int>());
  addParam("RunType", m_runType, "Run Type override", std::string(""));
  addParam("FillNEvent", m_fillNEvent, "NEvent override", 0);
  addParam("EventInterval", m_interval, "Time between events (seconds)", 20u);
  addParam("EnableRunInfo", m_enable_run_info, "Enable Run Info", false);
  B2DEBUG(1, "DQMHistAnalysisInputRootFile: Constructor done.");
}

Member Function Documentation

◆ addDeltaPar()

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

inherited

Add Delta histogram parameters.

Parameters

dirname	directory
histname	name of histogram
t	type of delta histogramming
p	numerical parameter depending on type, e.g. number of entries
a	amount of histograms in the past

Definition at line 95 of file DQMHistAnalysis.cc.

{
  std::string fullname;
  if (dirname.size() > 0) {
    fullname = dirname + "/" + histname;
  } else {
    fullname = histname;
  }
  s_deltaList[fullname].set(t, p, a);
}

◆ addHist()

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

staticinherited

Add histogram.

Parameters

dirname	The name of the directory.
histname	The name of the histogram.
h	The TH1 pointer for the histogram.

Returns: histogram was updated flag

Definition at line 59 of file DQMHistAnalysis.cc.

{
  std::string fullname;
  if (dirname.size() > 0) {
    fullname = dirname + "/" + histname;
  } else {
    fullname = histname;
  }
 
  if (s_histList[fullname].update(h)) {
    // only if histogram changed, check if delta histogram update needed
    auto it = s_deltaList.find(fullname);
    if (it != s_deltaList.end()) {
      B2DEBUG(20, "Found Delta" << fullname);
      it->second.update(h); // update
    }
    return true; // histogram changed
  }
 
  return false; // histogram didn't change
}

◆ addRefHist()

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

inherited

Add reference histogram.

Parameters

dirname	The name of the directory.
hist	The TH1 pointer for the reference.

Definition at line 81 of file DQMHistAnalysis.cc.

{
  string histname = hist->GetName();
  std::string name = dirname + "/" + histname;
  auto& n = s_refList[name];
  n.m_orghist_name = name;
  n.m_refhist_name = "ref/" + name;
  hist->SetName((n.m_refhist_name).c_str());
  hist->SetDirectory(0);
  n.setRefHist(hist); // transfer ownership!
  n.setRefCopy(nullptr);
  n.setCanvas(nullptr);
}

◆ addToHistList()

void addToHistList	(	std::vector< TH1 * > &	inputHistList,
		std::string	dirname,
		TKey *	key
	)

private

Read histogram from key and add to list vector.

Definition at line 109 of file DQMHistAnalysisInputRootFile.cc.

{
  TH1* h = (TH1*)key->ReadObj();
  if (h == nullptr) return; // would be strange, but better check
  std::string hname = h->GetName();
 
  if (hname.find("/") == std::string::npos) {
    if (dirname != "") {
      hname = dirname + "/" + hname;
      h->SetName(hname.c_str());
    } else {
      // histo in root dir without prefix -> do not keep!
      delete h;
      return;
    }
  }
 
  bool hpass = false;
  if (m_histograms.size() == 0) {// workaround for run info???
    hpass = true;
  } else {
    for (auto& hpattern : m_histograms) {
      if (hnamePatternMatch(hpattern, h->GetName())) {
        hpass = true;
        break;
      }
    }
  }
  if (!hpass) {
    delete h;
    return;
  }
 
  // Remove ":" from folder name, workaround!
  // Is this really needed?
  if (hname.find(":") != std::string::npos) {
    B2ERROR("histogram or folder name with : is problematic");
  }
  TString a = h->GetName();
  a.ReplaceAll(":", "");
  h->SetName(a);
  B2DEBUG(1, "DQMHistAnalysisInput2: get histo " << a.Data());
 
 
  Double_t scale = 1.0 * m_count / m_eventsList[m_run_idx];
  h->Scale(scale);
  h->SetEntries(h->GetEntries()*scale); // empty hists are not marked for update!
 
  // Histograms in the inputHistList list will be taken care of later (delete)
  inputHistList.push_back(h);
}

◆ beginRun()

void beginRun ( void )

finaloverrideprivatevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 103 of file DQMHistAnalysisInputRootFile.cc.

{
  B2INFO("DQMHistAnalysisInputRootFile: beginRun called.");
  clearRefList();
}

◆ CheckEpicsError() [1/2]

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

inherited

check the return status and check PV in case of error

Parameters

state	return state of epics function
message	message to print out
id	the chid of the affected PV

Definition at line 806 of file DQMHistAnalysis.cc.

{
  if (state != ECA_NORMAL) {
    std::string name;
    if (id) name =  ca_name(id);
    B2WARNING(message << ": " << name);
    printPVStatus(id, false);
  }
}

◆ 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

state	return state of epics function
message	message to print out
name	the (key)name of the affected PV

Definition at line 798 of file DQMHistAnalysis.cc.

{
  if (state != ECA_NORMAL) {
    B2WARNING(message << ": " << name);
    printPVStatus(m_epicsNameToChID[name], false);
  }
}

◆ checkPVStatus()

void checkPVStatus ( void )

inherited

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

Definition at line 762 of file DQMHistAnalysis.cc.

{
  B2INFO("Check PV Connections");
 
  for (auto& it : m_epicsChID) {
    printPVStatus(it);
  }
  B2INFO("Check PVs done");
}

◆ cleanupEpicsPVs()

void cleanupEpicsPVs ( void )

inherited

Unsubscribe from EPICS PVs on terminate.

Definition at line 643 of file DQMHistAnalysis.cc.

{
  // this should be called in terminate function of analysis modules
#ifdef _BELLE2_EPICS
  if (getUseEpics()) {
    for (auto& it : m_epicsChID) CheckEpicsError(ca_clear_channel(it), "ca_clear_channel failure", it);
    updateEpicsPVs(5.0);
    // Make sure we clean up both afterwards!
    m_epicsChID.clear();
    m_epicsNameToChID.clear();
  }
#endif
}

◆ clearCanvases()

void clearCanvases ( void )

inherited

Clear content of all Canvases.

Definition at line 309 of file DQMHistAnalysis.cc.

{
  TIter nextckey(gROOT->GetListOfCanvases());
  TObject* cobj = nullptr;
 
  while ((cobj = dynamic_cast<TObject*>(nextckey()))) {
    if (cobj->IsA()->InheritsFrom("TCanvas")) {
      TCanvas* cnv = dynamic_cast<TCanvas*>(cobj);
      cnv->Clear();
      colorizeCanvas(cnv, c_StatusDefault);
    }
  }
}

◆ clearHistList()

void clearHistList ( void )

staticinherited

Clears the list of histograms.

Definition at line 337 of file DQMHistAnalysis.cc.

{
  s_histList.clear();
}

◆ clearlist()

void clearlist ( void )

inherited

Clear all static global lists.

Definition at line 50 of file DQMHistAnalysis.cc.

{
  s_histList.clear();
  s_refList.clear();
// s_monObjList;
  s_deltaList.clear();
  s_canvasUpdatedList.clear();
}

◆ clearRefList()

void clearRefList ( void )

staticinherited

Clears the list of ref histograms.

Definition at line 342 of file DQMHistAnalysis.cc.

{
  s_refList.clear();
}

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

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

◆ colorizeCanvas()

void colorizeCanvas	(	TCanvas *	canvas,
		EStatus	status
	)

inherited

Helper function for Canvas colorization.

Parameters

canvas	Canvas to change
status	status to color

Definition at line 749 of file DQMHistAnalysis.cc.

{
  if (!canvas) return;
  auto color = getStatusColor(stat);
 
  canvas->Pad()->SetFillColor(color);
 
  canvas->Pad()->SetFrameFillColor(10); // White (kWhite is not used since it results in transparent!)
  canvas->Pad()->SetFrameFillStyle(1001);// White
  canvas->Pad()->Modified();
  canvas->Pad()->Update();
}

◆ 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(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:146

◆ 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(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:165

◆ 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(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:156

◆ 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(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ 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(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:175

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 165 of file Module.h.

165{};

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

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

◆ event()

void event ( void )

finaloverrideprivatevirtual

Event processor.

Input vector for histograms

Reimplemented from Module.

Definition at line 161 of file DQMHistAnalysisInputRootFile.cc.

{
  B2INFO("DQMHistAnalysisInputRootFile: event called.");
  TH1::AddDirectory(false);
 
  if (m_count == 0) {
    // special handling for 1 event to get proper max scaling
    if (m_eventsList[m_run_idx] == 1) m_count++;
    else m_eventsList[m_run_idx]--;
  } else {
    sleep(m_interval);
  }
 
  // Check for run change
  if (m_count > m_eventsList[m_run_idx]) {
    m_run_idx++;
    if (m_run_idx == m_fileList.size()) {
      m_eventMetaDataPtr.create();
      m_eventMetaDataPtr->setEndOfData();
      return;
    }
    m_count = 0;
    // special handling for 1 event to get proper max scaling
    if (m_eventsList[m_run_idx] == 1) m_count = 1;
    else m_eventsList[m_run_idx]--;
    // open next file
    if (m_file != nullptr) {
      m_file->Close();
      delete m_file;
    }
    m_file = new TFile(m_fileList[m_run_idx].c_str());
  }
 
  // Clear only after EndOfRun check, otherwise we won't have any histograms for MiraBelle
  // which expects analysis run in endRun function
  initHistListBeforeEvent();
 
  std::vector<TH1*> inputHistList;
 
  unsigned long long int ts = 0;
  m_file->cd();
  TIter next(m_file->GetListOfKeys());
  while (auto key = (TKey*)next()) {
    TClass* cl = gROOT->GetClass(key->GetClassName());
    if (ts == 0) ts = key->GetDatime().Convert();
    if (cl->InheritsFrom("TDirectory")) {
      TDirectory* d = (TDirectory*)key->ReadObj();
      std::string dirname = d->GetName();
 
      d->cd();
      TIter nextd(d->GetListOfKeys());
 
      while (auto dkey = (TKey*)nextd()) {
        if (gROOT->GetClass(dkey->GetClassName())->InheritsFrom("TH1")) {
          addToHistList(inputHistList, dirname, dkey);
        }
      }
      m_file->cd();
    } else if (cl->InheritsFrom("TH1")) {
      addToHistList(inputHistList, "", key);
    }
  }
 
  auto expno = m_expno;
  auto runno = m_runList.size() ? m_runList[m_run_idx] : 0;
  auto rtype = m_runType;
 
  if (m_h_expno) {
    m_h_expno->SetTitle(std::to_string(expno).c_str());
    inputHistList.push_back((TH1*)(m_h_expno->Clone()));
  }
  if (m_h_runno) {
    m_h_runno->SetTitle(std::to_string(runno).c_str());
    inputHistList.push_back((TH1*)(m_h_runno->Clone()));
  }
  if (m_h_rtype) {
    m_h_rtype->SetTitle(rtype.c_str());
    inputHistList.push_back((TH1*)(m_h_rtype->Clone()));
  }
  if (m_fillNEvent > 0) {
    inputHistList.push_back((TH1*)(m_h_fillNEvent->Clone()));
  }
  // check for no-override
  for (auto& h : inputHistList) {
    if (std::string(h->GetName()) == std::string("DQMInfo/expno")) {
      if (expno == 0) {
        expno = atoi(h->GetTitle());
      } else {
        h->SetTitle(std::to_string(expno).c_str());
      }
    }
    if (std::string(h->GetName()) == std::string("DQMInfo/runno")) {
      if (runno == 0) {
        runno = atoi(h->GetTitle());
      } else {
        h->SetTitle(std::to_string(runno).c_str());
      }
    }
    if (std::string(h->GetName()) == std::string("DQMInfo/rtype")) {
      if (rtype == "") {
        rtype = h->GetTitle();
      } else {
        h->SetTitle(rtype.c_str());
      }
    }
    if (std::string(h->GetName()) == std::string("DAQ/Nevent")) {
      if (m_fillNEvent > 0) {
        Double_t scale = 1.0 * m_count / m_eventsList[m_run_idx];
        h->Scale(scale);
        h->SetEntries(h->GetEntries()*scale); // empty hists are not marked for update!
      }
    }
  }
 
  if (m_c_info != nullptr) m_c_info->SetTitle(("OFFLINE: Exp " + std::to_string(expno) + ", Run " + std::to_string(
                                                   runno) + ", RunType " + rtype + ", Last Changed NEVER, Last Updated NEVER, Last DQM event NEVER").c_str());
 
  m_count++;
  m_eventMetaDataPtr.create();
  m_eventMetaDataPtr->setExperiment(expno);
  m_eventMetaDataPtr->setRun(runno);
  m_eventMetaDataPtr->setEvent(m_count);
  m_eventMetaDataPtr->setTime(ts * 1e9);
 
  ExtractRunType(inputHistList);
  ExtractNEvent(inputHistList);
 
  if (m_lastRun != runno or m_lastExp != expno) {
    // Run change detected
    m_lastRun = runno;
    m_lastExp = expno;
    // we cannot do that in beginRun(), otherwise all histos are cleare before first event
    clearHistList();
  }
 
  // this code must be run after "event processed" has been extracted
  for (size_t i = 0; i < inputHistList.size(); i++) {
    TH1* h = inputHistList[i];
    addHist("", h->GetName(), h);
    B2DEBUG(1, "Found : " << h->GetName() << " : " << h->GetEntries());
  }
 
  B2INFO("DQMHistAnalysisInputRootFile: event finished. count: " << m_count);
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional paths */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "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.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

◆ ExtractNEvent()

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

inherited

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

Definition at line 376 of file DQMHistAnalysis.cc.

{
  s_eventProcessed = 0;
  for (size_t i = 0; i < hs.size(); i++) {
    if (hs[i]->GetName() == std::string("DAQ/Nevent")) {
      s_eventProcessed = hs[i]->GetEntries();
      return;
    }
  }
  B2ERROR("ExtractEvent: Histogram \"DAQ/Nevent\" missing");
}

◆ ExtractRunType()

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

inherited

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

Definition at line 364 of file DQMHistAnalysis.cc.

{
  s_runType = "";
  for (size_t i = 0; i < hs.size(); i++) {
    if (hs[i]->GetName() == std::string("DQMInfo/rtype")) {
      s_runType = hs[i]->GetTitle();
      return;
    }
  }
  B2ERROR("ExtractRunType: Histogram \"DQMInfo/rtype\" missing");
}

◆ findCanvas()

TCanvas * findCanvas ( TString cname )

inherited

Find canvas by name.

Parameters

cname Name of the canvas

Returns: The pointer to the canvas, or nullptr if not found.

Definition at line 146 of file DQMHistAnalysis.cc.

{
  TIter nextkey(gROOT->GetListOfCanvases());
  TObject* obj{};
 
  while ((obj = dynamic_cast<TObject*>(nextkey()))) {
    if (obj->IsA()->InheritsFrom("TCanvas")) {
      if (obj->GetName() == canvas_name)
        return dynamic_cast<TCanvas*>(obj);
    }
  }
  return nullptr;
}

◆ findHist() [1/2]

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

staticinherited

Find histogram.

Parameters

dirname	The name of the directory.
histname	The name of the histogram.
onlyIfUpdated	req only updated hists, return nullptr otherwise

Returns: The found histogram, or nullptr if not found.

Definition at line 174 of file DQMHistAnalysis.cc.

{
  if (dirname.size() > 0) {
    return findHist(dirname + "/" + histname, updated);
  }
  return findHist(histname, updated);
}

◆ findHist() [2/2]

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

staticinherited

Get histogram from list (no other search).

Parameters

histname	The name of the histogram (incl dir).
onlyIfUpdated	req only updated hists, return nullptr otherwise

Returns: The found histogram, or nullptr if not found.

Definition at line 160 of file DQMHistAnalysis.cc.

{
  if (s_histList.find(histname) != s_histList.end()) {
    if (was_updated && !s_histList[histname].isUpdated()) return nullptr;
    if (s_histList[histname].getHist()) {
      return s_histList[histname].getHist();
    } else {
      B2ERROR("Histogram " << histname << " in histogram list but nullptr.");
    }
  }
  B2INFO("Histogram " << histname << " not in list.");
  return nullptr;
}

◆ findHistInCanvas()

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

inherited

Find histogram in corresponding canvas.

Parameters

hname	Name of the histogram (dir+name)
canvas	ptr 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.

{
  TCanvas* cnv = nullptr;
  // try to get canvas from outside
  if (cobj) cnv = *cobj;
  // if no canvas search for it
  if (cnv == nullptr) {
    // parse the dir+histo name and create the corresponding canvas name
    auto s = StringSplit(histo_name, '/');
    if (s.size() != 2) {
      B2ERROR("findHistInCanvas: histoname not valid (missing dir?), should be 'dirname/histname': " << histo_name);
      return nullptr;
    }
    auto dirname = s.at(0);
    auto hname = s.at(1);
    std::string canvas_name = dirname + "/c_" + hname;
    cnv = findCanvas(canvas_name);
    // set canvas pointer for outside
    if (cnv && cobj) *cobj = cnv;
  }
 
  // get histogram pointer
  if (cnv != nullptr) {
    TIter nextkey(cnv->GetListOfPrimitives());
    TObject* obj{};
    while ((obj = dynamic_cast<TObject*>(nextkey()))) {
      if (obj->IsA()->InheritsFrom("TH1")) {
        if (obj->GetName() == histo_name)
          return  dynamic_cast<TH1*>(obj);
      }
    }
  }
  return nullptr;
}

◆ findHistInFile()

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

staticinherited

Find histogram in specific TFile (e.g.

ref file).

Parameters

file	The TFile to search.
histname	The name of the histogram, can incl directory

Returns: The found histogram, or nullptr if not found.

Definition at line 263 of file DQMHistAnalysis.cc.

{
  // find histogram by name in file, histname CAN contain directory!
  // will return nullptr if file is zeroptr, not found or not correct type
  if (file && file->IsOpen()) {
    auto obj = file->Get(histname.data());
    if (obj != nullptr) {
      // check class type
      if (obj->IsA()->InheritsFrom("TH1")) {
        B2DEBUG(20, "Histogram " << histname << " found in file");
        return dynamic_cast<TH1*>(obj);
      } else {
        B2INFO("Found Object " << histname << " in file is not a histogram");
      }
    } else {
      B2INFO("Histogram " << histname << " not found in file");
    }
  }
  return nullptr;
}

◆ findMonitoringObject()

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

staticinherited

Find MonitoringObject.

Parameters

objName The name of the MonitoringObject.

Returns: The found MonitoringObject, or nullptr if not found.

Definition at line 284 of file DQMHistAnalysis.cc.

{
  if (s_monObjList.find(objName) != s_monObjList.end()) {
    return &s_monObjList[objName];
  }
  B2INFO("MonitoringObject " << objName << " not in memfile.");
  return nullptr;
}

◆ 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

dirname	The name of the directory.
histname	The name of the histogram.
scaling	enum what scaling to use
hist	histogram to scale to

Returns: The found histogram, or nullptr if not found.

Definition at line 219 of file DQMHistAnalysis.cc.

{
  if (dirname.size() > 0) {
    return findRefHist(dirname + "/" + histname, scaling, hist);
  }
  return findRefHist(histname, scaling, hist);
}

◆ 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

histname	The name of the histogram (incl dir).
scaling	enum what scaling to use
hist	histogram to scale to

Returns: The found histogram, or nullptr if not found.

Definition at line 208 of file DQMHistAnalysis.cc.

{
  if (s_refList.find(histname) != s_refList.end()) {
    // get a copy of the reference which we can modify
    // (it is still owned and managed by the framework)
    // then do the scaling
    return scaleReference(scaling, hist, s_refList[histname].getReference());
  }
  return nullptr;
}

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

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

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

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

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

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

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

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

◆ getDelta() [1/2]

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

inherited

Get Delta histogram.

Parameters

dirname	directory
histname	name of histogram
n	index of delta histogram, 0 is most recent one
onlyIfUpdated	req only updated deltas, return nullptr otherwise

Returns: delta histogram or nullptr

Definition at line 118 of file DQMHistAnalysis.cc.

{
  std::string fullname;
  if (dirname.size() > 0) {
    fullname = dirname + "/" + histname;
  } else {
    fullname = histname;
  }
  return getDelta(fullname, n, onlyIfUpdated);
}

◆ getDelta() [2/2]

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

inherited

Get Delta histogram.

Parameters

fullname	directory+name of histogram
n	index of delta histogram, 0 is most recent one
onlyIfUpdated	req only updated deltas, return nullptr otherwise

Returns: delta histogram or nullptr

Definition at line 129 of file DQMHistAnalysis.cc.

{
  auto it = s_deltaList.find(fullname);
  if (it != s_deltaList.end()) {
    return it->second.getDelta(n, onlyIfUpdated);
  }
  B2WARNING("Delta hist " << fullname << " not found");
  return nullptr;
}

◆ 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;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:510

◆ getEpicsPV() [1/2]

double getEpicsPV ( int index )

inherited

Read value from a EPICS PV.

Parameters

index index of PV

Returns: value or NAN if not existing

Definition at line 529 of file DQMHistAnalysis.cc.

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

◆ getEpicsPV() [2/2]

double getEpicsPV ( std::string keyname )

inherited

Read value from a EPICS PV.

Parameters

keyname key name (or full PV name) of PV

Returns: value or NAN if not existing

Definition at line 506 of file DQMHistAnalysis.cc.

{
  double value{NAN};
  if (!m_useEpics) return value;
#ifdef _BELLE2_EPICS
  if (m_epicsNameToChID[keyname] == nullptr) {
    B2ERROR("Epics PV " << keyname << " not registered!");
    return value;
  }
  // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
  // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
  // outstanding get requests are not automatically reissued following reconnect.
  auto r = ca_get(DBR_DOUBLE, m_epicsNameToChID[keyname], (void*)&value);
  if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
  if (r == ECA_NORMAL) {
    return value;
  } else {
    CheckEpicsError(r, "Read PV failed in ca_get or ca_pend_io failure", keyname);
  }
#endif
  return NAN;
}

◆ getEpicsPVChID() [1/2]

chid getEpicsPVChID ( int index )

inherited

Get EPICS PV Channel Id.

Parameters

index index of PV

Returns: Channel ID is written on success, otherwise nullptr

Definition at line 616 of file DQMHistAnalysis.cc.

{
#ifdef _BELLE2_EPICS
  if (m_useEpics) {
    if (index >= 0 && index < (int)m_epicsChID.size()) {
      return m_epicsChID[index];
    } else {
      B2ERROR("Epics PV with " << index << " not registered!");
    }
  }
#endif
  return nullptr;
}

◆ getEpicsPVChID() [2/2]

chid getEpicsPVChID ( std::string keyname )

inherited

Get EPICS PV Channel Id.

Parameters

keyname key name (or full PV name) of PV

Returns: Channel ID is written on success, otherwise nullptr

Definition at line 602 of file DQMHistAnalysis.cc.

{
#ifdef _BELLE2_EPICS
  if (m_useEpics) {
    if (m_epicsNameToChID[keyname] != nullptr) {
      return m_epicsNameToChID[keyname];
    } else {
      B2ERROR("Epics PV " << keyname << " not registered!");
    }
  }
#endif
  return nullptr;
}

◆ getEpicsStringPV() [1/2]

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

inherited

Read value from a EPICS PV.

Parameters

index	index of PV
status	return status (true on success)

Returns: string value (empty string if non existing)

Definition at line 577 of file DQMHistAnalysis.cc.

{
  status = false;
  char value[40] = "";
  if (!m_useEpics) return std::string(value);
#ifdef _BELLE2_EPICS
  if (index < 0 || index >= (int)m_epicsChID.size()) {
    B2ERROR("Epics PV with " << index << " not registered!");
    return std::string(value);
  }
  // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
  // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
  // outstanding get requests are not automatically reissued following reconnect.
  auto r = ca_get(DBR_DOUBLE, m_epicsChID[index], value);
  if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
  if (r == ECA_NORMAL) {
    status = true;
    return std::string(value);
  } else {
    CheckEpicsError(r, "Read PV (string) failed in ca_get or ca_pend_io failure", m_epicsChID[index]);
  }
#endif
  return std::string(value);
}

◆ getEpicsStringPV() [2/2]

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

inherited

Read value from a EPICS PV.

Parameters

keyname	key name (or full PV name) of PV
status	return status (true on success)

Returns: string value (empty string if non existing)

Definition at line 552 of file DQMHistAnalysis.cc.

{
  status = false;
  char value[40] = "";
  if (!m_useEpics) return std::string(value);
#ifdef _BELLE2_EPICS
  if (m_epicsNameToChID[keyname] == nullptr) {
    B2ERROR("Epics PV " << keyname << " not registered!");
    return std::string(value);
  }
  // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
  // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
  // outstanding get requests are not automatically reissued following reconnect.
  auto r = ca_get(DBR_STRING, m_epicsNameToChID[keyname], value);
  if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
  if (r == ECA_NORMAL) {
    status = true;
    return std::string(value);
  } else {
    CheckEpicsError(r, "Read PV (string) failed in ca_get or ca_pend_io failure", keyname);
  }
#endif
  return std::string(value);
}

◆ 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, StorageRootOutputModule, and RootOutputModule.

Definition at line 133 of file Module.h.

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

◆ 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

name	name of MonitoringObject to get

Returns: The MonitoringObject

Definition at line 139 of file DQMHistAnalysis.cc.

{
  auto obj = &s_monObjList[objName];
  obj->SetName(objName.c_str());
  return obj;
}

◆ 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;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:507

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

{
  return m_moduleParamList.getParamInfoListPython();
}

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

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

◆ getPVPrefix()

std::string & getPVPrefix ( void )

inlineinherited

get global Prefix for EPICS PVs

Returns: prefix in use

Definition at line 608 of file DQMHistAnalysis.h.

608{return m_PVPrefix;};

Belle2::DQMHistAnalysisModule::m_PVPrefix

static std::string m_PVPrefix

The Prefix for EPICS PVs.

Definition: DQMHistAnalysis.h:160

◆ 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 ) const

inherited

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

This quantity is an alternative to the standard deviation.

Parameters

h histogram

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

Definition at line 293 of file DQMHistAnalysis.cc.

{
  double probs[2] = {0.16, 1 - 0.16};
  double quant[2] = {0, 0};
  h->GetQuantiles(2, quant, probs);
  const double sigma68 = (-quant[0] + quant[1]) / 2;
  return sigma68;
}

◆ getStatusColor()

DQMHistAnalysisModule::EStatusColor getStatusColor ( EStatus status )

inherited

Return color for canvas state.

Parameters

status canvas status

Returns: alarm color

Definition at line 722 of file DQMHistAnalysis.cc.

{
  // white color is the default, if no colorize
  EStatusColor color = c_ColorDefault;
  switch (stat) {
    case c_StatusTooFew:
      color = c_ColorTooFew; // Magenta or Gray
      break;
    case c_StatusDefault:
      color = c_ColorDefault; // default no colors
      break;
    case c_StatusGood:
      color = c_ColorGood; // Good
      break;
    case c_StatusWarning:
      color = c_ColorWarning; // Warning
      break;
    case c_StatusError:
      color = c_ColorError; // Severe
      break;
    default:
      color = c_ColorDefault; // default no colors
      break;
  }
  return color;
}

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

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

◆ getUseEpics()

bool getUseEpics ( void )

inlineinherited

Getter for EPICS usage.

Returns: flag is in use

Definition at line 591 of file DQMHistAnalysis.h.

591{return m_useEpics;};

◆ getUseEpicsReadOnly()

bool getUseEpicsReadOnly ( void )

inlineinherited

Getter EPICS flag in read only mode.

Returns: flag if read only

Definition at line 597 of file DQMHistAnalysis.h.

597{return m_epicsReadOnly;};

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

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

inherited

Check if Delta histogram parameters exist for histogram.

Parameters

dirname	directory
histname	name of histogram

Returns: true if parameters have been set already

Definition at line 107 of file DQMHistAnalysis.cc.

{
  std::string fullname;
  if (dirname.size() > 0) {
    fullname = dirname + "/" + histname;
  } else {
    fullname = histname;
  }
  return s_deltaList.find(fullname) != s_deltaList.end(); // contains() if we switch to C++20
}

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

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

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

◆ hnamePatternMatch()

bool hnamePatternMatch	(	std::string	pattern,
		std::string	text
	)

private

Pattern match for histogram name.

Parameters

pattern	Used for matchng the histogram name. Wildcards (* and ?) are supported
text	Histogram name to be matched

Returns: true, if the pattern matches the text

Definition at line 79 of file DQMHistAnalysisInputRootFile.cc.

{
  boost::replace_all(pattern, "\\", "\\\\");
  boost::replace_all(pattern, "^", "\\^");
  boost::replace_all(pattern, ".", "\\.");
  boost::replace_all(pattern, "$", "\\$");
  boost::replace_all(pattern, "|", "\\|");
  boost::replace_all(pattern, "(", "\\(");
  boost::replace_all(pattern, ")", "\\)");
  boost::replace_all(pattern, "[", "\\[");
  boost::replace_all(pattern, "]", "\\]");
  boost::replace_all(pattern, "*", "\\*");
  boost::replace_all(pattern, "+", "\\+");
  boost::replace_all(pattern, "?", "\\?");
  boost::replace_all(pattern, "/", "\\/");
 
  boost::replace_all(pattern, "\\?", ".");
  boost::replace_all(pattern, "\\*", ".*");
 
  boost::regex bpattern(pattern);
 
  return regex_match(text, bpattern);
}

◆ 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

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initHistListBeforeEvent()

void initHistListBeforeEvent ( void )

staticinherited

Reset the list of histograms.

Definition at line 323 of file DQMHistAnalysis.cc.

{
  for (auto& it : s_histList) {
    // attention, we must use reference, otherwise we work on a copy
    it.second.resetBeforeEvent();
  }
  for (auto& it : s_deltaList) {
    // attention, we must use reference, otherwise we work on a copy
    it.second.setNotUpdated();
  }
 
  s_canvasUpdatedList.clear();
}

◆ initialize()

void initialize ( void )

finaloverrideprivatevirtual

Initialize the module.

Reimplemented from Module.

Definition at line 52 of file DQMHistAnalysisInputRootFile.cc.

{
  if (m_fileList.size() == 0) B2FATAL("File list is empty.");
  if (m_eventsList.size() == 0) {
    m_eventsList.resize(m_fileList.size(), 1); // default one events per file
  }
  if (m_fileList.size() != m_eventsList.size()) B2ERROR("File list does not have the same size as events list.");
  if (m_runList.size() != 0 and m_runList.size() != m_fileList.size()) B2ERROR("Run list does not have the same size as file list.");
  m_run_idx = 0;
  m_file = new TFile(m_fileList[m_run_idx].c_str());
  m_eventMetaDataPtr.registerInDataStore();
 
  if (m_enable_run_info) {
    m_c_info = new TCanvas("DQMInfo/c_info", "");
    m_c_info->SetTitle("");
  }
  if (m_expno > 0)  m_h_expno = new TH1F("DQMInfo/expno", "", 1, 0, 1);
  if (m_runList.size() != 0)  m_h_runno = new TH1F("DQMInfo/runno", "", 1, 0, 1);
  if (m_runType != "")  m_h_rtype = new TH1F("DQMInfo/rtype", m_runType.c_str(), 1, 0, 1);
  if (m_fillNEvent > 0) {
    m_h_fillNEvent = new TH1F("DAQ/Nevent", "", 1, 0, 1);
    m_h_fillNEvent->Fill(0., m_fillNEvent);
    m_h_fillNEvent->SetEntries(m_fillNEvent);
  }
  B2INFO("DQMHistAnalysisInputRootFile: initialized.");
}

◆ makeStatus()

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

inherited

Helper function to judge the status for coloring and EPICS.

Parameters

enough	enough events for judging
warn_flag	outside of expected range
error_flag	outside of warning range

Returns: the status

Definition at line 704 of file DQMHistAnalysis.cc.

{
  // white color is the default, if no colorize
  if (!enough) {
    return (c_StatusTooFew);
  } else {
    if (error_flag) {
      return (c_StatusError);
    } else if (warn_flag) {
      return (c_StatusWarning);
    } else {
      return (c_StatusGood);
    }
  }
 
  return (c_StatusDefault); // default, but should not be reached
}

◆ printPVStatus()

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

inherited

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

Parameters

pv	the chid of the PV to check
onlyError	print only if in error condition (default)

Definition at line 772 of file DQMHistAnalysis.cc.

{
  if (pv == nullptr) {
    B2WARNING("PV chid was nullptr");
    return;
  }
  auto state = ca_state(pv);
  switch (state) {
    case cs_never_conn: /* valid chid, server not found or unavailable */
      B2WARNING("Channel never connected " << ca_name(pv));
      break;
    case cs_prev_conn:  /* valid chid, previously connected to server */
      B2WARNING("Channel was connected, but now is not " << ca_name(pv));
      break;
    case cs_closed:   /* channel deleted by user */
      B2WARNING("Channel deleted already " << ca_name(pv));
      break;
    case cs_conn:       /* valid chid, connected to server */
      if (!onlyError) B2INFO("Channel connected and OK " << ca_name(pv));
      break;
    default:
      B2WARNING("Undefined status for channel " << ca_name(pv));
      break;
  }
}

◆ registerEpicsPV()

int registerEpicsPV	(	std::string	pvname,
		std::string	keyname = `""`
	)

inherited

EPICS related Functions.

Register a PV with its name and a key name

Parameters

pvname	full PV name
keyname	key 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.

{
  return registerEpicsPVwithPrefix(m_PVPrefix, pvname, keyname);
}

◆ registerEpicsPVwithPrefix()

int registerEpicsPVwithPrefix	(	std::string	prefix,
		std::string	pvname,
		std::string	keyname = `""`
	)

privateinherited

Register a PV with its name and a key name.

Parameters

prefix	prefix to PV name
pvname	full PV name without prefix
keyname	key 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.

{
  if (!m_useEpics) return -1;
#ifdef _BELLE2_EPICS
  if (m_epicsNameToChID[pvname] != nullptr) {
    B2ERROR("Epics PV " << pvname << " already registered!");
    return -1;
  }
  if (keyname != "" && m_epicsNameToChID[keyname] != nullptr) {
    B2ERROR("Epics PV with key " << keyname << " already registered!");
    return -1;
  }
 
  m_epicsChID.emplace_back();
  auto ptr = &m_epicsChID.back();
  if (!ca_current_context()) SEVCHK(ca_context_create(ca_disable_preemptive_callback), "ca_context_create");
  // the subscribed name includes the prefix, the map below does *not*
  CheckEpicsError(ca_create_channel((prefix + pvname).data(), NULL, NULL, 10, ptr), "ca_create_channel failure", pvname);
 
  m_epicsNameToChID[pvname] =  *ptr;
  if (keyname != "") m_epicsNameToChID[keyname] =  *ptr;
  return m_epicsChID.size() - 1; // return index to last added item
#else
  return -1;
#endif
}

◆ registerExternalEpicsPV()

int registerExternalEpicsPV	(	std::string	pvname,
		std::string	keyname = `""`
	)

inherited

Register a PV with its name and a key name.

Parameters

pvname	full PV name
keyname	key 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.

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

◆ requestLimitsFromEpicsPVs() [1/3]

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

inherited

Get Alarm Limits from EPICS PV.

Parameters

id	Channel ID
&lowerAlarm	return low Alarm limit (lolo) if set, not changed otherwise
&lowerWarn	return low Warning limit (low) if set, not changed otherwise
&upperWarn	return upper Warning limit (high) if set, not changed otherwise
&upperAlarm	return 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 669 of file DQMHistAnalysis.cc.

{
  // get warn and error limit only if pv exists
  // overwrite only if limit is defined (not NaN)
  // user should initialize with NaN before calling, unless
  // some "default" values should be set otherwise
  if (pv != nullptr) {
    struct dbr_ctrl_double tPvData;
    // From EPICS doc. When ca_get or ca_array_get are invoked the returned channel value can't be assumed to be stable
    // in the application supplied buffer until after ECA_NORMAL is returned from ca_pend_io. If a connection is lost
    // outstanding get requests are not automatically reissued following reconnect.
    auto r = ca_get(DBR_CTRL_DOUBLE, pv, &tPvData);
    if (r == ECA_NORMAL) r = ca_pend_io(5.0); // this is needed!
    if (r == ECA_NORMAL) {
      if (!std::isnan(tPvData.lower_alarm_limit)) {
        lowerAlarm = tPvData.lower_alarm_limit;
      }
      if (!std::isnan(tPvData.lower_warning_limit)) {
        lowerWarn = tPvData.lower_warning_limit;
      }
      if (!std::isnan(tPvData.upper_warning_limit)) {
        upperWarn = tPvData.upper_warning_limit;
      }
      if (!std::isnan(tPvData.upper_alarm_limit)) {
        upperAlarm = tPvData.upper_alarm_limit;
      }
      return true;
    } else {
      CheckEpicsError(r, "Reading PV Limits failed in ca_get or ca_pend_io failure", pv);
    }
  }
  return false;
}

◆ requestLimitsFromEpicsPVs() [2/3]

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

inherited

Get Alarm Limits from EPICS PV.

Parameters

index	index of PV
&lowerAlarm	return low Alarm limit (lolo) if set, not changed otherwise
&lowerWarn	return low Warning limit (low) if set, not changed otherwise
&upperWarn	return upper Warning limit (high) if set, not changed otherwise
&upperAlarm	return 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 663 of file DQMHistAnalysis.cc.

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

◆ requestLimitsFromEpicsPVs() [3/3]

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

inherited

Get Alarm Limits from EPICS PV.

Parameters

keyname	key name (or full PV name) of PV
&lowerAlarm	return low Alarm limit (lolo) if set, not changed otherwise
&lowerWarn	return low Warning limit (low) if set, not changed otherwise
&upperWarn	return upper Warning limit (high) if set, not changed otherwise
&upperAlarm	return 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 657 of file DQMHistAnalysis.cc.

{
  return requestLimitsFromEpicsPVs(getEpicsPVChID(name), lowerAlarm, lowerWarn, upperWarn, upperAlarm);
}

◆ resetDeltaList()

void resetDeltaList ( void )

inherited

Reset Delta.

Definition at line 347 of file DQMHistAnalysis.cc.

{
  for (auto& d : s_deltaList) {
    d.second.reset();
  }
}

◆ scaleReference()

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

staticinherited

Using the original and reference, create scaled version.

Parameters

scaling	scaling algorithm
hist	pointer to histogram
ref	pointer to reference

Returns: scaled reference

Definition at line 182 of file DQMHistAnalysis.cc.

{
  // if hist/ref is nullptr, nothing to do
  if (!hist || !ref)
    return ref;
 
  switch (scaling) {
    // default: do nothing
    case ERefScaling::c_RefScaleNone: //do nothing
      break;
    case ERefScaling::c_RefScaleEntries: // Integral
      // only if we have entries in reference
      if (hist->Integral() != 0 and ref->Integral() != 0) {
        ref->Scale(hist->Integral() / ref->Integral());
      }
      break;
    case ERefScaling::c_RefScaleMax: // Maximum
      // only if we have entries in reference
      if (hist->GetMaximum() != 0 and ref->GetMaximum() != 0) {
        ref->Scale(hist->GetMaximum() / ref->GetMaximum());
      }
      break;
  }
  return ref;
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setEpicsPV() [1/4]

void setEpicsPV	(	int	index,
		double	value
	)

inherited

Write value to a EPICS PV.

Parameters

index	index of PV
value	value to write

Definition at line 467 of file DQMHistAnalysis.cc.

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

◆ setEpicsPV() [2/4]

void setEpicsPV	(	int	index,
		int	value
	)

inherited

Write value to a EPICS PV.

Parameters

index	index of PV
value	value to write

Definition at line 479 of file DQMHistAnalysis.cc.

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

◆ setEpicsPV() [3/4]

void setEpicsPV	(	std::string	keyname,
		double	value
	)

inherited

Write value to a EPICS PV.

Parameters

keyname	key name (or full PV name) of PV
value	value to write

Definition at line 425 of file DQMHistAnalysis.cc.

{
  if (!m_useEpics || m_epicsReadOnly) return;
#ifdef _BELLE2_EPICS
  if (m_epicsNameToChID[keyname] == nullptr) {
    B2ERROR("Epics PV " << keyname << " not registered!");
    return;
  }
  CheckEpicsError(ca_put(DBR_DOUBLE, m_epicsNameToChID[keyname], (void*)&value), "ca_set failure", keyname);
#endif
}

◆ setEpicsPV() [4/4]

void setEpicsPV	(	std::string	keyname,
		int	value
	)

inherited

Write value to a EPICS PV.

Parameters

keyname	key name (or full PV name) of PV
value	value to write

Definition at line 437 of file DQMHistAnalysis.cc.

{
  if (!m_useEpics || m_epicsReadOnly) return;
#ifdef _BELLE2_EPICS
  if (m_epicsNameToChID[keyname] == nullptr) {
    B2ERROR("Epics PV " << keyname << " not registered!");
    return;
  }
  CheckEpicsError(ca_put(DBR_SHORT, m_epicsNameToChID[keyname], (void*)&value), "ca_set failure", keyname);
#endif
}

◆ setEpicsStringPV() [1/2]

void setEpicsStringPV	(	int	index,
		std::string	value
	)

inherited

Write string to a EPICS PV.

Parameters

index	index of PV
value	string to write

Definition at line 491 of file DQMHistAnalysis.cc.

{
  if (!m_useEpics || m_epicsReadOnly) return;
#ifdef _BELLE2_EPICS
  if (index < 0 || index >= (int)m_epicsChID.size()) {
    B2ERROR("Epics PV with " << index << " not registered!");
    return;
  }
  char text[41];
  strncpy(text, value.c_str(), 40);
  text[40] = 0;
  CheckEpicsError(ca_put(DBR_STRING, m_epicsChID[index], text), "ca_set failure", m_epicsChID[index]);
#endif
}

◆ setEpicsStringPV() [2/2]

void setEpicsStringPV	(	std::string	keyname,
		std::string	value
	)

inherited

Write string to a EPICS PV.

Parameters

keyname	key name (or full PV name) of PV
value	string to write

Definition at line 449 of file DQMHistAnalysis.cc.

{
  if (!m_useEpics || m_epicsReadOnly) return;
#ifdef _BELLE2_EPICS
  if (m_epicsNameToChID[keyname] == nullptr) {
    B2ERROR("Epics PV " << keyname << " not registered!");
    return;
  }
  if (value.length() > 40) {
    B2ERROR("Epics string PV " << keyname << " too long (>40 characters)!");
    return;
  }
  char text[40];
  strcpy(text, value.c_str());
  CheckEpicsError(ca_put(DBR_STRING, m_epicsNameToChID[keyname], text), "ca_set failure", keyname);
#endif
}

◆ setEventProcessed()

void setEventProcessed ( int e )

inlineinherited

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

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

◆ 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

name	The 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

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ 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

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setPVPrefix()

void setPVPrefix ( std::string & prefix )

inlineinherited

set global Prefix for EPICS PVs

Parameters

prefix Prefix to set

Definition at line 614 of file DQMHistAnalysis.h.

614{ 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

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ 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

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setRunType()

void setRunType ( std::string & t )

inlineinherited

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.

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

◆ setUseEpics()

void setUseEpics ( bool flag )

inlineinherited

Setter for EPICS usage.

Parameters

flag	set in use

Definition at line 579 of file DQMHistAnalysis.h.

579{m_useEpics = flag;};

◆ setUseEpicsReadOnly()

void setUseEpicsReadOnly ( bool flag )

inlineinherited

Setter EPICS flag in read only mode.

Parameters

flag	set read only

Definition at line 585 of file DQMHistAnalysis.h.

585{m_epicsReadOnly = flag;};

◆ StringSplit()

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

inherited

Helper function for string token split.

Parameters

s	String to split
delim	delimiter

Returns: vector of strings

Definition at line 302 of file DQMHistAnalysis.cc.

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

◆ terminate()

virtual void terminate ( void )

inlinevirtualinherited

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

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

This method can be implemented by subclasses.

Definition at line 175 of file Module.h.

175{};

◆ UpdateCanvas() [1/2]

void UpdateCanvas	(	std::string	name,
		bool	updated = `true`
	)

inherited

Mark canvas as updated (or not)

Parameters

name	name of Canvas
updated	was updated

Definition at line 354 of file DQMHistAnalysis.cc.

{
  s_canvasUpdatedList[name] = updated;
}

◆ UpdateCanvas() [2/2]

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

inherited

Mark canvas as updated (or not)

Parameters

canvas	Canvas from which to take the name for update
updated	was updated

Definition at line 359 of file DQMHistAnalysis.cc.

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

◆ updateEpicsPVs()

int updateEpicsPVs ( float timeout )

inherited

Update all EPICS PV (flush to network)

Parameters

timeout maximum time until timeout in s

Returns: status of ca_pend_io

Definition at line 630 of file DQMHistAnalysis.cc.

{
  int state = ECA_NORMAL;
  if (!m_useEpics) return state;
#ifdef _BELLE2_EPICS
  if (wait > 0.) {
    state = ca_pend_io(wait);
    SEVCHK(state, "ca_pend_io failure");
  }
#endif
  return state;
}

Member Data Documentation

◆ m_c_info

TCanvas* m_c_info {nullptr}

private

The canvas hold the basic DQM info.

Definition at line 80 of file DQMHistAnalysisInputRootFile.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_count

int m_count = 0

private

Event number.

Definition at line 91 of file DQMHistAnalysisInputRootFile.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_enable_run_info

bool m_enable_run_info

private

Whether to enable the run info to be displayed.

Definition at line 78 of file DQMHistAnalysisInputRootFile.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_eventMetaDataPtr

StoreObjPtr<EventMetaData> m_eventMetaDataPtr

private

Global EventMetaData for run number and event number.

Definition at line 83 of file DQMHistAnalysisInputRootFile.h.

◆ m_eventsList

std::vector<int> m_eventsList

private

List of total number of events for each run.

This is the number of issued update events for testing, not the number of events from which histograms were filled

Definition at line 103 of file DQMHistAnalysisInputRootFile.h.

◆ m_expno

int m_expno = 0

private

Exp number.

Definition at line 89 of file DQMHistAnalysisInputRootFile.h.

◆ m_file

TFile* m_file = nullptr

private

The TFile object for the input file.

Definition at line 75 of file DQMHistAnalysisInputRootFile.h.

◆ m_fileList

std::vector<std::string> m_fileList

private

The list of names of the input root file.

Definition at line 72 of file DQMHistAnalysisInputRootFile.h.

◆ m_fillNEvent

int m_fillNEvent = 0

private

Filled event number.

Definition at line 97 of file DQMHistAnalysisInputRootFile.h.

◆ m_h_expno

TH1F* m_h_expno {nullptr}

private

emulated histogram from runcontrol, expno

Definition at line 115 of file DQMHistAnalysisInputRootFile.h.

◆ m_h_fillNEvent

TH1F* m_h_fillNEvent {nullptr}

private

emulated histogram from daq, nevent

Definition at line 121 of file DQMHistAnalysisInputRootFile.h.

◆ m_h_rtype

TH1F* m_h_rtype {nullptr}

private

emulated histogram from runcontrol, runtype

Definition at line 119 of file DQMHistAnalysisInputRootFile.h.

◆ m_h_runno

TH1F* m_h_runno {nullptr}

private

emulated histogram from runcontrol, runno

Definition at line 117 of file DQMHistAnalysisInputRootFile.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_histograms

std::vector<std::string> m_histograms

private

List of histogram name patterns to process.

Definition at line 86 of file DQMHistAnalysisInputRootFile.h.

◆ m_interval

unsigned int m_interval = 0

private

Time between two events in second.

Definition at line 109 of file DQMHistAnalysisInputRootFile.h.

◆ m_lastExp

int m_lastExp {-1}

private

last exp

Definition at line 126 of file DQMHistAnalysisInputRootFile.h.

◆ m_lastRun

int m_lastRun {-1}

private

last run

Definition at line 124 of file DQMHistAnalysisInputRootFile.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_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_run_idx

unsigned int m_run_idx = 0

private

Index in the list of runs, events and files.

Definition at line 112 of file DQMHistAnalysisInputRootFile.h.

◆ m_runList

std::vector<int> m_runList

private

List of runs.

Definition at line 106 of file DQMHistAnalysisInputRootFile.h.

◆ m_runType

std::string m_runType

private

Run Type Override.

Definition at line 94 of file DQMHistAnalysisInputRootFile.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:

dqm/analysis/modules/include/DQMHistAnalysisInputRootFile.h
dqm/analysis/modules/src/DQMHistAnalysisInputRootFile.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ CanvasUpdatedList

◆ DeltaList

◆ EAfterConditionPath

◆ HistList

◆ MonObjList

◆ RefList

Member Enumeration Documentation

◆ EModulePropFlags

◆ ERefScaling

◆ EStatus

◆ EStatusColor

Constructor & Destructor Documentation

◆ DQMHistAnalysisInputRootFileModule()

Member Function Documentation

◆ addDeltaPar()

◆ addHist()

◆ addRefHist()

◆ addToHistList()

◆ beginRun()

◆ CheckEpicsError() [1/2]

◆ CheckEpicsError() [2/2]

◆ checkPVStatus()

◆ cleanupEpicsPVs()

◆ clearCanvases()

◆ clearHistList()

◆ clearlist()

◆ clearRefList()

◆ clone()

◆ colorizeCanvas()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ ExtractNEvent()

◆ ExtractRunType()

◆ findCanvas()

◆ findHist() [1/2]

◆ findHist() [2/2]

◆ findHistInCanvas()

◆ findHistInFile()

◆ findMonitoringObject()

◆ findRefHist() [1/2]

◆ findRefHist() [2/2]

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCanvasUpdatedList()

◆ getCondition()

◆ getConditionPath()

◆ getDelta() [1/2]

◆ getDelta() [2/2]

◆ getDeltaList()

◆ getDescription()

◆ getEpicsPV() [1/2]

◆ getEpicsPV() [2/2]

◆ getEpicsPVChID() [1/2]

◆ getEpicsPVChID() [2/2]

◆ getEpicsStringPV() [1/2]

◆ getEpicsStringPV() [2/2]

◆ getEventProcessed()

◆ getFileNames()

◆ getHistList()

◆ getLogConfig()

◆ getModules()

◆ getMonitoringObject()