Analysis of KLM DQM histograms. More...

#include <DQMHistAnalysisKLM.h>

Inheritance diagram for DQMHistAnalysisKLMModule:

[legend]

Collaboration diagram for DQMHistAnalysisKLMModule:

[legend]

Public Types
enum	EParamType { c_ParamINT, c_ParamFLOAT, c_ParamTEXT }
	The enumeration types for the module parameters. More...

typedef std::map< std::string, EParamType >	ParamTypeList
	The type of list of module parameter types.

typedef std::map< std::string, int >	IntValueList
	The type of list of integer module parameter.

typedef std::map< std::string, float >	FloatValueList
	The type of list of float module parameter.

typedef std::map< std::string, std::string >	TextList
	The type of list of string module parameter.

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

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

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

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

Public Member Functions
	DQMHistAnalysisKLMModule ()
	Constructor.

	~DQMHistAnalysisKLMModule ()
	Destructor.

void	initialize () override
	Initializer.

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

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

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

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

virtual std::vector< std::string >	getFileNames (__attribute__((unused)) bool outputFiles)
	Return a list of output filenames for this modules. 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	setIntValue (const std::string &parname, int vint)
	Set the integer value of the parameter. More...

static void	setFloatValue (const std::string &parname, float vfloat)
	Set the float value of the parameter. More...

static void	setText (const std::string &parname, const std::string &text)
	Set the string value of the parameter. More...

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

static 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 HistList &	getHists ()
	Get the list of histograms. More...

static ParamTypeList &	getParNames ()
	Get the list of the names and types of the parameters. More...

static IntValueList &	getIntValues ()
	Get the list of integer parameters. More...

static FloatValueList &	getFloatValues ()
	Get the list of float parameters. More...

static TextList &	getTexts ()
	Get the list of string parameters. More...

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

Protected Member Functions
double	getProcessedEvents ()
	Get number of processed events.

void	analyseChannelHitHistogram (int subdetector, int section, int sector, TH1 histogram, TCanvas canvas, TLatex &latex)
	Analyse channel hit histogram. More...

void	processPlaneHistogram (const std::string &histName, TLatex &latex)
	Process histogram containing the number of hits in plane. More...

void	fillMaskedChannelsHistogram (const std::string &histName)
	Fill histogram containing masked channels per sector. More...

TCanvas *	findCanvas (const std::string &canvasName)
	Find TCanvas that matches a given name. More...

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.

Protected Attributes
double	m_ProcessedEvents
	Number of processed events.

int	m_ThresholdForMasked
	Threshold for masked channels.

int	m_ThresholdForHot
	Threshold for hot channels.

int	m_MinHitsForFlagging
	Minimal number of hits for flagging.

double	m_MinProcessedEventsForMessagesInput
	Input parameter for minimal number of processed events for error messages.

double	m_MinProcessedEventsForMessages
	Minimal number of processed events for error messages.

std::vector< uint16_t >	m_DeadBarrelModules
	Vector of dead barrel modules.

std::vector< uint16_t >	m_DeadEndcapModules
	Vector of dead endcap modules.

std::vector< uint16_t >	m_MaskedChannels
	Vector of masked channels.

TLine	m_PlaneLine
	TLine for boundary in plane histograms.

TText	m_PlaneText
	TText for names in plane histograms.

const KLMChannelArrayIndex *	m_ChannelArrayIndex
	KLM channel array index.

const KLMSectorArrayIndex *	m_SectorArrayIndex
	KLM sector array index.

const KLMElementNumbers *	m_ElementNumbers
	KLM element numbers.

const EKLMElementNumbers *	m_EklmElementNumbers
	EKLM element numbers.

DBObjPtr< KLMElectronicsMap >	m_ElectronicsMap
	Electronics map.

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_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 ParamTypeList	g_parname
	The list of module parameter types.

static IntValueList	g_vint
	The list of integer module parameter.

static FloatValueList	g_vfloat
	The list of float module parameter.

static TextList	g_text
	The list of string module parameter.

static HistList	g_hist
	The list of histograms.

