Belle II Software development
TRGEfficiencyDQMModule Class Reference

Make summary of data quality from reconstruction. More...

#include <TRGEfficiencyDQMModule.h>

Inheritance diagram for TRGEfficiencyDQMModule:
HistoModule Module PathElement

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

 TRGEfficiencyDQMModule ()
 Constructor.
 
virtual ~TRGEfficiencyDQMModule ()
 Destructor.
 
void initialize () override
 Initialize the Module.
 
void defineHisto () override
 Histogram definitions.
 
void event () override
 Event processor.
 
virtual void beginRun () override
 Function to process begin_run record.
 
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.
 
LogConfiggetLogConfig ()
 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 ModuleConditiongetCondition () 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< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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.
 

Protected Attributes

StoreArray< Trackm_Tracks
 Tracks.
 
StoreArray< ECLClusterm_ECLClusters
 ECL Clusters.
 
StoreArray< KLMClusterm_KLMClusters
 KLM Clusters.
 
StoreObjPtr< TRGSummarym_TrgSummary
 Trigger summary.
 
StoreObjPtr< SoftwareTriggerResultm_HltResult
 HLT result.
 
TH1F * m_hPhi = nullptr
 Histogram of cdc phi of IP tracks.
 
TH1F * m_hPhi_psnecl = nullptr
 Histogram of cdc phi of IP tracks with ecl bit.
 
TH1F * m_hPhi_psnecl_ftdf = nullptr
 Histogram of cdc phi of IP tracks with ecl and f bit.
 
TH1F * m_hPt = nullptr
 
TH1F * m_hPt_psnecl = nullptr
 
TH1F * m_hPt_psnecl_ftdf = nullptr
 
TH1F * m_nobha_f_phi = nullptr
 
TH1F * m_nobha_f_phi_psnecl = nullptr
 
TH1F * m_nobha_f_phi_psnecl_ftdf = nullptr
 
TH1F * m_nobha_hPt = nullptr
 
TH1F * m_nobha_hPt_psnecl = nullptr
 
TH1F * m_nobha_hPt_psnecl_ftdf = nullptr
 
TH1F * m_hP3_z = nullptr
 
TH1F * m_hP3_z_psnecl = nullptr
 
TH1F * m_hP3_z_psnecl_ftdf = nullptr
 
TH1F * m_hP3_y = nullptr
 
TH1F * m_hP3_y_psnecl = nullptr
 
TH1F * m_hP3_y_psnecl_ftdf = nullptr
 
TH1F * m_nobha_hP3_z = nullptr
 
TH1F * m_nobha_hP3_z_psnecl = nullptr
 
TH1F * m_nobha_hP3_z_psnecl_ftdf = nullptr
 
TH1F * m_nobha_hP3_y = nullptr
 
TH1F * m_nobha_hP3_y_psnecl = nullptr
 
TH1F * m_nobha_hP3_y_psnecl_ftdf = nullptr
 
TH1F * m_nobha_phi_z = nullptr
 
TH1F * m_nobha_phi_z_psnecl = nullptr
 
TH1F * m_nobha_phi_z_psnecl_ftdf = nullptr
 
TH1F * m_nobha_phi_y = nullptr
 
TH1F * m_nobha_phi_y_psnecl = nullptr
 
TH1F * m_nobha_phi_y_psnecl_ftdf = nullptr
 
TH1F * m_fyo_dphi = nullptr
 
TH1F * m_fyo_dphi_psnecl = nullptr
 
TH1F * m_fyo_dphi_psnecl_ftdf = nullptr
 
TH1F * m_nobha_fyo_dphi = nullptr
 
TH1F * m_nobha_fyo_dphi_psnecl = nullptr
 
TH1F * m_nobha_fyo_dphi_psnecl_ftdf = nullptr
 
TH1F * m_stt_phi = nullptr
 
TH1F * m_stt_phi_psnecl = nullptr
 
TH1F * m_stt_phi_psnecl_ftdf = nullptr
 
TH1F * m_stt_P3 = nullptr
 
TH1F * m_stt_P3_psnecl = nullptr
 
TH1F * m_stt_P3_psnecl_ftdf = nullptr
 
TH1F * m_stt_theta = nullptr
 
TH1F * m_stt_theta_psnecl = nullptr
 
TH1F * m_stt_theta_psnecl_ftdf = nullptr
 
TH1F * m_nobha_stt_phi = nullptr
 
TH1F * m_nobha_stt_phi_psnecl = nullptr
 
TH1F * m_nobha_stt_phi_psnecl_ftdf = nullptr
 
TH1F * m_nobha_stt_P3 = nullptr
 
TH1F * m_nobha_stt_P3_psnecl = nullptr
 
TH1F * m_nobha_stt_P3_psnecl_ftdf = nullptr
 
TH1F * m_nobha_stt_theta = nullptr
 
TH1F * m_nobha_stt_theta_psnecl = nullptr
 
TH1F * m_nobha_stt_theta_psnecl_ftdf = nullptr
 
TH1F * m_hie_E = nullptr
 
TH1F * m_hie_E_psnecl = nullptr
 
TH1F * m_hie_E_psnecl_ftdf = nullptr
 
TH1F * m_nobha_hie_E = nullptr
 
TH1F * m_nobha_hie_E_psnecl = nullptr
 
TH1F * m_nobha_hie_E_psnecl_ftdf = nullptr
 
TH1F * m_ecltiming_E = nullptr
 
TH1F * m_ecltiming_E_psnecl = nullptr
 
TH1F * m_ecltiming_E_psnecl_ftdf = nullptr
 
TH1F * m_ecltiming_theta = nullptr
 
TH1F * m_ecltiming_theta_psnecl = nullptr
 
TH1F * m_ecltiming_theta_psnecl_ftdf = nullptr
 
TH1F * m_ecltiming_phi = nullptr
 
TH1F * m_ecltiming_phi_psnecl = nullptr
 
TH1F * m_ecltiming_phi_psnecl_ftdf = nullptr
 
TH1F * m_klmhit_phi = nullptr
 
TH1F * m_klmhit_phi_psnecl = nullptr
 
TH1F * m_klmhit_phi_psnecl_ftdf = nullptr
 
TH1F * m_klmhit_theta = nullptr
 
TH1F * m_klmhit_theta_psnecl = nullptr
 
TH1F * m_klmhit_theta_psnecl_ftdf = nullptr
 
TH1F * m_eklmhit_phi = nullptr
 
TH1F * m_eklmhit_phi_psnecl = nullptr
 
TH1F * m_eklmhit_phi_psnecl_ftdf = nullptr
 
TH1F * m_eklmhit_theta = nullptr
 
TH1F * m_eklmhit_theta_psnecl = nullptr
 
TH1F * m_eklmhit_theta_psnecl_ftdf = nullptr
 

Private Member Functions

std::list< ModulePtrgetModules () 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_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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Make summary of data quality from reconstruction.

Definition at line 37 of file TRGEfficiencyDQMModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

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.

77 {
78 c_Input = 1,
79 c_Output = 2,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
@ c_Output
Output Process.
Definition ProcHelper.h:19
@ c_Input
Input Process.
Definition ProcHelper.h:17

Constructor & Destructor Documentation

◆ TRGEfficiencyDQMModule()

Constructor.

Definition at line 31 of file TRGEfficiencyDQMModule.cc.

31 : HistoModule()
32{
33 setDescription("DQM module to calculcate the L1 trigger efficiency.");
35}
HistoModule()
Constructor.
Definition HistoModule.h:32
void setDescription(const std::string &description)
Sets the description of the module.
Definition Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition Module.cc:208
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition Module.h:80

◆ ~TRGEfficiencyDQMModule()

~TRGEfficiencyDQMModule ( )
virtual

Destructor.

Definition at line 37 of file TRGEfficiencyDQMModule.cc.

38{
39}

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void )
inlineoverridevirtualinherited

