KLMEventT0EstimatorModule Class Reference

Estimate per-event T0 using KLM (BKLM scint, BKLM RPC, EKLM scint). More...

#include <KLMEventT0EstimatorModule.h>

Inheritance diagram for KLMEventT0EstimatorModule:

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
void	defineHisto () override
	Definition of histograms (called once by HistoManager).
void	initialize () override
	Register inputs/params; get geometry; call REG_HISTOGRAM.
void	beginRun () override
	Per-run resets if desired (histos remain booked).
void	event () override
	Per-event algorithm: collect hits, compute residuals, fill outputs.
void	endRun () override
	Called when the current run ends.
void	terminate () override
	Called at the end of processing.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T>
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T>
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T>
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Types
using	ExtMap = std::multimap<unsigned int, Belle2::ExtHit>
	Multimap of ExtHit objects keyed by channel or module number.
using	ExtPair = std::pair<Belle2::ExtHit*, Belle2::ExtHit*>
	Pair of entry and exit ExtHit pointers.

Private Member Functions
bool	passesADCCut (double charge, int subdetector, int layer, bool inRPC) const
	Check if a digit passes the ADC charge cut.
void	collectExtrapolatedHits (const Track *track, ExtMap &scintMap, ExtMap &rpcMap)
	Build maps of extrapolated hits for a track (scint: channel key; RPC: module key).
ExtPair	matchExt (unsigned int key, ExtMap &v_ExtHits)
	Find earliest (entry) and latest (exit) ExtHits matching a key (channel or module).
double	getHitSigma (int subdetector, int layer, bool inRPC, int plane=0) const
	Get per-hit sigma for a digit based on detector category.
void	accumulateEKLM (const RelationVector< KLMHit2d > &, const ExtMap &, double &sumW, double &sumWT)
	Accumulate EKLM scintillator per-digit T0 estimates (weighted).
void	accumulateBKLMScint (RelationVector< KLMHit2d > &, const ExtMap &, double &sumW, double &sumWT)
	Accumulate BKLM scintillator per-digit T0 estimates (weighted).
void	accumulateBKLMRPC (RelationVector< KLMHit2d > &klmHit2ds, const ExtMap &rpcMap, double &sumW, double &sumWT)
	Accumulate BKLM RPC per-digit T0 estimates (weighted, both readout directions).
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
double	m_ADCCut_BKLM_Scint_Min
	Minimum ADC cut for BKLM scintillator.
double	m_ADCCut_BKLM_Scint_Max
	Maximum ADC cut for BKLM scintillator.
double	m_ADCCut_EKLM_Scint_Min
	Minimum ADC cut for EKLM scintillator.
double	m_ADCCut_EKLM_Scint_Max
	Maximum ADC cut for EKLM scintillator.
