This module is created to monitor ECL Data Quality. More...

#include <eclDQM.h>

Inheritance diagram for ECLDQMModule:

Public Types
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
	ECLDQMModule ()
	< derived from HistoModule class.

virtual	~ECLDQMModule ()
	Destructor.

virtual void	initialize () override
	Initialize the module.

virtual void	beginRun () override
	Call when a run begins.

virtual void	event () override
	Event processor.

virtual void	endRun () override
	Call when a run ends.

virtual void	terminate () override
	Terminate.

virtual void	defineHisto () override
	Function to define histograms.

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

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

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

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

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

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

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

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static 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.

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
bool	isRandomTrigger ()

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
ECL::ECLGeometryPar *	m_geom {nullptr}
	Geometry.

StoreObjPtr< EventMetaData >	m_eventmetadata
	StoreObjPtr EventMetaData.

StoreObjPtr< TRGSummary >	m_l1Trigger
	StoreObjPtr TRGSummary

ECL::ECLChannelMapper	mapper
	ECL channel mapper.

StoreArray< ECLDigit >	m_ECLDigits
	StoreArray ECLDigit.

StoreArray< ECLDsp >	m_ECLDsps
	StoreArray ECLDsp.

StoreArray< ECLTrig >	m_ECLTrigs
	StoreArray ECLTrig.

StoreArray< ECLCalDigit >	m_ECLCalDigits
	StoreArray ECLCalDigit.

DBObjPtr< ECLCrystalCalib >	m_calibrationThrApsd
	PSD waveform amplitude threshold.

int	m_iEvent { -1}
	Global event number.

std::string	m_histogramDirectoryName
	Histogram directory in ROOT file.

double	m_EnergyUpperThr
	Upper threshold of energy deposition in event, [GeV].

bool	m_DPHYTTYP {0}
	Flag to select events triggered by delayed bhabha.

std::vector< double >	m_HitThresholds = {}
	Parameters for hit occ.

std::vector< double >	m_TotalEnergyThresholds = {}
	Parameters for histograms w/ total energy.

std::vector< double >	m_TimingThresholds = {}
	Parameters for timing histograms.

std::vector< double >	m_HitNumberUpperLimits = {}
	Parameters for number of hits histograms.

std::vector< std::string >	m_WaveformOption
	Parameters for waveform histograms.

std::vector< double >	ecltot = {}
	Container for energy.

std::vector< double >	nhits = {}
	Container for channel multiplicity.

std::vector< int >	v_totalthrApsd = {}
	Vector to store psd wf amplitude threshold.

int	m_DspArray [ECLElementNumbers::c_NCrystals][31] = {}
	WF sampling points for digit array.

double	m_PedestalMean [ECLElementNumbers::c_NCrystals] = {}
	Pedestal average values.

double	m_PedestalRms [ECLElementNumbers::c_NCrystals] = {}
	Pedestal rms error values.

TH1F *	h_evtot {nullptr}
	Histogram: Total event no (auxiliary) to normalize hit map .

TH1F *	h_evtot_logic {nullptr}
	Histogram: Event no for logic (auxiliary) to normalize logic waveform flow.

TH1F *	h_evtot_rand {nullptr}
	Histogram: Event no for rand (auxiliary) to normalize rand waveform flow.

TH1F *	h_evtot_dphy {nullptr}
	Histogram: Event no for dphy (auxiliary) to normalize dphy waveform flow.

TH1F *	h_quality {nullptr}
	Histogram: Fit quality flag (0 - good, 1 - large amplitude, 3 - bad chi2).

TH1F *	h_quality_other {nullptr}
	Histogram: Fit quality flag for waveform type 'other'.

TH1F *	h_bad_quality {nullptr}
	Histogram: Cell IDs w/ bad fit quality flag.

TH1F *	h_trigtag1 {nullptr}
	Histogram: Trigger tag flag #1.

TH1F *	h_adc_hits {nullptr}
	Histogram: Fraction of digits above ADC threshold.

TH1F *	h_time_crate_Thr1GeV_large {nullptr}
	Histogram: Entries with crate time offsets > 100 ns (E > 1 GeV).

std::vector< TH1F * >	h_cids = {}
	Histogram vector: Hit map.

std::vector< TH1F * >	h_edeps = {}
	Histogram vector: Total energy.

std::vector< TH1F * >	h_time_barrels = {}
	Histogram vector: Reconstructed time for barrel.

std::vector< TH1F * >	h_time_endcaps = {}
	Histogram vector: Reconstructed time for endcaps.

std::vector< TH1F * >	h_ncevs = {}
	Histogram vector: Channel multiplicity.

std::vector< TH1F * >	h_cells = {}
	Histogram vector: Waveforms vs CellID.

TH1F *	h_cell_psd_norm {nullptr}
	Histogram: Normalize to psd hits for CellID.

