Belle II Software  light-2205-abys
TrackIsoCalculatorModule Class Reference

Calculate track isolation variables on the input ParticleList. More...

#include <TrackIsoCalculatorModule.h>

Inheritance diagram for TrackIsoCalculatorModule:
Collaboration diagram for TrackIsoCalculatorModule:

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

 TrackIsoCalculatorModule ()
 Constructor: Sets the description, the properties and the parameters of the module.
 
 ~TrackIsoCalculatorModule () override
 Destructor, use this to clean up anything you created in the constructor.
 
void initialize () override
 Use this to initialize resources or memory your module needs. More...
 
void event () override
 Called once for each event. More...
 
void terminate () override
 Module terminate().
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules. More...
 
virtual void beginRun ()
 Called when entering a new run. More...
 
virtual void endRun ()
 This method is called if the current run ends. More...
 
const std::string & getName () const
 Returns the name of the module. More...
 
const std::string & getType () const
 Returns the type of the module (i.e. More...
 
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. More...
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties. More...
 
LogConfiggetLogConfig ()
 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. More...
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module. More...
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module. More...
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module. More...
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () 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. More...
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished. More...
 
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. More...
 
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 ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter. More...
 
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. More...
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module. More...
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters. More...
 

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. More...
 
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. More...
 
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. More...
 
void setType (const std::string &type)
 Set the module type. More...
 
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. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module. More...
 
void setReturnValue (int value)
 Sets the return value for this module as integer. More...
 
void setReturnValue (bool value)
 Sets the return value for this module as bool. More...
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Member Functions

double getDistAtDetSurface (const Particle *iParticle, const Particle *jParticle)
 Calculate the distance between the points where the two input extrapolated track helices cross the given detector's cylindrical surface.
 
bool onlySelectedStdChargedInDecay ()
 Check whether input particle list and reference list are of a valid charged stable particle.
 
std::list< ModulePtrgetModules () 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. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Private Attributes

StoreArray< Particlem_particles
 StoreArray of Particles.
 
std::string m_decayString
 The name of the input charged stable particle list, or composite particle w/ charged stable daughters for which distances are to be calculated.
 
unsigned short m_nSelectedDaughters
 The number of selected daughters in the decay string.
 
std::string m_pListReferenceName
 The name of the input ParticleList of reference tracks.
 
std::string m_detSurface
 The name of the detector at whose inner (cylindrical) surface we extrapolate each track's polar and azimuthal angle.
 
std::unordered_map< std::string, bool > m_isSurfaceInDet
 Associate the detector flag to a boolean flag to quickly tell which detector it belongs too.
 
std::string m_extraInfoName
 The name of the distance variable to be added to each particle as extraInfo.
 
std::unordered_map< std::string, DetSurfCylBoundariesm_detSurfBoundaries
 Map that associates to each detector its valid cylindrical surface layer's boundaries. More...
 
StoreObjPtr< EventMetaDatam_event_metadata
 The event information. More...
 
StoreObjPtr< ParticleListm_pListTarget
 The input ParticleList object for which distances are to be calculated.
 
DecayDescriptor m_decaydescriptor
 < Decay descriptor of decays to look for.
 
StoreObjPtr< ParticleListm_pListReference
 The input ParticleList object of reference tracks.
 
bool m_useHighestProbMassForExt
 If this option is set, the helix extrapolation for the target and reference particles will use the track fit result for the most probable mass hypothesis, namely, the one that gives the highest chi2Prob of the fit.
 
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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Calculate track isolation variables on the input ParticleList.

Definition at line 68 of file TrackIsoCalculatorModule.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.

Member Function Documentation

◆ beginRun()

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

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

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

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Reimplemented in PyModule, AWESOMEBasicModule, TxModule, RxModule, SeqRootOutputModule, SeqRootInputModule, StatisticsSummaryModule, HistoManagerModule, RandomBarrierModule, EventInfoPrinterModule, SwitchDataStoreModule, SubEventModule, HistoModule, BelleMCOutputModule, B2BIIMdstInputModule, B2BIIConvertMdstModule, B2BIIMCParticlesMonitorModule, and CurlTaggerModule.

Definition at line 166 of file Module.h.

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

◆ event()

void event ( )
overridevirtual

Called once for each event.

This is most likely where your module will actually do anything.

Reimplemented from Module.

Definition at line 90 of file TrackIsoCalculatorModule.cc.

91 {
92  B2DEBUG(11, "Start processing EVENT: " << m_event_metadata->getEvent());
93 
94  const auto nMotherParticles = m_pListTarget->getListSize();
95 
96  // Fill transient container of all selected charged particles in the decay
97  // for which the distance to nearest neighbour is to be calculated.
98  // If the input ParticleList is that of standard charged particles, just copy
99  // the whole list over, otherwise loop over the selected charged daughters.
100  std::unordered_map<unsigned int, const Particle*> targetParticles;
101  targetParticles.reserve(nMotherParticles);
102 
103  for (unsigned int iPart(0); iPart < nMotherParticles; ++iPart) {
104 
105  auto iParticle = m_pListTarget->getParticle(iPart);
106 
107  if (m_nSelectedDaughters) {
108  for (auto* iDaughter : m_decaydescriptor.getSelectionParticles(iParticle)) {
109  // Check if the distance for this target particle has been set already,
110  // e.g. by a previous instance of this module.
111  if (iDaughter->hasExtraInfo(m_extraInfoName)) {
112  continue;
113  }
114  targetParticles.insert({iDaughter->getMdstArrayIndex(), iDaughter});
115  }
116  } else {
117  if (iParticle->hasExtraInfo(m_extraInfoName)) {
118  continue;
119  }
120  targetParticles.insert({iParticle->getMdstArrayIndex(), iParticle});
121  }
122  }
123 
124  const auto nParticlesTarget = targetParticles.size();
125  const auto nParticlesReference = m_pListReference->getListSize();
126 
127  B2DEBUG(11, "Detector surface: " << m_detSurface << "\n"
128  << "nMotherParticles: " << nMotherParticles << "\n"
129  << "nParticlesTarget: " << nParticlesTarget << "\n"
130  << "nParticlesReference: " << nParticlesReference);
131 
132  double dummyDist(-1.0);
133 
134  // Store the pair-wise distances in a map,
135  // where the keys are pairs of mdst indexes.
136  std::map<std::pair<unsigned int, unsigned int>, double> particleMdstIdxPairsToDist;
137 
138  for (const auto& targetParticle : targetParticles) {
139  auto iMdstIdx = targetParticle.first;
140  auto iParticle = targetParticle.second;
141 
142  for (unsigned int jPart(0); jPart < nParticlesReference; ++jPart) {
143 
144  auto jParticle = m_pListReference->getParticle(jPart);
145  auto jMdstIdx = jParticle->getMdstArrayIndex();
146 
147  auto partMdstIdxPair = std::make_pair(iMdstIdx, jMdstIdx);
148 
149  // Set dummy distance if same particle.
150  if (iMdstIdx == jMdstIdx) {
151  particleMdstIdxPairsToDist[partMdstIdxPair] = dummyDist;
152  continue;
153  }
154  // If:
155  //
156  // - the mass hypothesis of the best fit is used, OR
157  // - the mass hypothesis of the 'default' fit of the two particles is the same,
158  //
159  // avoid re-doing the calculation if a pair with the flipped mdst indexes in the map already exists.
160  if (m_useHighestProbMassForExt || (iParticle->getPDGCodeUsedForFit() == jParticle->getPDGCodeUsedForFit())) {
161  if (particleMdstIdxPairsToDist.count({jMdstIdx, iMdstIdx})) {
162  particleMdstIdxPairsToDist[partMdstIdxPair] = particleMdstIdxPairsToDist[ {jMdstIdx, iMdstIdx}];
163  continue;
164  }
165  }
166  // Calculate the pair-wise distance.
167  particleMdstIdxPairsToDist[partMdstIdxPair] = this->getDistAtDetSurface(iParticle, jParticle);
168  }
169  }
170 
171  // For each particle in the input list, find the minimum among all distances to the reference particles.
172  for (const auto& targetParticle : targetParticles) {
173  auto iMdstIdx = targetParticle.first;
174  auto iParticle = targetParticle.second;
175 
176  std::vector<double> iDistances;
177  for (const auto& [mdstIdxs, dist] : particleMdstIdxPairsToDist) {
178  if (mdstIdxs.first == iMdstIdx) {
179  if (!std::isnan(dist) && dist >= 0) {
180  iDistances.push_back(dist);
181  }
182  }
183  }
184 
185  if (!iDistances.size()) {
186  continue;
187  }
188 
189  const auto minDist = *std::min_element(std::begin(iDistances), std::end(iDistances));
190 
191  B2DEBUG(10, "Particle w/ mdstIndex[" << iMdstIdx << "] (PDG = "
192  << iParticle->getPDGCode() << "). Closest charged partner at "
193  << m_detSurface << " surface is found at D = " << minDist << " [cm]"
194  << "\n"
195  << "Storing ExtraInfo w/ name: " << m_extraInfoName);
196 
197  m_particles[iParticle->getArrayIndex()]->addExtraInfo(m_extraInfoName, minDist);
198 
199  }
200 
201  B2DEBUG(11, "Finished processing EVENT: " << m_event_metadata->getEvent());
202 }
std::vector< const Particle * > getSelectionParticles(const Particle *particle)
Get a vector of pointers with selected daughters in the decay tree.
StoreObjPtr< EventMetaData > m_event_metadata
The event information.
StoreObjPtr< ParticleList > m_pListTarget
The input ParticleList object for which distances are to be calculated.
StoreArray< Particle > m_particles
StoreArray of Particles.
DecayDescriptor m_decaydescriptor
< Decay descriptor of decays to look for.
std::string m_extraInfoName
The name of the distance variable to be added to each particle as extraInfo.
double getDistAtDetSurface(const Particle *iParticle, const Particle *jParticle)
Calculate the distance between the points where the two input extrapolated track helices cross the gi...
unsigned short m_nSelectedDaughters
The number of selected daughters in the decay string.
StoreObjPtr< ParticleList > m_pListReference
The input ParticleList object of reference tracks.
std::string m_detSurface
The name of the detector at whose inner (cylindrical) surface we extrapolate each track's polar and a...
bool m_useHighestProbMassForExt
If this option is set, the helix extrapolation for the target and reference particles will use the tr...

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

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

◆ 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 RootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

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

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

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

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

◆ initialize()

void initialize ( )
overridevirtual

Use this to initialize resources or memory your module needs.

Also register any outputs of your module (StoreArrays, StoreObjPtrs, relations) here, see the respective class documentation for details.

Reimplemented from Module.

Definition at line 45 of file TrackIsoCalculatorModule.cc.

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

◆ 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
nameThe name of the module

Definition at line 214 of file Module.h.

◆ 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

Member Data Documentation

◆ m_detSurfBoundaries

std::unordered_map<std::string, DetSurfCylBoundaries> m_detSurfBoundaries
private
Initial value:
= {
{"CDC0", DetSurfCylBoundaries(16.8, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC1", DetSurfCylBoundaries(25.7, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC2", DetSurfCylBoundaries(36.52, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC3", DetSurfCylBoundaries(47.69, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC4", DetSurfCylBoundaries(58.41, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC5", DetSurfCylBoundaries(69.53, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC6", DetSurfCylBoundaries(80.25, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC7", DetSurfCylBoundaries(91.37, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"CDC8", DetSurfCylBoundaries(102.09, 150.0, -75.0, 0.0, 0.29, 2.61, 3.14)},
{"TOP0", DetSurfCylBoundaries(117.8, 193.0, -94.0, 0.24, 0.52, 2.23, 3.14)},
{"ARICH0", DetSurfCylBoundaries(117.8, 193.0, -94.0, 0.24, 0.52, 2.23, 3.14)},
{"ECL0", DetSurfCylBoundaries(125.0, 196.0, -102.0, 0.21, 0.56, 2.24, 2.70)},
{"ECL1", DetSurfCylBoundaries(140.0, 211.0, -117.0, 0.21, 0.56, 2.24, 2.70)},
{"KLM0", DetSurfCylBoundaries(202.0, 283.9, -189.9, 0.40, 0.82, 2.13, 2.60)},
}

Map that associates to each detector its valid cylindrical surface layer's boundaries.

Values are taken from the B2 TDR.

Definition at line 143 of file TrackIsoCalculatorModule.h.

◆ m_event_metadata

StoreObjPtr<EventMetaData> m_event_metadata
private

The event information.

Used for debugging purposes.

Definition at line 163 of file TrackIsoCalculatorModule.h.


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