static MonObjList	g_monObj
	The list of MonitoringObjects.

Detailed Description

Analysis of KLM DQM histograms.

Definition at line 52 of file DQMHistAnalysisKLM.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 79 of file Module.h.

◆ EParamType

enum EParamType

inherited

The enumeration types for the module parameters.

Enumerator
c_ParamINT	The integer type for module parameter.
c_ParamFLOAT	The float type for module parameter.
c_ParamTEXT	The string type for module parameter.

Definition at line 33 of file DQMHistAnalysis.h.

Member Function Documentation

◆ addHist()

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

staticinherited

Add histogram.

Parameters

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.

◆ analyseChannelHitHistogram()

void analyseChannelHitHistogram	(	int	subdetector,
		int	section,
		int	sector,
		TH1 *	histogram,
		TCanvas *	canvas,
		TLatex &	latex
	)

protected

Analyse channel hit histogram.

Parameters

[in]	subdetector	Subdetector.
[in]	section	Section.
[in]	sector	Sector.
[in]	histogram	Histogram.
[in]	canvas	Canvas.
[out]	latex	TLatex to draw messages.

Definition at line 101 of file DQMHistAnalysisKLM.cc.

 {
   double x = 0.15;
   double y = 0.85;
   int i, n;
   std::map<uint16_t, double> moduleHitMap;
   std::map<uint16_t, double>::iterator it;
   double average = 0;
   int channelSubdetector, channelSection, channelSector;
   int layer, plane, strip;
   std::string str;
   canvas->Clear();
   canvas->cd();
   histogram->SetStats(false);
   histogram->Draw();
   n = histogram->GetXaxis()->GetNbins();
   for (i = 1; i <= n; i++) {
     uint16_t channelIndex = std::round(histogram->GetBinCenter(i));
     uint16_t channelNumber = m_ChannelArrayIndex->getNumber(channelIndex);
     double nHitsPerModule = histogram->GetBinContent(i);
     average = average + nHitsPerModule;
     m_ElementNumbers->channelNumberToElementNumbers(
       channelNumber, &channelSubdetector, &channelSection, &channelSector,
       &layer, &plane, &strip);
     if ((channelSubdetector != subdetector) ||
         (channelSection != section) ||
         (channelSector != sector))
       B2FATAL("Inconsistent element numbers.");
     uint16_t module = m_ElementNumbers->moduleNumber(
                         subdetector, section, sector, layer);
     it = moduleHitMap.find(module);
     if (it == moduleHitMap.end())
       moduleHitMap.insert(std::pair<uint16_t, double>(module, nHitsPerModule));
     else
       it->second += nHitsPerModule;
   }
   unsigned int activeModuleChannels = 0;
   for (it = moduleHitMap.begin(); it != moduleHitMap.end(); ++it) {
     uint16_t moduleNumber = it->first;
     if (it->second != 0) {
       activeModuleChannels += m_ElementNumbers->getNChannelsModule(moduleNumber);
       continue;
     }
     m_ElementNumbers->moduleNumberToElementNumbers(
       moduleNumber, &channelSubdetector, &channelSection, &channelSector, &layer);
     /* Channel with plane = 1, strip = 1 exists for any BKLM or EKLM module. */
     uint16_t channel = m_ElementNumbers->channelNumber(
                          channelSubdetector, channelSection, channelSector,
                          layer, 1, 1);
     const KLMElectronicsChannel* electronicsChannel =
       m_ElectronicsMap->getElectronicsChannel(channel);
     if (electronicsChannel == nullptr)
       B2FATAL("Incomplete KLM electronics map.");
     str = "No data from HSLB ";
     if (channelSubdetector == KLMElementNumbers::c_BKLM) {
       str += BKLMElementNumbers::getHSLBName(electronicsChannel->getCopper(),
                                              electronicsChannel->getSlot());
     } else {
       str += EKLMElementNumbers::getHSLBName(electronicsChannel->getCopper(),
                                              electronicsChannel->getSlot());
     }
     str += ", lane " + std::to_string(electronicsChannel->getLane());
     latex.DrawLatexNDC(x, y, str.c_str());
     y -= 0.05;
     /* Store the module number, used later in processPlaneHistogram
      * to color the canvas with red and to raise up an alarm. */
     if (channelSubdetector == KLMElementNumbers::c_BKLM) {
       std::vector<uint16_t>::iterator ite = std::find(m_DeadBarrelModules.begin(),
                                                       m_DeadBarrelModules.end(),
                                                       moduleNumber);
       if (ite == m_DeadBarrelModules.end())
         m_DeadBarrelModules.push_back(moduleNumber);
     } else {
       std::vector<uint16_t>::iterator ite = std::find(m_DeadEndcapModules.begin(),
                                                       m_DeadEndcapModules.end(),
                                                       moduleNumber);
       if (ite == m_DeadEndcapModules.end())
         m_DeadEndcapModules.push_back(moduleNumber);
     }
   }
   if (activeModuleChannels == 0)
     return;
   average /= activeModuleChannels;
   for (i = 1; i <= n; ++i) {
     uint16_t channelIndex = std::round(histogram->GetBinCenter(i));
     uint16_t channelNumber = m_ChannelArrayIndex->getNumber(channelIndex);
     double nHits = histogram->GetBinContent(i);
     m_ElementNumbers->channelNumberToElementNumbers(
       channelNumber, &channelSubdetector, &channelSection, &channelSector,
       &layer, &plane, &strip);
     std::string channelStatus = "Normal";
     if ((nHits > average * m_ThresholdForMasked) && (nHits > m_MinHitsForFlagging)) {
       channelStatus = "Masked";
       std::vector<uint16_t>::iterator ite = std::find(m_MaskedChannels.begin(),
                                                       m_MaskedChannels.end(),
                                                       channelNumber);
       if (ite == m_MaskedChannels.end())
         m_MaskedChannels.push_back(channelNumber);
       B2DEBUG(20, "KLM@MaskMe " << channelNumber);
     } else if ((nHits > average * m_ThresholdForHot) && (nHits > m_MinHitsForFlagging)) {
       channelStatus = "Hot";
     }
     if (channelStatus != "Normal") {
       const KLMElectronicsChannel* electronicsChannel =
         m_ElectronicsMap->getElectronicsChannel(channelNumber);
       if (electronicsChannel == nullptr)
         B2FATAL("Incomplete BKLM electronics map.");
       if (channelStatus == "Masked")
         histogram->SetBinContent(i, 0);
       str = channelStatus + " channel: HSLB ";
       if (channelSubdetector == KLMElementNumbers::c_BKLM) {
         str += BKLMElementNumbers::getHSLBName(electronicsChannel->getCopper(),
                                                electronicsChannel->getSlot());
       } else {
         str += EKLMElementNumbers::getHSLBName(electronicsChannel->getCopper(),
                                                electronicsChannel->getSlot());
       }
       str += (", lane " + std::to_string(electronicsChannel->getLane()) +
               ", axis " + std::to_string(electronicsChannel->getAxis()) +
               ", channel " + std::to_string(electronicsChannel->getChannel()));
       latex.DrawLatexNDC(x, y, str.c_str());
       y -= 0.05;
     }
   }
   canvas->Modified();
 }

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 181 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 441 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 422 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 98 of file Module.cc.

