KLMDigitizerModule Class Reference

KLM digitization module. More...

#include <KLMDigitizerModule.h>

Inheritance diagram for KLMDigitizerModule:

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
	KLMDigitizerModule ()
	Constructor.
	~KLMDigitizerModule ()
	Destructor.
void	initialize () override
	Initializer.
void	beginRun () override
	Called when entering a new run.
void	event () override
	This method is called for each event.
void	endRun () override
	This method is called if the current run ends.
void	terminate () override
	This method is called at the end of the event 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
enum	EfficiencyMode {   c_Strip ,   c_Plane }
	Efficiency determination mode. More...

Private Member Functions
void	checkScintillatorFEEParameters ()
	Check scintillator FEE parameters for channel-specific simulation.
void	digitizeRPC ()
	Digitization in RPCs.
void	digitizeScintillator ()
	Digitization in scintillators.
void	digitizeAsic ()
	Digitization in ASIC.
bool	checkActive (KLMChannelNumber channel)
	Check if channel is active (status is not KLMChannelStatus::c_Dead).
bool	efficiencyCorrection (float efficiency)
	Efficiency correction.
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
DBObjPtr< KLMChannelStatus >	m_ChannelStatus
	Channel status.
DBObjPtr< KLMElectronicsMap >	m_ElectronicsMap
	Electronics map.
DBObjPtr< KLMScintillatorDigitizationParameters >	m_DigPar
	Scintillator digitization parameters.
DBObjPtr< KLMScintillatorFEEParameters >	m_FEEPar
	Scintillator FEE parameters.
DBObjPtr< KLMScintillatorFirmware >	m_ScintillatorFirmware
	Scintillator FEE firmware version.
DBObjPtr< KLMStripEfficiency >	m_StripEfficiency
	Strip efficiency.
KLMTime *	m_Time
	Time conversion.
const KLMElementNumbers *	m_ElementNumbers
	Element numbers.
std::string	m_SimulationMode
	Simulation mode.
bool	m_ChannelSpecificSimulation
	Whether the simulation is channel-specific.
int	m_DigitizationInitialTime
	Initial digitization time in CTIME periods.
bool	m_SaveFPGAFit
	Save FPGA fit data (KLMScintillatorFirmwareFitResult).
std::string	m_Efficiency
	Efficiency determination mode ("Strip" or "Plane").
EfficiencyMode	m_EfficiencyMode
	Efficiency determination mode (converted from the string parameter).
bool	m_CreateMultiStripDigits
	Whether to create multi-strip digits.
bool	m_CreateMultiStripDigitsByRun
	Whether to create multi-strip digits for one particular run.
bool	m_Debug
	Use debug mode in EKLM::ScintillatorSimulator or not.
std::multimap< KLMPlaneNumber, const KLMSimHit * >	m_MapPlaneSimHit
	Simulation hit map (by plane).
std::multimap< KLMChannelNumber, const KLMSimHit * >	m_MapChannelSimHit
	Simulation hit map (by channel).
std::multimap< KLMElectronicsChannel, const KLMSimHit * >	m_MapAsicSimHit
	Simulation hit map (by ASIC).
KLMDigit *	m_AsicDigits [KLM::c_NChannelsAsic]
	Digits corresponding to ASIC channels.
std::multimap< KLMChannelNumber, constKLMSimHit * >::iterator	m_AsicDigitSimHitsLowerBound [KLM::c_NChannelsAsic]
	Simulation hits lower bound for ASIC digit.
std::multimap< KLMChannelNumber, constKLMSimHit * >::iterator	m_AsicDigitSimHitsUpperBound [KLM::c_NChannelsAsic]
	Simulation hits upper bound for ASIC digit.
KLM::ScintillatorFirmware *	m_Fitter
	FPGA fitter.
StoreArray< KLMSimHit >	m_SimHits
	Simulation hits.
StoreArray< KLMDigit >	m_Digits
	KLM digits.
StoreArray< KLMScintillatorFirmwareFitResult >	m_FPGAFits
	FPGA fits.
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

KLM digitization module.

Definition at line 39 of file KLMDigitizerModule.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

