DQM Histogram Analysis for PXD Common Modes. More...

#include <DQMHistAnalysisPXDCM.h>

Inheritance diagram for DQMHistAnalysisPXDCMModule:

[legend]

Collaboration diagram for DQMHistAnalysisPXDCMModule:

[legend]

Public Types
typedef std::map< std::string, TH1 * >	HistList
	The type of list of histograms.

typedef std::map< std::string, MonitoringObject * >	MonObjList
	The type of list of MonitoringObjects.

enum	EModulePropFlags { c_Input = 1 , c_Output = 2 , c_ParallelProcessingCertified = 4 , c_HistogramManager = 8 , c_InternalSerializer = 16 , c_TerminateInAllProcesses = 32 , c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...

typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	DQMHistAnalysisPXDCMModule ()
	Constructor.

	~DQMHistAnalysisPXDCMModule ()
	Destructor.

void	initialize (void) override final
	Initializer. More...

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

void	event (void) override final
	This method is called for each event. More...

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

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

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

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

const std::string &	getName () const
	Returns the name of the module. More...

const std::string &	getType () const
	Returns the type of the module (i.e. More...

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module. More...

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...

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

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module. More...

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module. More...

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module. More...

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

const 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. More...

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). More...

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished. More...

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module. More...

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter. More...

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module. More...

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module. More...

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters. More...

Static Public Member Functions
static const HistList &	getHistList ()
	Get the list of the histograms. More...

static const MonObjList &	getMonObjList ()
	Get the list of MonitoringObjects. More...

static TH1 *	findHist (const std::string &histname)
	Find histogram. More...

static TH1 *	findHist (const std::string &dirname, const std::string &histname)
	Find histogram. More...

static TH1 *	findHist (const TDirectory *histdir, const TString &histname)
	Find histogram. More...

static MonitoringObject *	findMonitoringObject (const std::string &objName)
	Find MonitoringObject. More...

static void	addHist (const std::string &dirname, const std::string &histname, TH1 *h)
	Add histogram. More...

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

static void	resetHist ()
	Clear and reset the list of histograms.

static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python. More...

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side. More...

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

void	setDescription (const std::string &description)
	Sets the description of the module. More...

void	setType (const std::string &type)
	Set the module type. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...

void	setReturnValue (int value)
	Sets the return value for this module as integer. More...

void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
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. More...

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

Private Attributes
std::string	m_histogramDirectoryName
	name of histogram directory

std::string	m_pvPrefix
	prefix for EPICS PVs

int	m_minEntries = 10000
	Update entry intervall.

double	m_warnMeanAdhoc {}
	warn level for mean adhoc plot

double	m_errorMeanAdhoc {}
	error level for mean adhoc plot

double	m_warnOutsideAdhoc {}
	warn level for outside fraction

double	m_errorOutsideAdhoc {}
	error level for outside fraction

int	m_upperLineAdhoc {}
	threshold level/line for outside fraction

double	m_warnMeanFull {}
	warn level for mean adhoc plot

double	m_errorMeanFull {}
	error level for mean adhoc plot

double	m_warnOutsideFull {}
	warn level for outside fraction

double	m_errorOutsideFull {}
	error level for outside fraction

int	m_upperLineFull {}
	threshold level/line for outside fraction

std::vector< std::string >	m_par_module_list
	Module list for mask.

std::vector< std::vector< int > >	m_par_gate_list
	Double-gate list for mask.

std::map< VxdID, std::vector< int > >	m_masked_gates
	Module wise gate masking in CM plot and alarm.

std::vector< VxdID >	m_PXDModules
	IDs of all PXD Modules to iterate over.

TH2D *	m_hCommonMode = nullptr
	histogram covering all modules

TH2D *	m_hCommonModeDelta = nullptr
	histogram covering all modules

TH2D *	m_hCommonModeOld = nullptr
	histogram covering all modules

TCanvas *	m_cCommonMode = nullptr
	Final Canvas.

TCanvas *	m_cCommonModeDelta = nullptr
	Final Canvas.

TLine *	m_line1 = nullptr
	Line in the Canvas to guide the eye.

TLine *	m_lineA = nullptr
	Line in the Canvas to guide the eye.

TLine *	m_lineF = nullptr
	Line in the Canvas to guide the eye.

MonitoringObject *	m_monObj {}
	Monitoring Object.

bool	m_useEpics
	flag if to export to EPICS

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

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Static Private Attributes
static HistList	g_hist
	The list of Histograms.

static MonObjList	g_monObj
	The list of MonitoringObjects.

Detailed Description

DQM Histogram Analysis for PXD Common Modes.

Definition at line 36 of file DQMHistAnalysisPXDCM.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.

Member Function Documentation

◆ addHist()

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

Definition at line 46 of file DQMHistAnalysis.cc.

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

◆ event()

void event ( void )

finaloverridevirtual

This method is called for each event.

use flags set above

Reimplemented from Module.

Definition at line 178 of file DQMHistAnalysisPXDCM.cc.

