This module simulates ECL Luminosity Online Monitor logic, i.e. More...

#include <eclLOMModule.h>

Inheritance diagram for ECLLOMModule:

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

virtual	~ECLLOMModule ()
	Destructor.

virtual void	initialize () override
	Initialize variables.

virtual void	beginRun () override
	begin run.

virtual void	event () override
	event per event.

virtual void	endRun () override
	end run.

virtual void	terminate () override
	terminate.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.

const std::string &	getName () const
	Returns the name of the module.

const std::string &	getType () const
	Returns the type of the module (i.e.

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module.

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

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

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module.

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.

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

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

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.

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

void	setDescription (const std::string &description)
	Sets the description of the module.

void	setType (const std::string &type)
	Set the module type.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.

void	setReturnValue (int value)
	Sets the return value for this module as integer.

void	setReturnValue (bool value)
	Sets the return value for this module as bool.

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
void	get_MCparticles ()
	Get MC particles parameters.

void	get_waveforms ()
	Get ECL waveforms comdined into sectors.

void	calculate_discr_output ()
	Transforms waveforms into discriminators output.

void	calculate_amplitudes ()
	Calculates amplitude [GeV] in an event for each sector.

bool	calculate_BE_quality (int iSample)
	Return Quality (topology) flag at sample point, iSample, for Backward Endcap.

bool	calculate_FE_quality (int iSample)
	Return Quality (topology) flag at sample point, iSample, for Forward Endcap.

void	calculate_coincidence (int iSample)
	Calculates Coincidence Matrix at sample point, iSample.

void	clear_lom_data ()
	Clear internal data.

std::list< ModulePtr >	getModules () const override
	no submodules, return empty list

std::string	getPathString () const override
	return the module name.

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::string	m_testFileName
	Name of file to save output.

double	m_thresholdFE
	Threshold [GeV] on signal for Forward Endcap .

double	m_thresholdBE
	Threshold [GeV] on signal for Backward Endcap .

double	m_thresholdBkg
	Threshold [GeV] on signal when sector considered as lighted.

double	m_discrTime
	Discriminator's signal duration in ns.

bool	m_includeInnerFE
	Flag to include Inner part of the Forward Endcap.

bool	m_saveSignal
	Flag to save signal wavefroms into file.

int	m_evtNum
	Event number.

double	m_BE_Waveform_100ns [16][64]
	Waveforms with 100ns sampling for Backward Endcap sectors.

double	m_FE_Waveform_100ns [16][64]
	Waveforms with 100ns sampling for Forward Endcap sectors.

double	m_mcen [2]
	Monte Carlo energy of the final state particles in main frame.

double	m_mcth [2]
	Monte Carlo thetha of the final state particles in main frame.

double	m_mcph [2]
	Monte Carlo phi of the final state particles in main frame.

double	m_com_en [2]
	Monte Carlo energy of the final state particles in CMS frame.

double	m_com_th [2]
	Monte Carlo thetha of the final state particles in CMS frame.

double	m_com_ph [2]
	Monte Carlo phi of the final state particles in CMS frame.

StoreArray< MCParticle >	m_MCParticles
	MC particles.

StoreArray< TRGECLWaveform >	m_TrgEclWaveforms
	Trigger waveforms.

bool	m_isBhabha
	Bha-bha signal for an event.

int	m_BhNum
	Number of Bha-bha signals in an event.

double	m_BE_Amplitude [16]
	Calculated amplitudes in sectors of Backward Endcap.

double	m_FE_Amplitude [16]
	Calculated amplitudes in sectors of Forward Endcap.

double	m_BESum_Amplitude [16]
	Calculated amplitudes in running sums of Backward Endcap.

double	m_FESum_Amplitude [16]
	Calculated amplitudes in running sums of Forward Endcap.

double	m_BE_Pedal [16]
	Calculated pedestal values for Backward Endcap.

double	m_FE_Pedal [16]
	Calculated pedestal values for Forward Endcap.

double	m_FESum_MaxAmp
	Maximum running sum amplitude in an event for Forward endcap.

double	m_BESum_MaxAmp
	Maximum running sum amplitude in an event for Backward endcap.

int	m_FESum_MaxId
	Id of a sector with maximum amplitude in Forward endcap.

int	m_BESum_MaxId
	Id of a sector with maximum amplitude in Backward endcap.

TH2D *	m_h2Coin
	Store number of coincedencies for i:j sectors (Forward:Backward) over all events.

TH2D *	m_h2SumCoin
	Store number of coincedencies in running sums for i:j sectors (Forward:Backward) over all events.

TH2D *	m_h2FEAmp
	Store sectors amplitudes for Forward endcap over all events.

TH2D *	m_h2BEAmp
	Store sectors amplitudes for Backward endcap over all events.

TH1D *	m_h1BEHits
	Store number of events when Backward sector i has signal exceeding Bha-Bha threshold over all events.

TH1D *	m_h1FEHits
	Store number of events when Forward sector i has signal exceeding Bha-Bha threshold over all events.

TFile *	m_testfile
	File to save output.

TTree *	m_testtree
	Tree to store output.

int	m_NSamples
	m_NSamples=631, number of samples for 10ns sampling.

double	m_BE_Waveform_10ns [16][631]
	Waveforms with 10ns sampling for Backward Endcap sectors.

double	m_FE_Waveform_10ns [16][631]
	Waveforms with 10ns sampling for Forward Endcap sectors.

double	m_BESum_Waveform_10ns [16][631]
	Running sum's waveforms with 10ns sampling for Backward Endcap sectors.

double	m_FESum_Waveform_10ns [16][631]
	Running sum's waveforms with 10ns sampling for Forward Endcap sectors.

bool	m_FESum_Discr [16][631]
	Discriminators values for running sums of Forward Endcap.

bool	m_BESum_Discr [16][631]
	Discriminators values for running sums of Backward Endcap.

bool	m_FEQual_Discr [16][631]
	Discriminators values for Quality signal of Forward Endcap.

bool	m_BEQual_Discr [16][631]
	Discriminators values for Quality signal of Backward Endcap.

bool	m_isBhabhaPatternFE
	Quality signal for Forward endcap.

bool	m_isBhabhaPatternBE
	Quality signal for Backward endcap.

int	m_CoincidenceMatrix [16][16]
	Stores current coincidence duration [in samples] between waveforms exceeding threshold in i:j sectors (Forward:Backward).

int	m_SumCoincidenceMatrix [16][16]
	Stores current coincidence duration [in samples] between running sums discriminators in i:j sectors (Forward:Backward).

int	m_CoincidenceCounterMatrix [16][16]
	Stores number of concidences between waveforms exceeding threshold in i:j sectors (Forward:Backward).

int	m_SumCoincidenceCounterMatrix [16][16]
	Stores number of concidences between running sums discriminators in i:j sectors (Forward:Backward).

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

This module simulates ECL Luminosity Online Monitor logic, i.e.

counts events with back-to-back energy depositions in the ECL endcaps utilizing coincedence scheme.

Definition at line 33 of file eclLOMModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

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

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

Definition at line 77 of file Module.h.

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

Constructor & Destructor Documentation

◆ ECLLOMModule()

ECLLOMModule ( )

Constructor.

Definition at line 22 of file eclLOMModule.cc.

{
  setDescription("module to emulate Luminosity Online Monitor");
  addParam("thresholdFE", m_thresholdFE, "Threshold for Forward Endcap [GeV]", 3.0);
  addParam("thresholdBE", m_thresholdBE, "Threshold for Backward Endcap [GeV]", 1.0);
  addParam("thresholdBkg", m_thresholdBkg, "Threshold when sector considered as lighted [GeV]", 0.5);
  addParam("discrTime", m_discrTime, "Duration of '1' (positive) signal from discriminators [ns]", 1000.0);
  addParam("includeInnerFE", m_includeInnerFE, "Flag to include/exclude Inner part of the Forward Endcap", false);
  addParam("saveSignal", m_saveSignal, "Flag to store or not signals' waveforms", false);
  addParam("testFileName", m_testFileName, "output file", std::string("lomtest.root"));
 
  m_evtNum = 0;
  for (int i = 0; i < 16; i++) {
    for (int j = 0; j < 16; j++) {
      m_CoincidenceCounterMatrix[i][j] = 0;
      m_SumCoincidenceCounterMatrix[i][j] = 0;
    }
  }
}

◆ ~ECLLOMModule()

~ECLLOMModule ( )

virtual

Destructor.

Definition at line 42 of file eclLOMModule.cc.

{
 
}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

begin run.

Reimplemented from Module.

Definition at line 95 of file eclLOMModule.cc.

96{

97}

◆ calculate_amplitudes()

void calculate_amplitudes ( )

private

Calculates amplitude [GeV] in an event for each sector.

Definition at line 344 of file eclLOMModule.cc.

{
  for (int iSample = 0; iSample < m_NSamples; iSample++) {
    for (int isector = 0; isector < 16; isector++) {
      if (m_FE_Waveform_10ns[isector][iSample] > m_FE_Amplitude[isector]) m_FE_Amplitude[isector] = m_FE_Waveform_10ns[isector][iSample];
      if (m_FESum_Waveform_10ns[isector][iSample] > m_FESum_Amplitude[isector]) m_FESum_Amplitude[isector] =
          m_FESum_Waveform_10ns[isector][iSample];
      if (m_BE_Waveform_10ns[isector][iSample] > m_BE_Amplitude[isector]) m_BE_Amplitude[isector] = m_BE_Waveform_10ns[isector][iSample];
      if (m_BESum_Waveform_10ns[isector][iSample] > m_BESum_Amplitude[isector]) m_BESum_Amplitude[isector] =
          m_BESum_Waveform_10ns[isector][iSample];
    }
  }
  for (int i = 0; i < 16; i++) {
    if (m_FESum_Amplitude[i] > m_FESum_MaxAmp) {
      m_FESum_MaxAmp  = m_FESum_Amplitude[i];
      m_FESum_MaxId = i;
    }
    if (m_BESum_Amplitude[i] > m_BESum_MaxAmp) {
      m_BESum_MaxAmp = m_BESum_Amplitude[i];
      m_BESum_MaxId  = i;
    }
    if (m_FE_Amplitude[i] > 0.5) m_h2FEAmp->Fill(i, m_FE_Amplitude[i]);
    if (m_BE_Amplitude[i] > 0.5) m_h2BEAmp->Fill(i, m_BE_Amplitude[i]);
 
    if (m_FE_Amplitude[i] > m_thresholdFE) m_h1FEHits->Fill(i);
    if (m_BE_Amplitude[i] > m_thresholdBE) m_h1BEHits->Fill(i);
  }
}

◆ calculate_BE_quality()

bool calculate_BE_quality ( int iSample )

private

Return Quality (topology) flag at sample point, iSample, for Backward Endcap.

Definition at line 255 of file eclLOMModule.cc.

{
  int nhit = 0;
  int First = 0;
  // calculate quality signal for backward endcap
  for (int iBESector = 0; iBESector < 16; iBESector++) {
    if (m_BEQual_Discr[iBESector][iSample]) {
      nhit++;
      if (nhit == 1) First = iBESector;
      if (nhit == 2 && !((iBESector + 1) % 16 == First || (First + 1) % 16 == iBESector)) return (false);
      if (nhit >= 3) return (false);
    }
  }
  return (true);
}

◆ calculate_coincidence()

void calculate_coincidence ( int iSample )

private

Calculates Coincidence Matrix at sample point, iSample.

Performs logical multiplication of disciminators signals for each sector (16x16 matrix). Should be called successively on iSample.

Definition at line 286 of file eclLOMModule.cc.

{
  for (int iFESector = 0; iFESector < 16; iFESector++) {
    for (int iBESector = 0; iBESector < 16; iBESector++) {
 
      if (m_FE_Waveform_10ns[iFESector][iSample] > m_thresholdFE && m_BE_Waveform_10ns[iBESector][iSample] > m_thresholdBE) {
        if (m_CoincidenceMatrix[iFESector][iBESector] == 0) m_CoincidenceCounterMatrix[iFESector][iBESector]++;
        m_CoincidenceMatrix[iFESector][iBESector]++;
      } else {
        m_CoincidenceMatrix[iFESector][iBESector] = 0;
      }
 
      if (m_FESum_Discr[iFESector][iSample] && m_BESum_Discr[iBESector][iSample]) {
        if (m_SumCoincidenceMatrix[iFESector][iBESector] == 0) m_SumCoincidenceCounterMatrix[iFESector][iBESector]++;
        m_SumCoincidenceMatrix[iFESector][iBESector]++;
      }
      m_SumCoincidenceMatrix[iFESector][iBESector] = 0;
    }
  }
}

◆ calculate_discr_output()

void calculate_discr_output ( )

private

Transforms waveforms into discriminators output.

Calculates running sums (energy deposition in two consecutive sectors) for endcaps. Unit output is emitted for &DiscrTime [ns] when signal exceeds given threshold. Also calculates and subtracts pedestals, and linearly interpolates waveforms from 100ns sampling interval to 10ns.

Definition at line 198 of file eclLOMModule.cc.

{
  for (int iSector = 0; iSector < 16; iSector++) { // Calculating pedestals
    for (int iSample = 15; iSample < 36; iSample++) {
      m_BE_Pedal[iSector] += m_BE_Waveform_100ns[iSector][iSample] / 20;
      m_FE_Pedal[iSector] += m_FE_Waveform_100ns[iSector][iSample] / 20;
    }
  }
  double dAdT; // convert 100 ns signal to 10 ns
  for (int iSector = 0; iSector < 16; iSector++) { // Linear interpolation from 100ns to 10ns
    for (int iSample = 0; iSample < 63; iSample++) {
      // forward
      dAdT = (m_FE_Waveform_100ns[iSector][iSample + 1] - m_FE_Waveform_100ns[iSector][iSample]) / 10.0;
      m_FE_Waveform_100ns[iSector][iSample] -= m_FE_Pedal[iSector]; //remove pedestals
      for (int j = 0; j < 10; j++) m_FE_Waveform_10ns[iSector][iSample * 10 + j] = m_FE_Waveform_100ns[iSector][iSample] + j * dAdT;
      m_FE_Waveform_10ns[iSector][630] = m_FE_Waveform_100ns[iSector][63] - m_FE_Pedal[iSector];
      //backward
      dAdT = (m_BE_Waveform_100ns[iSector][iSample + 1] - m_BE_Waveform_100ns[iSector][iSample]) / 10.0;
      m_BE_Waveform_100ns[iSector][iSample] -= m_BE_Pedal[iSector];
      for (int j = 0; j < 10; j++) m_BE_Waveform_10ns[iSector][iSample * 10 + j] = m_BE_Waveform_100ns[iSector][iSample] + j * dAdT;
      m_BE_Waveform_10ns[iSector][630] = m_BE_Waveform_100ns[iSector][63] - m_BE_Pedal[iSector];
    }
  }
  // calculate running sums for 10ns signal
  int TimeOfDiscr = int(m_discrTime / 10); //discriminator duration in samples
  for (int iSector = 0; iSector < 16; iSector++) {
    for (int iSample = 1; iSample < m_NSamples; iSample++) {
      int iNextSector = (iSector + 1) % 16;
      m_BESum_Waveform_10ns[iSector][iSample] = m_BE_Waveform_10ns[iSector][iSample] + m_BE_Waveform_10ns[iNextSector][iSample];
      m_FESum_Waveform_10ns[iSector][iSample] = m_FE_Waveform_10ns[iSector][iSample] + m_FE_Waveform_10ns[iNextSector][iSample];
 
      //filling Discriminators' signals
      if (m_FESum_Waveform_10ns[iSector][iSample] > m_thresholdFE && m_FESum_Discr[iSector][iSample] == 0) {
        for (int j = iSample; j < iSample + TimeOfDiscr; j++) {
          if (j < m_NSamples) m_FESum_Discr[iSector][j] = 1;
        }
      }
      if (m_BESum_Waveform_10ns[iSector][iSample] > m_thresholdBE && m_BESum_Discr[iSector][iSample] == 0) {
        for (int j = iSample; j < iSample + TimeOfDiscr; j++) {
          if (j < m_NSamples) m_BESum_Discr[iSector][j] = 1;
        }
      }
      if (m_FE_Waveform_10ns[iSector][iSample] > m_thresholdBkg && m_FEQual_Discr[iSector][iSample] == 0) {
        for (int j = iSample; j < iSample + TimeOfDiscr; j++) {
          if (j < m_NSamples) m_FEQual_Discr[iSector][j] = 1;
        }
      }
      if (m_BE_Waveform_10ns[iSector][iSample] > m_thresholdBkg && m_BEQual_Discr[iSector][iSample] == 0) {
        for (int j = iSample; j < iSample + TimeOfDiscr; j++) {
          if (j < m_NSamples) m_BEQual_Discr[iSector][j] = 1;
        }
      }
    }
  }
}

◆ calculate_FE_quality()

bool calculate_FE_quality ( int iSample )

private

Return Quality (topology) flag at sample point, iSample, for Forward Endcap.

Definition at line 271 of file eclLOMModule.cc.

{
  int nhit = 0;
  int First = 0;
  for (int iFESector = 0; iFESector < 16; iFESector++) {
    if (m_FEQual_Discr[iFESector][iSample]) {
      nhit++;
      if (nhit == 1) First = iFESector;
      if (nhit == 2 && !((iFESector + 1) % 16 == First || (First + 1) % 16 == iFESector)) return (false);
      if (nhit >= 3) return (false);
    }
  }
  return (true);
}

◆ clear_lom_data()

void clear_lom_data ( )

private

Clear internal data.

Definition at line 308 of file eclLOMModule.cc.

{
  for (int isector = 0; isector < 16; isector++) {
    for (int iSample = 0; iSample < 64; iSample++) {
      m_BE_Waveform_100ns[isector][iSample] = 0;
      m_FE_Waveform_100ns[isector][iSample] = 0;
    }
    for (int iSample = 0; iSample < m_NSamples; iSample++) {
      m_BE_Waveform_10ns[isector][iSample] = 0;
      m_FE_Waveform_10ns[isector][iSample] = 0;
      m_BESum_Waveform_10ns[isector][iSample] = 0;
      m_FESum_Waveform_10ns[isector][iSample] = 0;
      m_FESum_Discr[isector][iSample] = 0;
      m_BESum_Discr[isector][iSample] = 0;
      m_FEQual_Discr[isector][iSample] = 0;
      m_BEQual_Discr[isector][iSample] = 0;
    }
    m_BE_Pedal[isector] = 0;
    m_FE_Pedal[isector] = 0;
    m_BE_Amplitude[isector] = 0;
    m_FE_Amplitude[isector] = 0;
    m_BESum_Amplitude[isector] = 0;
    m_FESum_Amplitude[isector] = 0;
    for (int jsector = 0; jsector < 16; jsector++) {
      m_CoincidenceMatrix[isector][jsector] = 0;
      m_SumCoincidenceMatrix[isector][jsector] = 0;
    }
  }
  m_isBhabha = 0;
  m_BhNum = 0;
  m_FESum_MaxAmp = 0;
  m_BESum_MaxAmp = 0;
  m_FESum_MaxId = -1;
  m_BESum_MaxId = -1;
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ endRun()

void endRun ( void )

overridevirtual

end run.

Reimplemented from Module.

Definition at line 126 of file eclLOMModule.cc.

127{

128}

◆ 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

event per event.

Reimplemented from Module.

Definition at line 99 of file eclLOMModule.cc.

{
  clear_lom_data();
  get_MCparticles();
  get_waveforms();
  calculate_discr_output();
  calculate_amplitudes();
  // LOM logic
  for (int iSample = 300; iSample < 500; iSample++) { //300-500 window where BhaBha is expected
    m_isBhabhaPatternFE = calculate_FE_quality(iSample);
    m_isBhabhaPatternBE = calculate_BE_quality(iSample);
    calculate_coincidence(iSample);
    // generate bhabha signal
    for (int iFESector = 0; iFESector < 16; iFESector++) {
      // check opposite running sum:
      int iBESector = (iFESector + 8) % 16;
      if (m_SumCoincidenceMatrix[iFESector][iBESector] == 1 && m_isBhabhaPatternFE && m_isBhabhaPatternBE) {
        //coincidence at first tick
        m_isBhabha = true;
        m_BhNum++;
      }
    }
  }
  m_testtree->Fill();
  m_evtNum++;
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ get_MCparticles()

void get_MCparticles ( )

private

Get MC particles parameters.

Requires MCParticle to be stored.

Definition at line 146 of file eclLOMModule.cc.

{
  int nm_MCParticles = m_MCParticles.getEntries();
  if (nm_MCParticles >= 4) {
    for (int ind = 2; ind < 4; ind++) {
      m_mcen[ind - 2] = m_MCParticles[ind]->getEnergy();
      m_mcth[ind - 2] = m_MCParticles[ind]->getMomentum().Theta();
      m_mcph[ind - 2] = m_MCParticles[ind]->getMomentum().Phi();
    }
 
    ROOT::Math::PxPyPzEVector SummP(m_MCParticles[0]->get4Vector() + m_MCParticles[1]->get4Vector());
    ROOT::Math::XYZVector Boost_backV = SummP.BoostToCM();
    ROOT::Math::PxPyPzEVector ComP[2];
    ComP[0] = m_MCParticles[2]->get4Vector();
    ComP[1] = m_MCParticles[3]->get4Vector();
    ComP[0] = ROOT::Math::Boost(Boost_backV) * ComP[0];
    ComP[1] = ROOT::Math::Boost(Boost_backV) * ComP[1];
    for (int ind = 0; ind < 2; ind++) {
      m_com_en[ind] = ComP[ind].E();
      m_com_th[ind] = ComP[ind].Theta();
      m_com_ph[ind] = ComP[ind].Phi();
    }
  }
}

◆ get_waveforms()

void get_waveforms ( )

private

Get ECL waveforms comdined into sectors.

For both endcaps there are 16 sectors. Requires TRGECLWaveform to be stored.

Definition at line 171 of file eclLOMModule.cc.

{
  //int n_trg_digi = TrgEclDigiArray.getEntries();
  int n_trg_wf   = m_TrgEclWaveforms.getEntries();
  // calculate signals of endcap sectors for LOM input
  // as sum of corresponding TC signals
  for (int i = 0; i < n_trg_wf; i++) {
    const TRGECLWaveform* TCWaveform = m_TrgEclWaveforms[i];
    //int m_tcid = TCWaveform->getTCID();
    int tc_theta_id = TCWaveform->getThetaID(); //FE:1,2,3 BE:16,17  Checked for rel 4 02 08
    int tc_phi_id   = TCWaveform->getPhiID();   // 1 - 32
    double m_wf[64];
    TCWaveform->fillWaveform(m_wf);
 
    int iSectorIndex = (tc_phi_id - 1) / 2; // from 0 to 15
    if (tc_theta_id == 1 && !m_includeInnerFE) continue;
 
    for (int iSample = 0; iSample < 64; iSample++) {
      if (tc_theta_id <= 3) {   //Forward Endcap
        m_FE_Waveform_100ns[iSectorIndex][iSample] += m_wf[iSample];
      } else { // Backward Endcap
        if (tc_theta_id == 16 || tc_theta_id == 17) m_BE_Waveform_100ns[iSectorIndex][iSample] += m_wf[iSample];
      }
    }
  }
}

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void )

overridevirtual

Initialize variables.

Reimplemented from Module.

Definition at line 47 of file eclLOMModule.cc.

{
  if (!(m_MCParticles.isRequired() && m_TrgEclWaveforms.isRequired())) {
    //Fatal is not necessary here as the storeArrays should just look
    //empty if not registered but let's make sure everything is present
    B2FATAL("Not all collections found, exiting processing");
  }
 
  m_testfile = new TFile(m_testFileName.c_str(), "RECREATE");
  m_testtree = new TTree("lom_tree", "");
 
  m_testtree->Branch("ev", &m_evtNum);
  m_testtree->Branch("BE_amp[16]", m_BE_Amplitude, "BE_amp[16]/D");
  m_testtree->Branch("FE_amp[16]", m_FE_Amplitude, "FE_amp[16]/D");
  m_testtree->Branch("FESum_MaxAmp", &m_FESum_MaxAmp);
  m_testtree->Branch("BESum_MaxAmp", &m_BESum_MaxAmp);
  m_testtree->Branch("FESum_MaxId", &m_FESum_MaxId);
  m_testtree->Branch("BESum_MaxId", &m_BESum_MaxId);
  m_testtree->Branch("BE_Pedal[16]", m_BE_Pedal, "BE_Pedal[16]/D");
  m_testtree->Branch("FE_Pedal[16]", m_FE_Pedal, "FE_Pedal[16]/D");
 
  m_testtree->Branch("Bhabha", &m_isBhabha);
  m_testtree->Branch("BhNum", &m_BhNum);
 
  m_testtree->Branch("mc_en[2]", m_mcen, "mc_en[2]/D");
  m_testtree->Branch("mc_th[2]", m_mcth, "mc_th[2]/D");
  m_testtree->Branch("mc_ph[2]", m_mcph, "mc_ph[2]/D");
 
  m_testtree->Branch("com_en[2]", m_com_en, "com_en[2]/D");
  m_testtree->Branch("com_th[2]", m_com_th, "com_th[2]/D");
  m_testtree->Branch("com_ph[2]", m_com_ph, "com_ph[2]/D");
 
  if (m_saveSignal) {
    m_testtree->Branch("BE_wf[16][64]", m_BE_Waveform_100ns, "BE_wf[16][64]/D");
    m_testtree->Branch("FE_wf[16][64]", m_FE_Waveform_100ns, "FE_wf[16][64]/D");
  }
 
  //additional histograms. Represent data over the whole dataset:
  m_h2Coin = new TH2D("Coins", "Coincidence Matrix", 16, 0, 16, 16, 0, 16);
  m_h2SumCoin = new TH2D("SumCoins", "Sum Coincidence Matrix", 16, 0, 16, 16, 0, 16);
  m_h2FEAmp = new TH2D("FE_AmpId", "", 16, 0, 16, 100, 0, 8);
  m_h2BEAmp = new TH2D("BE_AmpId", "", 16, 0, 16, 100, 0, 8);
  m_h1BEHits = new TH1D("BE_Fired", "", 16, 0, 16);
  m_h1FEHits = new TH1D("FE_Fired", "", 16, 0, 16);
 
  m_NSamples = 631;
}

◆ setAbortLevel()

void setAbortLevel ( int abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

◆ setDebugLevel()

void setDebugLevel ( int debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

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

Definition at line 249 of file Module.cc.

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

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

void terminate ( void )

overridevirtual

terminate.

Reimplemented from Module.

Definition at line 130 of file eclLOMModule.cc.

{
 
  for (int i = 0; i < 16; i++) {
    for (int j = 0; j < 16; j++) {
      std::cout << m_CoincidenceCounterMatrix[i][j] << " ";
      m_h2Coin->SetBinContent(i + 1, j + 1, m_CoincidenceCounterMatrix[i][j]);
      m_h2SumCoin->SetBinContent(i + 1, j + 1, m_SumCoincidenceCounterMatrix[i][j]);
    }
    std::cout << std::endl;
  }
  m_testfile->Write();
  m_testfile->Close();
}

Member Data Documentation

◆ m_BE_Amplitude

double m_BE_Amplitude[16]

private

Calculated amplitudes in sectors of Backward Endcap.

Definition at line 128 of file eclLOMModule.h.

◆ m_BE_Pedal

double m_BE_Pedal[16]

private

Calculated pedestal values for Backward Endcap.

Definition at line 132 of file eclLOMModule.h.

◆ m_BE_Waveform_100ns

double m_BE_Waveform_100ns[16][64]

private

Waveforms with 100ns sampling for Backward Endcap sectors.

Definition at line 109 of file eclLOMModule.h.

◆ m_BE_Waveform_10ns

double m_BE_Waveform_10ns[16][631]

private

Waveforms with 10ns sampling for Backward Endcap sectors.

Definition at line 151 of file eclLOMModule.h.

◆ m_BEQual_Discr

bool m_BEQual_Discr[16][631]

private

Discriminators values for Quality signal of Backward Endcap.

Definition at line 158 of file eclLOMModule.h.

◆ m_BESum_Amplitude

double m_BESum_Amplitude[16]

private

Calculated amplitudes in running sums of Backward Endcap.

Definition at line 130 of file eclLOMModule.h.

◆ m_BESum_Discr

bool m_BESum_Discr[16][631]

private

Discriminators values for running sums of Backward Endcap.

Definition at line 156 of file eclLOMModule.h.

◆ m_BESum_MaxAmp

double m_BESum_MaxAmp

private

Maximum running sum amplitude in an event for Backward endcap.

Definition at line 135 of file eclLOMModule.h.

◆ m_BESum_MaxId

int m_BESum_MaxId

private

Id of a sector with maximum amplitude in Backward endcap.

Definition at line 137 of file eclLOMModule.h.

◆ m_BESum_Waveform_10ns

double m_BESum_Waveform_10ns[16][631]

private

Running sum's waveforms with 10ns sampling for Backward Endcap sectors.

Definition at line 153 of file eclLOMModule.h.

◆ m_BhNum

int m_BhNum

private

Number of Bha-bha signals in an event.

Could be >1.

Definition at line 127 of file eclLOMModule.h.

◆ m_CoincidenceCounterMatrix

int m_CoincidenceCounterMatrix[16][16]

private

Stores number of concidences between waveforms exceeding threshold in i:j sectors (Forward:Backward).

Definition at line 163 of file eclLOMModule.h.

◆ m_CoincidenceMatrix

int m_CoincidenceMatrix[16][16]

private

Stores current coincidence duration [in samples] between waveforms exceeding threshold in i:j sectors (Forward:Backward).

Definition at line 161 of file eclLOMModule.h.

◆ m_com_en

double m_com_en[2]

private

Monte Carlo energy of the final state particles in CMS frame.

Definition at line 114 of file eclLOMModule.h.

◆ m_com_ph

double m_com_ph[2]

private

Monte Carlo phi of the final state particles in CMS frame.

Definition at line 116 of file eclLOMModule.h.

◆ m_com_th

double m_com_th[2]

private

Monte Carlo thetha of the final state particles in CMS frame.

Definition at line 115 of file eclLOMModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_discrTime

double m_discrTime

private

Discriminator's signal duration in ns.

Definition at line 103 of file eclLOMModule.h.

◆ m_evtNum

int m_evtNum

private

Event number.

Definition at line 108 of file eclLOMModule.h.

◆ m_FE_Amplitude

double m_FE_Amplitude[16]

private

Calculated amplitudes in sectors of Forward Endcap.

Definition at line 129 of file eclLOMModule.h.

◆ m_FE_Pedal

double m_FE_Pedal[16]

private

Calculated pedestal values for Forward Endcap.

Definition at line 133 of file eclLOMModule.h.

◆ m_FE_Waveform_100ns

double m_FE_Waveform_100ns[16][64]

private

Waveforms with 100ns sampling for Forward Endcap sectors.

Definition at line 110 of file eclLOMModule.h.

◆ m_FE_Waveform_10ns

double m_FE_Waveform_10ns[16][631]

private

Waveforms with 10ns sampling for Forward Endcap sectors.

Definition at line 152 of file eclLOMModule.h.

◆ m_FEQual_Discr

bool m_FEQual_Discr[16][631]

private

Discriminators values for Quality signal of Forward Endcap.

Definition at line 157 of file eclLOMModule.h.

◆ m_FESum_Amplitude

double m_FESum_Amplitude[16]

private

Calculated amplitudes in running sums of Forward Endcap.

Definition at line 131 of file eclLOMModule.h.

◆ m_FESum_Discr

bool m_FESum_Discr[16][631]

private

Discriminators values for running sums of Forward Endcap.

Definition at line 155 of file eclLOMModule.h.

◆ m_FESum_MaxAmp

double m_FESum_MaxAmp

private

Maximum running sum amplitude in an event for Forward endcap.

Definition at line 134 of file eclLOMModule.h.

◆ m_FESum_MaxId

int m_FESum_MaxId

private

Id of a sector with maximum amplitude in Forward endcap.

Definition at line 136 of file eclLOMModule.h.

◆ m_FESum_Waveform_10ns

double m_FESum_Waveform_10ns[16][631]

private

Running sum's waveforms with 10ns sampling for Forward Endcap sectors.

Definition at line 154 of file eclLOMModule.h.

◆ m_h1BEHits

TH1D* m_h1BEHits

private

Store number of events when Backward sector i has signal exceeding Bha-Bha threshold over all events.

Definition at line 144 of file eclLOMModule.h.

◆ m_h1FEHits

TH1D* m_h1FEHits

private

Store number of events when Forward sector i has signal exceeding Bha-Bha threshold over all events.

Definition at line 145 of file eclLOMModule.h.

◆ m_h2BEAmp

TH2D* m_h2BEAmp

private

Store sectors amplitudes for Backward endcap over all events.

Definition at line 143 of file eclLOMModule.h.

◆ m_h2Coin

TH2D* m_h2Coin

private

Store number of coincedencies for i:j sectors (Forward:Backward) over all events.

Definition at line 140 of file eclLOMModule.h.

◆ m_h2FEAmp

TH2D* m_h2FEAmp

private

Store sectors amplitudes for Forward endcap over all events.

Definition at line 142 of file eclLOMModule.h.

◆ m_h2SumCoin

TH2D* m_h2SumCoin

private

Store number of coincedencies in running sums for i:j sectors (Forward:Backward) over all events.

Definition at line 141 of file eclLOMModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_includeInnerFE

bool m_includeInnerFE

private

Flag to include Inner part of the Forward Endcap.

Definition at line 104 of file eclLOMModule.h.

◆ m_isBhabha

bool m_isBhabha

private

Bha-bha signal for an event.

Definition at line 125 of file eclLOMModule.h.

◆ m_isBhabhaPatternBE

bool m_isBhabhaPatternBE

private

Quality signal for Backward endcap.

Definition at line 160 of file eclLOMModule.h.

◆ m_isBhabhaPatternFE

bool m_isBhabhaPatternFE

private

Quality signal for Forward endcap.

Definition at line 159 of file eclLOMModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mcen

double m_mcen[2]

private

Monte Carlo energy of the final state particles in main frame.

Definition at line 111 of file eclLOMModule.h.

◆ m_MCParticles

StoreArray<MCParticle> m_MCParticles

private

MC particles.

Definition at line 119 of file eclLOMModule.h.

◆ m_mcph

double m_mcph[2]

private

Monte Carlo phi of the final state particles in main frame.

Definition at line 113 of file eclLOMModule.h.

◆ m_mcth

double m_mcth[2]

private

Monte Carlo thetha of the final state particles in main frame.

Definition at line 112 of file eclLOMModule.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_NSamples

int m_NSamples

private

m_NSamples=631, number of samples for 10ns sampling.

Definition at line 150 of file eclLOMModule.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_saveSignal

bool m_saveSignal

private

Flag to save signal wavefroms into file.

Definition at line 105 of file eclLOMModule.h.

◆ m_SumCoincidenceCounterMatrix

int m_SumCoincidenceCounterMatrix[16][16]

private

Stores number of concidences between running sums discriminators in i:j sectors (Forward:Backward).

Definition at line 164 of file eclLOMModule.h.

◆ m_SumCoincidenceMatrix

int m_SumCoincidenceMatrix[16][16]

private

Stores current coincidence duration [in samples] between running sums discriminators in i:j sectors (Forward:Backward).

Definition at line 162 of file eclLOMModule.h.

◆ m_testfile

TFile* m_testfile

private

File to save output.

Definition at line 148 of file eclLOMModule.h.

◆ m_testFileName

std::string m_testFileName

private

Name of file to save output.

Definition at line 99 of file eclLOMModule.h.

◆ m_testtree

TTree* m_testtree

private

Tree to store output.

Definition at line 149 of file eclLOMModule.h.

◆ m_thresholdBE

double m_thresholdBE

private

Threshold [GeV] on signal for Backward Endcap .

Definition at line 101 of file eclLOMModule.h.

◆ m_thresholdBkg

double m_thresholdBkg

private

Threshold [GeV] on signal when sector considered as lighted.

For quality signal calculation.

Definition at line 102 of file eclLOMModule.h.

◆ m_thresholdFE

double m_thresholdFE

private

Threshold [GeV] on signal for Forward Endcap .

Definition at line 100 of file eclLOMModule.h.

◆ m_TrgEclWaveforms

StoreArray<TRGECLWaveform> m_TrgEclWaveforms

private

Trigger waveforms.

Definition at line 122 of file eclLOMModule.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:

ecl/modules/eclLOM/include/eclLOMModule.h
ecl/modules/eclLOM/src/eclLOMModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLLOMModule()

◆ ~ECLLOMModule()

Member Function Documentation

◆ beginRun()

◆ calculate_amplitudes()

◆ calculate_BE_quality()

◆ calculate_coincidence()

◆ calculate_discr_output()

◆ calculate_FE_quality()

◆ clear_lom_data()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ get_MCparticles()

◆ get_waveforms()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_BE_Amplitude

◆ m_BE_Pedal

◆ m_BE_Waveform_100ns

◆ m_BE_Waveform_10ns

◆ m_BEQual_Discr

◆ m_BESum_Amplitude