EfficiencyMode

enum EfficiencyMode

private

Efficiency determination mode.

Enumerator
c_Strip	Strip.
c_Plane	Plane.

Definition at line 83 of file KLMDigitizerModule.h.

                        {
 
      c_Strip,
 
      c_Plane,
 
    };

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

KLMDigitizerModule()

KLMDigitizerModule

(

)

Constructor.

Definition at line 28 of file KLMDigitizerModule.cc.

                                       :
  Module(),
  m_Time(&(KLMTime::Instance())),
  m_ElementNumbers(&(KLMElementNumbers::Instance())),
  m_ChannelSpecificSimulation(false),
  m_EfficiencyMode(c_Plane),
  m_Fitter(nullptr)
{
  setDescription("KLM digitization module: create KLMDigits from KLMSimHits.");
  setPropertyFlags(c_ParallelProcessingCertified);
  addParam("SimulationMode", m_SimulationMode,
           "Simulation mode (\"Generic\" or \"ChannelSpecific\").",
           std::string("Generic"));
  /*
   * Initial digitization time is negative to work with cosmic events (the part
   * of the track directed to the interaction pointhas a negative time).
   */
  addParam("DigitizationInitialTime", m_DigitizationInitialTime,
           "Initial digitization time in CTIME periods.", -5);
  addParam("SaveFPGAFit", m_SaveFPGAFit, "Save FPGA fit data and set a relation with KLMDigits.", false);
  addParam("Efficiency", m_Efficiency,
           "Efficiency determination mode (\"Strip\" or \"Plane\").",
           std::string("Plane"));
  addParam("CreateMultiStripDigits", m_CreateMultiStripDigits,
           "Whether to create multi-strip digits in Run 1 data (not used for Run 2+).", true);
  addParam("Debug", m_Debug,
           "Debug mode (generates additional output files with histograms).",
           false);
}

~KLMDigitizerModule()

~KLMDigitizerModule

(

)

Destructor.

Definition at line 58 of file KLMDigitizerModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 111 of file KLMDigitizerModule.cc.

{
  if (!m_DigPar.isValid())
    B2FATAL("KLM scintillator digitization parameters are not available.");
  if (!m_FEEPar.isValid())
    B2FATAL("KLM scintillator FEE parameters are not available.");
  if (!m_ChannelStatus.isValid())
    B2FATAL("KLM channel status data are not available.");
  if (!m_StripEfficiency.isValid())
    B2FATAL("KLM strip efficiency data are not available.");
  if (!m_ScintillatorFirmware.isValid())
    B2FATAL("KLM scintillator firmware version is not available.");
  if (m_ChannelSpecificSimulation)
    checkScintillatorFEEParameters();
  m_Time->updateConstants();
  m_Fitter = new KLM::ScintillatorFirmware(m_DigPar->getNDigitizations());
  KLMScintillatorFirmware::FirmwareVersion fwVersion = m_ScintillatorFirmware->getFirmwareVersion();
  m_CreateMultiStripDigitsByRun = false; // do not make multi-strip KLMDigits for Run 2+ events
  if ((fwVersion == KLMScintillatorFirmware::FirmwareVersion::c_Invalid) || // this should never happen!
      (fwVersion == KLMScintillatorFirmware::FirmwareVersion::c_Phase2) ||  // for very early data (deprecated)
      (fwVersion == KLMScintillatorFirmware::FirmwareVersion::c_Run1)) {  // for data up to and including 2022b
    m_CreateMultiStripDigitsByRun = m_CreateMultiStripDigits;
  }
  B2INFO("KLM multi-strip digits are " << (m_CreateMultiStripDigitsByRun ? "" : "NOT") << " simulated");
}

checkActive()

bool checkActive ( KLMChannelNumber  channel )

private

Check if channel is active (status is not KLMChannelStatus::c_Dead).

Parameters

[in]

channel

Channel.

Definition at line 142 of file KLMDigitizerModule.cc.

{
  enum KLMChannelStatus::ChannelStatus status =
    m_ChannelStatus->getChannelStatus(channel);
  if (status == KLMChannelStatus::c_Unknown)
    B2FATAL("Incomplete KLM channel status data.");
  return (status != KLMChannelStatus::c_Dead);
}