Function to process begin_run record.

Reimplemented from Module.

Reimplemented in AnalysisPhase1StudyModule, ARICHDQMModule, ARICHRateCalModule, B2BIIMCParticlesMonitorModule, BeamabortStudyModule, BgoStudyModule, CalibrationCollectorModule, CDCCRTestModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, ClawStudyModule, ClawsStudyModule, CsiStudy_v2Module, CsIStudyModule, DAQMonitorModule, DelayDQMModule, DetectorOccupanciesDQMModule, DosiStudyModule, DQMHistoModuleBase, ECLDQMInjectionModule, ECLBackgroundModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLDQMOutOfTimeDigitsModule, EventT0DQMModule, FANGSStudyModule, He3tubeStudyModule, IPDQMModule, KLMDQM2Module, KLMDQMModule, MicrotpcStudyModule, MonitorDataModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleEcmsBBModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PindiodeStudyModule, PXDDAQDQMModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDRawDQMChipsModule, PXDRawDQMModule, PXDROIDQMModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDRawDQMCorrModule, PXDTrackClusterDQMModule, QcsmonitorStudyModule, SoftwareTriggerHLTDQMModule, StatisticsTimingHLTDQMModule, SVDDQMDoseModule, SVDDQMInjectionModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, SVDDQMHitTimeModule, SVDUnpackerDQMModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserHitSelectorModule, TOPTBCComparatorModule, TrackAnaModule, TrackingAbortDQMModule, TRGCDCT2DDQMModule, TRGCDCT3DDQMModule, TRGCDCTSFDQMModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGGDLDQMModule, TRGGDLModule, TRGGRLDQMModule, TRGRAWDATAModule, TRGTOPDQMModule, TTDDQMModule, V0ObjectsDQMModule, vxdDigitMaskingModule, and VXDDQMExpressRecoModule.

Definition at line 40 of file HistoModule.h.

40{};

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

