Class to find connected regions. More...

#include <ECLLocalMaximumFinderModule.h>

Inheritance diagram for ECLLocalMaximumFinderModule:

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

virtual	~ECLLocalMaximumFinderModule ()
	Destructor.

virtual void	initialize () override
	Initialize.

virtual void	beginRun () override
	Begin.

virtual void	event () override
	Event.

virtual void	endRun () override
	End run.

virtual void	terminate () override
	Terminate (close ROOT files here if you have opened any).

virtual const char *	mcParticleArrayName () const
	MCParticles.

virtual const char *	eclHitArrayName () const
	Name to be used for default or PureCsI option: ECLHits.

virtual const char *	eclDigitArrayName () const
	Name to be used for default or PureCsI option: ECLDigits.

virtual const char *	eclCalDigitArrayName () const
	Name to be used for default or PureCsI option: ECLCalDigits.

virtual const char *	eclConnectedRegionArrayName () const
	Name to be used for default option: ECLConnectedRegions.

virtual const char *	eclLocalMaximumArrayName () const
	Name to be used for default option: ECLLocalMaximums.

void	resetClassifierVariables ()
	Reset Classifier Variables.

void	resetTrainingVariables ()
	Reset Debug Variables.

void	makeLocalMaximum (const ECLConnectedRegion &aCR, const int cellId, const int lmId)
	Make local maximum for a given connected region.

void	addToSignalEnergy (int motherpdg, int motherindex, int pi0index, double weight)
	Add energy to vector.

bool	isEnteringECL (const B2Vector3D &vec)
	Check if particle is produced outside of the ECL.

void	getEnteringMother (const MCParticle &particle, int &pdg, int &arrayindex, int &pi0arrayindex)
	Get enterging mother of this particle.

int	getIdPosition (const int type, const int id)
	Get Id position in the vector.

void	getMax (int &maxtype, int &maxpos)
	Get the highest energy deposition particle type.

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.

Public Attributes
StoreArray< MCParticle >	m_mcParticles
	Store array: MCParticle.

StoreArray< ECLHit >	m_eclHits
	Store array: ECLHit.

StoreArray< ECLDigit >	m_eclDigits
	Store array: ECLDigit.

StoreArray< ECLCalDigit >	m_eclCalDigits
	Store array: ECLCalDigit.

StoreArray< ECLConnectedRegion >	m_eclConnectedRegions
	Store array: ECLConnectedRegion.

StoreArray< ECLLocalMaximum >	m_eclLocalMaximums
	Store array: ECLLocalMaximum.

StoreObjPtr< EventLevelClusteringInfo >	m_eventLevelClusteringInfo
	EventLevelClusteringInfo.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
double	m_energyCut
	energy cut for seed

