Module for channel-by-channel gain/efficiency analysis. More...

#include <TOPGainEfficiencyCalculatorModule.h>

Inheritance diagram for TOPGainEfficiencyCalculatorModule:

Public Types
enum	{ c_NParameterGainFit = 6 }
	enum for the number of parameters used in fitting charge distribution More...

enum	{ c_NPlotsPerChannel = 3 , c_NChannelPerPage = 4 }
	enum for the number of channels to show the result plots per page in an output PDF file More...

enum	EHistogramType { c_LoadForFitHeight = 1 , c_LoadHitRateHeight = 2 , c_LoadForFitIntegral = 3 , c_LoadHitRateIntegral = 4 }
	enum for LoadHistograms switch. More...

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
	TOPGainEfficiencyCalculatorModule ()
	Constructor.

virtual	~TOPGainEfficiencyCalculatorModule ()
	Destructor.

virtual void	initialize () override
	Load time vs charge 2D histogram from a given input file (paramter "inputFile") and prepare hit timing and pulse charge distribution for each channel.

virtual void	beginRun () override
	The main processes, fitting charge distribution and calculating gain/efficiency, are done in this function.

virtual void	event () override
	This will be empty as the all the processes are done in beginRun() function thus input file can be a dummy file.

virtual void	endRun () override
	Draw plots to show fitting results for each channel and save them into a given PDF file (outputPDFFile).

virtual void	terminate () override
	Termination action.

virtual void	defineHisto () override
	Define TTree branches to store fit results for each channel This TTree is saved in an output file given by "histoFileName" parameter of "HistoManager" module.

void	LoadHistograms (const std::string &histotype)
	Load 2D histograms from a given input file (output of TOPLaserHitSelector) and create timing and charge distribution as projection histograms for the x- and y-axis, respectively.

void	FitHistograms (EHistogramType LoadHisto)
	Fit charge (or integrated charged) distribution to calculate gain and efficiency for each channel.

void	DummyFillBranch (EHistogramType LoadHisto)
	Fill Dummy for Branch.

void	DrawResult (const std::string &histotype, EHistogramType LoadHisto)
	Draw results of gain/efficiency calculation for each channel to a given output file.

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 double	TOPGainFunc (double var, double par)
	Fit function of pulse charge (or charnge) distribution for channel(pixel)-by-channel gain extraction, given by "[0]pow(x-[4],[1])exp(-pow(x-[4],[2])/[3])" smeared by Gaussian with a constant sigma to consider baseline fluctuation.

static double	FindPeakForSmallerXThan (TH1 *histo, double xmax=0)
	Find peak and return its position for a limited range of x (x smaller than the given value (xmax))

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
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
TTree *	m_tree = 0
	ntuple to store summary

std::vector< TBranch * >	m_branch [4]
	ntuple to store summary of gain using height distribution.

TH2F *	m_timeChargeHistogram [c_NChannelPerPMT] = {}
	2D histogram of hit timing and pulse charge (or charge), taken from an output file of TOPLaserHitSelector

TH1D *	m_timeHistogram [c_NChannelPerPMT] = {}
	hit timing distribution, extracted from m_timeChargeHistogram as a projection along its x-axis.

TH1D *	m_chargeHistogram [c_NChannelPerPMT] = {}
	pulse charge distribution, extracted from m_timeChargeHistogram as a projection along its y-axis with timing cut.

TH1F *	m_nCalPulseHistogram
	histogram to store the number of events with calibration pulse(s) identified for each asic (1,024) in total

TF1 *	m_funcForLaser [c_NChannelPerPMT] = {}
	array of TF1 pointer to store fit function for hit timing distribution

TF1 *	m_funcForFitRange [c_NChannelPerPMT] = {}
	array of TF1 pointer to store fit function for pulse charge distribution, defined only for fit region

TF1 *	m_funcForFullRange [c_NChannelPerPMT] = {}
	array of TF1 pointer to store fit function for pulse charge distribution, defined only for full range of pulse charge

std::string	m_inputFile = ""
	input file containing timing vs charge 2D histograms (output of TOPLaserHitSelector)

std::string	m_outputPDFFile
	output PDF file to store plots of 2D histogram, timing, and charge distribution for each channel

std::string	m_fitoption
	charge histograms fitting option.