180{
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
void setParameters(const ModuleParamList &params)
Set values for parameters from other parameter list.
const ModuleParamList & getParamList() const
Return module param list.
Definition Module.h:362
const std::string & getName() const
Returns the name of the module.
Definition Module.h:186
const std::string & getType() const
Returns the type of the module (i.e.
Definition Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition Module.h:511
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition Module.h:515
void setName(const std::string &name)
Set the name of the module.
Definition Module.h:213
LogConfig m_logConfig
The log system configuration of the module.
Definition Module.h:513
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition Module.h:520
std::string m_package
Package this module is found in (may be empty).
Definition Module.h:509
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ beginRun(); }

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

438{ endRun(); }

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

419{ initialize(); }

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

444{ terminate(); }

◆ defineHisto()

void defineHisto ( )
overridevirtual

Histogram definitions.

Reimplemented from HistoModule.

Definition at line 41 of file TRGEfficiencyDQMModule.cc.

42{
43 TDirectory* oldDir = gDirectory;
44 oldDir->mkdir("TRGEFF");
45 oldDir->cd("TRGEFF");
46
47 m_hPhi = new TH1F("hPhi", "", 36, -180.0, 180.0);
48 m_hPhi_psnecl = new TH1F("hPhi_psnecl", "", 36, -180.0, 180.0);
49 m_hPhi_psnecl_ftdf = new TH1F("hPhi_psnecl_ftdf", "", 36, -180.0, 180.0);
50
51 m_hPt = new TH1F("hPt", "", 50, 0, 5);
52 m_hPt_psnecl = new TH1F("hPt_psnecl", "", 50, 0, 5);
53 m_hPt_psnecl_ftdf = new TH1F("hPt_psnecl_ftdf", "", 50, 0, 5);
54
55 m_nobha_f_phi = new TH1F("nobha_f_phi", "", 36, -180., 180.);
56 m_nobha_f_phi_psnecl = new TH1F("nobha_f_phi_psnecl", "", 36, -180., 180.);
57 m_nobha_f_phi_psnecl_ftdf = new TH1F("nobha_f_phi_psnecl_ftdf", "", 36, -180., 180.);
58
59 m_nobha_hPt = new TH1F("nobha_hPt", "", 50, 0, 5);
60 m_nobha_hPt_psnecl = new TH1F("nobha_hPt_psnecl", "", 50, 0, 5);
61 m_nobha_hPt_psnecl_ftdf = new TH1F("nobha_hPt_psnecl_ftdf", "", 50, 0, 5);
62
63 m_hP3_y = new TH1F("hP3_y", "", 50, 0, 5);
64 m_hP3_y_psnecl = new TH1F("hP3_y_psnecl", "", 50, 0, 5);
65 m_hP3_y_psnecl_ftdf = new TH1F("hP3_y_psnecl_ftdf", "", 50, 0, 5);
66
67 m_hP3_z = new TH1F("hP3_z", "", 50, 0, 5);
68 m_hP3_z_psnecl = new TH1F("hP3_z_psnecl", "", 50, 0, 5);
69 m_hP3_z_psnecl_ftdf = new TH1F("hP3_z_psnecl_ftdf", "", 50, 0, 5);
70
71 m_nobha_hP3_y = new TH1F("nobha_hP3_y", "", 50, 0, 5);
72 m_nobha_hP3_y_psnecl = new TH1F("nobha_hP3_y_psnecl", "", 50, 0, 5);
73 m_nobha_hP3_y_psnecl_ftdf = new TH1F("nobha_hP3_y_psnecl_ftdf", "", 50, 0, 5);
74
75 m_nobha_hP3_z = new TH1F("nobha_hP3_z", "", 50, 0, 5);
76 m_nobha_hP3_z_psnecl = new TH1F("nobha_hP3_z_psnecl", "", 50, 0, 5);
77 m_nobha_hP3_z_psnecl_ftdf = new TH1F("nobha_hP3_z_psnecl_ftdf", "", 50, 0, 5);
78
79 m_nobha_phi_y = new TH1F("nobha_phi_y", "", 36, -180., 180.);
80 m_nobha_phi_y_psnecl = new TH1F("nobha_phi_y_psnecl", "", 36, -180., 180.);
81 m_nobha_phi_y_psnecl_ftdf = new TH1F("nobha_phi_y_psnecl_ftdf", "", 36, -180., 180.);
82
83 m_nobha_phi_z = new TH1F("nobha_phi_z", "", 36, -180., 180.);
84 m_nobha_phi_z_psnecl = new TH1F("nobha_phi_z_psnecl", "", 36, -180., 180.);
85 m_nobha_phi_z_psnecl_ftdf = new TH1F("nobha_phi_z_psnecl_ftdf", "", 36, -180., 180.);
86
87 m_fyo_dphi = new TH1F("fyo_dphi", "", 18, 0., 180.);
88 m_fyo_dphi_psnecl = new TH1F("fyo_dphi_psnecl", "", 18, 0., 180.);
89 m_fyo_dphi_psnecl_ftdf = new TH1F("fyo_dphi_psnecl_ftdf", "", 18, 0., 180.);
90
91 m_nobha_fyo_dphi = new TH1F("nobha_fyo_dphi", "", 18, 0., 180.);
92 m_nobha_fyo_dphi_psnecl = new TH1F("nobha_fyo_dphi_psnecl", "", 18, 0., 180.);
93 m_nobha_fyo_dphi_psnecl_ftdf = new TH1F("nobha_fyo_dphi_psnecl_ftdf", "", 18, 0., 180.);
94
95 m_stt_phi = new TH1F("stt_phi", "", 36, -180., 180.);
96 m_stt_phi_psnecl = new TH1F("stt_phi_psnecl", "", 36, -180., 180.);
97 m_stt_phi_psnecl_ftdf = new TH1F("stt_phi_psnecl_ftdf", "", 36, -180., 180.);
98
99 m_stt_P3 = new TH1F("stt_P3", "", 50, 0, 5);
100 m_stt_P3_psnecl = new TH1F("stt_P3_psnecl", "", 50, 0, 5);
101 m_stt_P3_psnecl_ftdf = new TH1F("stt_P3_psnecl_ftdf", "", 50, 0, 5);
102
103 m_stt_theta = new TH1F("stt_theta", "", 18, 0, 180);
104 m_stt_theta_psnecl = new TH1F("stt_theta_psnecl", "", 18, 0, 180);
105 m_stt_theta_psnecl_ftdf = new TH1F("stt_theta_psnecl_ftdf", "", 18, 0, 180);
106
107 m_nobha_stt_phi = new TH1F("nobha_stt_phi", "", 36, -180., 180.);
108 m_nobha_stt_phi_psnecl = new TH1F("nobha_stt_phi_psnecl", "", 36, -180., 180.);
109 m_nobha_stt_phi_psnecl_ftdf = new TH1F("nobha_stt_phi_psnecl_ftdf", "", 36, -180., 180.);
110
111 m_nobha_stt_P3 = new TH1F("nobha_stt_P3", "", 50, 0, 5);
112 m_nobha_stt_P3_psnecl = new TH1F("nobha_stt_P3_psnecl", "", 50, 0, 5);
113 m_nobha_stt_P3_psnecl_ftdf = new TH1F("nobha_stt_P3_psnecl_ftdf", "", 50, 0, 5);
114
115 m_nobha_stt_theta = new TH1F("nobha_stt_theta", "", 18, 0, 180);
116 m_nobha_stt_theta_psnecl = new TH1F("nobha_stt_theta_psnecl", "", 18, 0, 180);
117 m_nobha_stt_theta_psnecl_ftdf = new TH1F("nobha_stt_theta_psnecl_ftdf", "", 18, 0, 180);
118
119 m_hie_E = new TH1F("hie_E", "", 60, 0, 12);
120 m_hie_E_psnecl = new TH1F("hie_E_psnecl", "", 60, 0, 12);
121 m_hie_E_psnecl_ftdf = new TH1F("hie_E_psnecl_ftdf", "", 60, 0, 12);
122
123 m_nobha_hie_E = new TH1F("nobha_hie_E", "", 60, 0, 12);
124 m_nobha_hie_E_psnecl = new TH1F("nobha_hie_E_psnecl", "", 60, 0, 12);
125 m_nobha_hie_E_psnecl_ftdf = new TH1F("nobha_hie_E_psnecl_ftdf", "", 60, 0, 12);
126
127 m_ecltiming_E = new TH1F("ecltiming_E", "", 60, 0, 12);
128 m_ecltiming_E_psnecl = new TH1F("ecltiming_E_psnecl", "", 60, 0, 12);
129 m_ecltiming_E_psnecl_ftdf = new TH1F("ecltiming_E_psnecl_ftdf", "", 60, 0, 12);
130
131 m_ecltiming_theta = new TH1F("ecltiming_theta", "", 18, 0, 180);
132 m_ecltiming_theta_psnecl = new TH1F("ecltiming_theta_psnecl", "", 18, 0, 180);
133 m_ecltiming_theta_psnecl_ftdf = new TH1F("ecltiming_theta_psnecl_ftdf", "", 18, 0, 180);
134
135 m_ecltiming_phi = new TH1F("ecltiming_phi", "", 36, -180., 180.);
136 m_ecltiming_phi_psnecl = new TH1F("ecltiming_phi_psnecl", "", 36, -180., 180.);
137 m_ecltiming_phi_psnecl_ftdf = new TH1F("ecltiming_phi_psnecl_ftdf", "", 36, -180., 180.);
138
139 m_klmhit_phi = new TH1F("klmhit_phi", "", 18, -180., 180.);
140 m_klmhit_phi_psnecl = new TH1F("klmhit_phi_psnecl", "", 18, -180., 180.);
141 m_klmhit_phi_psnecl_ftdf = new TH1F("klmhit_phi_psnecl_ftdf", "", 18, -180., 180.);
142
143 m_klmhit_theta = new TH1F("klmhit_theta", "", 18, 0, 180);
144 m_klmhit_theta_psnecl = new TH1F("klmhit_theta_psnecl", "", 18, 0, 180);
145 m_klmhit_theta_psnecl_ftdf = new TH1F("klmhit_theta_psnecl_ftdf", "", 18, 0, 180);
146
147 m_eklmhit_phi = new TH1F("eklmhit_phi", "", 18, -180., 180.);
148 m_eklmhit_phi_psnecl = new TH1F("eklmhit_phi_psnecl", "", 18, -180., 180.);
149 m_eklmhit_phi_psnecl_ftdf = new TH1F("eklmhit_phi_psnecl_ftdf", "", 18, -180., 180.);
150
151 m_eklmhit_theta = new TH1F("eklmhit_theta", "", 18, 0, 180);
152 m_eklmhit_theta_psnecl = new TH1F("eklmhit_theta_psnecl", "", 18, 0, 180);
153 m_eklmhit_theta_psnecl_ftdf = new TH1F("eklmhit_theta_psnecl_ftdf", "", 18, 0, 180);
154
155 oldDir->cd();
156}
TH1F * m_hPhi_psnecl_ftdf
Histogram of cdc phi of IP tracks with ecl and f bit.
TH1F * m_hPhi_psnecl
Histogram of cdc phi of IP tracks with ecl bit.
TH1F * m_hPhi
Histogram of cdc phi of IP tracks.

◆ endRun()

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition Module.h:518
bool m_hasReturnValue
True, if the return value is set.
Definition Module.h:517

◆ event()

void event ( void )
overridevirtual

Event processor.

Reimplemented from HistoModule.

Definition at line 163 of file TRGEfficiencyDQMModule.cc.

164{
165 if (!m_Tracks.isOptional()) {
166 B2WARNING("Tracks array not available, but required to estimate the trigger efficiency");
167 return;
168 }
169 if (!m_ECLClusters.isOptional()) {
170 B2WARNING("ECLClusters array not available, but required to estimate the trigger efficiency");
171 return;
172 }
173 if (!m_KLMClusters.isOptional()) {
174 B2WARNING("KLMClusters array not available, but required to estimate the trigger efficiency");
175 return;
176 }
177 if (!m_TrgSummary.isValid()) {
178 B2WARNING("TRGSummary object not available but required to estimate the trigger efficiency");
179 return;
180 }
181 if (!m_HltResult.isValid()) {
182 B2WARNING("SoftwareTriggerResult object not available but required to get the HLT result");
183 return;
184 }
185
186 bool hltAccepted = false;
187 if (m_HltResult) {
188 try {
189 hltAccepted = (m_HltResult->getResult("software_trigger_cut&filter&total_result") == SoftwareTriggerCutResult::c_accept)
190 ?
191 true : false;
192 } catch (const std::out_of_range&) {
193 hltAccepted = false;
194 }
195 }
196
197 if (not hltAccepted) {
198 B2WARNING("TRGEfficiencyDQMModule: Event rejected by the HLT filter, skipping the module");
199 return;
200 }
201
205
206 // calculate the total energy
207 double E_ecl_all = 0; // the ECL total energy
208 double E_ecl_hie = 0; // the ECL total energy in the hie "acceptance"
209
210 bool trg_hie_psncdc = 0; // for ECL energy trigger, for hie
211 bool trg_hie_Eecl = 0; // for ECL energy trigger, for hie
212 bool trg_ecltiming_psncdc = 0; // for ECL energy trigger, for ecltiming
213 bool trg_ecltiming_Eecl = 0; // for ECL energy trigger. for ecltiming
214 bool trg_nobha_hie_Eecl = 0;
215
216 for (const auto& b2eclcluster : m_ECLClusters) {
217
218 if (!(b2eclcluster.hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons))) continue;
219
220 const double phi = b2eclcluster.getPhi() / Unit::deg;
221 const double theta = b2eclcluster.getTheta() / Unit::deg;
222 const double energy = b2eclcluster.getEnergyRaw();
223
224 if (energy < 0.1) continue;
225
226 E_ecl_all += energy;
227 // the ECL total energy in the thetaID range 2<=ThetaID<=15 (corresponds to 22.49<=theta<=126.80) for ehigh bit
228 if (theta >= 22.49 && theta <= 126.8) {
229 E_ecl_hie += energy;
230 }
231
232 const bool trg_psncdc = m_TrgSummary->testPsnm("ffy") || m_TrgSummary->testPsnm("fyo") || m_TrgSummary->testPsnm("stt");
233 const bool trg_hie = m_TrgSummary->testFtdl("hie");
234 const bool trg_hie_nobha = m_TrgSummary->testInput("ehigh"); // remove the bha_veto for hie bit
235 const bool trg_ecltiming = m_TrgSummary->testFtdl("ecltiming");
236
237 m_ecltiming_theta->Fill(theta);
238 m_ecltiming_phi->Fill(phi);
239
240 if (trg_psncdc) {
241 trg_hie_psncdc = 1;
242 trg_ecltiming_psncdc = 1;
243
244 m_ecltiming_theta_psnecl->Fill(theta);
245 m_ecltiming_phi_psnecl->Fill(phi);
246 }
247
248 if (trg_psncdc && trg_hie) {
249 trg_hie_Eecl = 1;
250 }
251 if (trg_psncdc && trg_hie_nobha) {
252 trg_nobha_hie_Eecl = 1;
253 }
254 if (trg_psncdc && trg_ecltiming) {
255 trg_ecltiming_Eecl = 1;
256
257 m_ecltiming_theta_psnecl_ftdf->Fill(theta);
258 m_ecltiming_phi_psnecl_ftdf->Fill(phi);
259 }
260 }
261
262 // sum of the ECL total energy
263 m_hie_E->Fill(E_ecl_hie);
264 m_nobha_hie_E->Fill(E_ecl_hie);
265 if (trg_hie_psncdc) {
266 m_hie_E_psnecl->Fill(E_ecl_hie);
267 m_nobha_hie_E_psnecl->Fill(E_ecl_hie);
268 }
269 if (trg_hie_Eecl) {
270 m_hie_E_psnecl_ftdf->Fill(E_ecl_hie);
271 }
272 if (trg_nobha_hie_Eecl) {
273 m_nobha_hie_E_psnecl_ftdf->Fill(E_ecl_hie);
274 }
275
276 m_ecltiming_E->Fill(E_ecl_all);
277 if (trg_ecltiming_psncdc) {
278 m_ecltiming_E_psnecl->Fill(E_ecl_all);
279 }
280 if (trg_ecltiming_Eecl) {
281 m_ecltiming_E_psnecl_ftdf->Fill(E_ecl_all);
282 }
283
287 for (const auto& b2klmcluster : m_KLMClusters) {
288 const int nlayer = b2klmcluster.getLayers();
289
290 if (nlayer <= 6)
291 continue;
292
293 const double phi = b2klmcluster.getMomentum().Phi() / Unit::deg;
294 const double theta = b2klmcluster.getMomentum().Theta() / Unit::deg;
295
296 bool trg_KLMecl = m_TrgSummary->testPsnm("hie") || m_TrgSummary->testPsnm("c4") || m_TrgSummary->testPsnm("eclmumu") ||
297 m_TrgSummary->testPsnm("lml1") || m_TrgSummary->testPsnm("lml2") || m_TrgSummary->testPsnm("lml6") ||
298 m_TrgSummary->testPsnm("lml7") || m_TrgSummary->testPsnm("lml8") || m_TrgSummary->testPsnm("lml9") ||
299 m_TrgSummary->testPsnm("lml10");
300 // these trigger flags are not available in older data
301 try {
302 trg_KLMecl |= m_TrgSummary->testPsnm("ecltaub2b3") || m_TrgSummary->testPsnm("hie4");
303 } catch (const std::exception&) {
304 }
305
306 const bool trg_klmhit = m_TrgSummary->testFtdl("klmhit");
307 const bool trg_eklmhit = m_TrgSummary->testFtdl("eklmhit");
308
309 m_klmhit_phi->Fill(phi);
310 m_klmhit_theta->Fill(theta);
311 m_eklmhit_phi->Fill(phi);
312 m_eklmhit_theta->Fill(theta);
313
314 if (trg_KLMecl) {
315 m_klmhit_theta_psnecl->Fill(theta);
316 m_eklmhit_theta_psnecl->Fill(theta);
317 }
318 if (trg_KLMecl && trg_klmhit) {
319 m_klmhit_theta_psnecl_ftdf->Fill(theta);
320 }
321 if (trg_KLMecl && trg_eklmhit) {
322 m_eklmhit_theta_psnecl_ftdf->Fill(theta);
323 }
324
325 // add theta cut for phi distribution, since the efficiency at some theta range is very low.
326 if (trg_KLMecl && theta > 50 && theta < 120) {
327 m_klmhit_phi_psnecl->Fill(phi);
328 }
329 if (trg_KLMecl && ((theta > 20 && theta < 40) || (theta > 120 && theta < 160))) {
330 m_eklmhit_phi_psnecl->Fill(phi);
331 }
332 if (trg_KLMecl && trg_klmhit && theta > 50 && theta < 120) {
333 m_klmhit_phi_psnecl_ftdf->Fill(phi);
334 }
335 if (trg_KLMecl && trg_eklmhit && ((theta > 20 && theta < 40) || (theta > 120 && theta < 160))) {
336 m_eklmhit_phi_psnecl_ftdf->Fill(phi);
337 }
338 }
339
343
344 std::vector<double> p_stt_P3_psnecl_ftdf, p_stt_P3_psnecl, p_stt_P3, phi_fyo_dphi, phi_fyo_dphi_psnecl, phi_fyo_dphi_psnecl_ftdf ;
345
346 std::vector<double> p_nobha_stt_P3_psnecl_ftdf, p_nobha_stt_P3_psnecl, p_nobha_stt_P3, phi_nobha_fyo_dphi,
347 phi_nobha_fyo_dphi_psnecl,
348 phi_nobha_fyo_dphi_psnecl_ftdf ;
349
350 int nitrack = 0; // the i track of the m_Tracks
351 for (const auto& b2track : m_Tracks) {
352 const Belle2::TrackFitResult* fitresult = b2track.getTrackFitResultWithClosestMass(Const::pion);
353 if (!fitresult) {
354 B2WARNING("No track fit result found.");
355 nitrack++;
356 continue;
357 }
358
359 // require high NDF track
360 const int ndf = fitresult->getNDF();
361 if (ndf < 20) {
362 nitrack++;
363 continue;
364 }
365
366 // IP tracks at barrel
367 if (std::abs(fitresult->getD0()) < 1.0 && std::abs(fitresult->getZ0()) < 1.0 && fitresult->getHitPatternCDC().getLastLayer() > 50
368 && fitresult->getHitPatternCDC().getFirstLayer() < 5) {
369 const double phi = fitresult->getPhi() / Unit::deg;
370 const double pt = fitresult->getTransverseMomentum();
371 const double p3 = fitresult->getMomentum().R(); // 3-momentum
372 const double theta = fitresult->getMomentum().Theta() / Unit::deg;
373
374 bool trg_psnecl = m_TrgSummary->testPsnm("hie") || m_TrgSummary->testPsnm("c4") || m_TrgSummary->testPsnm("eclmumu") ||
375 m_TrgSummary->testPsnm("lml1") || m_TrgSummary->testPsnm("lml2") || m_TrgSummary->testPsnm("lml6") ||
376 m_TrgSummary->testPsnm("lml7") || m_TrgSummary->testPsnm("lml8") || m_TrgSummary->testPsnm("lml9") ||
377 m_TrgSummary->testPsnm("lml10");
378 // these trigger flags are not available in older data
379 try {
380 trg_psnecl |= m_TrgSummary->testPsnm("ecltaub2b3") || m_TrgSummary->testPsnm("hie4");
381 } catch (const std::exception&) {
382 }
383
384 const bool trg_ftdf = m_TrgSummary->testFtdl("f");
385
386 // for f bit, reomove the Bhabha_veto
387 const bool trg_itdt2 = (m_TrgSummary->testInput("t2_0") || m_TrgSummary->testInput("t2_1") || m_TrgSummary->testInput("t2_2")
388 || m_TrgSummary->testInput("t2_3"));
389
390 // for z, reomove the Bhabha_veto
391 const bool trg_itdt3 = (m_TrgSummary->testInput("t3_0") || m_TrgSummary->testInput("t3_1") || m_TrgSummary->testInput("t3_2")
392 || m_TrgSummary->testInput("t3_3"));
393
394 // for y, reomove the Bhabha_veto
395 const bool trg_itdt4 = (m_TrgSummary->testInput("ty_0") || m_TrgSummary->testInput("ty_1") || m_TrgSummary->testInput("ty_2")
396 || m_TrgSummary->testInput("ty_3"));
397
398 // (t3>0 and !bhaveto and !veto) for z
399 const bool trg_ftdz = m_TrgSummary->testFtdl("z");
400
401 // (ty>0 and !bhaveto and !veto) for y
402 const bool trg_ftdy = m_TrgSummary->testFtdl("y");
403
404 // typ and !bha veto and !veto
405 const bool trg_stt = m_TrgSummary->testFtdl("stt");
406
407 // remove bha_veto
408 const bool trg_stt_nobha = m_TrgSummary->testInput("typ") ;
409
410 // require pt > 0.3 GeV
411 if (pt > 0.3) {
412 m_hPhi->Fill(phi);
413 if (trg_psnecl) {
414 m_hPhi_psnecl->Fill(phi);
415 }
416 if (trg_psnecl && trg_ftdf) {
417 m_hPhi_psnecl_ftdf->Fill(phi);
418 }
419 }
420
421 m_hPt->Fill(pt);
422 m_nobha_hPt->Fill(pt);
423 m_nobha_f_phi->Fill(phi);
424
425 m_hP3_z->Fill(p3);
426 m_hP3_y->Fill(p3);
427
428 m_nobha_hP3_z->Fill(p3);
429 m_nobha_hP3_y->Fill(p3);
430
431 m_nobha_phi_z->Fill(phi);
432 m_nobha_phi_y->Fill(phi);
433
434 m_stt_theta->Fill(theta);
435 m_stt_phi->Fill(phi);
436 p_stt_P3.push_back(p3);
437
438 m_nobha_stt_theta->Fill(theta);
439 m_nobha_stt_phi->Fill(phi);
440 p_nobha_stt_P3.push_back(p3);
441
442
443 if (trg_psnecl) {
444 m_hPt_psnecl->Fill(pt);
445 m_nobha_hPt_psnecl->Fill(pt);
446 m_nobha_f_phi_psnecl->Fill(phi);
447
448 m_hP3_z_psnecl->Fill(p3); // for z bit
449 m_hP3_y_psnecl->Fill(p3); // for y bit
450
451 m_nobha_hP3_z_psnecl->Fill(p3); // remove bhabha veto for z bit
452 m_nobha_hP3_y_psnecl->Fill(p3); // remove bhabha veto for y bit
453
454 m_nobha_phi_z_psnecl->Fill(phi);
455 m_nobha_phi_y_psnecl->Fill(phi);
456
457 m_stt_phi_psnecl->Fill(phi);
458 p_stt_P3_psnecl.push_back(p3);
459 m_stt_theta_psnecl->Fill(theta);
460
461 m_nobha_stt_phi_psnecl->Fill(phi);
462 p_nobha_stt_P3_psnecl.push_back(p3);
463 m_nobha_stt_theta_psnecl->Fill(theta);
464 }
465
466 if (trg_psnecl && trg_ftdf) {
467 m_hPt_psnecl_ftdf->Fill(pt);
468 }
469 if (trg_psnecl && trg_itdt2) {
470 m_nobha_hPt_psnecl_ftdf->Fill(pt);
471 m_nobha_f_phi_psnecl_ftdf->Fill(phi);
472 }
473
474 if (trg_psnecl && trg_ftdz) {
475 m_hP3_z_psnecl_ftdf->Fill(p3);
476 }
477 if (trg_psnecl && trg_ftdy) {
478 m_hP3_y_psnecl_ftdf->Fill(p3);
479 }
480 if (trg_psnecl && trg_itdt3) {
481 m_nobha_hP3_z_psnecl_ftdf->Fill(p3);
482 m_nobha_phi_z_psnecl_ftdf->Fill(phi);
483 }
484 if (trg_psnecl && trg_itdt4) {
485 m_nobha_hP3_y_psnecl_ftdf->Fill(p3);
486 m_nobha_phi_y_psnecl_ftdf->Fill(phi);
487 }
488
489 if (trg_psnecl && trg_stt) {
490 m_stt_phi_psnecl_ftdf->Fill(phi);
491 p_stt_P3_psnecl_ftdf.push_back(p3);
492 m_stt_theta_psnecl_ftdf->Fill(theta);
493 }
494 if (trg_psnecl && trg_stt_nobha) {
495 m_nobha_stt_phi_psnecl_ftdf->Fill(phi);
496 p_nobha_stt_P3_psnecl_ftdf.push_back(p3);
497 m_nobha_stt_theta_psnecl_ftdf->Fill(theta);
498 }
499
500 // the following is for fyo \deleta_phi
501 int njtrack = 0; // the j track of the m_Tracks
502 for (const auto& j_b2track : m_Tracks) {
503 if (nitrack >= njtrack) {
504 njtrack++;
505 continue;
506 }
507
508 const Belle2::TrackFitResult* jfitresult = j_b2track.getTrackFitResultWithClosestMass(Const::pion);
509 if (!jfitresult) {
510 B2WARNING("No track fit result found.");
511 njtrack++;
512 continue;
513 }
514
515 // require high NDF track
516 int jndf = jfitresult->getNDF();
517 if (jndf < 20) {
518 njtrack++;
519 continue;
520 }
521
522 // IP tracks at barrel
523 if (std::abs(jfitresult->getD0()) < 1.0 && std::abs(jfitresult->getZ0()) < 1.0 && jfitresult->getHitPatternCDC().getLastLayer() > 50
524 && jfitresult->getHitPatternCDC().getFirstLayer() < 5) {
525 const double jrk_phi = jfitresult->getPhi() / Unit::deg;
526 const double delta_phi = std::abs(phi - jrk_phi);
527 const double dphi = (delta_phi > 180) ? 360 - delta_phi : delta_phi;
528
529 const bool trg_fyo = m_TrgSummary->testFtdl("fyo");
530 const bool trg_fyo_nobha = (m_TrgSummary->testInput("t2_1") || m_TrgSummary->testInput("t2_2")
531 || m_TrgSummary->testInput("t2_3"))
532 &&
533 (m_TrgSummary->testInput("ty_0") || m_TrgSummary->testInput("ty_1") || m_TrgSummary->testInput("ty_2")
534 || m_TrgSummary->testInput("ty_3"))
535 &&
536 m_TrgSummary->testInput("cdc_open90");
537
538 phi_fyo_dphi.push_back(dphi);
539 phi_nobha_fyo_dphi.push_back(dphi);
540
541 if (trg_psnecl) {
542 phi_fyo_dphi_psnecl.push_back(dphi);
543 phi_nobha_fyo_dphi_psnecl.push_back(dphi);
544 }
545 if (trg_psnecl && trg_fyo) {
546 phi_fyo_dphi_psnecl_ftdf.push_back(dphi);
547 }
548 if (trg_psnecl && trg_fyo_nobha) {
549 phi_nobha_fyo_dphi_psnecl_ftdf.push_back(dphi);
550 }
551 }
552 njtrack++;
553 }
554 }
555 nitrack++;
556 }
557
558 // the largest cdc_open angle in an event for fyo bit
559 if (phi_fyo_dphi_psnecl_ftdf.size() != 0) {
560 const auto max_it = std::max_element(phi_fyo_dphi_psnecl_ftdf.begin(), phi_fyo_dphi_psnecl_ftdf.end());
561 const double max_value = *max_it;
562 m_fyo_dphi_psnecl_ftdf->Fill(max_value);
563 }
564 if (phi_fyo_dphi_psnecl.size() != 0) {
565 const auto max_it = std::max_element(phi_fyo_dphi_psnecl.begin(), phi_fyo_dphi_psnecl.end());
566 const double max_value = *max_it;
567 m_fyo_dphi_psnecl->Fill(max_value);
568 }
569 if (phi_fyo_dphi.size() != 0) {
570 const auto max_it = std::max_element(phi_fyo_dphi.begin(), phi_fyo_dphi.end());
571 const double max_value = *max_it;
572 m_fyo_dphi->Fill(max_value);
573 }
574
575 //
576 if (phi_nobha_fyo_dphi_psnecl_ftdf.size() != 0) {
577 const auto max_it = std::max_element(phi_nobha_fyo_dphi_psnecl_ftdf.begin(), phi_nobha_fyo_dphi_psnecl_ftdf.end());
578 const double max_value = *max_it;
579 m_nobha_fyo_dphi_psnecl_ftdf->Fill(max_value);
580 }
581 if (phi_nobha_fyo_dphi_psnecl.size() != 0) {
582 const auto max_it = std::max_element(phi_nobha_fyo_dphi_psnecl.begin(), phi_nobha_fyo_dphi_psnecl.end());
583 const double max_value = *max_it;
584 m_nobha_fyo_dphi_psnecl->Fill(max_value);
585 }
586 if (phi_nobha_fyo_dphi.size() != 0) {
587 const auto max_it = std::max_element(phi_nobha_fyo_dphi.begin(), phi_nobha_fyo_dphi.end());
588 const double max_value = *max_it;
589 m_nobha_fyo_dphi->Fill(max_value);
590 }
591
592 // the largest momentum track p in an event for stt bit
593 if (p_stt_P3_psnecl_ftdf.size() != 0) {
594 const auto max_it = std::max_element(p_stt_P3_psnecl_ftdf.begin(), p_stt_P3_psnecl_ftdf.end());
595 const double max_value = *max_it;
596 m_stt_P3_psnecl_ftdf->Fill(max_value);
597 }
598 if (p_stt_P3_psnecl.size() != 0) {
599 const auto max_it = std::max_element(p_stt_P3_psnecl.begin(), p_stt_P3_psnecl.end());
600 const double max_value = *max_it;
601 m_stt_P3_psnecl->Fill(max_value);
602 }
603 if (p_stt_P3.size() != 0) {
604 const auto max_it = std::max_element(p_stt_P3.begin(), p_stt_P3.end());
605 const double max_value = *max_it;
606 m_stt_P3->Fill(max_value);
607 }
608
609 //
610 if (p_nobha_stt_P3_psnecl_ftdf.size() != 0) {
611 const auto max_it = std::max_element(p_nobha_stt_P3_psnecl_ftdf.begin(), p_nobha_stt_P3_psnecl_ftdf.end());
612 const double max_value = *max_it;
613 m_nobha_stt_P3_psnecl_ftdf->Fill(max_value);
614 }
615 if (p_nobha_stt_P3_psnecl.size() != 0) {
616 const auto max_it = std::max_element(p_nobha_stt_P3_psnecl.begin(), p_nobha_stt_P3_psnecl.end());
617 const double max_value = *max_it;
618 m_nobha_stt_P3_psnecl->Fill(max_value);
619 }
620 if (p_nobha_stt_P3.size() != 0) {
621 const auto max_it = std::max_element(p_nobha_stt_P3.begin(), p_nobha_stt_P3.end());
622 const double max_value = *max_it;
623 m_nobha_stt_P3->Fill(max_value);
624 }
625
626}
static const ChargedStable pion
charged pion particle
Definition Const.h:661
@ c_nPhotons
CR is split into n photons (N1)
Definition ECLCluster.h:41
short getLastLayer() const
Returns the index of the last layer with a hit.
short getFirstLayer() const
Returns the index of the first layer with a hit.
StoreObjPtr< SoftwareTriggerResult > m_HltResult
HLT result.
StoreArray< ECLCluster > m_ECLClusters
ECL Clusters.
StoreArray< KLMCluster > m_KLMClusters
KLM Clusters.
StoreObjPtr< TRGSummary > m_TrgSummary
Trigger summary.
StoreArray< Track > m_Tracks
Tracks.
float getNDF() const
Getter for number of degrees of freedom of the track fit.
double getPhi() const
Getter for phi0 with CDF naming convention.
double getD0() const
Getter for d0.
double getTransverseMomentum() const
Getter for the absolute value of the transverse momentum at the perigee.
double getZ0() const
Getter for z0.
ROOT::Math::XYZVector getMomentum() const
Getter for vector of momentum at closest approach of track in r/phi projection.
HitPatternCDC getHitPatternCDC() const
Getter for the hit pattern in the CDC;.
static const double deg
degree to radians
Definition Unit.h:109

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional paths */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
491 &Module::setLogConfig)
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">".
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "==".
@ c_ST
Smaller than: "<".
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition Module.cc:90
Module()
Constructor.
Definition Module.cc:30
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition Module.cc:220
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition Module.h:81
@ c_Input
This module is an input module (reads data).
Definition Module.h:78
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition Module.h:82
@ c_Output
This module is an output module (writes data).
Definition Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition Module.h:83
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition Module.cc:85
ModuleCondition::EAfterConditionPath EAfterConditionPath
Forward the EAfterConditionPath definition from the ModuleCondition.
Definition Module.h:88

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 323 of file Module.h.