int	m_isTrainingMode
	training mode for MVA methods (i.e.

std::string	m_outfileName
	file name prefix of the training output file

std::string	m_method
	Method to find the local maximum.

double	m_truthFraction
	MC truth fraction.

double	m_cutOffset
	cut offset

double	m_cutSlope
	cut slope.

double	m_cutRatioCorrection
	correction for nominator and denominator of the ratio.

const double	c_minEnergyCut = 5.0 * Belle2::Unit::MeV
	Minimum LM energy.

std::vector< int >	m_StoreArrPosition
	vector (ECLElementNumbers::c_NCrystals + 1 entries) with cell id to store array positions

ECL::ECLNeighbours *	m_neighbourMap {nullptr}
	Neighbour maps.

ECL::ECLGeometryPar *	m_geom {nullptr}
	Geometry.

TFile *	m_outfile {nullptr}
	Output training files and trees.

TTree *	m_tree {nullptr}
	tree that contain information for MVA training

float	m_energyRatioNeighbour [c_nMaxNeighbours] {}
	energy ratio of neighbour 0..9 to center

float	m_time = 0.0
	time

float	m_energy = 0.0
	Variables to monitor the MVA training.

float	m_thetaId = 0.0
	local maximum center theta Id

float	m_phiId = 0.0
	local maximum center theta Id

float	m_cellId = 0.0
	local maximum center cell Id

float	m_maxNeighbourEnergy = 0.0
	highest energy of all neighbours

float	m_timeResolution = 0.0
	time resolution

float	m_timeFitFailed = 0.0
	failed fit

float	m_CRId = 0.0
	CR ID.

float	m_LMId = 0.0
	LM ID.

float	m_target = 0.0
	MC truth variables.

float	m_targetindex = 0.0
	target array index

float	m_targetpi0index = 0.0
	target array index

float	m_nNeighbours10 = 0.0
	Variables (possibly) used for cut classification.

float	m_maxEnergyRatio = 0.0
	Highest energetic neighbour energy divided by LM energy.

double	m_totalSignalEnergy = 0.0
	total energy of this digit

double	m_signalEnergy [10][5] {}
	total energy per MC matching type of this digit

int	m_signalId [10][5] {}
	total energy per MC matching type of this digit

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.

Static Private Attributes
static const unsigned	c_nMaxNeighbours = 12
	Variables (possibly) used for MVA classification.

Detailed Description

Class to find connected regions.

Definition at line 41 of file ECLLocalMaximumFinderModule.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

◆ ECLLocalMaximumFinderModule()

ECLLocalMaximumFinderModule ( )

Constructor.

Definition at line 44 of file ECLLocalMaximumFinderModule.cc.

                                                         : Module(),
  m_mcParticles(mcParticleArrayName()),
  m_eclHits(eclHitArrayName()),
  m_eclDigits(eclDigitArrayName()),
  m_eclCalDigits(eclCalDigitArrayName()),
  m_eclConnectedRegions(eclConnectedRegionArrayName()),
  m_eclLocalMaximums(eclLocalMaximumArrayName())
{
  // Set description.
  setDescription("ECLLocalMaximumFinderModule");
 
  // Parallel processing certification.
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Add module parameters.
  addParam("energyCut", m_energyCut, "Seed energy cut [MeV], minimum is 5.0 MeV.", 10.0 * Belle2::Unit::MeV);
  addParam("isTrainingMode", m_isTrainingMode,
           "Run in training mode (i.e. fill file with MVA input variables and determine MC truth of LM.).", 0);
  addParam("outfileName", m_outfileName, "Output file name for training file.", std::string("ECLLocalMaximumFinderOutput.root"));
  addParam("method", m_method, "Method to determine the LM (cut, none, fastbdt).", std::string("none"));
  addParam("truthFraction", m_truthFraction, "Minimum matched energy fraction truth/rec for the LM.", 0.51);
  addParam("cutOffset", m_cutOffset, "Cut method specific: Offset. (BaBar: 2.5, high eff: 1.40)", 2.5);
  addParam("cutSlope", m_cutSlope, "Cut method specific: Slope. (BaBar: 0.5, high eff: 3.0)", 0.5);
  addParam("cutRatioCorrection", m_cutRatioCorrection, "Cut method specific: Ratio correction.", 0.0);
 
}

◆ ~ECLLocalMaximumFinderModule()

~ECLLocalMaximumFinderModule ( )

virtual

Destructor.

Definition at line 71 of file ECLLocalMaximumFinderModule.cc.

{
  ;
}

Member Function Documentation

◆ addToSignalEnergy()

void addToSignalEnergy	(	int	motherpdg,
		int	motherindex,
		int	pi0index,
		double	weight
	)

Add energy to vector.

Definition at line 522 of file ECLLocalMaximumFinderModule.cc.

{
 
  // for the LM training and CR/LM debugging
  if (motherpdg == Const::photon.getPDGCode()) {
    if (pi0index >= 0) { // photon from pi0
      int idpos = getIdPosition(1, motherindex);
      m_signalEnergy[1][idpos] += weight;
    } else {
      int idpos = getIdPosition(0, motherindex);
      m_signalEnergy[0][idpos] += weight; // photon from another source
    }
  } else if (abs(motherpdg) == Const::electron.getPDGCode()) { // electron
    int idpos = getIdPosition(2, motherindex);
    m_signalEnergy[2][idpos] += weight;
  } else if (abs(motherpdg) == Const::muon.getPDGCode()) { // muon
    int idpos = getIdPosition(3, motherindex);
    m_signalEnergy[3][idpos] += weight;
  } else if (abs(motherpdg) == Const::Klong.getPDGCode() or abs(motherpdg) == Const::neutron.getPDGCode()) { // neutral hadron
    int idpos = getIdPosition(4, motherindex);
    m_signalEnergy[4][idpos] += weight;
  } else if (abs(motherpdg) == Const::pion.getPDGCode() or abs(motherpdg) == Const::kaon.getPDGCode()
             or abs(motherpdg) == Const::proton.getPDGCode()) { // charged hadron
    int idpos = getIdPosition(5, motherindex);
    m_signalEnergy[5][idpos] += weight;
  } else { // everything else
    int idpos = getIdPosition(6, motherindex);
    m_signalEnergy[6][idpos] += weight;
  }
}

◆ beginRun()

void beginRun ( void )

overridevirtual

Begin.

Reimplemented from Module.

Definition at line 161 of file ECLLocalMaximumFinderModule.cc.

{
  ;
}

◆ 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

◆ eclCalDigitArrayName()

virtual const char * eclCalDigitArrayName ( ) const

inlinevirtual

Name to be used for default or PureCsI option: ECLCalDigits.

Reimplemented in ECLLocalMaximumFinderPureCsIModule.

Definition at line 99 of file ECLLocalMaximumFinderModule.h.

100 { return "ECLCalDigits" ; }

◆ eclConnectedRegionArrayName()

virtual const char * eclConnectedRegionArrayName ( ) const

inlinevirtual

Name to be used for default option: ECLConnectedRegions.

Reimplemented in ECLLocalMaximumFinderPureCsIModule.

Definition at line 103 of file ECLLocalMaximumFinderModule.h.

104 { return "ECLConnectedRegions" ; }

◆ eclDigitArrayName()

virtual const char * eclDigitArrayName ( ) const

inlinevirtual

Name to be used for default or PureCsI option: ECLDigits.

Reimplemented in ECLLocalMaximumFinderPureCsIModule.

Definition at line 95 of file ECLLocalMaximumFinderModule.h.

96 { return "ECLDigits" ; }

◆ eclHitArrayName()

virtual const char * eclHitArrayName ( ) const

inlinevirtual

Name to be used for default or PureCsI option: ECLHits.

Definition at line 91 of file ECLLocalMaximumFinderModule.h.

92 { return "ECLHits" ; }

◆ eclLocalMaximumArrayName()

virtual const char * eclLocalMaximumArrayName ( ) const

inlinevirtual

Name to be used for default option: ECLLocalMaximums.

Reimplemented in ECLLocalMaximumFinderPureCsIModule.

Definition at line 107 of file ECLLocalMaximumFinderModule.h.

108 { return "ECLLocalMaximums" ; }

◆ endRun()

void endRun ( void )

overridevirtual

End run.

Reimplemented from Module.

Definition at line 357 of file ECLLocalMaximumFinderModule.cc.

{
  B2DEBUG(200, "ECLLocalMaximumFinderModule::endRun()");
}

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

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

Reimplemented from Module.

Definition at line 166 of file ECLLocalMaximumFinderModule.cc.

{
  B2DEBUG(200, "ECLLocalMaximumFinderModule::event()");
 
  // Fill a vector that can be used to map cellid -> store array position
  std::fill_n(m_StoreArrPosition.begin(), m_StoreArrPosition.size(), -1);
  for (int i = 0; i < m_eclCalDigits.getEntries(); i++) {
    m_StoreArrPosition[m_eclCalDigits[i]->getCellId()] = i;
  }
 
  // Vector with neighbour ids.
  std::vector< double > vNeighourEnergies;
  vNeighourEnergies.resize(c_nMaxNeighbours);
 
  // Loop over connected regions.
  for (const ECLConnectedRegion& aCR : m_eclConnectedRegions) {
    const int crId = aCR.getCRId();
    int iLM = 1;
 
    // Loop over all entries in this CR.
    for (const ECLCalDigit& aECLCalDigit : aCR.getRelationsTo<ECLCalDigit>()) {
      // Check seed energy cut.
      if (aECLCalDigit.getEnergy() >= m_energyCut) {
 
        // Clean up for this candiate (MVA is trained per LM, regardless of CR)
        std::fill_n(vNeighourEnergies.begin(), vNeighourEnergies.size(),
                    -999);   // -999 means later: this digit is just not available in this neighbour definition.
        resetTrainingVariables();
        resetClassifierVariables();
 
        // Check neighbours: Must be a local energy maximum.
        bool isLocMax = 1;
        int neighbourCount = 0;
        for (auto& neighbourId : m_neighbourMap->getNeighbours(aECLCalDigit.getCellId())) {
          if (neighbourId == aECLCalDigit.getCellId()) continue; // Skip the center cell to avoid possible floating point issues.
 
          const int pos = m_StoreArrPosition[neighbourId]; // Get position in the store array for this digit.
 
          double energyNeighbour = 0.0;
          if (pos >= 0) {
            energyNeighbour = m_eclCalDigits[pos]->getEnergy(); // Get the energy directly from the store array.
            vNeighourEnergies[neighbourCount] = energyNeighbour;
          } else {
            // Digit does not belong to this CR
            vNeighourEnergies[neighbourCount] = 0.0;
          }
          ++neighbourCount;
 
          if (energyNeighbour > aECLCalDigit.getEnergy()) {
            isLocMax = 0;
            break;
          }
        }
 
        // It is a local maximum. Get all variables needed for classification.
        if (isLocMax) {
 
          for (unsigned int npos = 0; npos < vNeighourEnergies.size(); ++npos) {
            if (vNeighourEnergies[npos] >= 0) {
              m_energyRatioNeighbour[npos] = static_cast < float >(vNeighourEnergies[npos] / aECLCalDigit.getEnergy());
              if (vNeighourEnergies[npos] > m_maxNeighbourEnergy) m_maxNeighbourEnergy = vNeighourEnergies[npos];
              if (vNeighourEnergies[npos] > 1.0 * Belle2::Unit::MeV) ++m_nNeighbours10;
            } else m_energyRatioNeighbour[npos] = 0.0;
          }
          m_time           = aECLCalDigit.getTime();
          m_maxEnergyRatio = m_maxNeighbourEnergy / aECLCalDigit.getEnergy();
 
          // Fill training monitoring variables and MC truth information.
          if (m_isTrainingMode > 0) {
 
            m_energy                  = static_cast < float >(aECLCalDigit.getEnergy());
            m_cellId                  = static_cast < float >(aECLCalDigit.getCellId());
            m_timeResolution          = static_cast < float >(aECLCalDigit.getTimeResolution());
            m_timeFitFailed           = static_cast < float >(aECLCalDigit.isFailedFit());
            m_CRId                    = static_cast < float >(crId);
            m_LMId                    = static_cast < float >(iLM);
 
            m_geom->Mapping(m_cellId - 1);
            m_thetaId                 = static_cast < float >(m_geom->GetThetaID());
            m_phiId                   = static_cast < float >(m_geom->GetPhiID());
 
            // This requires MC matching before this stage!
            int pi0index    = -1;
            int maxtype     = 0;
            int maxpos      = 0;
 
            auto relatedParticlePairs = aECLCalDigit.getRelationsWith<MCParticle>();
 
            for (unsigned int irel = 0; irel < relatedParticlePairs.size(); irel++) {
              const auto particle = relatedParticlePairs.object(irel);
              const double weight = relatedParticlePairs.weight(irel);
 
              int motherpdg = -1;
              int motherindex = -1;
              pi0index = -1;
              getEnteringMother(*particle, motherpdg, motherindex, pi0index);
              addToSignalEnergy(motherpdg, motherindex, pi0index, weight);
            }
 
            B2DEBUG(175, "  -> digt energy: " << aECLCalDigit.getEnergy());
            B2DEBUG(175, "photon: " << m_signalEnergy[0][0] << " " << m_signalEnergy[0][1]);
            B2DEBUG(175, "pi0: " << m_signalEnergy[1][0] << " " << m_signalEnergy[1][1]);
            B2DEBUG(175, "electron: " << m_signalEnergy[2][0] << " " << m_signalEnergy[2][1]);
            B2DEBUG(175, "muon: " << m_signalEnergy[3][0] << " " << m_signalEnergy[3][1]);
            B2DEBUG(175, "neutral hadron: " << m_signalEnergy[4][0] << " " << m_signalEnergy[4][1]);
            B2DEBUG(175, "charged hadron: " << m_signalEnergy[5][0] << " " << m_signalEnergy[5][1]);
            B2DEBUG(175, "other: " << m_signalEnergy[6][0]);
 
            maxtype     = 0;
            maxpos      = 0;
            getMax(maxtype, maxpos);
 
            if (maxtype >= 0) {
              if (m_signalEnergy[maxtype][maxpos] >= m_truthFraction * aECLCalDigit.getEnergy()) {
                m_target = maxtype;
                m_targetindex = m_signalId[maxtype][maxpos];
                m_targetpi0index = pi0index;
              } else {
                m_target = 7;
              }
            } else {
              m_target = 7;
            }
 
            m_tree->Fill();
 
          } // end training
 
          if (m_method == "cut") {
 
            B2DEBUG(200, "m_cutSlope: " << m_cutSlope << ", m_nNeighbours10: " << m_nNeighbours10 << ", m_cutOffset: " << m_cutOffset <<
                    ", m_maxNeighbourEnergy: " << m_maxNeighbourEnergy << ", m_cutRatioCorrection: " << m_cutRatioCorrection <<
                    ", aECLCalDigit.getEnergy(): " << aECLCalDigit.getEnergy());
            B2DEBUG(200, "m_cutSlope * (m_nNeighbours10 - m_cutOffset): " << m_cutSlope * (m_nNeighbours10 - m_cutOffset));
            B2DEBUG(200, "(m_maxNeighbourEnergy - m_cutRatioCorrection) / (aECLCalDigit.getEnergy() - m_cutRatioCorrection)" <<
                    (m_maxNeighbourEnergy - m_cutRatioCorrection) / (aECLCalDigit.getEnergy() - m_cutRatioCorrection) << "\n");
 
            if (m_cutSlope * (m_nNeighbours10 - m_cutOffset) >= (m_maxNeighbourEnergy - m_cutRatioCorrection) /
                (aECLCalDigit.getEnergy() - m_cutRatioCorrection)) {
              makeLocalMaximum(aCR, aECLCalDigit.getCellId(), iLM);
              ++iLM;
            }
          } else if (m_method == "none") { // All energy local maximums will become local maximums.
            makeLocalMaximum(aCR, aECLCalDigit.getCellId(), iLM);
            ++iLM;
          }
 
        }
 
      } // end check energy
 
    } // end CalDigit loop
 
    // Check if there is at least one local maximum in the CR. If not, make the highest energetic crystal one.
    if (iLM == 1) {
 
      int highestEnergyCellId = -1;
      double highestEnergy = 0.0;
 
      // Loop over all entries in this CR.
      for (const ECLCalDigit& aECLCalDigit : aCR.getRelationsTo<ECLCalDigit>(eclCalDigitArrayName())) {
        if (aECLCalDigit.getEnergy() > highestEnergy) {
          highestEnergyCellId = aECLCalDigit.getCellId();
          highestEnergy = aECLCalDigit.getEnergy();
        }
      } // end CalDigit loop
 
      makeLocalMaximum(aCR, highestEnergyCellId, 0);
 
    }
 
  } // end CR loop
 
  // Find the number of local maximums in each ECL region in mdst
  uint16_t nLMPerRegion[3] = {};
  for (const ECLLocalMaximum& aLM : m_eclLocalMaximums) {
    const int iCellId = aLM.getCellId();
    if (ECLElementNumbers::isForward(iCellId)) {nLMPerRegion[0]++;}
    if (ECLElementNumbers::isBarrel(iCellId)) {nLMPerRegion[1]++;}
    if (ECLElementNumbers::isBackward(iCellId)) {nLMPerRegion[2]++;}
  }
 
  // Store numbers in EventLevelClusteringInfo mdst object
  if (!m_eventLevelClusteringInfo) { m_eventLevelClusteringInfo.create();}
  m_eventLevelClusteringInfo->setNECLLocalMaximumsFWD(nLMPerRegion[0]);
  m_eventLevelClusteringInfo->setNECLLocalMaximumsBarrel(nLMPerRegion[1]);
  m_eventLevelClusteringInfo->setNECLLocalMaximumsBWD(nLMPerRegion[2]);
 
}

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

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getEnteringMother()

void getEnteringMother	(	const MCParticle &	particle,
		int &	pdg,
		int &	arrayindex,
		int &	pi0arrayindex
	)

Get enterging mother of this particle.

Definition at line 437 of file ECLLocalMaximumFinderModule.cc.

{
 
  int index = particle.getArrayIndex();
  int pi0index = -1;
 
  while (!isEnteringECL(m_mcParticles[index]->getProductionVertex())) {
    if (m_mcParticles[index]->getMother()) index = m_mcParticles[index]->getMother()->getArrayIndex();
    else index = -1;
  };
 
  // For photon mother: are they from a pi0? This can be used to improved overlap/merged pi0 reconstruction.
  if (m_mcParticles[index]->getPDG() == Const::photon.getPDGCode()) {
    if (m_mcParticles[index]->getMother()->getPDG() == Const::pi0.getPDGCode()) {
      pi0index = m_mcParticles[index]->getMother()->getArrayIndex();
    }
  }
 
  // Dont include mother if its energy is too low or if its a photon from a neutron interaction.
  if ((m_mcParticles[index]->getEnergy() < 5.0 * Belle2::Unit::MeV)
      or (m_mcParticles[index]->getPDG() == Const::photon.getPDGCode()
          and abs(m_mcParticles[index]->getMother()->getPDG()) == Const::proton.getPDGCode())) {
    pdg = -1;
    arrayindex = -1;
    pi0arrayindex = -1;
  } else {
    pdg = m_mcParticles[index]->getPDG();
    arrayindex = index;
    pi0arrayindex = pi0index;
  }
}

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

◆ getIdPosition()

int getIdPosition	(	const int	type,
		const int	id
	)

Get Id position in the vector.

Definition at line 486 of file ECLLocalMaximumFinderModule.cc.

{
 
  for (int i = 0; i < 5; i++) {
    if (m_signalId[type][i] == id) return i;
    if (m_signalId[type][i] == -1) {
      m_signalId[type][i] = id;
      return i; //next free one
    }
  }
 
  return -1;
}

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getMax()

void getMax	(	int &	maxtype,
		int &	maxpos
	)

Get the highest energy deposition particle type.

Definition at line 501 of file ECLLocalMaximumFinderModule.cc.

{
  double maxe = 0.;
  int maxtype = -1;
  int maxid = -1;
 
  for (unsigned int i = 0; i < 10; ++i) {
    for (unsigned int j = 0; j < 5; ++j) {
      if (m_signalEnergy[i][j] > maxe) {
        maxe = m_signalEnergy[i][j];
        maxtype = i;
        maxid = j;
      }
    }
  }
 
  type = maxtype;
  id = maxid;
 
}

◆ 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://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

Initialize.

Reimplemented from Module.

Definition at line 76 of file ECLLocalMaximumFinderModule.cc.

{
  B2DEBUG(200, "ECLLocalMaximumFinderModule::initialize()");
 
  m_eclCalDigits.isRequired(eclCalDigitArrayName());
  m_eclConnectedRegions.isRequired(eclConnectedRegionArrayName());
  m_eclConnectedRegions.requireRelationTo(m_eclCalDigits);
  m_eclLocalMaximums.registerInDataStore(eclLocalMaximumArrayName());
  m_eclConnectedRegions.registerRelationTo(m_eclLocalMaximums);
  m_eventLevelClusteringInfo.isRequired();
 
  // Check user input.
  if (m_energyCut < c_minEnergyCut) {
    B2WARNING("ECLLocalMaximumFinderModule::initialize: Energy threshold too small, resetting to " << c_minEnergyCut << " GeV");
    m_energyCut = c_minEnergyCut;
  }
 
  if (m_truthFraction < 1e-6) {
    B2WARNING("ECLLocalMaximumFinderModule::initialize: Matching fraction must be above 1e-6, input: " << m_truthFraction <<
              " will be reset to 1e-6.");
    m_truthFraction = 1e-6;
  }
 
  if (m_truthFraction > 1.0) {
    B2WARNING("ECLLocalMaximumFinderModule::initialize: Matching fraction must be below 1.0, input: " << m_truthFraction <<
              " will be reset to 1.0.");
    m_truthFraction = 1.0;
  }
 
  // Geometry instance.
  m_geom = ECLGeometryPar::Instance();
 
  // Initialize neighbour map.
  m_neighbourMap = new ECLNeighbours("N", 1);
 
  // Reset all variables.
  resetClassifierVariables();
 
  // Open output files and declare branches if in training mode. Each file will hold a flat ntuple of training data.
  m_outfile = nullptr;
  m_tree = nullptr;
  if (m_isTrainingMode > 0) {
    const int cBufferLength = 500;
    char tmpBuffer[cBufferLength];
    int tmpBufferLength = sprintf(tmpBuffer, "%s", m_outfileName.c_str());
 
    if (tmpBufferLength >= cBufferLength) {
      B2FATAL("ECLLocalMaximumFinderModule::initialize(): Output training filename length too long!");
    }
 
    m_outfile = new TFile(tmpBuffer, "RECREATE");
    m_tree = new TTree("locmax", "locmax");
    m_tree->Branch("energyRatioNeighbour0", &m_energyRatioNeighbour[0], "energyRatioNeighbour0/F");
    m_tree->Branch("energyRatioNeighbour1", &m_energyRatioNeighbour[1], "energyRatioNeighbour1/F");
    m_tree->Branch("energyRatioNeighbour2", &m_energyRatioNeighbour[2], "energyRatioNeighbour2/F");
    m_tree->Branch("energyRatioNeighbour3", &m_energyRatioNeighbour[3], "energyRatioNeighbour3/F");
    m_tree->Branch("energyRatioNeighbour4", &m_energyRatioNeighbour[4], "energyRatioNeighbour4/F");
    m_tree->Branch("energyRatioNeighbour5", &m_energyRatioNeighbour[5], "energyRatioNeighbour5/F");
    m_tree->Branch("energyRatioNeighbour6", &m_energyRatioNeighbour[6], "energyRatioNeighbour6/F");
    m_tree->Branch("energyRatioNeighbour7", &m_energyRatioNeighbour[7], "energyRatioNeighbour7/F");
    m_tree->Branch("energyRatioNeighbour8", &m_energyRatioNeighbour[8], "energyRatioNeighbour8/F");
    m_tree->Branch("energyRatioNeighbour9", &m_energyRatioNeighbour[9], "energyRatioNeighbour9/F");
    m_tree->Branch("energyRatioNeighbour10", &m_energyRatioNeighbour[10], "energyRatioNeighbour10/F");
    m_tree->Branch("energyRatioNeighbour11", &m_energyRatioNeighbour[11], "energyRatioNeighbour11/F");
    m_tree->Branch("energy", &m_energy, "energy/F");
    m_tree->Branch("target", &m_target, "target/F");
    m_tree->Branch("targetindex", &m_targetindex, "targetindex/F");
    m_tree->Branch("targetpi0index", &m_targetpi0index, "targetpi0index/F");
    m_tree->Branch("thetaId", &m_thetaId, "thetaId/F");
    m_tree->Branch("phiId", &m_phiId, "phiId/F");
    m_tree->Branch("cellId", &m_cellId, "cellId/F");
    m_tree->Branch("maxNeighbourEnergy", &m_maxNeighbourEnergy, "maxNeighbourEnergy/F");
    m_tree->Branch("nNeighbours10", &m_nNeighbours10, "nNeighbours10/F");
    m_tree->Branch("time", &m_time, "time/F");
    m_tree->Branch("timeResolution", &m_timeResolution, "timeResolution/F");
    m_tree->Branch("timeFitFailed", &m_timeFitFailed, "timeFitFailed/F");
    m_tree->Branch("CRId", &m_CRId, "CRId/F");
    m_tree->Branch("LMId", &m_LMId, "LMId/F");
  }
 
  // initialize the vector that gives the relation between cellid and store array position
  m_StoreArrPosition.resize(ECLElementNumbers::c_NCrystals + 1);
 
}

◆ isEnteringECL()

bool isEnteringECL ( const B2Vector3D & vec )

Check if particle is produced outside of the ECL.

Definition at line 469 of file ECLLocalMaximumFinderModule.cc.

{
 
  const double theta = vertex.Theta();
 
  if (theta > 0.555015 and theta < 2.26369) { //barrel
    double radius = vertex.Perp();
    if (radius < 125 * Belle2::Unit::cm) return true;
  } else if (theta <= 0.555015) { //fwd
    if (vertex.Z() < 196.16 * Belle2::Unit::cm) return true;
  } else if (theta >= 2.26369) { //bwd
    if (vertex.Z() > -102.16 * Belle2::Unit::cm) return true;
  }
 
  return false;
}

◆ makeLocalMaximum()

void makeLocalMaximum	(	const ECLConnectedRegion &	aCR,
		const int	cellId,
		const int	lmId
	)

Make local maximum for a given connected region.

Definition at line 380 of file ECLLocalMaximumFinderModule.cc.

{
  // Set the local maximum dataobject.
  const auto aLocalMaximum = m_eclLocalMaximums.appendNew();
 
  B2DEBUG(175, "ECLLocalMaximumFinderModule::makeLocalMaximum(): local maximum cellid: " << cellId);
 
  // Set the id of this local maximum.
  aLocalMaximum->setLMId(lmId);
 
  // Set the cell Id of the digit.
  aLocalMaximum->setCellId(cellId);
 
  // Add relations to ECLConnectedRegion.
  aCR.addRelationTo(aLocalMaximum);
 
}

◆ mcParticleArrayName()

virtual const char * mcParticleArrayName ( ) const

inlinevirtual

MCParticles.

Definition at line 87 of file ECLLocalMaximumFinderModule.h.

88 { return "MCParticles" ; }

◆ resetClassifierVariables()

void resetClassifierVariables ( )

Reset Classifier Variables.

Definition at line 415 of file ECLLocalMaximumFinderModule.cc.

{
 
  for (unsigned i = 0; i < c_nMaxNeighbours; ++i) {
    m_energyRatioNeighbour[i] = 0.;
  }
 
  m_energy = 0.;
  m_cellId = -1;
  m_thetaId = -1;
  m_phiId = -1;
  m_nNeighbours10 = 0;
  m_maxNeighbourEnergy = 0.0;
  m_time = -9999;
  m_timeResolution = -9999.;
  m_timeFitFailed = -9999.;
  m_CRId = -1;
  m_LMId = -1;
  m_maxEnergyRatio = 0.0;
}

◆ resetTrainingVariables()

void resetTrainingVariables ( )

Reset Debug Variables.

Definition at line 398 of file ECLLocalMaximumFinderModule.cc.

{
  m_target = -1;
  m_targetindex = -1;
  m_targetpi0index = -1;
 
  m_totalSignalEnergy = 0.;
 
  for (unsigned int i = 0; i < 10; ++i) {
    for (unsigned int j = 0; j < 5; ++j) {
      m_signalEnergy[i][j] = 0.;
      m_signalId[i][j] = -1;
    }
  }
 
}

◆ 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 (close ROOT files here if you have opened any).

Reimplemented from Module.

Definition at line 363 of file ECLLocalMaximumFinderModule.cc.

{
  B2DEBUG(200, "ECLLocalMaximumFinderModule::terminate()");
 
  // If run in trainingmode, write the training file.
  if (m_outfile and m_tree) {
    m_outfile->cd();
    m_tree->Write();
    m_outfile->Write();
    m_outfile->Close();
    delete m_outfile;
  }
 
  if (m_neighbourMap) delete m_neighbourMap;
 
}

Member Data Documentation

◆ c_minEnergyCut

const double c_minEnergyCut = 5.0 * Belle2::Unit::MeV

private

Minimum LM energy.

Definition at line 147 of file ECLLocalMaximumFinderModule.h.

◆ c_nMaxNeighbours

const unsigned c_nMaxNeighbours = 12

staticprivate

Variables (possibly) used for MVA classification.

Must be float for our framework mvas. maximal number of neighbours (can be more than 8 only in the endcaps)

Definition at line 163 of file ECLLocalMaximumFinderModule.h.

◆ m_cellId

float m_cellId = 0.0

private

local maximum center cell Id

Definition at line 171 of file ECLLocalMaximumFinderModule.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_CRId

float m_CRId = 0.0

private

CR ID.

Definition at line 175 of file ECLLocalMaximumFinderModule.h.

◆ m_cutOffset

double m_cutOffset

private

cut offset

Definition at line 142 of file ECLLocalMaximumFinderModule.h.

◆ m_cutRatioCorrection

double m_cutRatioCorrection

private

correction for nominator and denominator of the ratio.

Definition at line 144 of file ECLLocalMaximumFinderModule.h.

◆ m_cutSlope

double m_cutSlope

private

cut slope.

Definition at line 143 of file ECLLocalMaximumFinderModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_eclCalDigits

StoreArray<ECLCalDigit> m_eclCalDigits

Store array: ECLCalDigit.

Definition at line 75 of file ECLLocalMaximumFinderModule.h.

◆ m_eclConnectedRegions

StoreArray<ECLConnectedRegion> m_eclConnectedRegions

Store array: ECLConnectedRegion.

Definition at line 78 of file ECLLocalMaximumFinderModule.h.

◆ m_eclDigits

StoreArray<ECLDigit> m_eclDigits

Store array: ECLDigit.

Definition at line 72 of file ECLLocalMaximumFinderModule.h.

◆ m_eclHits

StoreArray<ECLHit> m_eclHits

Store array: ECLHit.

Definition at line 69 of file ECLLocalMaximumFinderModule.h.

◆ m_eclLocalMaximums

StoreArray<ECLLocalMaximum> m_eclLocalMaximums

Store array: ECLLocalMaximum.

Definition at line 81 of file ECLLocalMaximumFinderModule.h.

◆ m_energy

float m_energy = 0.0

private

Variables to monitor the MVA training.

energy of the center cell

Definition at line 168 of file ECLLocalMaximumFinderModule.h.

◆ m_energyCut

double m_energyCut

private

energy cut for seed

Definition at line 137 of file ECLLocalMaximumFinderModule.h.

◆ m_energyRatioNeighbour

float m_energyRatioNeighbour[c_nMaxNeighbours] {}

private

energy ratio of neighbour 0..9 to center

Definition at line 164 of file ECLLocalMaximumFinderModule.h.

◆ m_eventLevelClusteringInfo

StoreObjPtr<EventLevelClusteringInfo> m_eventLevelClusteringInfo

EventLevelClusteringInfo.

Definition at line 84 of file ECLLocalMaximumFinderModule.h.

◆ m_geom

ECL::ECLGeometryPar* m_geom {nullptr}

private

Geometry.

Definition at line 156 of file ECLLocalMaximumFinderModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_isTrainingMode

int m_isTrainingMode

private

training mode for MVA methods (i.e.

create weights)

Definition at line 138 of file ECLLocalMaximumFinderModule.h.

◆ m_LMId

float m_LMId = 0.0

private

LM ID.

Definition at line 176 of file ECLLocalMaximumFinderModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_maxEnergyRatio

float m_maxEnergyRatio = 0.0

private

Highest energetic neighbour energy divided by LM energy.

Definition at line 185 of file ECLLocalMaximumFinderModule.h.

◆ m_maxNeighbourEnergy

float m_maxNeighbourEnergy = 0.0

private

highest energy of all neighbours

Definition at line 172 of file ECLLocalMaximumFinderModule.h.

◆ m_mcParticles

StoreArray<MCParticle> m_mcParticles

Store array: MCParticle.

Definition at line 66 of file ECLLocalMaximumFinderModule.h.

◆ m_method

std::string m_method

private

Method to find the local maximum.

Definition at line 140 of file ECLLocalMaximumFinderModule.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_neighbourMap

ECL::ECLNeighbours* m_neighbourMap {nullptr}

private

Neighbour maps.

Definition at line 153 of file ECLLocalMaximumFinderModule.h.

◆ m_nNeighbours10

float m_nNeighbours10 = 0.0

private

Variables (possibly) used for cut classification.

Number of neighbours above 1.0 MeV.

Definition at line 184 of file ECLLocalMaximumFinderModule.h.

◆ m_outfile

TFile* m_outfile {nullptr}

private

Output training files and trees.

outfiles that contain tree

Definition at line 159 of file ECLLocalMaximumFinderModule.h.

◆ m_outfileName

std::string m_outfileName

private

file name prefix of the training output file

Definition at line 139 of file ECLLocalMaximumFinderModule.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_phiId

float m_phiId = 0.0

private

local maximum center theta Id

Definition at line 170 of file ECLLocalMaximumFinderModule.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_signalEnergy

double m_signalEnergy[10][5] {}

private

total energy per MC matching type of this digit

Definition at line 188 of file ECLLocalMaximumFinderModule.h.

◆ m_signalId

int m_signalId[10][5] {}

private

total energy per MC matching type of this digit

Definition at line 189 of file ECLLocalMaximumFinderModule.h.

◆ m_StoreArrPosition

std::vector< int > m_StoreArrPosition

private

vector (ECLElementNumbers::c_NCrystals + 1 entries) with cell id to store array positions

Definition at line 150 of file ECLLocalMaximumFinderModule.h.

◆ m_target

float m_target = 0.0

private

MC truth variables.

target type

Definition at line 179 of file ECLLocalMaximumFinderModule.h.

◆ m_targetindex

float m_targetindex = 0.0

private

target array index

Definition at line 180 of file ECLLocalMaximumFinderModule.h.

◆ m_targetpi0index

float m_targetpi0index = 0.0

private

target array index

Definition at line 181 of file ECLLocalMaximumFinderModule.h.

◆ m_thetaId

float m_thetaId = 0.0

private

local maximum center theta Id

Definition at line 169 of file ECLLocalMaximumFinderModule.h.

◆ m_time

float m_time = 0.0

private

time

Definition at line 165 of file ECLLocalMaximumFinderModule.h.

◆ m_timeFitFailed

float m_timeFitFailed = 0.0

private

failed fit

Definition at line 174 of file ECLLocalMaximumFinderModule.h.

◆ m_timeResolution

float m_timeResolution = 0.0

private

time resolution

Definition at line 173 of file ECLLocalMaximumFinderModule.h.

◆ m_totalSignalEnergy

double m_totalSignalEnergy = 0.0

private

total energy of this digit

Definition at line 187 of file ECLLocalMaximumFinderModule.h.

◆ m_tree

TTree* m_tree {nullptr}

private

tree that contain information for MVA training

Definition at line 160 of file ECLLocalMaximumFinderModule.h.

◆ m_truthFraction

double m_truthFraction

private

MC truth fraction.

Definition at line 141 of file ECLLocalMaximumFinderModule.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/eclLocalMaximumFinder/include/ECLLocalMaximumFinderModule.h
ecl/modules/eclLocalMaximumFinder/src/ECLLocalMaximumFinderModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ECLLocalMaximumFinderModule()

◆ ~ECLLocalMaximumFinderModule()

Member Function Documentation

◆ addToSignalEnergy()

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ eclCalDigitArrayName()

◆ eclConnectedRegionArrayName()

◆ eclDigitArrayName()

◆ eclHitArrayName()

◆ eclLocalMaximumArrayName()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getEnteringMother()

◆ getFileNames()

◆ getIdPosition()

◆ getLogConfig()

◆ getMax()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ isEnteringECL()

◆ makeLocalMaximum()

◆ mcParticleArrayName()

◆ resetClassifierVariables()

◆ resetTrainingVariables()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()