std::vector< TH1F * >	h_time_crate_Thr1GeV = {}
	Histogram vector: Reconstructed signal time for all ECL crates above the threshold = 1 GeV.

TH2F *	h_trigtime_trigid {nullptr}
	Histogram: Trigger time vs.

TH2F *	h_trigtag2_trigid {nullptr}
	Histogram: Trigger tag flag #2 vs.

TProfile *	h_pedmean_cellid {nullptr}
	Histogram: Pedestal Average vs.

TProfile *	h_pedrms_cellid {nullptr}
	Histogram: Pedestal rms error vs.

TProfile *	h_pedrms_thetaid {nullptr}
	Histogram: Pedestal rms error vs.

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.

Detailed Description

This module is created to monitor ECL Data Quality.

Definition at line 43 of file eclDQM.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.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,  
    };

Constructor & Destructor Documentation

◆ ECLDQMModule()

ECLDQMModule ( )

< derived from HistoModule class.

Constructor.

Definition at line 50 of file eclDQM.cc.

  : HistoModule(),
    m_calibrationThrApsd("ECL_FPGA_StoreWaveform")
{
  //Set module properties.
  setDescription(
    "Primary module for ECL Data Quality Monitor.\n"
    "This module provides a large set of low-level histograms: occupancy, time distribution, number of saved waveforms, etc.");
  setPropertyFlags(c_ParallelProcessingCertified);  // specify parallel processing.
 
  m_WaveformOption = {"psd", "logic", "rand", "dphy", "other"};
 
  addParam("histogramDirectoryName", m_histogramDirectoryName,
           "histogram directory in ROOT file", std::string("ECL"));
  addParam("EnergyUpperThr", m_EnergyUpperThr, "Upper threshold of energy deposition in event, [GeV]", 20.0 * Belle2::Unit::GeV);
  addParam("HitThresholds", m_HitThresholds, "Thresholds to display hit occupancy, MeV", std::vector<double> {0, 5, 10, 50});
  addParam("TotalEnergyThresholds", m_TotalEnergyThresholds, "Thresholds to display total energy, MeV", std::vector<double> {0, 5, 7});
  addParam("TimingThresholds", m_TimingThresholds, "Thresholds (MeV) to display ECL timing", std::vector<double> {5, 10, 50});
  addParam("HitNumberUpperlimits", m_HitNumberUpperLimits,
           "Upper limit (# of hits) to display hit multiplicity", std::vector<double> {10000, 1000, 700, 200});
  addParam("WaveformOption", m_WaveformOption, "Option (all,psd,logic,rand,dphy,other) to display waveform flow",
           m_WaveformOption);
  addParam("DPHYTTYP", m_DPHYTTYP,
           "Flag to control trigger of delayed bhabha events; 0 - select events by 'bha_delay' trigger bit, 1 - select by TTYP_DPHY", false);
}

◆ ~ECLDQMModule()

~ECLDQMModule ( )

virtual

Destructor.

Definition at line 76 of file eclDQM.cc.

77{

78}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

Call when a run begins.

Reimplemented from HistoModule.

Definition at line 262 of file eclDQM.cc.

{
  h_evtot->Reset();
  h_evtot_logic->Reset();
  h_evtot_rand->Reset();
  h_evtot_dphy->Reset();
  h_quality->Reset();
  h_quality_other->Reset();
  h_bad_quality->Reset();
  h_trigtag1->Reset();
  h_adc_hits->Reset();
  h_time_crate_Thr1GeV_large->Reset();
  h_cell_psd_norm->Reset();
  std::for_each(h_cids.begin(), h_cids.end(), [](auto & it) {it->Reset();});
  std::for_each(h_edeps.begin(), h_edeps.end(), [](auto & it) {it->Reset();});
  std::for_each(h_time_barrels.begin(), h_time_barrels.end(), [](auto & it) {it->Reset();});
  std::for_each(h_time_endcaps.begin(), h_time_endcaps.end(), [](auto & it) {it->Reset();});
  std::for_each(h_ncevs.begin(), h_ncevs.end(), [](auto & it) {it->Reset();});
  std::for_each(h_cells.begin(), h_cells.end(), [](auto & it) {it->Reset();});
  for (int i = 0; i < ECL_CRATES; i++) h_time_crate_Thr1GeV[i]->Reset();
  h_trigtag2_trigid->Reset();
  h_pedmean_cellid->Reset();
  h_pedrms_cellid->Reset();
  h_pedrms_thetaid->Reset();
  h_trigtime_trigid->Reset();
}

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

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

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

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

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

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

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

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