short	m_targetSlotId = 0
	slot ID

short	m_targetPmtId = 0
	PMT ID.

short	m_targetPmtChId = -1
	PMT channel ID.

short	m_hvDiff = 0
	HV difference from nominal HV value.

float	m_fitHalfWidth = 1.
	half fit width for direct laser hit peak in [ns] unit

float	m_threshold = 100
	pulse charge threshold, which defines lower limit of fit region and efficiency calculation

float	m_thresholdForIntegral
	pulse integral threshold, which defines lower limit of fit region and efficiency calculation

float	m_p0HeightIntegral = -50.0
	Parameter from p0 + x*p1 function that fits height-integral distribution.

float	m_p1HeightIntegral = 6.0
	Parameter from p0 + x*p1 function that fits height-integral distribution.

float	m_fitMax = 0
	upper limit of fit region for pulse charge distribution, determined based on m_fracFit value

float	m_fracFit = 0.99
	fraction of events which are covered by an area [0,m_fitMax]

float	m_initialP0 = (float)(-1.)
	initial value of the fit parameter p0

float	m_initialP1 = (float)(-1.)
	initial value of the fit parameter p1

float	m_initialP2 = (float)(-1.)
	initial value of the fit parameter p2

float	m_initialX0 = (float)(-1.)
	initial value of the fit parameter x0

float	m_pedestalSigma = 10.
	sigma of pedestal

short	m_pixelId = 0
	pixel ID, calculated from PMT ID and PMT channel ID

short	m_pmtChId = 0
	PMT channel ID.

float	m_hitTiming = 0
	timing of laser direct photon hits, given by Gaussian fit mean

float	m_hitTimingSigma = 0
	Gaussian fit sigma for a peak of laser direct photons in hit timing distribution.

int	m_nEntries = 0
	entries of pulse charge distribution

int	m_nCalPulse = 0
	the number of events with calibration pulse(s) identified

int	m_nOverflowEvents = 0
	the number of events outside histogram range

float	m_meanPulseHeight = 0
	histogram mean of pulse height distribution

float	m_meanPulseHeightError = 0
	histogram mean error of pulse height distribution

float	m_gain = 0
	calculated gain from fitting of pulse charge distribution

float	m_efficiency = 0
	calculated efficiency from fitting of pulse charge distribution

float	m_p0 = 0
	fit result of p0

float	m_p1 = 0
	fit result of p1

float	m_p2 = 0
	fit result of p2

float	m_x0 = 0
	fit result of x0

float	m_p0Error = 0
	fit error of p0

float	m_p1Error = 0
	fit error of p1

float	m_p2Error = 0
	fit error of p2

float	m_x0Error = 0
	fit error of x0

float	m_chisquare = 0
	chi2 of fitting

int	m_ndf = 0
	NDF of fitting.

float	m_funcFullRangeIntegral = 0
	integral of fit function for its full range

float	m_funcFitRangeIntegral = 0
	integral of fit function for a range [threshold, fitMax]

float	m_histoFitRangeIntegral = 0
	integral of histogram for a range [threshold, fitMax]

float	m_histoMeanAboveThre = 0
	mean of histogram above threshold, ignore overflow bin

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

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

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

std::string	m_description
	The description of the module.

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

LogConfig	m_logConfig
	The log system configuration of the module.

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

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

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

Detailed Description

Module for channel-by-channel gain/efficiency analysis.

2D histograms of hit timing and charge (integral or pulse height), crated by TOPLaserHitSelectorModule,

Definition at line 32 of file TOPGainEfficiencyCalculatorModule.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

◆ anonymous enum

anonymous enum

enum for the number of parameters used in fitting charge distribution

Definition at line 39 of file TOPGainEfficiencyCalculatorModule.h.

39{ c_NParameterGainFit = 6 };

◆ anonymous enum

anonymous enum

enum for the number of channels to show the result plots per page in an output PDF file

Definition at line 44 of file TOPGainEfficiencyCalculatorModule.h.

44{ c_NPlotsPerChannel = 3, c_NChannelPerPage = 4 };

◆ EHistogramType

enum EHistogramType

enum for LoadHistograms switch.

CS means Charge Share. IsoratedHit is used for gain calc. and IncludePrimaryCS is used for efficiency calc..