std::string	m_MuonListName
	Input ParticleList (e.g.
bool	m_useCDCTemporaryT0 {true}
	Use CDC temporary EventT0 as a diagnostic seed (not applied to averaging).
bool	m_ignoreBackward {false}
	Ignore backward-propagated ExtHits when forming entry/exit pairs.
std::string	m_histDirName
	Parent directory inside the ROOT file (HistoManager) for this module.
std::string	m_histSubdirUncorr {"uncorrected"}
	Subdirectory name for uncorrected timing histograms.
Belle2::bklm::GeometryPar *	m_geoParB {nullptr}
	BKLM geometry.
const Belle2::EKLM::GeometryData *	m_geoParE {nullptr}
	EKLM geometry data.
Belle2::EKLM::TransformData *	m_transformE {nullptr}
	EKLM strip transformation data.
const KLMElementNumbers *	m_elementNum {&KLMElementNumbers::Instance()}
	Element numbering helpers.
DBObjPtr< KLMChannelStatus >	m_channelStatus
	Channel status (Normal/Dead/etc.).
DBObjPtr< KLMEventT0HitResolution >	m_eventT0HitResolution
	Per-hit time resolution for EventT0 estimation.
StoreObjPtr< ParticleList >	m_MuonList
	Selected muon particle list.
StoreArray< Track >	m_tracks
	Reconstructed tracks.
ExtMap	m_extScint
	Extrapolated hits keyed by channel number (scintillator).
ExtMap	m_extRPC
	Extrapolated hits keyed by module number (RPC).
double	m_seedT0 {0.0}
	Optional seed from CDC (for logging only).
TH1D *	m_hT0Trk_BKLM_Scint {nullptr}
	Per-track T0 for BKLM scintillator [ns].
TH1D *	m_hT0Trk_BKLM_RPC {nullptr}
	Per-track T0 for BKLM RPC [ns].
TH1D *	m_hT0Trk_EKLM_Scint {nullptr}
	Per-track T0 for EKLM scintillator [ns].
TH1D *	m_hT0Evt_TrkAvg_BKLM_Scint {nullptr}
	Per-event T0 track-average for BKLM scintillator (mean) [ns].
TH1D *	m_hT0Evt_TrkAvg_BKLM_RPC {nullptr}
	Per-event T0 track-average for BKLM RPC (mean) [ns].
TH1D *	m_hT0Evt_TrkAvg_EKLM_Scint {nullptr}
	Per-event T0 track-average for EKLM scintillator (mean) [ns].
TH1D *	m_hT0Evt_TrkAvg_All {nullptr}
	Per-event T0 track-average combined (mean) [ns].
TH1D *	m_hT0Evt_TrkAvg_BKLM_Scint_SEM {nullptr}
	Per-event T0 track-average for BKLM scintillator (SEM) [ns].
TH1D *	m_hT0Evt_TrkAvg_BKLM_RPC_SEM {nullptr}
	Per-event T0 track-average for BKLM RPC (SEM) [ns].
TH1D *	m_hT0Evt_TrkAvg_EKLM_Scint_SEM {nullptr}
	Per-event T0 track-average for EKLM scintillator (SEM) [ns].
TH1D *	m_hT0Evt_TrkAvg_All_SEM {nullptr}
	Per-event T0 track-average combined (SEM) [ns].
TH1I *	m_hFinalSource {nullptr}
	Final EventT0 source selection (7 bins).
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

Estimate per-event T0 using KLM (BKLM scint, BKLM RPC, EKLM scint).

Inputs:

• ParticleList (tracks with relations to KLMHit2d and ExtHit)
• KLM conditions (time constants, cable delays, channel status, calibrated per-hit resolution)
• BKLM/EKLM geometry for propagation distances and transforms

Outputs:

• A single KLM EventT0 component per event (combination of all available categories: BKLM-Scint, BKLM-RPC, EKLM-Scint) saved via addTemporaryEventT0 and setEventT0.
• Monitoring histograms under histogramDirectoryName with subdirectories: per_track/ — per-track T0 by detector category per_event/ — per-event track-averages and SEMs final/ — final combined EventT0 and source audit

Validation histograms (pulls, residuals, dimuon ΔT0, pairwise sector analysis, cross-detector ΔT0) are handled separately by KLMEventT0ValidationModule in klm/validation/KLMEventT0Validation.py.

Definition at line 82 of file KLMEventT0EstimatorModule.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.

ExtMap

using ExtMap = std::multimap<unsigned int, Belle2::ExtHit>

private

Multimap of ExtHit objects keyed by channel or module number.

Definition at line 110 of file KLMEventT0EstimatorModule.h.

ExtPair

using ExtPair = std::pair<Belle2::ExtHit*, Belle2::ExtHit*>

private

Pair of entry and exit ExtHit pointers.

Definition at line 113 of file KLMEventT0EstimatorModule.h.

Member Enumeration Documentation

EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

KLMEventT0EstimatorModule()

KLMEventT0EstimatorModule

(

)

Definition at line 30 of file KLMEventT0EstimatorModule.cc.

                                                     :
  HistoModule(),
  m_geoParB(nullptr),
  m_geoParE(nullptr),
  m_transformE(nullptr)
{
  setDescription("Estimate per-event T0 using KLM digits matched to extrapolated tracks (BKLM/EKLM scintillators and RPC) with per-event track averages, uncertainties, and final combined KLM value.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("MuonListName", m_MuonListName,
           "Muon (or generic) ParticleList name used to access tracks and KLM relations (e.g. 'mu+:forT0').",
           std::string("mu+:forT0"));
  addParam("useCDCTemporaryT0", m_useCDCTemporaryT0,
           "Read CDC temporary EventT0 as a seed/diagnostic (not applied to the mean).",
           true);
  addParam("IgnoreBackwardPropagation", m_ignoreBackward,
           "Ignore backward-propagated ExtHits when forming entry/exit pairs.",
           false);
  addParam("histogramDirectoryName", m_histDirName,
           "Top directory for KLMEventT0Estimator histograms inside the ROOT file.",
           std::string("KLMEventT0Estimator"));
  addParam("histogramSubdirUncorrected", m_histSubdirUncorr,
           "Subdirectory name for uncorrected timing histograms.",
           std::string("uncorrected"));
 
  // ADC cut parameters
  addParam("ADCCut_BKLM_Scint_Min", m_ADCCut_BKLM_Scint_Min,
           "Minimum ADC charge cut for BKLM scintillator. Set to 0 to disable lower cut.",
           30.0);
  addParam("ADCCut_BKLM_Scint_Max", m_ADCCut_BKLM_Scint_Max,
           "Maximum ADC charge cut for BKLM scintillator. Set to large value to disable upper cut.",
           320.0);
  addParam("ADCCut_EKLM_Scint_Min", m_ADCCut_EKLM_Scint_Min,
           "Minimum ADC charge cut for EKLM scintillator. Set to 0 to disable lower cut.",
           40.0);
  addParam("ADCCut_EKLM_Scint_Max", m_ADCCut_EKLM_Scint_Max,
           "Maximum ADC charge cut for EKLM scintillator. Set to large value to disable upper cut.",
           350.0);
 
}

~KLMEventT0EstimatorModule()

~KLMEventT0EstimatorModule ( )

override

Definition at line 71 of file KLMEventT0EstimatorModule.cc.

{
  delete m_transformE;
}

Member Function Documentation

accumulateBKLMRPC()

void accumulateBKLMRPC ( RelationVector< KLMHit2d > & klmHit2ds, const ExtMap & rpcMap, double & sumW, double & sumWT )

private

Accumulate BKLM RPC per-digit T0 estimates (weighted, both readout directions).

Parameters

[in]	klmHit2ds	KLM 2D hits associated with the track.
[in]	rpcMap	Map of extrapolated RPC hits keyed by module number.
[out]	sumW	Sum of inverse-variance weights.
[out]	sumWT	Sum of weight times time.

Definition at line 475 of file KLMEventT0EstimatorModule.cc.

{
  DBObjPtr<KLMTimeConstants> timeConstants;
  DBObjPtr<KLMTimeCableDelay> timeCableDelay;
 
  const double delayPhi = timeConstants.isValid()
                          ? timeConstants->getDelay(KLMTimeConstants::c_RPCPhi)
                          : 0.0;
  const double delayZ   = timeConstants.isValid()
                          ? timeConstants->getDelay(KLMTimeConstants::c_RPCZ)
                          : 0.0;
 
  for (KLMHit2d& hit2d : klmHit2ds) {
    if (hit2d.getSubdetector() != KLMElementNumbers::c_BKLM) continue;
    if (!hit2d.inRPC()) continue;
    if (hit2d.isOutOfTime()) continue;
 
    RelationVector<BKLMHit1d> b1ds = hit2d.getRelationsTo<BKLMHit1d>();
    if (b1ds.size() == 0) continue;
 
    const bklm::Module* mod = m_geoParB->findModule(hit2d.getSection(), hit2d.getSector(), hit2d.getLayer());
    const ROOT::Math::XYZVector posG2d = hit2d.getPosition();
 
    for (const BKLMHit1d& h1d : b1ds) {
      const bool isPhi = h1d.isPhiReadout();
      RelationVector<KLMDigit> digits = h1d.getRelationsTo<KLMDigit>();
 
      for (const KLMDigit& d : digits) {
        if (!d.inRPC()) continue;
 
        unsigned int cid = d.getUniqueChannelID();
        if (m_channelStatus.isValid() &&
            m_channelStatus->getChannelStatus(cid) != KLMChannelStatus::c_Normal) continue;
 
        if (!d.isGood()) continue;
 
        // RPC matched by module key
        unsigned int moduleKey = m_elementNum->moduleNumber(d.getSubdetector(), d.getSection(), d.getSector(), d.getLayer());
        ExtPair p = const_cast<KLMEventT0EstimatorModule*>(this)->matchExt(moduleKey, const_cast<ExtMap&>(rpcMap));
        if (!p.first || !p.second) continue;
 
        const double flyTime = 0.5 * (p.first->getTOF() + p.second->getTOF());
        const ROOT::Math::XYZVector posGext = 0.5 * (p.first->getPosition() + p.second->getPosition());
 
        const CLHEP::Hep3Vector locExt  = mod->globalToLocal(CLHEP::Hep3Vector(posGext.X(), posGext.Y(), posGext.Z()), true);
        const CLHEP::Hep3Vector locHit2 = mod->globalToLocal(CLHEP::Hep3Vector(posG2d.X(),  posG2d.Y(),  posG2d.Z()),  true);
 
        const CLHEP::Hep3Vector diff = locExt - locHit2;
        if (std::fabs(diff.z()) > mod->getZStripWidth() || std::fabs(diff.y()) > mod->getPhiStripWidth()) continue;
 
        const CLHEP::Hep3Vector propaV = mod->getPropagationDistance(locExt);
        const double propaDist = isPhi ? propaV.y() : propaV.z();
 
        // Components
        const double Trec = d.getTime();
        const double Tcable = timeCableDelay.isValid() ? timeCableDelay->getTimeDelay(cid) : 0.0;
        const double Tprop = propaDist * (isPhi ? delayPhi : delayZ);
        const double Tfly = flyTime;
 
        double t = Trec;
        if (timeCableDelay.isValid()) t -= Tcable;
        t -= Tprop;
 
        const double t0_est = t - Tfly;
        if (!std::isfinite(t0_est)) continue;
 
        // Weighted accumulation using calibrated sigma with direction-specific resolution
        const int plane = isPhi ? BKLMElementNumbers::c_PhiPlane : BKLMElementNumbers::c_ZPlane;
        const double sigma = getHitSigma(KLMElementNumbers::c_BKLM, d.getLayer(), true, plane);
        acc_stat_weighted(t0_est, sigma, sumW, sumWT);
      }
    }
  }
}

accumulateBKLMScint()

void accumulateBKLMScint ( RelationVector< KLMHit2d > & klmHit2ds, const ExtMap & scintMap, double & sumW, double & sumWT )

private

Accumulate BKLM scintillator per-digit T0 estimates (weighted).

Definition at line 399 of file KLMEventT0EstimatorModule.cc.

{
  DBObjPtr<KLMTimeConstants> timeConstants;
  DBObjPtr<KLMTimeCableDelay> timeCableDelay;
 
  const double delayScint = timeConstants.isValid()
                            ? timeConstants->getDelay(KLMTimeConstants::c_BKLM)
                            : 0.0;
 
  for (KLMHit2d& hit2d : klmHit2ds) {
    if (hit2d.getSubdetector() != KLMElementNumbers::c_BKLM) continue;
    if (hit2d.inRPC()) continue;
    if (hit2d.isOutOfTime()) continue;
 
    RelationVector<BKLMHit1d> b1ds = hit2d.getRelationsTo<BKLMHit1d>();
    if (b1ds.size() == 0) continue;
 
    const bklm::Module* mod = m_geoParB->findModule(hit2d.getSection(), hit2d.getSector(), hit2d.getLayer());
    const ROOT::Math::XYZVector posG2d = hit2d.getPosition();
 
    for (const BKLMHit1d& h1d : b1ds) {
      RelationVector<KLMDigit> digits = h1d.getRelationsTo<KLMDigit>();
 
      for (const KLMDigit& d : digits) {
        if (d.inRPC() || !d.isGood()) continue;
 
        unsigned int cid = d.getUniqueChannelID();
        if (m_channelStatus.isValid() &&
            m_channelStatus->getChannelStatus(cid) != KLMChannelStatus::c_Normal) continue;
 
        // Apply ADC cut
        if (!passesADCCut(d.getCharge(), KLMElementNumbers::c_BKLM, d.getLayer(), false)) {
          continue;
        }
 
        // Match using channel ID
        ExtPair p = const_cast<KLMEventT0EstimatorModule*>(this)->matchExt(cid, const_cast<ExtMap&>(scintMap));
        if (!p.first || !p.second) continue;
 
        const double flyTime = 0.5 * (p.first->getTOF() + p.second->getTOF());
        const ROOT::Math::XYZVector posGext = 0.5 * (p.first->getPosition() + p.second->getPosition());
 
        // Gate in local
        const CLHEP::Hep3Vector locExt  = mod->globalToLocal(CLHEP::Hep3Vector(posGext.X(), posGext.Y(), posGext.Z()), true);
        const CLHEP::Hep3Vector locHit2 = mod->globalToLocal(CLHEP::Hep3Vector(posG2d.X(),  posG2d.Y(),  posG2d.Z()),  true);
        const CLHEP::Hep3Vector diff    = locExt - locHit2;
        if (std::fabs(diff.z()) > mod->getZStripWidth() || std::fabs(diff.y()) > mod->getPhiStripWidth()) continue;
 
        // Prop distance
        const bool isPhiReadout = h1d.isPhiReadout();
        double propaLen = mod->getPropagationDistance(locExt, d.getStrip(), isPhiReadout);
 
        // Components
        const double Trec = d.getTime();
        const double Tcable = timeCableDelay.isValid() ? timeCableDelay->getTimeDelay(cid) : 0.0;
        const double Tprop = propaLen * delayScint;
        const double Tfly = flyTime;
 
        double t = Trec;
        if (timeCableDelay.isValid()) t -= Tcable;
        t -= Tprop;
 
        const double t0_est = t - Tfly;
        if (!std::isfinite(t0_est)) continue;
 
        // Weighted accumulation using calibrated sigma
        const double sigma = getHitSigma(KLMElementNumbers::c_BKLM, d.getLayer(), false);
        acc_stat_weighted(t0_est, sigma, sumW, sumWT);
      }
    }
  }
}

accumulateEKLM()

void accumulateEKLM ( const RelationVector< KLMHit2d > & klmHit2ds, const ExtMap & scintMap, double & sumW, double & sumWT )

private

Accumulate EKLM scintillator per-digit T0 estimates (weighted).

Note: EKLM section 1=backward (z<0), section 2=forward (z>0).

Definition at line 330 of file KLMEventT0EstimatorModule.cc.

{
  DBObjPtr<KLMTimeConstants> timeConstants;
  DBObjPtr<KLMTimeCableDelay> timeCableDelay;
 
  const double delayScint = timeConstants.isValid()
                            ? timeConstants->getDelay(KLMTimeConstants::c_EKLM)
                            : 0.0;
 
  HepGeom::Point3D<double> hitGlobal_ext, hitLocal_ext;
 
  for (const KLMHit2d& hit2d : klmHit2ds) {
    if (hit2d.getSubdetector() != KLMElementNumbers::c_EKLM) continue;
 
    RelationVector<KLMDigit> digits = hit2d.getRelationsTo<KLMDigit>();
    if (digits.size() == 0) continue;
 
    for (const KLMDigit& d : digits) {
      if (!d.isGood()) continue;
 
      unsigned int cid = d.getUniqueChannelID();
      if (m_channelStatus.isValid() &&
          m_channelStatus->getChannelStatus(cid) != KLMChannelStatus::c_Normal) continue;
 
      // Apply ADC cut
      if (!passesADCCut(d.getCharge(), KLMElementNumbers::c_EKLM, d.getLayer(), false)) {
        continue;
      }
 
      // Match using channel ID
      ExtPair ex = const_cast<KLMEventT0EstimatorModule*>(this)->matchExt(cid, const_cast<ExtMap&>(scintMap));
      if (!ex.first || !ex.second) continue;
      const double flyTime = 0.5 * (ex.first->getTOF() + ex.second->getTOF());
 
      // Distance along strip to readout
      const ROOT::Math::XYZVector posGlobExt = 0.5 * (ex.first->getPosition() + ex.second->getPosition());
      hitGlobal_ext.setX(posGlobExt.X() / Unit::mm * CLHEP::mm);
      hitGlobal_ext.setY(posGlobExt.Y() / Unit::mm * CLHEP::mm);
      hitGlobal_ext.setZ(posGlobExt.Z() / Unit::mm * CLHEP::mm);
 
      const double Lmm = m_geoParE->getStripLength(d.getStrip()) / CLHEP::mm * Unit::mm;
      const HepGeom::Transform3D* tr = m_transformE->getStripGlobalToLocal(const_cast<KLMDigit*>(&d));
      hitLocal_ext = (*tr) * hitGlobal_ext;
      const double dist_mm = 0.5 * Lmm - hitLocal_ext.x() / CLHEP::mm * Unit::mm;
 
      // Components
      const double Trec = d.getTime();
      const double Tcable = timeCableDelay.isValid() ? timeCableDelay->getTimeDelay(cid) : 0.0;
      const double Tprop = dist_mm * delayScint;
      const double Tfly = flyTime;
 
      // Correct digit time
      double t = Trec;
      if (timeCableDelay.isValid()) t -= Tcable;
      t -= Tprop;
 
      const double t0_est = t - Tfly;
      if (!std::isfinite(t0_est)) continue;
 
      // Weighted accumulation using calibrated sigma
      const double sigma = getHitSigma(KLMElementNumbers::c_EKLM, d.getLayer(), false);
      acc_stat_weighted(t0_est, sigma, sumW, sumWT);
    }
  }
}

beginRun()

void beginRun ( void )

overridevirtual

Per-run resets if desired (histos remain booked).

Reimplemented from HistoModule.

Definition at line 161 of file KLMEventT0EstimatorModule.cc.

{
  if (!m_eventT0HitResolution.isValid())
    B2FATAL("KLMEventT0Estimator: KLM EventT0 hit resolution data are not available.");
 
  B2DEBUG(20, "KLMEventT0Estimator: Using calibrated per-hit resolution."
          << LogVar("sigma_RPC (ns)", m_eventT0HitResolution->getSigmaRPC())
          << LogVar("sigma_BKLM_Scint (ns)", m_eventT0HitResolution->getSigmaBKLMScint())
          << LogVar("sigma_EKLM_Scint (ns)", m_eventT0HitResolution->getSigmaEKLMScint()));
}

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

collectExtrapolatedHits()

void collectExtrapolatedHits ( const Track * track, ExtMap & scintMap, ExtMap & rpcMap )

private

Build maps of extrapolated hits for a track (scint: channel key; RPC: module key).

Definition at line 240 of file KLMEventT0EstimatorModule.cc.

{
  scintMap.clear();
  rpcMap.clear();
 
  RelationVector<ExtHit> extHits = track->getRelationsTo<ExtHit>();
  KLMMuidLikelihood* muidLikelihood = track->getRelatedTo<KLMMuidLikelihood>();
 
  for (const ExtHit& eHit : extHits) {
    if (eHit.getStatus() != EXT_EXIT) continue;
    if (m_ignoreBackward && eHit.isBackwardPropagated()) continue;
 
    const bool isB = (eHit.getDetectorID() == Const::EDetector::BKLM);
    const bool isE = (eHit.getDetectorID() == Const::EDetector::EKLM);
    if (!isB && !isE) continue;
 
    int copyId = eHit.getCopyID();
    int tFor, tSec, tLay, tPla, tStr;
    int tSub = -1;
 
    if (isE) {
      tSub = KLMElementNumbers::c_EKLM;
      EKLMElementNumbers::Instance().stripNumberToElementNumbers(copyId,
                                                                 &tFor, &tLay, &tSec, &tPla, &tStr);
    }
    if (isB) {
      tSub = KLMElementNumbers::c_BKLM;
      BKLMElementNumbers::channelNumberToElementNumbers(copyId,
                                                        &tFor, &tSec, &tLay, &tPla, &tStr);
    }
    if (tSub < 0) continue;
 
    bool crossed = false;
 
    if (isB) {
      crossed = muidLikelihood
                ? muidLikelihood->isExtrapolatedBarrelLayerCrossed(tLay - 1)
                : true;
      if (!crossed) continue;
 
      const bool isRPC = (tLay >= BKLMElementNumbers::c_FirstRPCLayer);
 
      if (isRPC) {
        // RPC: match by module
        unsigned int moduleKey =
          m_elementNum->moduleNumber(tSub, tFor, tSec, tLay);
        rpcMap.insert(std::make_pair(moduleKey, eHit));
      } else {
        // BKLM scintillator: match by channel
        unsigned int channelKey =
          m_elementNum->channelNumber(tSub, tFor, tSec, tLay, tPla, tStr);
        if (m_channelStatus.isValid() &&
            m_channelStatus->getChannelStatus(channelKey) != KLMChannelStatus::c_Normal)
          continue;
        scintMap.insert(std::make_pair(channelKey, eHit));
      }
    }
 
    if (isE) {
      crossed = muidLikelihood
                ? muidLikelihood->isExtrapolatedEndcapLayerCrossed(tLay - 1)
                : true;
      if (!crossed) continue;
 
      unsigned int channelKey =
        m_elementNum->channelNumber(tSub, tFor, tSec, tLay, tPla, tStr);
      if (m_channelStatus.isValid() &&
          m_channelStatus->getChannelStatus(channelKey) != KLMChannelStatus::c_Normal)
        continue;
      scintMap.insert(std::make_pair(channelKey, eHit));
    }
  }
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

{ terminate(); }

defineHisto()

void defineHisto ( )

overridevirtual

Definition of histograms (called once by HistoManager).

Reimplemented from HistoModule.

Definition at line 78 of file KLMEventT0EstimatorModule.cc.

{
  // Parent directory for this module
  TDirectory* topdir = gDirectory->mkdir(m_histDirName.c_str());
  TDirectory::TContext ctxTop{gDirectory, topdir};
 
  // Subdirectory for uncorrected timing histograms (always created)
  TDirectory* d_unc = topdir->mkdir(m_histSubdirUncorr.c_str());
 
  auto H1 = [](const char* n, const char* t, int nb, double lo, double hi) {
    return new TH1D(n, t, nb, lo, hi);
  };
 
  /* Uncorrected timing histograms. */
  {
    TDirectory::TContext ctxUnc{gDirectory, d_unc};
 
    // --- per_track/ subdirectory ---
    TDirectory* d_per_track = d_unc->mkdir("per_track");
    {
      TDirectory::TContext ctxTrk{gDirectory, d_per_track};
      m_hT0Trk_BKLM_Scint = H1("h_t0trk_bklm_scint", "Per-track T0 (BKLM Scint);T0 [ns]", 800, -100, 100);
      m_hT0Trk_BKLM_RPC   = H1("h_t0trk_bklm_rpc",   "Per-track T0 (BKLM RPC);T0 [ns]",   800, -100, 100);
      m_hT0Trk_EKLM_Scint = H1("h_t0trk_eklm_scint", "Per-track T0 (EKLM Scint);T0 [ns]", 800, -100, 100);
    }
 
    // --- per_event/ subdirectory ---
    TDirectory* d_per_event = d_unc->mkdir("per_event");
    {
      TDirectory::TContext ctxEvt{gDirectory, d_per_event};
 
      // Track-average
      m_hT0Evt_TrkAvg_BKLM_Scint     = H1("h_t0evt_trkavg_bklm_scint",     "Per-event T0 (track-avg, BKLM Scint);T0 [ns]", 800, -100,
                                          100);
      m_hT0Evt_TrkAvg_BKLM_RPC       = H1("h_t0evt_trkavg_bklm_rpc",       "Per-event T0 (track-avg, BKLM RPC);T0 [ns]",   800, -100,
                                          100);
      m_hT0Evt_TrkAvg_EKLM_Scint     = H1("h_t0evt_trkavg_eklm_scint",     "Per-event T0 (track-avg, EKLM Scint);T0 [ns]", 800, -100,
                                          100);
      m_hT0Evt_TrkAvg_All            = H1("h_t0evt_trkavg_all",            "Per-event T0 (track-avg, all categories);T0 [ns]", 800, -100,
                                          100);
      m_hT0Evt_TrkAvg_BKLM_Scint_SEM = H1("h_t0evt_trkavg_bklm_scint_sem", "SEM (track-avg, BKLM Scint);SEM [ns]", 800, 0.0, 20.0);
      m_hT0Evt_TrkAvg_BKLM_RPC_SEM   = H1("h_t0evt_trkavg_bklm_rpc_sem",   "SEM (track-avg, BKLM RPC);SEM [ns]",   800, 0.0, 20.0);
      m_hT0Evt_TrkAvg_EKLM_Scint_SEM = H1("h_t0evt_trkavg_eklm_scint_sem", "SEM (track-avg, EKLM Scint);SEM [ns]", 800, 0.0, 20.0);
      m_hT0Evt_TrkAvg_All_SEM        = H1("h_t0evt_trkavg_all_sem",        "SEM (track-avg, all categories);SEM [ns]", 800, 0.0, 20.0);
 
      // Final-source audit: all possible combinations of B(KLM Scint), E(KLM Scint), R(PC)
      m_hFinalSource = new TH1I("h_final_source", "Final KLM source;;events", 7, 0.5, 7.5);
      m_hFinalSource->GetXaxis()->SetBinLabel(1, "B only");
      m_hFinalSource->GetXaxis()->SetBinLabel(2, "E only");
      m_hFinalSource->GetXaxis()->SetBinLabel(3, "R only");
      m_hFinalSource->GetXaxis()->SetBinLabel(4, "B+E");
      m_hFinalSource->GetXaxis()->SetBinLabel(5, "B+R");
      m_hFinalSource->GetXaxis()->SetBinLabel(6, "E+R");
      m_hFinalSource->GetXaxis()->SetBinLabel(7, "B+E+R");
    }
  } // end uncorrected/ directory
 
}

endRun()

void endRun ( void )

overridevirtual

Called when the current run ends.

Reimplemented from HistoModule.

Definition at line 172 of file KLMEventT0EstimatorModule.cc.

{
}

evalCondition()

bool evalCondition ( ) const

inherited

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

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

Returns

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

Definition at line 96 of file Module.cc.

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

event()

void event ( void )

overridevirtual

Per-event algorithm: collect hits, compute residuals, fill outputs.

Reimplemented from HistoModule.

Definition at line 554 of file KLMEventT0EstimatorModule.cc.

{
  // CDC seed for logging (not used to compute the means)
  m_seedT0 = 0.0;
  if (m_useCDCTemporaryT0) {
    StoreObjPtr<EventT0> evtT0("EventT0", DataStore::c_Event);
    if (evtT0.isValid() && evtT0->hasTemporaryEventT0(Const::EDetector::CDC)) {
      const auto best = evtT0->getBestCDCTemporaryEventT0();
      if (best) m_seedT0 = best->eventT0;
    }
  }
 
  if (!m_MuonList.isValid()) { B2WARNING("KLMEventT0Estimator: ParticleList '" << m_MuonListName << "' not found."); return; }
  const unsigned nTracks = m_MuonList->getListSize();
  if (nTracks == 0u) return;
 
  // Weighted mean and uncertainty from running sums
  auto weighted_result = [](double wsum, double wtsum) -> std::pair<double, double> {
    if (wsum <= 0.0) return {NAN, NAN};
    return {wtsum / wsum, std::sqrt(1.0 / wsum)};
  };
 
  // Weighted track averaging using inverse-variance (1/SEM²) weighting
  auto mean_sem_tracks = [](const std::vector<std::pair<double, double>>& v) -> std::pair<double, double> {
    if (v.empty()) return {NAN, NAN};
    if (v.size() == 1)
    {
      return {v[0].first, std::isfinite(v[0].second) ? v[0].second : 0.0};
    }
 
    bool allValid = true;
    for (const auto& [t0, sem] : v)
    {
      if (!std::isfinite(sem) || sem <= 0.0) { allValid = false; break; }
    }
 
    if (allValid)
    {
      double wsum = 0.0, wtsum = 0.0;
      for (const auto& [t0, sem] : v) {
        const double w = 1.0 / (sem * sem);
        wsum += w;
        wtsum += w * t0;
      }
      if (wsum > 0.0) {
        return {wtsum / wsum, std::sqrt(1.0 / wsum)};
      }
    }
 
    // Fallback to simple average if weights not valid
    double s = 0.0;
    for (const auto& [t0, sem] : v) s += t0;
    const double mu = s / v.size();
    double ss = 0.0;
    for (const auto& [t0, sem] : v) { const double d = t0 - mu; ss += d * d; }
    const double var = (v.size() > 1) ? ss / (v.size() - 1) : 0.0;
    return {mu, std::sqrt(var / v.size())};
  };
 
  // For per-event track-averages: pairs of (T0, SEM) for weighted averaging
  std::vector<std::pair<double, double>> vTrk_B, vTrk_R, vTrk_E, vTrk_All;
 
  for (unsigned i = 0; i < nTracks; ++i) {
    const Particle* particle = m_MuonList->getParticle(i);
    if (!particle) continue;
    const Track* track = particle->getTrack();
    if (!track) continue;
 
    RelationVector<KLMHit2d> hit2ds = track->getRelationsTo<KLMHit2d>();
    if (hit2ds.size() == 0) continue;
 
    // Build ExtHit maps for this track
    m_extScint.clear();
    m_extRPC.clear();
    collectExtrapolatedHits(track, m_extScint, m_extRPC);
 
    // Per-track digit sums per category (weighted)
    double wE = 0, wTE = 0;
    accumulateEKLM(hit2ds, m_extScint, wE, wTE);
 
    double wB = 0, wTB = 0;
    accumulateBKLMScint(hit2ds, m_extScint, wB, wTB);
 
    double wR = 0, wTR = 0;
    accumulateBKLMRPC(hit2ds, m_extRPC, wR, wTR);
 
    // Per-track means and SEMs by category
    if (wB > 0.0) {
      auto [muB, seB] = weighted_result(wB, wTB);
      if (m_hT0Trk_BKLM_Scint && std::isfinite(muB)) m_hT0Trk_BKLM_Scint->Fill(muB);
      if (std::isfinite(muB)) vTrk_B.push_back({muB, seB});
    }
 
    if (wR > 0.0) {
      auto [muR, seR] = weighted_result(wR, wTR);
      if (m_hT0Trk_BKLM_RPC && std::isfinite(muR)) m_hT0Trk_BKLM_RPC->Fill(muR);
      if (std::isfinite(muR)) vTrk_R.push_back({muR, seR});
    }
 
    if (wE > 0.0) {
      auto [muE, seE] = weighted_result(wE, wTE);
      if (m_hT0Trk_EKLM_Scint && std::isfinite(muE)) m_hT0Trk_EKLM_Scint->Fill(muE);
      if (std::isfinite(muE)) vTrk_E.push_back({muE, seE});
    }
 
    // Per-track overall (if any category present)
    {
      const double wAll = wB + wE + wR;
      const double wtAll = wTB + wTE + wTR;
      if (wAll > 0.0) {
        const double t0 = wtAll / wAll;
        const double se = std::sqrt(1.0 / wAll);
        vTrk_All.push_back({t0, se});
      }
    }
  }
 
  if (vTrk_All.empty()) {
    B2DEBUG(20, "KLMEventT0Estimator: no usable KLM timing residuals for this event.");
    return;
  }
 
  // Per-event track-averages using inverse-variance (1/SEM²) weighting
  const auto [muB_trk,   seB_trk]   = mean_sem_tracks(vTrk_B);
  const auto [muR_trk,   seR_trk]   = mean_sem_tracks(vTrk_R);
  const auto [muE_trk,   seE_trk]   = mean_sem_tracks(vTrk_E);
  const auto [muAll_trk, seAll_trk]  = mean_sem_tracks(vTrk_All);
 
  if (m_hT0Evt_TrkAvg_BKLM_Scint && std::isfinite(muB_trk))   m_hT0Evt_TrkAvg_BKLM_Scint->Fill(muB_trk);
  if (m_hT0Evt_TrkAvg_BKLM_RPC   && std::isfinite(muR_trk))   m_hT0Evt_TrkAvg_BKLM_RPC->Fill(muR_trk);
  if (m_hT0Evt_TrkAvg_EKLM_Scint && std::isfinite(muE_trk))   m_hT0Evt_TrkAvg_EKLM_Scint->Fill(muE_trk);
  if (m_hT0Evt_TrkAvg_All        && std::isfinite(muAll_trk)) m_hT0Evt_TrkAvg_All->Fill(muAll_trk);
 
  if (m_hT0Evt_TrkAvg_BKLM_Scint_SEM && std::isfinite(seB_trk))   m_hT0Evt_TrkAvg_BKLM_Scint_SEM->Fill(seB_trk);
  if (m_hT0Evt_TrkAvg_BKLM_RPC_SEM   && std::isfinite(seR_trk))   m_hT0Evt_TrkAvg_BKLM_RPC_SEM->Fill(seR_trk);
  if (m_hT0Evt_TrkAvg_EKLM_Scint_SEM && std::isfinite(seE_trk))   m_hT0Evt_TrkAvg_EKLM_Scint_SEM->Fill(seE_trk);
  if (m_hT0Evt_TrkAvg_All_SEM        && std::isfinite(seAll_trk)) m_hT0Evt_TrkAvg_All_SEM->Fill(seAll_trk);
 
  // ---------------- Final KLM combination (single saved component) ----------------
  const bool useB = std::isfinite(muB_trk);
  const bool useE = std::isfinite(muE_trk);
  const bool useR = std::isfinite(muR_trk);
 
  double finalT0 = NAN, finalSE = NAN;
  int sourceBin = -1;
 
  {
    std::vector<std::pair<double, double>> parts;
    if (useB) parts.emplace_back(muB_trk, seB_trk);
    if (useE) parts.emplace_back(muE_trk, seE_trk);
    if (useR) parts.emplace_back(muR_trk, seR_trk);
 
    auto [t0, se] = mean_sem_tracks(parts);
    finalT0 = t0;
    finalSE = se;
 
    if (useB && useE && useR) sourceBin = 7;
    else if (useB && useE) sourceBin = 4;
    else if (useB && useR) sourceBin = 5;
    else if (useE && useR) sourceBin = 6;
    else if (useB) sourceBin = 1;
    else if (useE) sourceBin = 2;
    else if (useR) sourceBin = 3;
  }
 
  B2DEBUG(20, "KLMEventT0Estimator: "
          << "T0_trkavg_all=" << muAll_trk << " ns  (seed CDC=" << m_seedT0 << " ns)"
          << " | E=" << muE_trk << " | Bsc=" << muB_trk << " | Brpc=" << muR_trk
          << (std::isfinite(finalT0) ? (std::string(" | FINAL KLM=") + std::to_string(finalT0) + " ns") : std::string("")));
 
  StoreObjPtr<EventT0> outT0("EventT0", DataStore::c_Event);
  if (!outT0.isValid()) outT0.construct();
 
  if (std::isfinite(finalT0)) {
    if (m_hFinalSource && sourceBin > 0) m_hFinalSource->Fill(sourceBin);
    const double quality = static_cast<double>((useB ? 1 : 0) + (useE ? 1 : 0) + (useR ? 1 : 0));
    EventT0::EventT0Component klmT0Component(finalT0, std::isfinite(finalSE) ? finalSE : 0.0,
                                             Const::KLM, "KLM", quality);
    outT0->addTemporaryEventT0(klmT0Component);
    outT0->setEventT0(klmT0Component);
  }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 313 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

getHitSigma()

double getHitSigma ( int subdetector, int layer, bool inRPC, int plane = 0 ) const

private

Get per-hit sigma for a digit based on detector category.

Uses calibrated per-hit resolution from KLMEventT0HitResolution payload.

Parameters

subdetector	KLM subdetector (BKLM or EKLM)
layer	Layer number (1-indexed)
inRPC	Whether the digit is from RPC
plane	Plane number (for RPC: BKLMElementNumbers::c_ZPlane or c_PhiPlane)

Returns

Per-hit sigma in ns

Definition at line 200 of file KLMEventT0EstimatorModule.cc.

{
  if (!m_eventT0HitResolution.isValid()) {
    B2ERROR("KLMEventT0Estimator: Calibrated hit resolution payload not available!");
    return 1.0; // Fallback
  }
 
  if (subdetector == KLMElementNumbers::c_BKLM) {
    if (inRPC || layer >= BKLMElementNumbers::c_FirstRPCLayer) {
      // Use direction-specific RPC resolution if available (version 2+)
      // Fall back to combined RPC resolution for backward compatibility
      if (plane == BKLMElementNumbers::c_ZPlane) {
        float sigmaZ = m_eventT0HitResolution->getSigmaRPCZ();
        return (sigmaZ > 0.0) ? sigmaZ : m_eventT0HitResolution->getSigmaRPC();
      } else {
        float sigmaPhi = m_eventT0HitResolution->getSigmaRPCPhi();
        return (sigmaPhi > 0.0) ? sigmaPhi : m_eventT0HitResolution->getSigmaRPC();
      }
    } else {
      return m_eventT0HitResolution->getSigmaBKLMScint();
    }
  } else { // EKLM
    return m_eventT0HitResolution->getSigmaEKLMScint();
  }
}

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 186 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 380 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 310 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 377 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void )

overridevirtual

Register inputs/params; get geometry; call REG_HISTOGRAM.

Reimplemented from HistoModule.

Definition at line 139 of file KLMEventT0EstimatorModule.cc.

{
  // Register that we define histograms
  REG_HISTOGRAM;
 
  // Inputs
  m_MuonList.isRequired(m_MuonListName);
  m_tracks.isRequired();
 
  // Geometry
  m_geoParB = bklm::GeometryPar::instance();
  m_geoParE = &(EKLM::GeometryData::Instance());
  m_transformE = new EKLM::TransformData(true, EKLM::TransformData::c_None);
 
  // Log ADC cut settings
  B2DEBUG(20, "KLMEventT0Estimator: ADC cuts configured:"
          << LogVar("BKLM Scint min", m_ADCCut_BKLM_Scint_Min)
          << LogVar("BKLM Scint max", m_ADCCut_BKLM_Scint_Max)
          << LogVar("EKLM Scint min", m_ADCCut_EKLM_Scint_Min)
          << LogVar("EKLM Scint max", m_ADCCut_EKLM_Scint_Max));
}

matchExt()

KLMEventT0EstimatorModule::ExtPair matchExt ( unsigned int key, ExtMap & v_ExtHits )

private

Find earliest (entry) and latest (exit) ExtHits matching a key (channel or module).

Definition at line 227 of file KLMEventT0EstimatorModule.cc.

{
  ExtHit* entryHit = nullptr;
  ExtHit* exitHit  = nullptr;
  auto itlow = v_ExtHits.lower_bound(key);
  auto itup  = v_ExtHits.upper_bound(key);
  for (auto it = itlow; it != itup; ++it) {
    if (!entryHit || it->second.getTOF() < entryHit->getTOF()) entryHit = &(it->second);
    if (!exitHit  || it->second.getTOF() > exitHit->getTOF())  exitHit  = &(it->second);
  }
  return std::make_pair(entryHit, exitHit);
}

passesADCCut()

bool passesADCCut ( double charge, int subdetector, int layer, bool inRPC ) const

private

Check if a digit passes the ADC charge cut.

Parameters

charge	ADC charge value
subdetector	KLM subdetector (BKLM or EKLM)
layer	Layer number (1-indexed)
inRPC	Whether the digit is from RPC

Returns

true if passes cut, false otherwise

Definition at line 180 of file KLMEventT0EstimatorModule.cc.

{
  // RPC: No ADC cut applied
  if (subdetector == KLMElementNumbers::c_BKLM && (inRPC || layer >= BKLMElementNumbers::c_FirstRPCLayer)) {
    return true;
  }
 
  // BKLM Scintillator
  if (subdetector == KLMElementNumbers::c_BKLM) {
    return (charge >= m_ADCCut_BKLM_Scint_Min && charge <= m_ADCCut_BKLM_Scint_Max);
  }
 
  // EKLM Scintillator
  if (subdetector == KLMElementNumbers::c_EKLM) {
    return (charge >= m_ADCCut_EKLM_Scint_Min && charge <= m_ADCCut_EKLM_Scint_Max);
  }
 
  return true;
}

setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int logLevel, unsigned int logInfo )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

terminate()

void terminate ( void )

overridevirtual

Called at the end of processing.

Reimplemented from HistoModule.

Definition at line 176 of file KLMEventT0EstimatorModule.cc.

{}

Member Data Documentation

m_ADCCut_BKLM_Scint_Max

double m_ADCCut_BKLM_Scint_Max

private

Maximum ADC cut for BKLM scintillator.

Definition at line 116 of file KLMEventT0EstimatorModule.h.

m_ADCCut_BKLM_Scint_Min

double m_ADCCut_BKLM_Scint_Min

private

Minimum ADC cut for BKLM scintillator.

Definition at line 115 of file KLMEventT0EstimatorModule.h.

m_ADCCut_EKLM_Scint_Max

double m_ADCCut_EKLM_Scint_Max

private

Maximum ADC cut for EKLM scintillator.

Definition at line 118 of file KLMEventT0EstimatorModule.h.

m_ADCCut_EKLM_Scint_Min

double m_ADCCut_EKLM_Scint_Min

private

Minimum ADC cut for EKLM scintillator.

Definition at line 117 of file KLMEventT0EstimatorModule.h.

m_channelStatus

DBObjPtr<KLMChannelStatus> m_channelStatus

private

Channel status (Normal/Dead/etc.).

Definition at line 202 of file KLMEventT0EstimatorModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_elementNum

const KLMElementNumbers* m_elementNum {&KLMElementNumbers::Instance()}

private

Element numbering helpers.

Definition at line 199 of file KLMEventT0EstimatorModule.h.

{&KLMElementNumbers::Instance()};

m_eventT0HitResolution

DBObjPtr<KLMEventT0HitResolution> m_eventT0HitResolution

private

Per-hit time resolution for EventT0 estimation.

Definition at line 205 of file KLMEventT0EstimatorModule.h.

m_extRPC

ExtMap m_extRPC

private

Extrapolated hits keyed by module number (RPC).

Definition at line 221 of file KLMEventT0EstimatorModule.h.

m_extScint

ExtMap m_extScint

private

Extrapolated hits keyed by channel number (scintillator).

Definition at line 218 of file KLMEventT0EstimatorModule.h.

m_geoParB

Belle2::bklm::GeometryPar* m_geoParB {nullptr}

private

BKLM geometry.

Definition at line 190 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_geoParE

const Belle2::EKLM::GeometryData* m_geoParE {nullptr}

private

EKLM geometry data.

Definition at line 193 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

m_hFinalSource

TH1I* m_hFinalSource {nullptr}

private

Final EventT0 source selection (7 bins).

Definition at line 262 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_histDirName

std::string m_histDirName

private

Parent directory inside the ROOT file (HistoManager) for this module.

Definition at line 182 of file KLMEventT0EstimatorModule.h.

m_histSubdirUncorr

std::string m_histSubdirUncorr {"uncorrected"}

private

Subdirectory name for uncorrected timing histograms.

Definition at line 185 of file KLMEventT0EstimatorModule.h.

{"uncorrected"};

m_hT0Evt_TrkAvg_All

TH1D* m_hT0Evt_TrkAvg_All {nullptr}

private

Per-event T0 track-average combined (mean) [ns].

Definition at line 247 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_All_SEM

TH1D* m_hT0Evt_TrkAvg_All_SEM {nullptr}

private

Per-event T0 track-average combined (SEM) [ns].

Definition at line 259 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_BKLM_RPC

TH1D* m_hT0Evt_TrkAvg_BKLM_RPC {nullptr}

private

Per-event T0 track-average for BKLM RPC (mean) [ns].

Definition at line 241 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_BKLM_RPC_SEM

TH1D* m_hT0Evt_TrkAvg_BKLM_RPC_SEM {nullptr}

private

Per-event T0 track-average for BKLM RPC (SEM) [ns].

Definition at line 253 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_BKLM_Scint

TH1D* m_hT0Evt_TrkAvg_BKLM_Scint {nullptr}

private

Per-event T0 track-average for BKLM scintillator (mean) [ns].

Definition at line 238 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_BKLM_Scint_SEM

TH1D* m_hT0Evt_TrkAvg_BKLM_Scint_SEM {nullptr}

private

Per-event T0 track-average for BKLM scintillator (SEM) [ns].

Definition at line 250 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_EKLM_Scint

TH1D* m_hT0Evt_TrkAvg_EKLM_Scint {nullptr}

private

Per-event T0 track-average for EKLM scintillator (mean) [ns].

Definition at line 244 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Evt_TrkAvg_EKLM_Scint_SEM

TH1D* m_hT0Evt_TrkAvg_EKLM_Scint_SEM {nullptr}

private

Per-event T0 track-average for EKLM scintillator (SEM) [ns].

Definition at line 256 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Trk_BKLM_RPC

TH1D* m_hT0Trk_BKLM_RPC {nullptr}

private

Per-track T0 for BKLM RPC [ns].

Definition at line 232 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Trk_BKLM_Scint

TH1D* m_hT0Trk_BKLM_Scint {nullptr}

private

Per-track T0 for BKLM scintillator [ns].

Definition at line 229 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_hT0Trk_EKLM_Scint

TH1D* m_hT0Trk_EKLM_Scint {nullptr}

private

Per-track T0 for EKLM scintillator [ns].

Definition at line 235 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_ignoreBackward

bool m_ignoreBackward {false}

private

Ignore backward-propagated ExtHits when forming entry/exit pairs.

Definition at line 179 of file KLMEventT0EstimatorModule.h.

{false};

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_MuonList

StoreObjPtr<ParticleList> m_MuonList

private

Selected muon particle list.

Definition at line 210 of file KLMEventT0EstimatorModule.h.

m_MuonListName

std::string m_MuonListName

private

Input ParticleList (e.g.

"mu+:forT0").

Definition at line 173 of file KLMEventT0EstimatorModule.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_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_seedT0

double m_seedT0 {0.0}

private

Optional seed from CDC (for logging only).

Definition at line 224 of file KLMEventT0EstimatorModule.h.

{0.0};

m_tracks

StoreArray<Track> m_tracks

private

Reconstructed tracks.

Definition at line 213 of file KLMEventT0EstimatorModule.h.

m_transformE

Belle2::EKLM::TransformData* m_transformE {nullptr}

private

EKLM strip transformation data.

Definition at line 196 of file KLMEventT0EstimatorModule.h.

{nullptr};

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

m_useCDCTemporaryT0

bool m_useCDCTemporaryT0 {true}

private

Use CDC temporary EventT0 as a diagnostic seed (not applied to averaging).

Definition at line 176 of file KLMEventT0EstimatorModule.h.

{true};

---

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

• klm/modules/KLMEventT0Estimator/include/KLMEventT0EstimatorModule.h
• klm/modules/KLMEventT0Estimator/src/KLMEventT0EstimatorModule.cc