checkScintillatorFEEParameters()

void checkScintillatorFEEParameters ( )

private

Check scintillator FEE parameters for channel-specific simulation.

Definition at line 86 of file KLMDigitizerModule.cc.

{
  KLMChannelIndex klmChannels;
  for (KLMChannelIndex& klmChannel : klmChannels) {
    KLMChannelNumber channel = m_ElementNumbers->channelNumber(klmChannel.getSubdetector(), klmChannel.getSection(),
                                                               klmChannel.getSector(), klmChannel.getLayer(),
                                                               klmChannel.getPlane(), klmChannel.getStrip());
    const KLMScintillatorFEEData* FEEData = m_FEEPar->getFEEData(channel);
    if (FEEData == nullptr)
      B2FATAL("Incomplete scintillator FEE data.");
    if (FEEData->getPhotoelectronAmplitude() <= 0) {
      B2ERROR("Non-positive photoelectron amplitude. The requested "
              "channel-specific simulation is impossible. "
              "KLMDigitizer is switched to the generic mode."
              << LogVar("Section", klmChannel.getSection())
              << LogVar("Layer", klmChannel.getLayer())
              << LogVar("Sector", klmChannel.getSector())
              << LogVar("Plane", klmChannel.getPlane())
              << LogVar("Strip", klmChannel.getStrip()));
      m_ChannelSpecificSimulation = false;
      return;
    }
  }
}

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.

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

{ terminate(); }

digitizeAsic()

void digitizeAsic ( )

private

Digitization in ASIC.

Definition at line 265 of file KLMDigitizerModule.cc.

{
  std::multimap<KLMElectronicsChannel, const KLMSimHit*>::iterator
  it, it2, upperBound;
  std::multimap<KLMChannelNumber, const KLMSimHit*>::iterator it3;
  it = m_MapAsicSimHit.begin();
  while (it != m_MapAsicSimHit.end()) {
    upperBound = m_MapAsicSimHit.upper_bound(it->first);
    m_MapChannelSimHit.clear();
    for (it2 = it; it2 != upperBound; ++it2) {
      const KLMSimHit* hit = it2->second;
      KLMChannelNumber channel =
        m_ElementNumbers->channelNumber(
          hit->getSubdetector(), hit->getSection(), hit->getSector(),
          hit->getLayer(), hit->getPlane(), hit->getStrip());
      m_MapChannelSimHit.insert(
        std::pair<KLMChannelNumber, const KLMSimHit*>(channel, hit));
    }
    digitizeScintillator();
    if (m_CreateMultiStripDigitsByRun) {
      int nDigits = 0;
      for (int i = 0; i < KLM::c_NChannelsAsic; ++i) {
        if (m_AsicDigits[i] != nullptr)
          nDigits += 1;
      }
      bool multiStripMode = (nDigits >= 2);
      int i = 0;
      while (i < KLM::c_NChannelsAsic) {
        KLMDigit* digit = m_AsicDigits[i];
        if (digit == nullptr) {
          ++i;
          continue;
        }
        // Firmware bug (used OR of struck channel numbers in range 1..15) defeated the
        // expected by-4 grouping so we assume the worst case: all 15 channels are struck.
        // This will be reduced for BKLM scintillators if there are missing detectorChannels.
        int minGroupChannel = 1;
        int maxGroupChannel = KLM::c_NChannelsAsic;
        KLMDigit* arrayDigit = m_Digits.appendNew(*digit);
        KLMElectronicsChannel electronicsChannel(it->first);
        int asic = electronicsChannel.getChannel();
        bool connectedChannelFound = false;
        int minStrip, maxStrip;
        for (int j = minGroupChannel; j <= maxGroupChannel; ++j) {
          electronicsChannel.setChannel(KLM::c_NChannelsAsic * asic + j);
          const KLMChannelNumber* detectorChannel =
            m_ElectronicsMap->getDetectorChannel(&electronicsChannel);
          if (detectorChannel != nullptr) {
            int subdetector, section, sector, layer, plane, strip;
            m_ElementNumbers->channelNumberToElementNumbers(
              *detectorChannel, &subdetector, &section, &sector, &layer,
              &plane, &strip);
            if (!connectedChannelFound) {
              connectedChannelFound = true;
              minStrip = strip;
              maxStrip = strip;
            } else {
              if (strip < minStrip)
                minStrip = strip;
              if (strip > maxStrip)
                maxStrip = strip;
            }
          }
        }
        /* This should never happen. */
        if (!connectedChannelFound)
          B2FATAL("Cannot find connected electronics channels.");
        if (multiStripMode) {
          arrayDigit->setStrip(minStrip);
          arrayDigit->setLastStrip(maxStrip);
        }
        for (int j = i; j < maxGroupChannel; ++j) {
          if (m_AsicDigits[j] == nullptr)
            continue;
          for (it3 = m_AsicDigitSimHitsLowerBound[j];
               it3 != m_AsicDigitSimHitsUpperBound[j]; ++it3) {
            arrayDigit->addRelationTo(it3->second);
          }
        }
        i = maxGroupChannel;
      }
      for (i = 0; i < KLM::c_NChannelsAsic; ++i) {
        if (m_AsicDigits[i] != nullptr)
          delete m_AsicDigits[i];
      }
    } else {
      for (int i = 0; i < KLM::c_NChannelsAsic; ++i) {
        KLMDigit* digit = m_AsicDigits[i];
        if (digit == nullptr)
          continue;
        KLMDigit* arrayDigit = m_Digits.appendNew(*digit);
        for (it3 = m_AsicDigitSimHitsLowerBound[i];
             it3 != m_AsicDigitSimHitsUpperBound[i]; ++it3) {
          arrayDigit->addRelationTo(it3->second);
        }
        delete digit;
      }
    }
    it = upperBound;
  }
}