Definition at line 49 of file TOPGainEfficiencyCalculatorModule.h.

                        { c_LoadForFitHeight = 1, c_LoadHitRateHeight = 2,
                          c_LoadForFitIntegral = 3, c_LoadHitRateIntegral = 4
                        };

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

Member Function Documentation

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

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

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://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 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

See https://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);
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

Member Data Documentation

◆ m_branch

std::vector<TBranch*> m_branch[4]

private

ntuple to store summary of gain using height distribution.

It will be merged to m_tree

Definition at line 135 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_chargeHistogram

TH1D* m_chargeHistogram[c_NChannelPerPMT] = {}

private

pulse charge distribution, extracted from m_timeChargeHistogram as a projection along its y-axis with timing cut.

Used gain/efficiency calculation.

Definition at line 139 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_chisquare

float m_chisquare = 0

private

chi2 of fitting

Definition at line 191 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_efficiency

float m_efficiency = 0

private

calculated efficiency from fitting of pulse charge distribution

Definition at line 182 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_fitHalfWidth

float m_fitHalfWidth = 1.

private

half fit width for direct laser hit peak in [ns] unit

Definition at line 158 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_fitMax

float m_fitMax = 0

private

upper limit of fit region for pulse charge distribution, determined based on m_fracFit value

Definition at line 164 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_fitoption

std::string m_fitoption

private

Initial value:

=

"L"

charge histograms fitting option.

type R for chisquare fit. type L for likelihood fit(default)

Definition at line 150 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_fracFit

float m_fracFit = 0.99

private

fraction of events which are covered by an area [0,m_fitMax]

Definition at line 165 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_funcFitRangeIntegral

float m_funcFitRangeIntegral = 0

private

integral of fit function for a range [threshold, fitMax]

Definition at line 194 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_funcForFitRange

TF1* m_funcForFitRange[c_NChannelPerPMT] = {}

private

array of TF1 pointer to store fit function for pulse charge distribution, defined only for fit region

Definition at line 143 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_funcForFullRange

TF1* m_funcForFullRange[c_NChannelPerPMT] = {}

private

array of TF1 pointer to store fit function for pulse charge distribution, defined only for full range of pulse charge

Definition at line 144 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_funcForLaser

TF1* m_funcForLaser[c_NChannelPerPMT] = {}

private

array of TF1 pointer to store fit function for hit timing distribution

Definition at line 142 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_funcFullRangeIntegral

float m_funcFullRangeIntegral = 0

private

integral of fit function for its full range

Definition at line 193 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_gain

float m_gain = 0

private

calculated gain from fitting of pulse charge distribution

Definition at line 181 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_histoFitRangeIntegral

float m_histoFitRangeIntegral = 0

private

integral of histogram for a range [threshold, fitMax]

Definition at line 195 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_histoMeanAboveThre

float m_histoMeanAboveThre = 0

private

mean of histogram above threshold, ignore overflow bin

Definition at line 196 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_hitTiming

float m_hitTiming = 0

private

timing of laser direct photon hits, given by Gaussian fit mean

Definition at line 174 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_hitTimingSigma

float m_hitTimingSigma = 0

private

Gaussian fit sigma for a peak of laser direct photons in hit timing distribution.

Definition at line 175 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_hvDiff

short m_hvDiff = 0

private

HV difference from nominal HV value.

Use it when you analyze HV scan data.

Definition at line 156 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_initialP0

float m_initialP0 = (float)(-1.)

private

initial value of the fit parameter p0

Definition at line 166 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_initialP1

float m_initialP1 = (float)(-1.)

private

initial value of the fit parameter p1

Definition at line 167 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_initialP2

float m_initialP2 = (float)(-1.)

private

initial value of the fit parameter p2

Definition at line 168 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_initialX0

float m_initialX0 = (float)(-1.)

private

initial value of the fit parameter x0

Definition at line 169 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_inputFile

std::string m_inputFile = ""

private

input file containing timing vs charge 2D histograms (output of TOPLaserHitSelector)

Definition at line 146 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_meanPulseHeight

float m_meanPulseHeight = 0

private

histogram mean of pulse height distribution

Definition at line 179 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_meanPulseHeightError

float m_meanPulseHeightError = 0

private

histogram mean error of pulse height distribution

Definition at line 180 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

◆ m_nCalPulse

int m_nCalPulse = 0