324 {
325 return m_conditions;
326 }

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

314 {
315 if (m_conditions.empty()) {
316 return nullptr;
317 } else {
318 return &m_conditions.front();
319 }
320 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

201{return m_description;}

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

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 186 of file Module.h.

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 380 of file Module.h.

380{ return m_returnValue; }

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

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition Module.h:508

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 310 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

Return true if this module has a valid return value set.

Definition at line 377 of file Module.h.

377{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )
overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from HistoModule.

Definition at line 158 of file TRGEfficiencyDQMModule.cc.

159{
160 REG_HISTOGRAM
161}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string & description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}
std::string m_description
The description of the module.
Definition Module.h:510

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig)
inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int logLevel,
unsigned int logInfo )
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition LogConfig.cc:25

◆ 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
nameThe name of the module

Definition at line 213 of file Module.h.

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition LogSystem.h:200
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition LogSystem.cc:28
LogConfig & getLogConfig()
Returns the log system configuration.
Definition Module.h:224
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition Module.h:507
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ terminate()

Member Data Documentation

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

StoreArray<ECLCluster> m_ECLClusters
protected

ECL Clusters.

Definition at line 71 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_E

TH1F* m_ecltiming_E = nullptr
protected

Definition at line 163 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_E_psnecl