◆ fillMaskedChannelsHistogram()

void fillMaskedChannelsHistogram ( const std::string & histName )

protected

Fill histogram containing masked channels per sector.

Parameters

[in] histName Histogram name.

Definition at line 230 of file DQMHistAnalysisKLM.cc.

◆ findCanvas()

TCanvas * findCanvas ( const std::string & canvasName )

protected

Find TCanvas that matches a given name.

Parameters

[in]	canvasName	Name of the desired TCanvas.
[out]	TCanvas*	Matching TCanvas.

Definition at line 366 of file DQMHistAnalysisKLM.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 130 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 83 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 139 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 153 of file DQMHistAnalysis.cc.

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 135 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 115 of file Module.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Definition at line 136 of file Module.h.

◆ getFloatValues()

static FloatValueList& getFloatValues ( )

inlinestaticinherited

Get the list of float parameters.

Returns: The list of float parameters.

Definition at line 199 of file DQMHistAnalysis.h.

◆ getHistList()

const DQMHistAnalysisModule::HistList & getHistList ( )

staticinherited

Get the list of the histograms.

Returns: The list of the histograms.

Definition at line 72 of file DQMHistAnalysis.cc.

◆ getHists()

static HistList& getHists ( )

inlinestaticinherited

Get the list of histograms.