private

the number of events with calibration pulse(s) identified

Definition at line 177 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_nCalPulseHistogram

TH1F* m_nCalPulseHistogram

private

Initial value:

=

0

histogram to store the number of events with calibration pulse(s) identified for each asic (1,024) in total

Definition at line 140 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_ndf

int m_ndf = 0

private

NDF of fitting.

Definition at line 192 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_nEntries

int m_nEntries = 0

private

entries of pulse charge distribution

Definition at line 176 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_nOverflowEvents

int m_nOverflowEvents = 0

private

the number of events outside histogram range

Definition at line 178 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_outputPDFFile

std::string m_outputPDFFile

private

Initial value:

=

""

output PDF file to store plots of 2D histogram, timing, and charge distribution for each channel

Definition at line 147 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p0

float m_p0 = 0

private

fit result of p0

Definition at line 183 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p0Error

float m_p0Error = 0

private

fit error of p0

Definition at line 187 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p0HeightIntegral

float m_p0HeightIntegral = -50.0

private

Parameter from p0 + x*p1 function that fits height-integral distribution.

Definition at line 162 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p1

float m_p1 = 0

private

fit result of p1

Definition at line 184 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p1Error

float m_p1Error = 0

private

fit error of p1

Definition at line 188 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p1HeightIntegral

float m_p1HeightIntegral = 6.0

private

Parameter from p0 + x*p1 function that fits height-integral distribution.

Definition at line 163 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p2

float m_p2 = 0

private

fit result of p2

Definition at line 185 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_p2Error

float m_p2Error = 0

private

fit error of p2

Definition at line 189 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

◆ m_pedestalSigma

float m_pedestalSigma = 10.

private

sigma of pedestal

Definition at line 170 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_pixelId

short m_pixelId = 0

private

pixel ID, calculated from PMT ID and PMT channel ID

Definition at line 172 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_pmtChId

short m_pmtChId = 0

private

PMT channel ID.

Definition at line 173 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_targetPmtChId

short m_targetPmtChId = -1

private

PMT channel ID.

Definition at line 155 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_targetPmtId

short m_targetPmtId = 0

private

PMT ID.

Definition at line 154 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_targetSlotId

short m_targetSlotId = 0

private

slot ID

Definition at line 153 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_threshold

float m_threshold = 100

private

pulse charge threshold, which defines lower limit of fit region and efficiency calculation

Definition at line 159 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_thresholdForIntegral

float m_thresholdForIntegral

private

Initial value:

=

550

pulse integral threshold, which defines lower limit of fit region and efficiency calculation

Definition at line 160 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_timeChargeHistogram

TH2F* m_timeChargeHistogram[c_NChannelPerPMT] = {}

private

2D histogram of hit timing and pulse charge (or charge), taken from an output file of TOPLaserHitSelector

Definition at line 137 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_timeHistogram

TH1D* m_timeHistogram[c_NChannelPerPMT] = {}

private

hit timing distribution, extracted from m_timeChargeHistogram as a projection along its x-axis.

Used to define direct laser photon hit timing

Definition at line 138 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_tree

TTree* m_tree = 0

private

ntuple to store summary

Definition at line 134 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_x0

float m_x0 = 0

private

fit result of x0

Definition at line 186 of file TOPGainEfficiencyCalculatorModule.h.

◆ m_x0Error

float m_x0Error = 0

private

fit error of x0

Definition at line 190 of file TOPGainEfficiencyCalculatorModule.h.

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

top/modules/TOPGainEfficiencyMonitor/include/TOPGainEfficiencyCalculatorModule.h
top/modules/TOPGainEfficiencyMonitor/src/TOPGainEfficiencyCalculatorModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ EHistogramType

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ evalCondition()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_branch

◆ m_chargeHistogram

◆ m_chisquare

◆ m_conditions

◆ m_description

◆ m_efficiency

◆ m_fitHalfWidth

◆ m_fitMax

◆ m_fitoption

◆ m_fracFit

◆ m_funcFitRangeIntegral

◆ m_funcForFitRange

◆ m_funcForFullRange

◆ m_funcForLaser

◆ m_funcFullRangeIntegral

◆ m_gain

◆ m_hasReturnValue

◆ m_histoFitRangeIntegral

◆ m_histoMeanAboveThre