 {
   double all_outside = 0.0, all = 0.0;
   double all_cm = 0.0;
   bool error_full_flag = false;
   bool warn_full_flag = false;
   bool error_adhoc_flag = false;
   bool warn_adhoc_flag = false;
   bool anyupdate = false;
   if (!m_cCommonMode) return;
   m_hCommonMode->Reset(); // dont sum up!!!
  
   auto leg = new TPaveText(0.1, 0.6, 0.90, 0.95, "NDC");
   leg->SetFillStyle(0);
   leg->SetBorderSize(0);
  
   for (unsigned int i = 0; i < m_PXDModules.size(); i++) {
     auto modname = (std::string)m_PXDModules[i];
     std::string name = "PXDDAQCM_" + modname;
     // std::replace( name.begin(), name.end(), '.', '_');
  
     TH1* hh1 = findHist(name);
     if (hh1 == NULL) {
       hh1 = findHist(m_histogramDirectoryName, name);
     }
     if (hh1) {
       double current_full = 0.0;
       double outside_full = 0.0;
  
       auto nevent = hh1->GetBinContent(0); // misuse underflow as event counter
       double scale = nevent - m_hCommonModeOld->GetBinContent(i + 1, 0); // number of new events for delta
       bool update = scale > m_minEntries ;
       anyupdate |= update;
       if (update) m_hCommonModeOld->SetBinContent(i + 1, 0, nevent);
       if (scale > 0) scale = 1.0 / scale;
       else scale = 1.; // worst case, no events at run start
  
       auto& gm = m_masked_gates[m_PXDModules[i]];
       // We loop over a 2d histogram!
       // loop CM values
       double dhpc = 0.0;
       for (int bin = 1; bin <= 64; bin++) { // including CM63!!!
         // loop gates*asics
         double v = 0;
         for (int gate = 0; gate < 192; gate++) {
           // attention, gate is not bin nr!
           if (std::find(gm.begin(), gm.end(), gate) == gm.end()) {
             v += hh1->GetBinContent(hh1->GetBin(gate + 1 + 192 * 0, bin)) +
                  hh1->GetBinContent(hh1->GetBin(gate + 1 + 192 * 1, bin)) +
                  hh1->GetBinContent(hh1->GetBin(gate + 1 + 192 * 2, bin)) +
                  hh1->GetBinContent(hh1->GetBin(gate + 1 + 192 * 3, bin));
           }
         }
         m_hCommonMode->SetBinContent(i + 1, bin, v); // attention, mixing bin nr and index
         // integration intervalls depend on CM default value, this seems to be agreed =10
         // FIXME currently we have to much noise below the line ... thus excluding this to avoid false alarms
         // outside_full += hh1->Integral(1 /*0*/, 5); /// FIXME we exclude bin 0 as we use it for debugging/timing pixels
         // attention, n bins!
         // we integrate up including value 62 (cm overflow), but not 63 (fifo full)
         if (bin == 63 + 1) { // CM63
           dhpc += v;
         } else { // excluding CM63
           current_full += v;
           if (bin > m_upperLineFull + 1) outside_full += v;
         }
         if (nevent < m_minEntries) {
           m_hCommonModeDelta->SetBinContent(i + 1, bin, v * scale); // attention, mixing bin nr and index
         } else if (update) {
           auto old = m_hCommonModeOld->GetBinContent(i + 1, bin); // attention, mixing bin nr and index
           m_hCommonModeDelta->SetBinContent(i + 1, bin, (v - old)*scale); // attention, mixing bin nr and index
           m_hCommonModeOld->SetBinContent(i + 1, bin, v); // attention, mixing bin nr and index
         }
       }
  
       all_outside += outside_full;
       all += current_full;
       all_cm += dhpc;
       if (current_full > 1) {
         error_full_flag |= (outside_full / current_full > m_errorOutsideFull);
         warn_full_flag |= (outside_full / current_full > m_warnOutsideFull);
       }
  
       if (update) {
         Double_t mean_adhoc = 0.;
         Double_t entries_adhoc = 0.;
         Double_t outside_adhoc = 0.;
  
         // Attention, Bins
         // we do not need to re-scale it as the scale is the same for all bins
         for (int cm_y = 0; cm_y < m_upperLineAdhoc; cm_y++) {
           auto v = m_hCommonModeDelta->GetBinContent(m_hCommonModeDelta->GetBin(i + 1, cm_y + 1));
           entries_adhoc += v;
           mean_adhoc += v * (cm_y + 1);
         }
         // Attention, Bins
         // We ignore CM63 in outside and overall count
         for (int cm_y = m_upperLineAdhoc; cm_y < 63; cm_y++) {
           auto v = m_hCommonModeDelta->GetBinContent(m_hCommonModeDelta->GetBin(i + 1, cm_y + 1));
           entries_adhoc += v;
           outside_adhoc += v;
         }
         if (entries_adhoc > 0 && scale < 1e-3) { // ignore modules with minimum events
           // scale <1e-3 == >1000 events
           mean_adhoc /= entries_adhoc; // calculate mean
           auto warn_tmp_m = fabs(10.0 - mean_adhoc) > m_warnMeanAdhoc;
           auto err_tmp_m = fabs(10.0 - mean_adhoc) > m_errorMeanAdhoc;
           auto warn_tmp_os = outside_adhoc / entries_adhoc > m_warnOutsideAdhoc;
           auto err_tmp_os = outside_adhoc / entries_adhoc > m_errorOutsideAdhoc;
           warn_adhoc_flag |= warn_tmp_m || warn_tmp_os;
           error_adhoc_flag |= err_tmp_m || err_tmp_os;
  
           if (warn_tmp_m || err_tmp_m) {
             TString tmp;
             tmp.Form("%s: Mean %f", modname.c_str(), mean_adhoc);
             leg->AddText(tmp);
             B2INFO(name << " Mean " <<  mean_adhoc << " " << warn_tmp_m << err_tmp_m);
           }
           if (warn_tmp_os || err_tmp_os) {
             TString tmp;
             tmp.Form("%s: Outside %f %%", modname.c_str(), 100. * outside_adhoc / entries_adhoc);
             leg->AddText(tmp);
             B2INFO(name << " Outside " << outside_adhoc / entries_adhoc << " (" << outside_adhoc << "/" << entries_adhoc << ") " << warn_tmp_os
                    << err_tmp_os);
           }
           m_monObj->setVariable(("cm_" + modname).c_str(), mean_adhoc);
 #ifdef _BELLE2_EPICS
           if (m_useEpics) {
             auto my = mychid_mean[m_PXDModules[i]];
             if (my) SEVCHK(ca_put(DBR_DOUBLE, my, (void*)&mean_adhoc), "ca_set failure");
           }
 #endif
         }
       }
     }
   }
  
   int status = 0;
   {
     m_cCommonMode->cd();
     // not enough Entries
     if (all < 100.) {
       m_cCommonMode->Pad()->SetFillColor(kGray);// Magenta or Gray
       status = 0; // default
     } else {
       if (all_outside / all > m_errorOutsideFull || error_full_flag) {
         m_cCommonMode->Pad()->SetFillColor(kRed);// Red
         status = 4;
       } else if (all_outside / all > m_warnOutsideFull || warn_full_flag) {
         m_cCommonMode->Pad()->SetFillColor(kYellow);// Yellow
         status = 3;
       } else if (all_outside == 0. /*&& all_cm == 0.*/) {
         // do not react on all_cm, we better monitor it elsewhere for clearity
         m_cCommonMode->Pad()->SetFillColor(kGreen);// Green
         status = 2;
       } else { // between 0 and 50 ...
         m_cCommonMode->Pad()->SetFillColor(kWhite);// White
         status = 1;
       }
     }
  
     if (m_hCommonMode) {
       m_hCommonMode->Draw("colz");
       m_line1->Draw();
       m_lineA->Draw();
     }
  
     auto tt = new TLatex(5.5, 3, "1.3.2 Module is excluded, please ignore");
     tt->SetTextAngle(90);// Rotated
     tt->SetTextAlign(12);// Centered
     tt->Draw();
  
     m_cCommonMode->Modified();
     m_cCommonMode->Update();
   }
  
   {
     int status_adhoc = 0;
     m_cCommonModeDelta->cd();
     // not enough Entries
  
     if (all < 100.) { // delta cannot be more than all
       m_cCommonModeDelta->Pad()->SetFillColor(kGray);// Magenta or Gray
       status_adhoc = 0; // default
     } else {
       if (error_adhoc_flag) {
         m_cCommonModeDelta->Pad()->SetFillColor(kRed);// Red
         status_adhoc = 4;
       } else if (warn_adhoc_flag) {
         m_cCommonModeDelta->Pad()->SetFillColor(kYellow);// Yellow
         status_adhoc = 3;
       } else {
         m_cCommonModeDelta->Pad()->SetFillColor(kGreen);// Green
         status_adhoc = 2;
         /*      } else { // between 0 and 50 ...
                 m_cCommonModeDelta->Pad()->SetFillColor(kWhite);// White
                 status_adhoc = 1;*/
       }
     }
 #ifdef _BELLE2_EPICS
     if (m_useEpics && anyupdate) SEVCHK(ca_put(DBR_INT, mychid[3], (void*)&status_adhoc), "ca_set failure");
 #endif
     if (m_hCommonModeDelta) {
       m_hCommonModeDelta->Draw("colz");
       leg->Draw();
       m_line1->Draw();
       m_lineA->Draw();
     }
  
     // keep this commented code as we may have excluded modules in phase4
 //     auto tt = new TLatex(5.5, 3, "1.3.2 Module is excluded, please ignore");
 //     tt->SetTextAngle(90);// Rotated
 //     tt->SetTextAlign(12);// Centered
 //     tt->Draw();
  
     m_cCommonModeDelta->Modified();
     m_cCommonModeDelta->Update();
   }
  
 #ifdef _BELLE2_EPICS
   if (m_useEpics) {
     double data = all > 0 ? (all_outside / all) : 0;
     double data2 = all > 0 ? (all_cm / all) : 0;
     SEVCHK(ca_put(DBR_DOUBLE, mychid[0], (void*)&data), "ca_set failure");
     SEVCHK(ca_put(DBR_INT, mychid[1], (void*)&status), "ca_set failure");
     SEVCHK(ca_put(DBR_DOUBLE, mychid[2], (void*)&data2), "ca_set failure");
     SEVCHK(ca_pend_io(5.0), "ca_pend_io failure");
   }
 #endif
 }

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

◆ findHist() [1/3]

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

staticinherited

Find histogram.

Parameters

dirname	The name of the directory.
histname	The name of the histogram.

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

Definition at line 132 of file DQMHistAnalysis.cc.

◆ findHist() [2/3]

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

staticinherited

Find histogram.

Parameters

histname The name of the histogram.

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

Definition at line 85 of file DQMHistAnalysis.cc.

◆ findHist() [3/3]

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

staticinherited

Find histogram.

Parameters

histdir	The TDirectory of the directory.
histname	The name of the histogram.

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

Definition at line 140 of file DQMHistAnalysis.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getHistList()

static const HistList& getHistList ( )

inlinestaticinherited

Get the list of the histograms.

Returns: The list of the histograms.

Definition at line 61 of file DQMHistAnalysis.h.

◆ getMonitoringObject()

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

staticinherited

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

Parameters

histname name of MonitoringObject to get

Definition at line 55 of file DQMHistAnalysis.cc.

◆ getMonObjList()

static const MonObjList& getMonObjList ( )

inlinestaticinherited

Get the list of MonitoringObjects.

Returns: The list of the MonitoringObjects.

Definition at line 67 of file DQMHistAnalysis.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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_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()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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.

◆ initialize()

void initialize ( void )

finaloverridevirtual

Initializer.

FIXME were to put the lines depends ...

Reimplemented from Module.

Definition at line 71 of file DQMHistAnalysisPXDCM.cc.

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

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

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

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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.

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

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

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

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

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

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ addHist()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ endRun()

◆ evalCondition()

◆ event()

◆ findCanvas()

◆ findHist() [1/3]

◆ findHist() [2/3]

◆ findHist() [3/3]

◆ findMonitoringObject()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getHistList()

◆ getMonitoringObject()

◆ getMonObjList()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()