TH1F* m_ecltiming_E_psnecl = nullptr
protected

Definition at line 164 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_E_psnecl_ftdf

TH1F* m_ecltiming_E_psnecl_ftdf = nullptr
protected

Definition at line 165 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_phi

TH1F* m_ecltiming_phi = nullptr
protected

Definition at line 171 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_phi_psnecl

TH1F* m_ecltiming_phi_psnecl = nullptr
protected

Definition at line 172 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_phi_psnecl_ftdf

TH1F* m_ecltiming_phi_psnecl_ftdf = nullptr
protected

Definition at line 173 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_theta

TH1F* m_ecltiming_theta = nullptr
protected

Definition at line 167 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_theta_psnecl

TH1F* m_ecltiming_theta_psnecl = nullptr
protected

Definition at line 168 of file TRGEfficiencyDQMModule.h.

◆ m_ecltiming_theta_psnecl_ftdf

TH1F* m_ecltiming_theta_psnecl_ftdf = nullptr
protected

Definition at line 169 of file TRGEfficiencyDQMModule.h.

◆ m_eklmhit_phi

TH1F* m_eklmhit_phi = nullptr
protected

Definition at line 184 of file TRGEfficiencyDQMModule.h.

◆ m_eklmhit_phi_psnecl

TH1F* m_eklmhit_phi_psnecl = nullptr
protected

