TrackingAbortDQMModule Class Reference

Tracking DQM Module to monitor aborts & background conditions before the HLT filter. More...

#include <TrackingAbortDQMModule.h>

Inheritance diagram for TrackingAbortDQMModule:

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
	TrackingAbortDQMModule ()
	Constructor.
void	initialize () override final
	Module function initialize.
void	beginRun () override final
	Module function beginRun.
void	event () override final
	Module function event.
void	defineHisto () override final
	Defines Histograms.
virtual void	endRun () override
	Function to process end_run record.
virtual void	terminate () override
	Function to terminate module.
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
void	updateBinContent (int index, int bin, float valueToBeAdded)
	function to update the bin content
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_histogramDirectoryName
	Name of the histogram directory in ROOT file.
SVDNoiseCalibrations	m_NoiseCal
	SVDNoise calibration db object.
StoreObjPtr< EventLevelTrackingInfo >	m_eventLevelTrackingInfo
	tracking abort info
StoreObjPtr< EventMetaData >	m_eventMetaData
	event meta data
StoreArray< SVDShaperDigit >	m_strips
	SVD strips.
StoreArray< SVDCluster >	m_clusters
	SVD clusters.
TrackingUtilities::StoreWrappedObjPtr< std::vector< Belle2::TrackingUtilities::CDCWireHit > >	m_wireHitVector {"CDCWireHitVector"}
	CDC wire hits.
StoreObjPtr< TRGSummary >	m_trgSummary
	trg summary
StoreArray< Track >	m_tracks
	tracks
TH1F *	m_nEventsWithAbort [2]
	0: no abort; 1: at least one abort
TH1F *	m_trackingErrorFlagsReasons [2]
	stores the reason of the abort
TH1F *	m_svdL3uZS5Occupancy [2]
	distribution of the SVD L3 V ZS5 occupancy
TH1F *	m_svdL3uZS5Occupancy_VXDTF2aborts [2]
	distribution of the SVD L3 V ZS5 occupancy when VXDTF2 aborts
TH1F *	m_svdL3uZS5Occupancy_toSVDCKFaborts [2]
	distribution of the SVD L3 V ZS5 occupancy when toSVDCKF aborts
TH1F *	m_nCDCExtraHits [2]
	distribution of the number of extra CDC hits
TH1F *	m_svdTime [2]
	L3 V-side time for all clusters.
TH1D *	m_integratedAverages [2]
	integrated averages of additional SVD, CDC variables
TH1F *	m_nCDCExtraHitsSL [2][9]
	distribution of the number of extra CDC hits divided by SL
TH1F *	m_nCDCHitsSL [2][9]
	distribution of the number of signal CDC hits divided by SL
TH1F *	m_noCDCHitsInSL [2]
	number of tracks without CDC hits in each SL
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 constexpr int	m_nStripsL3U = 768 * 2 * 7
	number of U-side L3 strips

Detailed Description

Tracking DQM Module to monitor aborts & background conditions before the HLT filter.

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

TrackingAbortDQMModule()

TrackingAbortDQMModule

(

)

Constructor.

Definition at line 37 of file TrackingAbortDQMModule.cc.

                                               : HistoModule()
{
  setDescription("DQM Module to monitor Tracking Aborts and detector-related quantities.");
 
  addParam("histogramDirectoryName", m_histogramDirectoryName, "Name of the directory where histograms will be placed.",
           std::string("TrackingAbort"));
 
  setPropertyFlags(c_ParallelProcessingCertified);
}

~TrackingAbortDQMModule()

~TrackingAbortDQMModule ( )

virtual

Definition at line 48 of file TrackingAbortDQMModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void )

finaloverridevirtual

Module function beginRun.

Reimplemented from HistoModule.

Definition at line 259 of file TrackingAbortDQMModule.cc.