Returns: The list of histograms.

Definition at line 184 of file DQMHistAnalysis.h.

◆ getIntValues()

static IntValueList& getIntValues ( )

inlinestaticinherited

Get the list of integer parameters.

Returns: The list of integer parameters.

Definition at line 194 of file DQMHistAnalysis.h.

◆ getMonitoringObject()

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

staticinherited

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

Parameters

objName name of MonitoringObject to get

Definition at line 55 of file DQMHistAnalysis.cc.

◆ getMonObjList()

const DQMHistAnalysisModule::MonObjList & getMonObjList ( )

staticinherited

Get the list of MonitoringObjects.

Returns: The list of the MonitoringObjects.

Definition at line 77 of file DQMHistAnalysis.cc.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 189 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 281 of file Module.cc.

◆ getParNames()

static ParamTypeList& getParNames ( )

inlinestaticinherited

Get the list of the names and types of the parameters.

Returns: The list of the names and types of the parameters.

Definition at line 189 of file DQMHistAnalysis.h.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 383 of file Module.h.

◆ getTexts()

static TextList& getTexts ( )

inlinestaticinherited

Get the list of string parameters.

Returns: The list of string parameters.

Definition at line 204 of file DQMHistAnalysis.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 43 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 162 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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 87 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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 92 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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 81 of file Module.cc.

◆ processPlaneHistogram()

void processPlaneHistogram	(	const std::string &	histName,
		TLatex &	latex
	)

protected

Process histogram containing the number of hits in plane.

Parameters

[in]	histName	Histogram name.
[out]	latex	TLatex to draw messages.

Definition at line 267 of file DQMHistAnalysisKLM.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 216 of file Module.cc.

◆ setFloatValue()

void setFloatValue	(	const std::string &	parname,
		float	vfloat
	)

staticinherited

Set the float value of the parameter.

Parameters

parname	The name of the parameter.
vfloat	The value to be set.

Definition at line 181 of file DQMHistAnalysis.cc.

◆ setIntValue()

void setIntValue	(	const std::string &	parname,
		int	vint
	)

staticinherited

Set the integer value of the parameter.

Parameters

parname	The name of the parameter.
vint	The value to be set.

Definition at line 169 of file DQMHistAnalysis.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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 75 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note: The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 216 of file Module.h.

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 236 of file Module.cc.

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 210 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 229 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 222 of file Module.cc.

◆ setText()

void setText	(	const std::string &	parname,
		const std::string &	text
	)

staticinherited

Set the string value of the parameter.

Parameters

parname	The name of the parameter.
text	The value to be set.

Definition at line 193 of file DQMHistAnalysis.cc.

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 50 of file Module.cc.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

◆ EParamType

Member Function Documentation

◆ addHist()

◆ analyseChannelHitHistogram()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ evalCondition()

◆ fillMaskedChannelsHistogram()

◆ findCanvas()

◆ findHist() [1/3]

◆ findHist() [2/3]

◆ findHist() [3/3]

◆ findMonitoringObject()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getFloatValues()

◆ getHistList()

◆ getHists()

◆ getIntValues()

◆ getMonitoringObject()

◆ getMonObjList()

◆ getName()

◆ getParamInfoListPython()

◆ getParNames()

◆ getReturnValue()

◆ getTexts()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ processPlaneHistogram()

◆ setDescription()

◆ setFloatValue()

◆ setIntValue()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setText()

◆ setType()