Definition at line 185 of file TRGEfficiencyDQMModule.h.

◆ m_eklmhit_phi_psnecl_ftdf

TH1F* m_eklmhit_phi_psnecl_ftdf = nullptr
protected

Definition at line 186 of file TRGEfficiencyDQMModule.h.

◆ m_eklmhit_theta

TH1F* m_eklmhit_theta = nullptr
protected

Definition at line 188 of file TRGEfficiencyDQMModule.h.

◆ m_eklmhit_theta_psnecl

TH1F* m_eklmhit_theta_psnecl = nullptr
protected

Definition at line 189 of file TRGEfficiencyDQMModule.h.

◆ m_eklmhit_theta_psnecl_ftdf

TH1F* m_eklmhit_theta_psnecl_ftdf = nullptr
protected

Definition at line 190 of file TRGEfficiencyDQMModule.h.

◆ m_fyo_dphi

TH1F* m_fyo_dphi = nullptr
protected

Definition at line 120 of file TRGEfficiencyDQMModule.h.

◆ m_fyo_dphi_psnecl

TH1F* m_fyo_dphi_psnecl = nullptr
protected

Definition at line 121 of file TRGEfficiencyDQMModule.h.

◆ m_fyo_dphi_psnecl_ftdf

TH1F* m_fyo_dphi_psnecl_ftdf = nullptr
protected