digitizeRPC()

void digitizeRPC ( )

private

Digitization in RPCs.

Definition at line 159 of file KLMDigitizerModule.cc.

{
  std::multimap<KLMChannelNumber, const KLMSimHit*>::iterator
  it, it2, lowerBound, upperBound;
  it = m_MapChannelSimHit.begin();
  while (it != m_MapChannelSimHit.end()) {
    lowerBound = it;
    upperBound = m_MapChannelSimHit.upper_bound(it->first);
    it = upperBound;
    if (not lowerBound->second->inRPC())
      B2FATAL("KLMDigitizer::digitizeRPC is trying to process a scintillator hit.");
    if (m_EfficiencyMode == c_Strip) {
      float efficiency = m_StripEfficiency->getEfficiency(lowerBound->first);
      if (!efficiencyCorrection(efficiency))
        continue;
    }
    int strip = BKLMElementNumbers::getStripByModule(
                  m_ElementNumbers->localChannelNumberBKLM(lowerBound->first));
    /* Select hit that has the smallest time. */
    it2 = lowerBound;
    const KLMSimHit* hit = lowerBound->second;
    double time = hit->getTime();
    ++it2;
    while (it2 != upperBound) {
      if (it2->second->getTime() < time) {
        time = it2->second->getTime();
        hit = it2->second;
      }
      ++it2;
    }
    KLMDigit* digit = m_Digits.appendNew(hit, strip);
    it2 = lowerBound;
    while (it2 != upperBound) {
      digit->addRelationTo(it2->second);
      ++it2;
    }
  }
}

digitizeScintillator()

void digitizeScintillator ( )

private

Digitization in scintillators.

Definition at line 198 of file KLMDigitizerModule.cc.