{
 
  if (m_trackingErrorFlagsReasons[0] != nullptr) m_trackingErrorFlagsReasons[0]->Reset();
  if (m_trackingErrorFlagsReasons[1] != nullptr) m_trackingErrorFlagsReasons[1]->Reset();
  if (m_nEventsWithAbort[0] != nullptr)  m_nEventsWithAbort[0]->Reset();
  if (m_nEventsWithAbort[1] != nullptr)  m_nEventsWithAbort[1]->Reset();
  if (m_svdL3uZS5Occupancy[0] != nullptr)  m_svdL3uZS5Occupancy[0]->Reset();
  if (m_svdL3uZS5Occupancy[1] != nullptr)  m_svdL3uZS5Occupancy[1]->Reset();
  if (m_svdL3uZS5Occupancy_VXDTF2aborts[0] != nullptr)  m_svdL3uZS5Occupancy_VXDTF2aborts[0]->Reset();
  if (m_svdL3uZS5Occupancy_VXDTF2aborts[1] != nullptr)  m_svdL3uZS5Occupancy_VXDTF2aborts[1]->Reset();
  if (m_svdL3uZS5Occupancy_toSVDCKFaborts[0] != nullptr)  m_svdL3uZS5Occupancy_toSVDCKFaborts[0]->Reset();
  if (m_svdL3uZS5Occupancy_toSVDCKFaborts[1] != nullptr)  m_svdL3uZS5Occupancy_toSVDCKFaborts[1]->Reset();
  if (m_nCDCExtraHits[0] != nullptr) m_nCDCExtraHits[0]->Reset();
  if (m_nCDCExtraHits[1] != nullptr) m_nCDCExtraHits[1]->Reset();
  if (m_svdTime[0] != nullptr) m_svdTime[0]->Reset();
  if (m_svdTime[1] != nullptr) m_svdTime[1]->Reset();
  if (m_integratedAverages[0] != nullptr) m_integratedAverages[0]->Reset();
  if (m_integratedAverages[1] != nullptr) m_integratedAverages[1]->Reset();
  for (int sl = 0; sl < 9; sl++) {
    if (m_nCDCExtraHitsSL[0][sl] != nullptr) m_nCDCExtraHitsSL[0][sl]->Reset();
    if (m_nCDCExtraHitsSL[1][sl] != nullptr) m_nCDCExtraHitsSL[1][sl]->Reset();
    if (m_nCDCHitsSL[0][sl] != nullptr) m_nCDCHitsSL[0][sl]->Reset();
    if (m_nCDCHitsSL[1][sl] != nullptr) m_nCDCHitsSL[1][sl]->Reset();
  }
  if (m_noCDCHitsInSL[0] != nullptr) m_noCDCHitsInSL[0]->Reset();
  if (m_noCDCHitsInSL[1] != nullptr) m_noCDCHitsInSL[1]->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 425 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

{ terminate(); }

defineHisto()

void defineHisto ( )

finaloverridevirtual

Defines Histograms.

Reimplemented from HistoModule.

Definition at line 56 of file TrackingAbortDQMModule.cc.

{
 
  // Create a separate histogram directories and cd into it.
  TDirectory* oldDir = gDirectory;
  if (m_histogramDirectoryName != "") {
    oldDir->mkdir(m_histogramDirectoryName.c_str());
    oldDir->cd(m_histogramDirectoryName.c_str());
  }
 
  //histogram index:
  // 0 if the event is triggered OUTSIDE the active_veto window
  std::string tag[2] = {"OUT", "IN"};
  std::string title[2] = {"[Outside Active Veto Window]", "[Inside Active Veto Window]"};
 
 
  //number of events with and without at least one abort
  //outside active_veto window:
  std::string histoName = "EventsWithAborts";
  std::string histoTitle = "Events With at Least one Abort";
  m_nEventsWithAbort[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                   TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                   2, -0.5, 1.5);
  m_nEventsWithAbort[0]->GetYaxis()->SetTitle("Number of Events");
  m_nEventsWithAbort[0]->GetXaxis()->SetBinLabel(1, "No Abort");
  m_nEventsWithAbort[0]->GetXaxis()->SetBinLabel(2, "At Least One Abort");
  m_nEventsWithAbort[0]->SetMinimum(0.1);
 
  //inside active_veto window:
  m_nEventsWithAbort[1] = new TH1F(*m_nEventsWithAbort[0]);
  m_nEventsWithAbort[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_nEventsWithAbort[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  //abort flag reason
  //outside active_veto window:
  histoName = "TrkAbortReason";
  histoTitle = "Tracking Abort Reason";
  m_trackingErrorFlagsReasons[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                            TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                            5, -0.5, 4.5);
  m_trackingErrorFlagsReasons[0]->GetXaxis()->SetTitle("Type of error occurred");
  m_trackingErrorFlagsReasons[0]->GetYaxis()->SetTitle("Number of Events");
  m_trackingErrorFlagsReasons[0]->GetXaxis()->SetBinLabel(1, "Unspecified PR");
  m_trackingErrorFlagsReasons[0]->GetXaxis()->SetBinLabel(2, "VXDTF2");
  m_trackingErrorFlagsReasons[0]->GetXaxis()->SetBinLabel(3, "SVDCKF");
  m_trackingErrorFlagsReasons[0]->GetXaxis()->SetBinLabel(4, "PXDCKF");
  m_trackingErrorFlagsReasons[0]->GetXaxis()->SetBinLabel(5, "SpacePoint");
  //inside active_veto window:
  m_trackingErrorFlagsReasons[1] = new TH1F(*m_trackingErrorFlagsReasons[0]);
  m_trackingErrorFlagsReasons[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_trackingErrorFlagsReasons[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
 
  //SVD L3 occupancy - see SVDDQMDose module for details
  histoName = "SVDL3UOcc";
  histoTitle = "SVD L3 u-side ZS5 Occupancy (%)";
  //outside active_veto window:
  m_svdL3uZS5Occupancy[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                     TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                     90, 0, 100.0 / 1536.0 * 90);
  m_svdL3uZS5Occupancy[0]->GetXaxis()->SetTitle("occupancy [%]");
  m_svdL3uZS5Occupancy[0]->GetYaxis()->SetTitle("Number of Events");
  //inside active_veto window:
  m_svdL3uZS5Occupancy[1] = new TH1F(*m_svdL3uZS5Occupancy[0]);
  m_svdL3uZS5Occupancy[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_svdL3uZS5Occupancy[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  //SVD L3 occupancy when VXDTF2 Aborts- see SVDDQMDose module for details
  histoName = "SVDL3UOccVXDTF2aborts";
  histoTitle = "SVD L3 u-side ZS5 Occupancy (%) when VXDTF2 Aborts";
  //outside active_veto window:
  m_svdL3uZS5Occupancy_VXDTF2aborts[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                                  TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                                  180, 0, 100.0 / 1536.0 * 180);
  m_svdL3uZS5Occupancy_VXDTF2aborts[0]->GetXaxis()->SetTitle("occupancy [%]");
  m_svdL3uZS5Occupancy_VXDTF2aborts[0]->GetYaxis()->SetTitle("Number of Events");
  //inside active_veto window:
  m_svdL3uZS5Occupancy_VXDTF2aborts[1] = new TH1F(*m_svdL3uZS5Occupancy_VXDTF2aborts[0]);
  m_svdL3uZS5Occupancy_VXDTF2aborts[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_svdL3uZS5Occupancy_VXDTF2aborts[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
//SVD L3 occupancy when toSVDCFK Aborts- see SVDDQMDose module for details
  histoName = "SVDL3UOccToSVDCKFaborts";
  histoTitle = "SVD L3 u-side ZS5 Occupancy (%) when toSVDCKF Aborts";
  //outside active_veto window:
  m_svdL3uZS5Occupancy_toSVDCKFaborts[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                                    TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                                    180, 0, 100.0 / 1536.0 * 180);
  m_svdL3uZS5Occupancy_toSVDCKFaborts[0]->GetXaxis()->SetTitle("occupancy [%]");
  m_svdL3uZS5Occupancy_toSVDCKFaborts[0]->GetYaxis()->SetTitle("Number of Events");
  //inside active_veto window:
  m_svdL3uZS5Occupancy_toSVDCKFaborts[1] = new TH1F(*m_svdL3uZS5Occupancy_toSVDCKFaborts[0]);
  m_svdL3uZS5Occupancy_toSVDCKFaborts[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_svdL3uZS5Occupancy_toSVDCKFaborts[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  //CDC extra hits
  histoName = "nCDCExtraHits";
  histoTitle = "Number of CDC Extra Hits";
  //outside active_veto window:
  m_nCDCExtraHits[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                200, 0, 5000);
  m_nCDCExtraHits[0]->GetXaxis()->SetTitle("nCDCExtraHits");
  m_nCDCExtraHits[0]->GetYaxis()->SetTitle("Number of Events");
  //inside active_veto window:
  m_nCDCExtraHits[1] = new TH1F(*m_nCDCExtraHits[0]);
  m_nCDCExtraHits[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_nCDCExtraHits[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  //SVD L3 v-side cluster time
  histoName = "svdL3VTime";
  histoTitle = "Layer3 v-side Cluster Time Distribution";
  //outside active_veto window:
  m_svdTime[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                          TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                          300, -150, 150);
  m_svdTime[0]->GetXaxis()->SetTitle("cluster time (ns)");
  m_svdTime[0]->GetYaxis()->SetTitle("Number of Clusters");
  //inside active_veto window:
  m_svdTime[1] = new TH1F(*m_svdTime[0]);
  m_svdTime[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_svdTime[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  //SVD, CDC Averages
  histoName = "averages";
  histoTitle = "Averages from SVD and CDC";
  //outside active_veto window:
  m_integratedAverages[0] = new TH1D(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                     TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                     5, 0, 5);
  m_integratedAverages[0]->GetYaxis()->SetTitle("Number of X [bin-dependent]");
  m_integratedAverages[0]->GetXaxis()->SetBinLabel(1, "nCDCHitsInner");
  m_integratedAverages[0]->GetXaxis()->SetBinLabel(2, "nCDCHitsOuter");
  m_integratedAverages[0]->GetXaxis()->SetBinLabel(3, "nStripsZS5_L3V");
  m_integratedAverages[0]->GetXaxis()->SetBinLabel(4, "nStripsZS5_L4U");
  m_integratedAverages[0]->GetXaxis()->SetBinLabel(5, "nStripsZS5_L4V");
  //inside active_veto window:
  m_integratedAverages[1] = new TH1D(*m_integratedAverages[0]);
  m_integratedAverages[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_integratedAverages[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  //CDC extra hits per SL
  histoName = "nCDCExtraHitsSL";
  histoTitle = "Number of CDC Extra Hits in SL";
  for (int sl = 0; sl < 9; sl++) {
    //outside active_veto window:
    m_nCDCExtraHitsSL[0][sl] = new TH1F(TString::Format("%s%d_%s", histoName.c_str(), sl, tag[0].c_str()),
                                        TString::Format("%s%d %s", histoTitle.c_str(), sl, title[0].c_str()),
                                        201, -1000 / 200 / 2, 1000 + 1000 / 200 / 2);
    m_nCDCExtraHitsSL[0][sl]->GetXaxis()->SetTitle("nCDCExtraHits");
    m_nCDCExtraHitsSL[0][sl]->GetYaxis()->SetTitle("Number of Events");
    //inside active_veto window:
    m_nCDCExtraHitsSL[1][sl] = new TH1F(*m_nCDCExtraHitsSL[0][sl]);
    m_nCDCExtraHitsSL[1][sl]->SetName(TString::Format("%s%d_%s", histoName.c_str(), sl, tag[1].c_str()));
    m_nCDCExtraHitsSL[1][sl]->SetTitle(TString::Format("%s%d %s", histoTitle.c_str(), sl, title[1].c_str()));
  }
 
  //CDC signal hits per SL
  histoName = "nCDCHitsSL";
  histoTitle = "Average Number of CDC Hits per Track in SL";
  for (int sl = 0; sl < 9; sl++) {
    //outside active_veto window:
    m_nCDCHitsSL[0][sl] = new TH1F(TString::Format("%s%d_%s", histoName.c_str(), sl, tag[0].c_str()),
                                   TString::Format("%s%d %s", histoTitle.c_str(), sl, title[0].c_str()),
                                   31, -0.5, 30 + 0.5);
    m_nCDCHitsSL[0][sl]->GetXaxis()->SetTitle("average nCDCHits per track");
    m_nCDCHitsSL[0][sl]->GetYaxis()->SetTitle("Number of Events");
    //inside active_veto window:
    m_nCDCHitsSL[1][sl] = new TH1F(*m_nCDCHitsSL[0][sl]);
    m_nCDCHitsSL[1][sl]->SetName(TString::Format("%s%d_%s", histoName.c_str(), sl, tag[1].c_str()));
    m_nCDCHitsSL[1][sl]->SetTitle(TString::Format("%s%d %s", histoTitle.c_str(), sl, title[1].c_str()));
  }
 
  //no CDC signal hits in SL
  histoName = "noCDCHitsInSL";
  histoTitle = "No Signal CDC Hits in SL";
  //outside active_veto window:
  m_noCDCHitsInSL[0] = new TH1F(TString::Format("%s_%s", histoName.c_str(), tag[0].c_str()),
                                TString::Format("%s %s", histoTitle.c_str(), title[0].c_str()),
                                9, -0.5, 8 + 0.5);
  m_noCDCHitsInSL[0]->GetXaxis()->SetTitle("SuperLayer");
  m_noCDCHitsInSL[0]->GetYaxis()->SetTitle("Number of Events");
  //inside active_veto window:
  m_noCDCHitsInSL[1] = new TH1F(*m_noCDCHitsInSL[0]);
  m_noCDCHitsInSL[1]->SetName(TString::Format("%s_%s", histoName.c_str(), tag[1].c_str()));
  m_noCDCHitsInSL[1]->SetTitle(TString::Format("%s %s", histoTitle.c_str(), title[1].c_str()));
 
  oldDir->cd();
 
}

endRun()

virtual void endRun ( void )

inlineoverridevirtualinherited

Function to process end_run record.

Reimplemented from Module.

Reimplemented in AlignDQMModule, AnalysisPhase1StudyModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, BeamabortStudyModule, BgoStudyModule, CalibrationCollectorModule, CDCCRTestModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, ECLBackgroundModule, ECLDQMEXTENDEDModule, ECLDQMModule, FANGSStudyModule, He3tubeStudyModule, KLMDQM2Module, KLMDQMModule, KLMEventT0EstimatorModule, MicrotpcStudyModule, TPCStudyModule, MonitorDataModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PindiodeStudyModule, QcsmonitorStudyModule, SVDROIDQMModule, SVDUnpackerDQMModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserHitSelectorModule, TOPTBCComparatorModule, TOPWaveformQualityPlotterModule, TrackAnaModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLDQMModule, TRGGDLModule, TRGGRLDQMModule, TRGRAWDATAModule, TRGTOPDQMModule, and vxdDigitMaskingModule.

Definition at line 44 of file HistoModule.h.

{};

evalCondition()

bool evalCondition ( ) const

inherited

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

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

Returns

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

Definition at line 96 of file Module.cc.

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

finaloverridevirtual

Module function event.

Reimplemented from HistoModule.

Definition at line 289 of file TrackingAbortDQMModule.cc.

{
 
  //skip events in which we do not have EventMetaData or TRGSummary
  if (!m_eventMetaData.isValid()) return;
  if (!m_trgSummary.isValid()) return;
 
  //skip the empty events
  if (m_eventMetaData->getErrorFlag() & EventMetaData::EventErrorFlag::c_B2LinkPacketCRCError)
    return;
 
  if (m_eventMetaData->getErrorFlag() & EventMetaData::EventErrorFlag::c_B2LinkEventCRCError)
    return;
 
  if (m_eventMetaData->getErrorFlag() & EventMetaData::EventErrorFlag::c_HLTCrash)
    return;
 
  if (m_eventMetaData->getErrorFlag() & EventMetaData::EventErrorFlag::c_ReconstructionAbort)
    return;
 
  //find out if we are in the passive veto (i=0) or in the active veto window (i=1)
  int index = 0; //events accepted in the passive veto window but not in the active
  try {
    if (m_trgSummary->testInput("passive_veto") == 1 &&  m_trgSummary->testInput("cdcecl_veto") == 0) index = 1;
  } catch (const std::exception&) {
  }
 
  //fill the tracking abort reason histogram & nEvents with Abort
  if (m_eventLevelTrackingInfo.isValid()) {
    if (m_eventLevelTrackingInfo->hasAnErrorFlag()) {
 
      m_nEventsWithAbort[index]->Fill(1);
 
      if (m_eventLevelTrackingInfo->hasUnspecifiedTrackFindingFailure())
        m_trackingErrorFlagsReasons[index]->Fill(0);
      if (m_eventLevelTrackingInfo->hasVXDTF2AbortionFlag())
        m_trackingErrorFlagsReasons[index]->Fill(1);
      if (m_eventLevelTrackingInfo->hasSVDCKFAbortionFlag())
        m_trackingErrorFlagsReasons[index]->Fill(2);
      if (m_eventLevelTrackingInfo->hasPXDCKFAbortionFlag())
        m_trackingErrorFlagsReasons[index]->Fill(3);
      if (m_eventLevelTrackingInfo->hasSVDSpacePointCreatorAbortionFlag())
        m_trackingErrorFlagsReasons[index]->Fill(4);
    } else { //EventLevelTrackingInfo valid but no error
      m_nEventsWithAbort[index]->Fill(0);
    }
  } else //EventLevelTrackingInfo not valid
    m_nEventsWithAbort[index]->Fill(0);
 
  //compute the number of ZS5 strips of L3 and L4, both sides
  float nStripsL3UZS5 = 0;
  float nStripsL3VZS5 = 0;
  float nStripsL4UZS5 = 0;
  float nStripsL4VZS5 = 0;
  for (const SVDShaperDigit& hit : m_strips) {
    const VxdID& sensorID = hit.getSensorID();
    if (sensorID.getLayerNumber() > 4) continue;
    const float noise = m_NoiseCal.getNoise(sensorID, hit.isUStrip(), hit.getCellID());
    const float cutMinSignal = std::round(5 * noise);
 
    if (hit.passesZS(1, cutMinSignal)) {
      if (sensorID.getLayerNumber() == 3) {
        if (hit.isUStrip()) nStripsL3UZS5++;
        else nStripsL3VZS5++;
      } else if (hit.isUStrip()) nStripsL4UZS5++;
      else nStripsL4VZS5++;
    }
  }
 
  //fill the SVD L3 v-side cluster time
  for (const SVDCluster& hit : m_clusters) {
    const VxdID& sensorID = hit.getSensorID();
    if (sensorID.getLayerNumber() != 3) continue;
    if (hit.isUCluster()) continue;
 
    m_svdTime[index]->Fill(hit.getClsTime());
  }
 
  // fill the svd L3 v ZS5 occupancy, add the overflow in the last bin to make them visible in the plot
  double tmp_L3uZS5occupancy = (double)nStripsL3UZS5 / m_nStripsL3U * 100;
  double L3uZS5occupancy = std::min(tmp_L3uZS5occupancy, (double)100.0 / 1536.0 * 90);
  m_svdL3uZS5Occupancy[index]->Fill(L3uZS5occupancy);
  double L3uZS5occupancy_abort = std::min(tmp_L3uZS5occupancy, (double)100.0 / 1536.0 * 180);
  if (m_eventLevelTrackingInfo->hasVXDTF2AbortionFlag())
    m_svdL3uZS5Occupancy_VXDTF2aborts[index]->Fill(L3uZS5occupancy_abort);
  if (m_eventLevelTrackingInfo->hasSVDCKFAbortionFlag())
    m_svdL3uZS5Occupancy_toSVDCKFaborts[index]->Fill(L3uZS5occupancy_abort);
 
  //fill the nCDCExtraHits, add the overflow in the last bin to make them visible in the plot
  if (m_eventLevelTrackingInfo.isValid())
    m_nCDCExtraHits[index]->Fill(std::min((int)m_eventLevelTrackingInfo->getNCDCHitsNotAssigned(), (int)4999));
 
  //compute number of CDC hits in the inner and outer layers
  //and the number of signal-per-track and extra hits per SL
  int nTracks = m_tracks.getEntries();
 
  int nCDCHitsInner = 0;
  int nCDCHitsOuter = 0;
  int nTotalCDCHits[9] = {0};
  int nTakenCDCHits[9] = {0};
  int nBgCDCHits[9] = {0};
 
  const std::vector<CDCWireHit>& wireHitVector = *m_wireHitVector;
  int wireHitAmount = wireHitVector.size();
  for (int hitID = 0; hitID < wireHitAmount; ++hitID) {
    const auto& wireHit = wireHitVector[hitID];
    int sl = wireHit.getISuperLayer();
    if (sl == 0) nCDCHitsInner++;
    else nCDCHitsOuter++;
 
    nTotalCDCHits[sl] += 1;
    if (wireHit->hasTakenFlag()) nTakenCDCHits[sl] += 1;
    if (wireHit->hasBackgroundFlag()) nBgCDCHits[sl] += 1;
  }
 
  for (int sl = 0; sl < 9; sl++) {
 
    float nSignalCDCHits = nTakenCDCHits[sl] - nBgCDCHits[sl];
    int nCDCExtraHits = nTotalCDCHits[sl] - nSignalCDCHits;
    if (nTracks > 0) nSignalCDCHits = nSignalCDCHits / nTracks;
 
    if (nSignalCDCHits == 0) m_noCDCHitsInSL[index]->Fill(sl);
    else {
      if (m_nCDCExtraHitsSL[index][sl] != nullptr) m_nCDCExtraHitsSL[index][sl]->Fill(std::min(nCDCExtraHits, (int)999));
      if (m_nCDCHitsSL[index][sl] != nullptr) m_nCDCHitsSL[index][sl]->Fill(std::min(nSignalCDCHits, (float)30.5));
    }
  }
 
  // fill the integrated averages TH1F
  // bin 1: nCDCHits Inner layers
  updateBinContent(index, 1, nCDCHitsInner);
  // bin 2: nCDCHits Outer layers
  updateBinContent(index, 2, nCDCHitsOuter);
  // bin 3: nStrips L3 V-side
  updateBinContent(index, 3, nStripsL3VZS5);
  // bin 4: nStrips L4 U-side
  updateBinContent(index, 4, nStripsL4UZS5);
  // bin 5: nStrips L4 V-side
  updateBinContent(index, 5, nStripsL4VZS5);
 
 
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 313 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

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

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

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void )

finaloverridevirtual

Module function initialize.

Reimplemented from HistoModule.

Definition at line 247 of file TrackingAbortDQMModule.cc.

{
  m_eventLevelTrackingInfo.isOptional();
  m_eventMetaData.isOptional();
  m_trgSummary.isOptional();
  m_strips.isOptional();
 
  // Register histograms (calls back defineHisto)
  REG_HISTOGRAM
}

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

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int logLevel, unsigned int logInfo )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

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

virtual void terminate ( void )

inlineoverridevirtualinherited

Function to terminate module.

Reimplemented from Module.

Reimplemented in AnalysisPhase1StudyModule, B2BIIMCParticlesMonitorModule, BeamabortStudyModule, BgoStudyModule, CalibrationCollectorModule, CDCCRTestModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DosiStudyModule, ECLBackgroundModule, ECLDQMEXTENDEDModule, ECLDQMModule, FANGSStudyModule, He3tubeStudyModule, KLMDQM2Module, KLMDQMModule, KLMEventT0EstimatorModule, MicrotpcStudyModule, MonitorDataModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PindiodeStudyModule, QcsmonitorStudyModule, ROIDQMModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserHitSelectorModule, TOPPDFCheckerModule, TOPTBCComparatorModule, TrackAnaModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGGDLDQMModule, TRGGDLModule, TRGGRLDQMModule, TRGRAWDATAModule, and TRGTOPDQMModule.

Definition at line 46 of file HistoModule.h.

{};

updateBinContent()

void updateBinContent ( int index, int bin, float valueToBeAdded )

private

function to update the bin content

Definition at line 432 of file TrackingAbortDQMModule.cc.

{
  float oldValue = m_integratedAverages[index]->GetBinContent(bin);
  m_integratedAverages[index]->SetBinContent(bin, oldValue + valueToBeAdded);
}

Member Data Documentation

m_clusters

StoreArray<SVDCluster> m_clusters

private

SVD clusters.

Definition at line 73 of file TrackingAbortDQMModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_eventLevelTrackingInfo

StoreObjPtr<EventLevelTrackingInfo> m_eventLevelTrackingInfo

private

tracking abort info

Definition at line 69 of file TrackingAbortDQMModule.h.

m_eventMetaData

StoreObjPtr<EventMetaData> m_eventMetaData

private

event meta data

Definition at line 70 of file TrackingAbortDQMModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

m_histogramDirectoryName

std::string m_histogramDirectoryName

private

Name of the histogram directory in ROOT file.

Definition at line 61 of file TrackingAbortDQMModule.h.

m_integratedAverages

TH1D* m_integratedAverages[2]

private

integrated averages of additional SVD, CDC variables

Definition at line 86 of file TrackingAbortDQMModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 507 of file Module.h.

m_nCDCExtraHits

TH1F* m_nCDCExtraHits[2]

private

distribution of the number of extra CDC hits

Definition at line 84 of file TrackingAbortDQMModule.h.

m_nCDCExtraHitsSL

TH1F* m_nCDCExtraHitsSL[2][9]

private

distribution of the number of extra CDC hits divided by SL

Definition at line 87 of file TrackingAbortDQMModule.h.

m_nCDCHitsSL

TH1F* m_nCDCHitsSL[2][9]

private

distribution of the number of signal CDC hits divided by SL

Definition at line 88 of file TrackingAbortDQMModule.h.

m_nEventsWithAbort

TH1F* m_nEventsWithAbort[2]

private

0: no abort; 1: at least one abort

Definition at line 79 of file TrackingAbortDQMModule.h.

m_noCDCHitsInSL

TH1F* m_noCDCHitsInSL[2]

private

number of tracks without CDC hits in each SL

Definition at line 89 of file TrackingAbortDQMModule.h.

m_NoiseCal

SVDNoiseCalibrations m_NoiseCal

private

SVDNoise calibration db object.

Definition at line 65 of file TrackingAbortDQMModule.h.

m_nStripsL3U

int m_nStripsL3U = 768 * 2 * 7

staticconstexprprivate

number of U-side L3 strips

Definition at line 67 of file TrackingAbortDQMModule.h.

m_package

std::string m_package

privateinherited

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

Definition at line 509 of file Module.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 511 of file Module.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

m_strips

StoreArray<SVDShaperDigit> m_strips

private

SVD strips.

Definition at line 72 of file TrackingAbortDQMModule.h.

m_svdL3uZS5Occupancy

TH1F* m_svdL3uZS5Occupancy[2]

private

distribution of the SVD L3 V ZS5 occupancy

Definition at line 81 of file TrackingAbortDQMModule.h.

m_svdL3uZS5Occupancy_toSVDCKFaborts

TH1F* m_svdL3uZS5Occupancy_toSVDCKFaborts[2]

private

distribution of the SVD L3 V ZS5 occupancy when toSVDCKF aborts

Definition at line 83 of file TrackingAbortDQMModule.h.

m_svdL3uZS5Occupancy_VXDTF2aborts

TH1F* m_svdL3uZS5Occupancy_VXDTF2aborts[2]

private

distribution of the SVD L3 V ZS5 occupancy when VXDTF2 aborts

Definition at line 82 of file TrackingAbortDQMModule.h.

m_svdTime

TH1F* m_svdTime[2]

private

L3 V-side time for all clusters.

Definition at line 85 of file TrackingAbortDQMModule.h.

m_trackingErrorFlagsReasons

TH1F* m_trackingErrorFlagsReasons[2]

private

stores the reason of the abort

Definition at line 80 of file TrackingAbortDQMModule.h.

m_tracks

StoreArray<Track> m_tracks

private

tracks

Definition at line 76 of file TrackingAbortDQMModule.h.

m_trgSummary

StoreObjPtr<TRGSummary> m_trgSummary

private

trg summary

Definition at line 75 of file TrackingAbortDQMModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

m_wireHitVector

TrackingUtilities::StoreWrappedObjPtr<std::vector<Belle2::TrackingUtilities::CDCWireHit> > m_wireHitVector {"CDCWireHitVector"}

private

CDC wire hits.

Definition at line 74 of file TrackingAbortDQMModule.h.

{"CDCWireHitVector"}; 

---

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

• tracking/modules/trackingDQM/include/TrackingAbortDQMModule.h
• tracking/modules/trackingDQM/src/TrackingAbortDQMModule.cc