Definition at line 122 of file TRGEfficiencyDQMModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_hie_E

TH1F* m_hie_E = nullptr
protected

Definition at line 154 of file TRGEfficiencyDQMModule.h.

◆ m_hie_E_psnecl

TH1F* m_hie_E_psnecl = nullptr
protected

Definition at line 155 of file TRGEfficiencyDQMModule.h.

◆ m_hie_E_psnecl_ftdf

TH1F* m_hie_E_psnecl_ftdf = nullptr
protected

Definition at line 156 of file TRGEfficiencyDQMModule.h.

◆ m_HltResult

StoreObjPtr<SoftwareTriggerResult> m_HltResult
protected

HLT result.

Definition at line 74 of file TRGEfficiencyDQMModule.h.

◆ m_hP3_y

TH1F* m_hP3_y = nullptr
protected

Definition at line 98 of file TRGEfficiencyDQMModule.h.

◆ m_hP3_y_psnecl

TH1F* m_hP3_y_psnecl = nullptr
protected

Definition at line 99 of file TRGEfficiencyDQMModule.h.

◆ m_hP3_y_psnecl_ftdf

TH1F* m_hP3_y_psnecl_ftdf = nullptr
protected

Definition at line 100 of file TRGEfficiencyDQMModule.h.

◆ m_hP3_z

TH1F* m_hP3_z = nullptr
protected

Definition at line 93 of file TRGEfficiencyDQMModule.h.

◆ m_hP3_z_psnecl

TH1F* m_hP3_z_psnecl = nullptr
protected

Definition at line 94 of file TRGEfficiencyDQMModule.h.

◆ m_hP3_z_psnecl_ftdf

TH1F* m_hP3_z_psnecl_ftdf = nullptr
protected

Definition at line 95 of file TRGEfficiencyDQMModule.h.

◆ m_hPhi

TH1F* m_hPhi = nullptr
protected

Histogram of cdc phi of IP tracks.

Definition at line 76 of file TRGEfficiencyDQMModule.h.

◆ m_hPhi_psnecl

TH1F* m_hPhi_psnecl = nullptr
protected

Histogram of cdc phi of IP tracks with ecl bit.

Definition at line 77 of file TRGEfficiencyDQMModule.h.

◆ m_hPhi_psnecl_ftdf

TH1F* m_hPhi_psnecl_ftdf = nullptr
protected

Histogram of cdc phi of IP tracks with ecl and f bit.

Definition at line 78 of file TRGEfficiencyDQMModule.h.

◆ m_hPt

TH1F* m_hPt = nullptr
protected

Definition at line 80 of file TRGEfficiencyDQMModule.h.

◆ m_hPt_psnecl

TH1F* m_hPt_psnecl = nullptr
protected

Definition at line 81 of file TRGEfficiencyDQMModule.h.

◆ m_hPt_psnecl_ftdf