{
  uint16_t tdc;
  KLM::ScintillatorSimulator simulator(
    &(*m_DigPar), m_Fitter,
    m_DigitizationInitialTime * m_Time->getCTimePeriod(), m_Debug);
  const KLMScintillatorFEEData* FEEData;
  std::multimap<KLMChannelNumber, const KLMSimHit*>::iterator
  it, lowerBound, upperBound;
  for (int i = 0; i < KLM::c_NChannelsAsic; ++i)
    m_AsicDigits[i] = nullptr;
  it = m_MapChannelSimHit.begin();
  while (it != m_MapChannelSimHit.end()) {
    lowerBound = it;
    upperBound = m_MapChannelSimHit.upper_bound(it->first);
    it = upperBound;
    if (lowerBound->second->inRPC())
      B2FATAL("KLMDigitizer::digitizeScintillator is trying to process a RPC hit.");
    const KLMSimHit* simHit = lowerBound->second;
    if (m_EfficiencyMode == c_Strip) {
      float efficiency = m_StripEfficiency->getEfficiency(lowerBound->first);
      if (!efficiencyCorrection(efficiency))
        continue;
    }
    if (m_ChannelSpecificSimulation) {
      FEEData = m_FEEPar->getFEEData(lowerBound->first);
      if (FEEData == nullptr)
        B2FATAL("Incomplete KLM scintillator FEE data.");
      simulator.setFEEData(FEEData);
    }
    simulator.simulate(lowerBound, upperBound);
    if (simulator.getNGeneratedPhotoelectrons() == 0)
      continue;
    const KLMElectronicsChannel* electronicsChannel =
      m_ElectronicsMap->getElectronicsChannel(lowerBound->first);
    int channel = (electronicsChannel->getChannel() - 1) %
                  KLM::c_NChannelsAsic;
    KLMDigit* digit = new KLMDigit(simHit);
    m_AsicDigits[channel] = digit;
    m_AsicDigitSimHitsLowerBound[channel] = lowerBound;
    m_AsicDigitSimHitsUpperBound[channel] = upperBound;
    digit->setMCTime(simulator.getMCTime());
    digit->setSiPMMCTime(simulator.getSiPMMCTime());
    digit->setNGeneratedPhotoelectrons(
      simulator.getNGeneratedPhotoelectrons());
    if (simulator.getFitStatus() ==
        KLM::c_ScintillatorFirmwareSuccessfulFit) {
      tdc = simulator.getFPGAFit()->getStartTime();
      digit->setCharge(simulator.getFPGAFit()->getMinimalAmplitude());
    } else {
      tdc = 0;
      digit->setCharge(m_DigPar->getADCRange() - 1);
    }
    digit->setTDC(tdc);
    digit->setTime(m_Time->getTimeSimulation(tdc, true));
    digit->setFitStatus(simulator.getFitStatus());
    digit->setNPhotoelectrons(simulator.getNPhotoelectrons());
    digit->setEnergyDeposit(simulator.getEnergy());
    if (m_SaveFPGAFit && (simulator.getFitStatus() ==
                          KLM::c_ScintillatorFirmwareSuccessfulFit)) {
      KLMScintillatorFirmwareFitResult* fit =
        m_FPGAFits.appendNew(*simulator.getFPGAFit());
      digit->addRelationTo(fit);
    }
  }
}

efficiencyCorrection()

bool efficiencyCorrection ( float  efficiency )

private

Efficiency correction.

Parameters

[in]

efficiency

Efficiency.

Returns

True if the digitization passes the efficiency correction.

Definition at line 151 of file KLMDigitizerModule.cc.

{
  if (std::isnan(efficiency))
    B2FATAL("Incomplete KLM efficiency data.");
  double selection = gRandom->Rndm();
  return (selection < efficiency);
}

endRun()

void endRun ( void  )

overridevirtual

This method is called if the current run ends.

Reimplemented from Module.

Definition at line 516 of file KLMDigitizerModule.cc.

{
  delete m_Fitter;
}

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

This method is called for each event.

Reimplemented from Module.

Definition at line 367 of file KLMDigitizerModule.cc.