420{ 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 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ defineHisto()

void defineHisto ( )

overridevirtual

Function to define histograms.

Reimplemented from HistoModule.

Definition at line 81 of file eclDQM.cc.

{
  TDirectory* oldDir = gDirectory;
 
  // Create a separate histogram directory and cd into it.
 
  TDirectory* dirDAQ = dynamic_cast<TDirectory*>(oldDir->Get(m_histogramDirectoryName.c_str()));
  if (!dirDAQ) dirDAQ = oldDir->mkdir(m_histogramDirectoryName.c_str());
  dirDAQ->cd();
 
  //1D histograms creation.
  h_evtot = new TH1F("event", "Total event bank", 1, 0, 1);
 
  h_quality = new TH1F("quality", "Fit quality flag. 0-good, 1-integer overflow, 2-low amplitude, 3-bad chi2", 4, 0, 4);
  h_quality->GetXaxis()->SetTitle("Quality flag");
  h_quality->GetYaxis()->SetTitle("ECL hits count");
  h_quality->SetFillColor(kPink - 4);
 
  h_quality_other = new TH1F("quality_other", "Fit quality flag for unexpectedly saved waveforms", 4, 0, 4);
  h_quality_other->GetXaxis()->SetTitle("Quality flag. 0-good,1-int overflow,2-low amplitude,3-bad chi2");
  h_quality_other->SetFillColor(kPink - 4);
 
  h_bad_quality = new TH1F("bad_quality", "Fraction of hits with bad chi2 (qual=3) and E > 1 GeV vs Cell ID",
                           ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
  h_bad_quality->GetXaxis()->SetTitle("Cell ID");
  h_bad_quality->GetYaxis()->SetTitle("ECL hits count");
 
  h_trigtag1 = new TH1F("trigtag1", "Consistency b/w global event number and trigger tag. 0-good, 1-DQM error", 2, 0, 2);
  h_trigtag1->GetXaxis()->SetTitle("Flag value");
  h_trigtag1->GetYaxis()->SetTitle("Events count");
  h_trigtag1->SetDrawOption("hist");
  h_trigtag1->SetFillColor(kPink - 4);
 
  h_adc_hits = new TH1F("adc_hits", "Fraction of high-energy hits (E > 50 MeV)", 1001, 0, 1.001);
  h_adc_hits->GetXaxis()->SetTitle("Fraction");
  h_adc_hits->GetYaxis()->SetTitle("Events count");
 
  h_time_crate_Thr1GeV_large = new TH1F("time_crate_Thr1GeV_large",
                                        "Number of hits with timing outside #pm 100 ns per Crate ID (E > 1 GeV)",
                                        52, 1, 53);
  h_time_crate_Thr1GeV_large->GetXaxis()->SetTitle("Crate ID (same as ECLCollector ID)");
  h_time_crate_Thr1GeV_large->GetYaxis()->SetTitle("ECL hits count");
 
  for (const auto& id : m_HitThresholds) {
    std::string h_name, h_title;
    h_name = str(boost::format("cid_Thr%1%MeV") % id);
    h_title = str(boost::format("Occupancy per Cell ID (E > %1% MeV)") % id);
    TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(),
                       ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
    h->GetXaxis()->SetTitle("Cell ID");
    h->GetYaxis()->SetTitle("Occupancy (hits / events_count)");
    h_cids.push_back(h);
  }
 
  for (const auto& id : m_TotalEnergyThresholds) {
    std::string h_name, h_title;
    h_name = str(boost::format("edep_Thr%1%MeV") % id);
    h_title = str(boost::format("Total energy (thr = %1% MeV)") % id);
    TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(), (int)(100 * m_EnergyUpperThr), 0, m_EnergyUpperThr);
    h->GetXaxis()->SetTitle("Energy, [GeV]");
    h_edeps.push_back(h);
  }
 
  for (const auto& id : m_TimingThresholds) {
    std::string h_bar_name, h_bar_title;
    std::string h_end_name, h_end_title;
    h_bar_name = str(boost::format("time_barrel_Thr%1%MeV") % id);
    h_bar_title = str(boost::format("Reconstructed time for ECL barrel (E > %1% MeV)") % id);
    h_end_name = str(boost::format("time_endcaps_Thr%1%MeV") % id);
    h_end_title = str(boost::format("Reconstructed time for ECL endcaps (E > %1% MeV)") % id);
    TH1F* h_time_barrel = new TH1F(h_bar_name.c_str(), h_bar_title.c_str(), 206, -1030, 1030);
    TH1F* h_time_endcap = new TH1F(h_end_name.c_str(), h_end_title.c_str(), 206, -1030, 1030);
    h_time_barrel->GetXaxis()->SetTitle("Time, [ns]");
    h_time_endcap->GetXaxis()->SetTitle("Time, [ns]");
    h_time_barrels.push_back(h_time_barrel);
    h_time_endcaps.push_back(h_time_endcap);
  }
 
  for (const auto& id : boost::combine(m_HitThresholds, m_HitNumberUpperLimits)) {
    double id1 = 0, id2 = 0;
    boost::tie(id1, id2) = id;
    std::string h_name, h_title;
    h_name = str(boost::format("ncev_Thr%1%MeV") % id1);
    h_title = str(boost::format("Number of hits in event (E > %1% MeV)") % id1);
    TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(), id2, 0, id2);
    h->GetXaxis()->SetTitle("Number of hits");
    h_ncevs.push_back(h);
  }
 
  for (int i = 0; i < ECL_CRATES; i++) {
    int crate = i + 1;
    std::string h_name, h_title;
    h_name = str(boost::format("time_crate_%1%_Thr1GeV") % (crate));
    h_title = str(boost::format("Reconstructed time for ECL crate #%1% with E > 1 GeV") % (crate));
    TH1F* h = new TH1F(h_name.c_str(), h_title.c_str(), 400, -100, 100);
    h->GetXaxis()->SetTitle("Time [ns]");
    h_time_crate_Thr1GeV.push_back(h);
  }
 
  for (const auto& id : m_WaveformOption) {
    if (id != "all" && id != "psd" && id != "logic" && id != "rand" && id != "dphy" && id != "other")
      B2WARNING("Waveform Options are not correctly assigned. They must be 'all', 'psd', 'logic', 'rand', 'dphy', 'other'!");
    std::string h_title;
    std::string h_cell_name;
    if (id == "other") h_title = "Unexpectedly saved waveforms";
    if (id == "psd") h_title = "#frac{Saved}{Expected} waveforms for high-energy hits (E > 50 MeV)";
    if (id == "logic") h_title = "#frac{Saved}{Expected} waveforms for every 1000th event";
    if (id == "rand") h_title = "#frac{Saved}{Expected} waveforms for random trigger events";
    if (id == "dphy") h_title = "#frac{Saved}{Expected} waveforms for delayed bhabha (DPHY) events";
    if (id == "all") h_title = "#frac{Saved}{Expected} waveforms for all events";
    h_cell_name = str(boost::format("wf_cid_%1%") % (id));
    TH1F* h_cell = new TH1F(h_cell_name.c_str(), h_title.c_str(),
                            ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
    h_cell->GetXaxis()->SetTitle("Cell ID");
    if (id == "psd") {
      h_cell_psd_norm = new TH1F("psd_cid", "Normalization to psd hits for cid",
                                 ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
    }
    if (id == "logic") {
      h_evtot_logic = new TH1F("event_logic", "Event bank for logic", 1, 0, 1);
    }
    if (id == "rand") {
      h_evtot_rand = new TH1F("event_rand", "Event bank for rand", 1, 0, 1);
    }
    if (id == "dphy") {
      h_evtot_dphy = new TH1F("event_dphy", "Event bank for dphy", 1, 0, 1);
    }
    h_cells.push_back(h_cell);
  }
 
  //2D histograms creation.
 
  h_trigtag2_trigid = new TH2F("trigtag2_trigid", "Internal data consistency vs crate. 0-good, 1-data corruption",
                               52, 1, 53, 11, -1, 10);
  h_trigtag2_trigid->GetXaxis()->SetTitle("Crate ID (same as ECLCollector ID)");
  h_trigtag2_trigid->GetYaxis()->SetTitle("Data consistency flag");
 
  h_pedmean_cellid = new TProfile("pedmean_cellid", "Pedestal vs Cell ID",
                                  ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
  h_pedmean_cellid->GetXaxis()->SetTitle("Cell ID");
  h_pedmean_cellid->GetYaxis()->SetTitle("Ped. average (ADC units, #approx 0.05 MeV)");
 
  h_pedrms_cellid = new TProfile("pedrms_cellid", "Pedestal stddev vs Cell ID",
                                 ECLElementNumbers::c_NCrystals, 1, ECLElementNumbers::c_NCrystals + 1);
  h_pedrms_cellid->GetXaxis()->SetTitle("Cell ID");
  h_pedrms_cellid->GetYaxis()->SetTitle("Ped. stddev (ADC units, #approx 0.05 MeV)");
 
  h_pedrms_thetaid = new TProfile("pedrms_thetaid", "Pedestal stddev vs #theta ID",
                                  68, 0, 68);
  h_pedrms_thetaid->GetXaxis()->SetTitle("#theta ID (0-12=FWD, 59-67=BWD endcap)");
  h_pedrms_thetaid->GetYaxis()->SetTitle("Ped. stddev (ADC units, #approx 0.05 MeV)");
 
  h_trigtime_trigid = new TH2F("trigtime_trigid", "Trigger time vs Crate ID", 52, 1, 53, 145, 0, 145);
  h_trigtime_trigid->GetXaxis()->SetTitle("Crate ID (same as ECLCollector ID)");
  h_trigtime_trigid->GetYaxis()->SetTitle("Trigger time (only even, 0-142)");
 
  //cd into parent directory.
 
  oldDir->cd();
}

◆ endRun()

void endRun ( void )

overridevirtual

Call when a run ends.

Reimplemented from HistoModule.

Definition at line 429 of file eclDQM.cc.

430{

431}

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

overridevirtual

Event processor.

Reimplemented from HistoModule.

Definition at line 289 of file eclDQM.cc.

{
  int trigtag1 = 0;
  int NDigits = 0;
  for (auto& value : ecltot) value = 0;
  for (auto& value : nhits) value = 0;
  bool bhatrig = false;
 
  if (m_l1Trigger.isValid() && m_DPHYTTYP) bhatrig = m_l1Trigger->getTimType() == TRGSummary::ETimingType::TTYP_DPHY;
  else if (m_l1Trigger.isValid() && !m_DPHYTTYP) {
    try { bhatrig = m_l1Trigger->testInput("bha_delay"); }
    catch (const std::exception&) { bhatrig = false; }
  }
 
  m_iEvent = -1;
  if (m_eventmetadata.isValid()) {
    if (m_eventmetadata->getErrorFlag() != 0x10) {
      m_iEvent = m_eventmetadata->getEvent();
      h_evtot->Fill(0);
      for (const auto& id : m_WaveformOption) {
        if (id == "logic" && m_iEvent % 1000 == 999) h_evtot_logic->Fill(0);
        if (id == "rand" && isRandomTrigger()) h_evtot_rand->Fill(0);
        if (id == "dphy" && bhatrig) h_evtot_dphy->Fill(0);
      }
    }
  }
 
  for (auto& aECLDigit : m_ECLDigits) {
    int i = aECLDigit.getCellId() - 1;
    h_quality->Fill(aECLDigit.getQuality());  //Fit quality histogram filling.
    if (aECLDigit.getAmp() > 2.e04 && aECLDigit.getQuality() == 3) h_bad_quality->Fill(aECLDigit.getCellId());
    if (aECLDigit.getAmp() >= (v_totalthrApsd[i] / 4 * 4)) NDigits ++;
    for (const auto& id : m_WaveformOption) {
      if (id != "psd") continue;
      else if (id == "psd" && (m_iEvent % 1000 == 999 ||
                               isRandomTrigger() ||
                               bhatrig ||
                               aECLDigit.getAmp() < (v_totalthrApsd[i] / 4 * 4))) continue;
      h_cell_psd_norm->Fill(aECLDigit.getCellId());
    }
  }
 
  for (auto& aECLTrig : m_ECLTrigs) {
    double itrg = aECLTrig.getTimeTrig();
    //trigger time conversion to acceptable units in range (0, ..., 142).
    //one trigger time clock corresponds to 0.567/144*1000 = 3.93 ns
    int tg = (int)itrg - 2 * ((int)itrg / 8);
    h_trigtime_trigid->Fill(aECLTrig.getTrigId(), tg); //Trigger time histogram filling.
    trigtag1 += aECLTrig.getTrigTag();
    h_trigtag2_trigid->Fill(aECLTrig.getTrigId(), aECLTrig.getTrigTagQualityFlag()); //Data consistency histogram filling.
  }
 
  if (m_ECLTrigs.getEntries() > 0) {
    int flagtag = 1;
    trigtag1 /= m_ECLTrigs.getEntries();
    int compar = (65535 & m_iEvent);
    if (compar == trigtag1) flagtag = 0;
    h_trigtag1->Fill(flagtag);  //Trigger tag flag #1 histogram filling.
  }
 
  for (auto& aECLCalDigit : m_ECLCalDigits) {
    int cid        = aECLCalDigit.getCellId();
    double energy  = aECLCalDigit.getEnergy(); //get calibrated energy.
    double timing  = aECLCalDigit.getTime();   //get calibrated time.
 
    for (const auto& id : m_HitThresholds) {
      auto scale = id / 1000.;
      auto index = std::distance(m_HitThresholds.begin(), std::find(m_HitThresholds.begin(), m_HitThresholds.end(), id));
      if (energy > scale)  {
        h_cids[index]->Fill(cid);
        nhits[index] += 1;
      }
    }
 
    for (const auto& id : m_TotalEnergyThresholds) {
      auto scale = id / 1000.;
      auto index = std::distance(m_TotalEnergyThresholds.begin(), std::find(m_TotalEnergyThresholds.begin(),
                                 m_TotalEnergyThresholds.end(), id));
      if (energy > scale) ecltot[index] += energy;
    }
 
    for (const auto& id : m_TimingThresholds) {
      auto scale = id / 1000.;
      auto index = std::distance(m_TimingThresholds.begin(), std::find(m_TimingThresholds.begin(), m_TimingThresholds.end(), id));
      if (energy > scale) {
        if (cid > ECL_FWD_CHANNELS && cid <= ECL_FWD_CHANNELS + ECL_BARREL_CHANNELS) h_time_barrels[index]->Fill(timing);
        else h_time_endcaps[index]->Fill(timing);
      }
    }
 
    if (energy > 1.000 && std::abs(timing) < 100.)  h_time_crate_Thr1GeV[mapper.getCrateID(cid) - 1]->Fill(timing);
    if (energy > 1.000 && std::abs(timing) > 100.) h_time_crate_Thr1GeV_large->Fill(mapper.getCrateID(cid));
  }
 
  for (auto& h : h_edeps) {
    auto index = std::distance(h_edeps.begin(), std::find(h_edeps.begin(), h_edeps.end(), h));
    h->Fill(ecltot[index]);
  }
 
  for (auto& h : h_ncevs) {
    auto index = std::distance(h_ncevs.begin(), std::find(h_ncevs.begin(), h_ncevs.end(), h));
    h->Fill(nhits[index]);
  }
 
  for (auto& aECLDsp : m_ECLDsps)  {
    int i = aECLDsp.getCellId() - 1; //get number of Cell ID in m_DspArray.
    aECLDsp.getDspA(m_DspArray[i]);
    m_PedestalMean[i] = 0;
    m_PedestalRms[i] = 0;
 
    for (int j = 0; j < 16; j++) m_PedestalMean[i] += m_DspArray[i][j];
    m_PedestalMean[i] /= 16;
    h_pedmean_cellid->Fill(aECLDsp.getCellId(), m_PedestalMean[i]); //Pedestal Avg histogram filling.
 
    for (int j = 0; j < 16; j++) m_PedestalRms[i] += pow(m_DspArray[i][j] - m_PedestalMean[i], 2);
    m_PedestalRms[i] = sqrt(m_PedestalRms[i] / 15.);
    h_pedrms_cellid->Fill(aECLDsp.getCellId(), m_PedestalRms[i]); //Pedestal stddev histogram filling.
    m_geom->Mapping(i);
    h_pedrms_thetaid->Fill(m_geom->GetThetaID(), m_PedestalRms[i]);
 
    ECLDigit* aECLDigit = ECLDigit::getByCellID(aECLDsp.getCellId());
 
    for (const auto& id : m_WaveformOption) {
      auto index = std::distance(m_WaveformOption.begin(), std::find(m_WaveformOption.begin(), m_WaveformOption.end(), id));
      if (id != "all" && id != "psd" && id != "logic" && id != "rand" && id != "dphy" && id != "other") continue;
      else if (id == "psd" && (m_iEvent % 1000 == 999 || isRandomTrigger() || bhatrig ||
                               !aECLDigit || aECLDigit->getAmp() < (v_totalthrApsd[i] / 4 * 4))) continue;
      else if (id == "logic" && m_iEvent % 1000 != 999) continue;
      else if (id == "rand" && (m_iEvent % 1000 == 999 || !isRandomTrigger())) continue;
      else if (id == "dphy" && (m_iEvent % 1000 == 999 || !bhatrig)) continue;
      else if (id == "other" && (m_iEvent % 1000 == 999 || isRandomTrigger() || bhatrig ||
                                 (aECLDigit && aECLDigit->getAmp() >= (v_totalthrApsd[i] / 4 * 4)))) continue;
      h_cells[index]->Fill(aECLDsp.getCellId());
      if (id == "other" && aECLDigit) h_quality_other->Fill(aECLDigit->getQuality());
    }
  }
  if (m_ECLDigits.getEntries() > 0)
    h_adc_hits->Fill((double)NDigits / (double)m_ECLDigits.getEntries()); //Fraction of high-energy hits
}

◆ 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 pathes */
  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://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  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)

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

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 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;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

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

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

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

187{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:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{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 363 of file Module.h.

363{ 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;
}

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

381{ return m_returnValue; }

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

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

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

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

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize the module.

Reimplemented from HistoModule.

Definition at line 242 of file eclDQM.cc.

{
  REG_HISTOGRAM;   // required to register histograms to HistoManager.
  m_ECLDigits.isRequired();
  m_ECLCalDigits.isOptional();
  m_ECLTrigs.isOptional();
  m_ECLDsps.isOptional();
  m_l1Trigger.isOptional();
 
  if (!mapper.initFromDB()) B2FATAL("ECL DQM: Can't initialize eclChannelMapper");
 
  ecltot.resize(m_TotalEnergyThresholds.size());
  nhits.resize(m_HitNumberUpperLimits.size());
 
  m_geom = ECLGeometryPar::Instance();
 
  v_totalthrApsd.resize((m_calibrationThrApsd->getCalibVector()).size());
  for (size_t i = 0; i < v_totalthrApsd.size(); i++) v_totalthrApsd[i] = (int)(m_calibrationThrApsd->getCalibVector())[i];
}

◆ isRandomTrigger()

bool isRandomTrigger ( )

private

Returns: true if the current event is a random trigger event, false otherwise.

Definition at line 438 of file eclDQM.cc.

{
  if (!m_l1Trigger.isValid()) return false;
  return m_l1Trigger->getTimType() == TRGSummary::ETimingType::TTYP_RAND ||
         m_l1Trigger->getTimType() == TRGSummary::ETimingType::TTYP_POIS;
}

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

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

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

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ 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;
}

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

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

◆ terminate()

void terminate ( void )

overridevirtual

Terminate.

Reimplemented from HistoModule.

Definition at line 434 of file eclDQM.cc.

435{

436}

Member Data Documentation

◆ ecltot

std::vector<double> ecltot = {}

private

Container for energy.

Definition at line 113 of file eclDQM.h.

◆ h_adc_hits

TH1F* h_adc_hits {nullptr}

private

Histogram: Fraction of digits above ADC threshold.

Definition at line 144 of file eclDQM.h.

◆ h_bad_quality

TH1F* h_bad_quality {nullptr}

private

Histogram: Cell IDs w/ bad fit quality flag.

Definition at line 140 of file eclDQM.h.

◆ h_cell_psd_norm

TH1F* h_cell_psd_norm {nullptr}

private

Histogram: Normalize to psd hits for CellID.

Definition at line 161 of file eclDQM.h.

◆ h_cells

std::vector<TH1F*> h_cells = {}

private

Histogram vector: Waveforms vs CellID.

Definition at line 159 of file eclDQM.h.

◆ h_cids

std::vector<TH1F*> h_cids = {}

private

Histogram vector: Hit map.

Definition at line 149 of file eclDQM.h.

◆ h_edeps

std::vector<TH1F*> h_edeps = {}

private

Histogram vector: Total energy.

Definition at line 151 of file eclDQM.h.

◆ h_evtot

TH1F* h_evtot {nullptr}

private

Histogram: Total event no (auxiliary) to normalize hit map .

Definition at line 128 of file eclDQM.h.

◆ h_evtot_dphy

TH1F* h_evtot_dphy {nullptr}

private

Histogram: Event no for dphy (auxiliary) to normalize dphy waveform flow.

Definition at line 134 of file eclDQM.h.

◆ h_evtot_logic

TH1F* h_evtot_logic {nullptr}

private

Histogram: Event no for logic (auxiliary) to normalize logic waveform flow.

Definition at line 130 of file eclDQM.h.

◆ h_evtot_rand

TH1F* h_evtot_rand {nullptr}

private

Histogram: Event no for rand (auxiliary) to normalize rand waveform flow.

Definition at line 132 of file eclDQM.h.

◆ h_ncevs

std::vector<TH1F*> h_ncevs = {}

private

Histogram vector: Channel multiplicity.

Definition at line 157 of file eclDQM.h.

◆ h_pedmean_cellid

TProfile* h_pedmean_cellid {nullptr}

private

Histogram: Pedestal Average vs.

Cell ID.

Definition at line 169 of file eclDQM.h.

◆ h_pedrms_cellid

TProfile* h_pedrms_cellid {nullptr}

private

Histogram: Pedestal rms error vs.

Cell ID.

Definition at line 171 of file eclDQM.h.

◆ h_pedrms_thetaid

TProfile* h_pedrms_thetaid {nullptr}

private

Histogram: Pedestal rms error vs.

Theta ID.

Definition at line 173 of file eclDQM.h.

◆ h_quality

TH1F* h_quality {nullptr}

private

Histogram: Fit quality flag (0 - good, 1 - large amplitude, 3 - bad chi2).

Definition at line 136 of file eclDQM.h.

◆ h_quality_other

TH1F* h_quality_other {nullptr}

private

Histogram: Fit quality flag for waveform type 'other'.

Definition at line 138 of file eclDQM.h.

◆ h_time_barrels

std::vector<TH1F*> h_time_barrels = {}

private

Histogram vector: Reconstructed time for barrel.

Definition at line 153 of file eclDQM.h.

◆ h_time_crate_Thr1GeV

std::vector<TH1F*> h_time_crate_Thr1GeV = {}

private

Histogram vector: Reconstructed signal time for all ECL crates above the threshold = 1 GeV.

Definition at line 163 of file eclDQM.h.

◆ h_time_crate_Thr1GeV_large

TH1F* h_time_crate_Thr1GeV_large {nullptr}

private

Histogram: Entries with crate time offsets > 100 ns (E > 1 GeV).

Definition at line 146 of file eclDQM.h.

◆ h_time_endcaps

std::vector<TH1F*> h_time_endcaps = {}

private

Histogram vector: Reconstructed time for endcaps.

Definition at line 155 of file eclDQM.h.

◆ h_trigtag1

TH1F* h_trigtag1 {nullptr}

private

Histogram: Trigger tag flag #1.

Definition at line 142 of file eclDQM.h.

◆ h_trigtag2_trigid

TH2F* h_trigtag2_trigid {nullptr}

private

Histogram: Trigger tag flag #2 vs.

Trig Cell ID.

Definition at line 167 of file eclDQM.h.

◆ h_trigtime_trigid

TH2F* h_trigtime_trigid {nullptr}

private

Histogram: Trigger time vs.

Trig Cell ID.

Definition at line 165 of file eclDQM.h.

◆ m_calibrationThrApsd

DBObjPtr<ECLCrystalCalib> m_calibrationThrApsd

private

PSD waveform amplitude threshold.

Definition at line 91 of file eclDQM.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_DPHYTTYP

bool m_DPHYTTYP {0}

private

Flag to select events triggered by delayed bhabha.

Definition at line 100 of file eclDQM.h.

◆ m_DspArray

int m_DspArray[ECLElementNumbers::c_NCrystals][31] = {}

private

WF sampling points for digit array.

Definition at line 121 of file eclDQM.h.

◆ m_ECLCalDigits

StoreArray<ECLCalDigit> m_ECLCalDigits

private

StoreArray ECLCalDigit.

Definition at line 89 of file eclDQM.h.

◆ m_ECLDigits

StoreArray<ECLDigit> m_ECLDigits

private

StoreArray ECLDigit.

Definition at line 83 of file eclDQM.h.

◆ m_ECLDsps

StoreArray<ECLDsp> m_ECLDsps

private

StoreArray ECLDsp.

Definition at line 85 of file eclDQM.h.

◆ m_ECLTrigs

StoreArray<ECLTrig> m_ECLTrigs

private

StoreArray ECLTrig.

Definition at line 87 of file eclDQM.h.

◆ m_EnergyUpperThr

double m_EnergyUpperThr

private

Upper threshold of energy deposition in event, [GeV].

Definition at line 98 of file eclDQM.h.

◆ m_eventmetadata

StoreObjPtr<EventMetaData> m_eventmetadata

private

StoreObjPtr EventMetaData.

Definition at line 77 of file eclDQM.h.

◆ m_geom

ECL::ECLGeometryPar* m_geom {nullptr}

private

Geometry.

Definition at line 75 of file eclDQM.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_histogramDirectoryName

std::string m_histogramDirectoryName

private

Histogram directory in ROOT file.

Definition at line 96 of file eclDQM.h.

◆ m_HitNumberUpperLimits

std::vector<double> m_HitNumberUpperLimits = {}

private

Parameters for number of hits histograms.

Definition at line 109 of file eclDQM.h.

◆ m_HitThresholds

std::vector<double> m_HitThresholds = {}

private

Parameters for hit occ.

histograms.

Definition at line 103 of file eclDQM.h.

◆ m_iEvent

int m_iEvent { -1}

private

Global event number.

Definition at line 94 of file eclDQM.h.

◆ m_l1Trigger

StoreObjPtr<TRGSummary> m_l1Trigger

private

StoreObjPtr TRGSummary

Definition at line 79 of file eclDQM.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 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 508 of file Module.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

◆ m_PedestalMean

double m_PedestalMean[ECLElementNumbers::c_NCrystals] = {}

private

Pedestal average values.

Definition at line 123 of file eclDQM.h.

◆ m_PedestalRms

double m_PedestalRms[ECLElementNumbers::c_NCrystals] = {}

private

Pedestal rms error values.

Definition at line 125 of file eclDQM.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_TimingThresholds

std::vector<double> m_TimingThresholds = {}

private

Parameters for timing histograms.

Definition at line 107 of file eclDQM.h.

◆ m_TotalEnergyThresholds

std::vector<double> m_TotalEnergyThresholds = {}

private

Parameters for histograms w/ total energy.

Definition at line 105 of file eclDQM.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_WaveformOption

std::vector<std::string> m_WaveformOption

private

Parameters for waveform histograms.

Definition at line 111 of file eclDQM.h.

◆ mapper

ECL::ECLChannelMapper mapper

private

ECL channel mapper.

Definition at line 81 of file eclDQM.h.

◆ nhits

std::vector<double> nhits = {}

private

Container for channel multiplicity.

Definition at line 115 of file eclDQM.h.

◆ v_totalthrApsd

std::vector<int> v_totalthrApsd = {}

private

Vector to store psd wf amplitude threshold.

Definition at line 117 of file eclDQM.h.

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

ecl/modules/eclDQM/include/eclDQM.h
ecl/modules/eclDQM/src/eclDQM.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLDQMModule()

◆ ~ECLDQMModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ defineHisto()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ isRandomTrigger()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ ecltot

◆ h_adc_hits

◆ h_bad_quality

◆ h_cell_psd_norm

◆ h_cells

◆ h_cids

◆ h_edeps

◆ h_evtot

◆ h_evtot_dphy

◆ h_evtot_logic

◆ h_evtot_rand

◆ h_ncevs