TH1F* m_hPt_psnecl_ftdf = nullptr
protected

Definition at line 82 of file TRGEfficiencyDQMModule.h.

◆ m_KLMClusters

StoreArray<KLMCluster> m_KLMClusters
protected

KLM Clusters.

Definition at line 72 of file TRGEfficiencyDQMModule.h.

◆ m_klmhit_phi

TH1F* m_klmhit_phi = nullptr
protected

Definition at line 176 of file TRGEfficiencyDQMModule.h.

◆ m_klmhit_phi_psnecl

TH1F* m_klmhit_phi_psnecl = nullptr
protected

Definition at line 177 of file TRGEfficiencyDQMModule.h.

◆ m_klmhit_phi_psnecl_ftdf

TH1F* m_klmhit_phi_psnecl_ftdf = nullptr
protected

Definition at line 178 of file TRGEfficiencyDQMModule.h.

◆ m_klmhit_theta

TH1F* m_klmhit_theta = nullptr
protected

Definition at line 180 of file TRGEfficiencyDQMModule.h.

◆ m_klmhit_theta_psnecl

TH1F* m_klmhit_theta_psnecl = nullptr
protected

Definition at line 181 of file TRGEfficiencyDQMModule.h.

◆ m_klmhit_theta_psnecl_ftdf

TH1F* m_klmhit_theta_psnecl_ftdf = nullptr
protected

Definition at line 182 of file TRGEfficiencyDQMModule.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_nobha_f_phi

TH1F* m_nobha_f_phi = nullptr
protected

Definition at line 84 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_f_phi_psnecl

TH1F* m_nobha_f_phi_psnecl = nullptr
protected

Definition at line 85 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_f_phi_psnecl_ftdf

TH1F* m_nobha_f_phi_psnecl_ftdf = nullptr
protected

Definition at line 86 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_fyo_dphi

TH1F* m_nobha_fyo_dphi = nullptr
protected

Definition at line 124 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_fyo_dphi_psnecl

TH1F* m_nobha_fyo_dphi_psnecl = nullptr
protected

Definition at line 125 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_fyo_dphi_psnecl_ftdf

TH1F* m_nobha_fyo_dphi_psnecl_ftdf = nullptr
protected

Definition at line 126 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hie_E

TH1F* m_nobha_hie_E = nullptr
protected

Definition at line 158 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hie_E_psnecl

TH1F* m_nobha_hie_E_psnecl = nullptr
protected

Definition at line 159 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hie_E_psnecl_ftdf

TH1F* m_nobha_hie_E_psnecl_ftdf = nullptr
protected

Definition at line 160 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hP3_y

TH1F* m_nobha_hP3_y = nullptr
protected

Definition at line 107 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hP3_y_psnecl

TH1F* m_nobha_hP3_y_psnecl = nullptr
protected

Definition at line 108 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hP3_y_psnecl_ftdf

TH1F* m_nobha_hP3_y_psnecl_ftdf = nullptr
protected

Definition at line 109 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hP3_z

TH1F* m_nobha_hP3_z = nullptr
protected

Definition at line 103 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hP3_z_psnecl

TH1F* m_nobha_hP3_z_psnecl = nullptr
protected

Definition at line 104 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hP3_z_psnecl_ftdf

TH1F* m_nobha_hP3_z_psnecl_ftdf = nullptr
protected

Definition at line 105 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hPt

TH1F* m_nobha_hPt = nullptr
protected

Definition at line 88 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hPt_psnecl

TH1F* m_nobha_hPt_psnecl = nullptr
protected

Definition at line 89 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_hPt_psnecl_ftdf

TH1F* m_nobha_hPt_psnecl_ftdf = nullptr
protected

Definition at line 90 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_phi_y

TH1F* m_nobha_phi_y = nullptr
protected

Definition at line 115 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_phi_y_psnecl

TH1F* m_nobha_phi_y_psnecl = nullptr
protected

Definition at line 116 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_phi_y_psnecl_ftdf

TH1F* m_nobha_phi_y_psnecl_ftdf = nullptr
protected

Definition at line 117 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_phi_z

TH1F* m_nobha_phi_z = nullptr
protected

Definition at line 111 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_phi_z_psnecl

TH1F* m_nobha_phi_z_psnecl = nullptr
protected

Definition at line 112 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_phi_z_psnecl_ftdf

TH1F* m_nobha_phi_z_psnecl_ftdf = nullptr
protected

Definition at line 113 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_P3

TH1F* m_nobha_stt_P3 = nullptr
protected

Definition at line 145 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_P3_psnecl

TH1F* m_nobha_stt_P3_psnecl = nullptr
protected

Definition at line 146 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_P3_psnecl_ftdf

TH1F* m_nobha_stt_P3_psnecl_ftdf = nullptr
protected

Definition at line 147 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_phi

TH1F* m_nobha_stt_phi = nullptr
protected

Definition at line 141 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_phi_psnecl

TH1F* m_nobha_stt_phi_psnecl = nullptr
protected

Definition at line 142 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_phi_psnecl_ftdf

TH1F* m_nobha_stt_phi_psnecl_ftdf = nullptr
protected

Definition at line 143 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_theta

TH1F* m_nobha_stt_theta = nullptr
protected

Definition at line 149 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_theta_psnecl

TH1F* m_nobha_stt_theta_psnecl = nullptr
protected

Definition at line 150 of file TRGEfficiencyDQMModule.h.

◆ m_nobha_stt_theta_psnecl_ftdf

TH1F* m_nobha_stt_theta_psnecl_ftdf = nullptr
protected

Definition at line 151 of file TRGEfficiencyDQMModule.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_stt_P3

TH1F* m_stt_P3 = nullptr
protected

Definition at line 133 of file TRGEfficiencyDQMModule.h.

◆ m_stt_P3_psnecl

TH1F* m_stt_P3_psnecl = nullptr
protected

Definition at line 134 of file TRGEfficiencyDQMModule.h.

◆ m_stt_P3_psnecl_ftdf

TH1F* m_stt_P3_psnecl_ftdf = nullptr
protected

Definition at line 135 of file TRGEfficiencyDQMModule.h.

◆ m_stt_phi

TH1F* m_stt_phi = nullptr
protected

Definition at line 129 of file TRGEfficiencyDQMModule.h.

◆ m_stt_phi_psnecl

TH1F* m_stt_phi_psnecl = nullptr
protected

Definition at line 130 of file TRGEfficiencyDQMModule.h.

◆ m_stt_phi_psnecl_ftdf

TH1F* m_stt_phi_psnecl_ftdf = nullptr
protected

Definition at line 131 of file TRGEfficiencyDQMModule.h.

◆ m_stt_theta

TH1F* m_stt_theta = nullptr
protected

Definition at line 137 of file TRGEfficiencyDQMModule.h.

◆ m_stt_theta_psnecl

TH1F* m_stt_theta_psnecl = nullptr
protected

Definition at line 138 of file TRGEfficiencyDQMModule.h.

◆ m_stt_theta_psnecl_ftdf

TH1F* m_stt_theta_psnecl_ftdf = nullptr
protected

Definition at line 139 of file TRGEfficiencyDQMModule.h.

◆ m_Tracks

StoreArray<Track> m_Tracks
protected

Tracks.

Definition at line 70 of file TRGEfficiencyDQMModule.h.

◆ m_TrgSummary

StoreObjPtr<TRGSummary> m_TrgSummary
protected

Trigger summary.

Definition at line 73 of file TRGEfficiencyDQMModule.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.


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