{
  int i;
  KLMChannelNumber channel;
  m_MapChannelSimHit.clear();
  m_MapAsicSimHit.clear();
  if (m_EfficiencyMode == c_Plane) {
    m_MapPlaneSimHit.clear();
    for (i = 0; i < m_SimHits.getEntries(); i++) {
      const KLMSimHit* hit = m_SimHits[i];
      /* For RPCs. */
      if (hit->getStrip() <= 0)
        continue;
      const MCParticle* particle = hit->getRelatedFrom<MCParticle>();
      /*
       * We do not simulate the plane efficiency for KLMSimHits
       * from beam background because there are no MCParticles associated
       * to them.
       */
      if (particle != nullptr) {
        KLMPlaneNumber plane =
          m_ElementNumbers->planeNumber(
            hit->getSubdetector(), hit->getSection(), hit->getSector(),
            hit->getLayer(), hit->getPlane());
        m_MapPlaneSimHit.insert(
          std::pair<KLMPlaneNumber, const KLMSimHit*>(plane, hit));
      } else {
        B2ASSERT("The KLMSimHit is not related to any MCParticle and "
                 "it is also not a beam background hit.",
                 hit->getBackgroundTag() != BackgroundMetaData::bg_none);
        channel =
          m_ElementNumbers->channelNumber(
            hit->getSubdetector(), hit->getSection(), hit->getSector(),
            hit->getLayer(), hit->getPlane(), hit->getStrip());
        if (checkActive(channel)) {
          bool rpc = hit->inRPC();
          if (rpc) {
            m_MapChannelSimHit.insert(std::pair<KLMChannelNumber, const KLMSimHit*>(channel, hit));
          } else {
            const KLMElectronicsChannel* electronicsChannel =
              m_ElectronicsMap->getElectronicsChannel(channel);
            if (electronicsChannel == nullptr)
              B2FATAL("Incomplete electronics map.");
            KLMElectronicsChannel asic = electronicsChannel->getAsic();
            m_MapAsicSimHit.insert(std::pair<KLMElectronicsChannel, const KLMSimHit*>(asic, hit));
          }
        }
      }
    }
    std::multimap<KLMPlaneNumber, const KLMSimHit*>::iterator it, it2;
    std::multimap<const MCParticle*, const KLMSimHit*> particleHitMap;
    std::multimap<const MCParticle*, const KLMSimHit*>::iterator
    itParticle, it2Particle;
    it = m_MapPlaneSimHit.begin();
    while (it != m_MapPlaneSimHit.end()) {
      particleHitMap.clear();
      it2 = it;
      while (true) {
        const KLMSimHit* hit = it2->second;
        const MCParticle* particle = hit->getRelatedFrom<MCParticle>();
        particleHitMap.insert(
          std::pair<const MCParticle*, const KLMSimHit*>(particle, hit));
        ++it2;
        if (it2 == m_MapPlaneSimHit.end())
          break;
        if (it2->first != it->first)
          break;
      }
      itParticle = particleHitMap.begin();
      while (itParticle != particleHitMap.end()) {
        it2Particle = itParticle;
        const KLMSimHit* hit = it2Particle->second;
        channel =
          m_ElementNumbers->channelNumber(
            hit->getSubdetector(), hit->getSection(), hit->getSector(),
            hit->getLayer(), hit->getPlane(), hit->getStrip());
        float efficiency = m_StripEfficiency->getEfficiency(channel);
        bool hitSelected = efficiencyCorrection(efficiency);
        while (true) {
          hit = it2Particle->second;
          bool rpc = hit->inRPC();
          if (hitSelected) {
            for (int s = hit->getStrip(); s <= hit->getLastStrip(); ++s) {
              channel =
                m_ElementNumbers->channelNumber(
                  hit->getSubdetector(), hit->getSection(), hit->getSector(),
                  hit->getLayer(), hit->getPlane(), s);
              if (!checkActive(channel))
                continue;
              if (rpc) {
                m_MapChannelSimHit.insert(
                  std::pair<KLMChannelNumber, const KLMSimHit*>(channel, hit));
              } else {
                const KLMElectronicsChannel* electronicsChannel =
                  m_ElectronicsMap->getElectronicsChannel(channel);
                if (electronicsChannel == nullptr)
                  B2FATAL("Incomplete electronics map.");
                KLMElectronicsChannel asic = electronicsChannel->getAsic();
                m_MapAsicSimHit.insert(
                  std::pair<KLMElectronicsChannel, const KLMSimHit*>(
                    asic, hit));
              }
            }
          }
          ++it2Particle;
          if (it2Particle == particleHitMap.end())
            break;
          if (it2Particle->first != itParticle->first)
            break;
        }
        itParticle = it2Particle;
      }
      it = it2;
    }
  } else {
    for (i = 0; i < m_SimHits.getEntries(); i++) {
      const KLMSimHit* hit = m_SimHits[i];
      if (hit->inRPC()) {
        if (hit->getStrip() <= 0)
          continue;
        for (int s = hit->getStrip(); s <= hit->getLastStrip(); ++s) {
          channel = m_ElementNumbers->channelNumberBKLM(
                      hit->getSection(), hit->getSector(), hit->getLayer(),
                      hit->getPlane(), s);
          if (checkActive(channel)) {
            m_MapChannelSimHit.insert(
              std::pair<KLMChannelNumber, const KLMSimHit*>(channel, hit));
          }
        }
      } else {
        channel = m_ElementNumbers->channelNumber(
                    hit->getSubdetector(), hit->getSection(), hit->getSector(),
                    hit->getLayer(), hit->getPlane(), hit->getStrip());
        if (checkActive(channel)) {
          const KLMElectronicsChannel* electronicsChannel =
            m_ElectronicsMap->getElectronicsChannel(channel);
          if (electronicsChannel == nullptr)
            B2FATAL("Incomplete electronics map.");
          KLMElectronicsChannel asic = electronicsChannel->getAsic();
          m_MapAsicSimHit.insert(
            std::pair<KLMElectronicsChannel, const KLMSimHit*>(asic, hit));
        }
      }
    }
  }
  digitizeRPC();
  digitizeAsic();
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{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, 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.

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

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

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 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 363 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 381 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 311 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 378 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://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void  )

overridevirtual

Initializer.

Reimplemented from Module.

Definition at line 62 of file KLMDigitizerModule.cc.

{
  m_SimHits.isRequired();
  m_Digits.registerInDataStore();
  m_Digits.registerRelationTo(m_SimHits);
  if (m_SaveFPGAFit) {
    m_FPGAFits.registerInDataStore();
    m_Digits.registerRelationTo(m_FPGAFits);
  }
  if (m_SimulationMode == "Generic") {
    /* Nothing to do. */
  } else if (m_SimulationMode == "ChannelSpecific") {
    m_ChannelSpecificSimulation = true;
  } else {
    B2FATAL("Unknown simulation mode: " << m_SimulationMode);
  }
  if (m_Efficiency == "Strip")
    m_EfficiencyMode = c_Strip;
  else if (m_Efficiency == "Plane")
    m_EfficiencyMode = c_Plane;
  else
    B2FATAL("Unknown efficiency mode: " << m_EfficiencyMode);
}

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.

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

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 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

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

Reimplemented from Module.

Definition at line 521 of file KLMDigitizerModule.cc.

{
}

Member Data Documentation

m_AsicDigits

KLMDigit* m_AsicDigits[KLM::c_NChannelsAsic]

private

Digits corresponding to ASIC channels.

Definition at line 187 of file KLMDigitizerModule.h.

m_AsicDigitSimHitsLowerBound

std::multimap<KLMChannelNumber,constKLMSimHit*>::iterator m_AsicDigitSimHitsLowerBound[KLM::c_NChannelsAsic]

private

Simulation hits lower bound for ASIC digit.

Definition at line 191 of file KLMDigitizerModule.h.

m_AsicDigitSimHitsUpperBound

std::multimap<KLMChannelNumber,constKLMSimHit*>::iterator m_AsicDigitSimHitsUpperBound[KLM::c_NChannelsAsic]

private

Simulation hits upper bound for ASIC digit.

Definition at line 195 of file KLMDigitizerModule.h.

m_ChannelSpecificSimulation

bool m_ChannelSpecificSimulation

private

Whether the simulation is channel-specific.

Definition at line 154 of file KLMDigitizerModule.h.

m_ChannelStatus

DBObjPtr<KLMChannelStatus> m_ChannelStatus

private

Channel status.

Definition at line 127 of file KLMDigitizerModule.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_CreateMultiStripDigits

bool m_CreateMultiStripDigits

private

Whether to create multi-strip digits.

Definition at line 169 of file KLMDigitizerModule.h.

m_CreateMultiStripDigitsByRun

bool m_CreateMultiStripDigitsByRun

private

Whether to create multi-strip digits for one particular run.

Definition at line 172 of file KLMDigitizerModule.h.

m_Debug

bool m_Debug

private

Use debug mode in EKLM::ScintillatorSimulator or not.

Definition at line 175 of file KLMDigitizerModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_DigitizationInitialTime

int m_DigitizationInitialTime

private

Initial digitization time in CTIME periods.

Definition at line 157 of file KLMDigitizerModule.h.

m_Digits

StoreArray<KLMDigit> m_Digits

private

KLM digits.

Definition at line 204 of file KLMDigitizerModule.h.

m_DigPar

DBObjPtr<KLMScintillatorDigitizationParameters> m_DigPar

private

Scintillator digitization parameters.

Definition at line 133 of file KLMDigitizerModule.h.

m_Efficiency

std::string m_Efficiency

private

Efficiency determination mode ("Strip" or "Plane").

Definition at line 163 of file KLMDigitizerModule.h.

m_EfficiencyMode

EfficiencyMode m_EfficiencyMode

private

Efficiency determination mode (converted from the string parameter).

Definition at line 166 of file KLMDigitizerModule.h.

m_ElectronicsMap

DBObjPtr<KLMElectronicsMap> m_ElectronicsMap

private

Electronics map.

Definition at line 130 of file KLMDigitizerModule.h.

m_ElementNumbers

const KLMElementNumbers* m_ElementNumbers

private

Element numbers.

Definition at line 148 of file KLMDigitizerModule.h.

m_FEEPar

DBObjPtr<KLMScintillatorFEEParameters> m_FEEPar

private

Scintillator FEE parameters.

Definition at line 136 of file KLMDigitizerModule.h.

m_Fitter

KLM::ScintillatorFirmware* m_Fitter

private

FPGA fitter.

Definition at line 198 of file KLMDigitizerModule.h.

m_FPGAFits

StoreArray<KLMScintillatorFirmwareFitResult> m_FPGAFits

private

FPGA fits.

Definition at line 207 of file KLMDigitizerModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_MapAsicSimHit

std::multimap<KLMElectronicsChannel, const KLMSimHit*> m_MapAsicSimHit

private

Simulation hit map (by ASIC).

Definition at line 184 of file KLMDigitizerModule.h.

m_MapChannelSimHit

std::multimap<KLMChannelNumber, const KLMSimHit*> m_MapChannelSimHit

private

Simulation hit map (by channel).

Definition at line 181 of file KLMDigitizerModule.h.

m_MapPlaneSimHit

std::multimap<KLMPlaneNumber, const KLMSimHit*> m_MapPlaneSimHit

private

Simulation hit map (by plane).

Definition at line 178 of file KLMDigitizerModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

m_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_SaveFPGAFit

bool m_SaveFPGAFit

private

Save FPGA fit data (KLMScintillatorFirmwareFitResult).

Definition at line 160 of file KLMDigitizerModule.h.

m_ScintillatorFirmware

DBObjPtr<KLMScintillatorFirmware> m_ScintillatorFirmware

private

Scintillator FEE firmware version.

Definition at line 139 of file KLMDigitizerModule.h.

m_SimHits

StoreArray<KLMSimHit> m_SimHits

private

Simulation hits.

Definition at line 201 of file KLMDigitizerModule.h.

m_SimulationMode

std::string m_SimulationMode

private

Simulation mode.

Definition at line 151 of file KLMDigitizerModule.h.

m_StripEfficiency

DBObjPtr<KLMStripEfficiency> m_StripEfficiency

private

Strip efficiency.

Definition at line 142 of file KLMDigitizerModule.h.

m_Time

KLMTime* m_Time

private

Time conversion.

Definition at line 145 of file KLMDigitizerModule.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.

---

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

• klm/modules/KLMDigitizer/include/KLMDigitizerModule.h
• klm/modules/KLMDigitizer/src/KLMDigitizerModule.cc