Belle II Software development
TpcDigitizerModule Class Reference

Micro TPC digitizer. More...

#include <TpcDigitizerModule.h>

Inheritance diagram for TpcDigitizerModule:
Module PathElement

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

 TpcDigitizerModule ()
 Constructor: Sets the description, the properties and the parameters of the module.
 
virtual void initialize () override
 Initialize the Module.
 
virtual void beginRun () override
 Called when entering a new run.
 
virtual void event () override
 This method is the core of the module.
 
virtual void endRun () override
 This method is called if the current run ends.
 
virtual void terminate () override
 This method is called at the end of the event processing.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
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.
 
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 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.
 
std::shared_ptr< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

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

Private Member Functions

void getXMLData ()
 reads data from MICROTPC.xml: tube location, drift data filename, sigma of impulse response function
 
void Pixelization ()
 Produces the pixelization.
 
virtual void Drift (double, double, double, double &, double &, double &, double &, double, double, double)
 Drift ionization Make the ionization drifting from (x,y,z) to GEM1 top plane.
 
ROOT::Math::XYVector GEMGeo1 (double x1, double y1)
 GEMazition of GEM1.
 
ROOT::Math::XYVector GEMGeo2 (double x1, double y1)
 GEMazition of GEM2.
 
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.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

StoreArray< MicrotpcHitm_microtpcHit
 Array for MicrotpcHit.
 
Int_t m_phase
 Phase.
 
TF1 * fctToT_Calib1
 Define ToT calib 1.
 
TF1 * fctToT_Calib2
 Define ToT calib 2.
 
double m_GEMGain1
 GEM 1 gain.
 
double m_GEMGainRMS1
 GEM 1 RMS.
 
double m_ScaleGain1
 Scale GEM 1 gain.
 
double m_GEMGain2
 GEM 2 gain.
 
double m_GEMGainRMS2
 GEM 2 RMS.
 
double m_ScaleGain2
 Scale GEM 2 gain.
 
double m_GEMpitch
 GEM pitch.
 
int m_PixelThreshold
 Pixel threshold.
 
int m_PixelThresholdRMS
 Pixel threshold RMS.
 
int m_ChipColumnNb
 Chip column number.
 
int m_ChipRowNb
 Chip row number.
 
double m_ChipColumnX
 Chip column x dimension.
 
double m_ChipRowY
 Chip row y dimension.
 
int m_PixelTimeBinNb
 Pixel time number of bin.
 
double m_PixelTimeBin
 Pixel time bin.
 
double m_TOTA1
 TOT factor A1.
 
double m_TOTB1
 TOT factor B1.
 
double m_TOTC1
 TOT factor C1.
 
double m_TOTQ1
 TOT factor Q1.
 
double m_TOTA2
 TOT factor A2.
 
double m_TOTB2
 TOT factor B2.
 
double m_TOTC2
 TOT factor C2.
 
double m_TOTQ2
 TOT factor Q2.
 
double m_z_DG
 z drift gap
 
double m_z_TG
 z transfer gap
 
double m_z_CG
 z collection gap
 
double m_Dt_DG
 Transverse diffusion in drift gap.
 
double m_Dt_TG
 Transverse diffusion in transfer gap.
 
double m_Dt_CG
 Transverse diffusion in collection gap.
 
double m_Dl_DG
 Longitudinal diffusion in drift gap.
 
double m_Dl_TG
 Longitudinal diffusion in transfer gap.
 
double m_Dl_CG
 Longitudinal diffusion in collection gap.
 
double m_v_DG
 Drift velocity in drift gap.
 
double m_v_TG
 Drift velocity in transfer gap.
 
double m_v_CG
 Drift velocity in collection gap.
 
double m_Workfct
 Work function.
 
double m_Fanofac
 Fano factor.
 
double m_GasAbs
 Absorption in gas.
 
std::map< std::tuple< int, int, int >, int > m_dchip
 chip store arrays
 
std::map< std::tuple< int, int >, int > m_dchip_map
 chip map arrays
 
std::map< std::tuple< int, int >, int > m_dchip_pdg_map
 chip pdg map arrays
 
std::map< std::tuple< int, int >, int > m_dchip_trkID_map
 chip track ID map arrays
 
std::map< std::tuple< int, int >, int > m_dchip_detNb_map
 chip Nb map arrays
 
int m_LookAtRec
 Flag 0/1 only look at nuclear recoils.
 
int m_nTPC = 0
 number of detectors.
 
std::vector< ROOT::Math::XYZVector > m_TPCCenter
 TPC coordinate.
 
std::vector< float > m_TPCAngleX
 TPC angle X.
 
std::vector< float > m_TPCAngleZ
 TPC angle Z.
 
double m_lowerTimingCut = 0
 Lower timing cut.
 
double m_upperTimingCut = 1000000
 Upper timing cut.
 
int olddetNb = -1
 Old detector counter.
 
int oldtrkID = -1
 Old track ID.
 
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

Micro TPC digitizer.

Creates TpcHits from TpcSimHits

Definition at line 41 of file TpcDigitizerModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

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.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ TpcDigitizerModule()

Constructor: Sets the description, the properties and the parameters of the module.

Definition at line 37 of file TpcDigitizerModule.cc.

37 : Module()
38{
39 // Set module properties
40 setDescription("Microtpc digitizer module");
41
42 //Default values are set here. New values can be in MICROTPC.xml.
43 addParam("LowerTimingCut", m_lowerTimingCut, "Lower timing cut", 0.);
44 addParam("UpperTimingCut", m_upperTimingCut, "Upper timing cut", 1000000.);
45}
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Module()
Constructor.
Definition: Module.cc:30
double m_lowerTimingCut
Lower timing cut.
double m_upperTimingCut
Upper timing cut.
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

◆ ~TpcDigitizerModule()

~TpcDigitizerModule ( )
virtual

Definition at line 47 of file TpcDigitizerModule.cc.

48{
49}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 79 of file TpcDigitizerModule.cc.

80{
81}

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

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ 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(); }
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(); }
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(); }
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(); }
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(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ Drift()

void Drift ( double  x1,
double  y1,
double  z1,
double &  x2,
double &  y2,
double &  z2,
double &  t2,
double  st,
double  sl,
double  vd 
)
privatevirtual

Drift ionization Make the ionization drifting from (x,y,z) to GEM1 top plane.

Definition at line 297 of file TpcDigitizerModule.cc.

299{
300 //check if
301 if (z1 > 0.) {
302 //transverse diffusion
303 x2 = x1 + gRandom->Gaus(0., sqrt(z1) * st);
304 //transverse diffusion
305 y2 = y1 + gRandom->Gaus(0., sqrt(z1) * st);
306 //longitidinal diffusion
307 z2 = z1 + gRandom->Gaus(0., sqrt(z1) * sl);
308 //time to diffuse
309 t2 = z2 / vd;
310 } else {
311 x2 = -1000; y2 = -1000; z2 = -1000; t2 = -1000;
312 }
313}
double sqrt(double a)
sqrt for double
Definition: beamHelpers.h:28

◆ endRun()

void endRun ( void  )
overridevirtual

This method is called if the current run ends.

Reimplemented from Module.

Definition at line 721 of file TpcDigitizerModule.cc.

722{
723}

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

Reimplemented from Module.

Definition at line 83 of file TpcDigitizerModule.cc.

84{
85 StoreArray<MCParticle> mcParticles;
86 StoreArray<MicrotpcSimHit> microtpcSimHits;
87
88 m_dchip_map.clear();
89 m_dchip.clear();
90 m_dchip_detNb_map.clear();
91 m_dchip_pdg_map.clear();
92 m_dchip_trkID_map.clear();
93
94 std::vector<double> T0(m_nTPC,
95 m_upperTimingCut); // TODO: why this number? Maybe pick something larger the the upperTiming cut? e.g. m_upperTimingCut + 1
96 //std::vector<bool> PixelFired(m_nTPC, false);
97
98 for (const auto& microtpcSimHit : microtpcSimHits) {
99 const int detNb = microtpcSimHit.getdetNb();
100 const ROOT::Math::XYZVector simHitPosition = microtpcSimHit.gettkPos();
101 B2Vector3D chipPosition(
102 simHitPosition.X() / 100. - m_TPCCenter[detNb].X(),
103 simHitPosition.Y() / 100. - m_TPCCenter[detNb].Y(),
104 simHitPosition.Z() / 100. - m_TPCCenter[detNb].Z()
105 );
106 chipPosition.RotateZ(-m_TPCAngleZ[detNb] * TMath::DegToRad());
107 chipPosition.RotateX(-m_TPCAngleX[detNb] * TMath::DegToRad());
108 const double T = chipPosition.Z() + m_z_DG / 2.;
109 if (T < T0[detNb]) {
110 T0[detNb] = T;
111 }
112 }
113
114 for (auto& val : T0) {
115 if (m_lowerTimingCut < val && val < m_upperTimingCut) {
116 val = val / m_v_DG;
117 } else {
118 val = -1.;
119 }
120 }
121 olddetNb = -1;
122 oldtrkID = -1;
123 //loop on all entries to store in 3D the ionization for each TPC
124 for (const auto& microtpcSimHit : microtpcSimHits) {
125
126 const int PDGid = microtpcSimHit.gettkPDG();
127 if (m_LookAtRec == 1) {
128 if (PDGid != 1000020040 && PDGid != 1000060120 && PDGid != 1000080160 && PDGid != Const::proton.getPDGCode()) {
129 continue;
130 }
131 }
132
133 const int detNb = microtpcSimHit.getdetNb();
134 const double edep = microtpcSimHit.getEnergyDep();
135 const double niel = microtpcSimHit.getEnergyNiel();
136 const int pdg = microtpcSimHit.gettkPDG();
137 const int trkID = microtpcSimHit.gettkID();
138
139 const ROOT::Math::XYZVector simHitPosition = microtpcSimHit.gettkPos();
140 B2Vector3D chipPosition(
141 simHitPosition.X() / 100. - m_TPCCenter[detNb].X(),
142 simHitPosition.Y() / 100. - m_TPCCenter[detNb].Y(),
143 simHitPosition.Z() / 100. - m_TPCCenter[detNb].Z()
144 );
145 chipPosition.RotateZ(-m_TPCAngleZ[detNb] * TMath::DegToRad());
146 chipPosition.RotateX(-m_TPCAngleX[detNb] * TMath::DegToRad());
147
148 ROOT::Math::XYZVector ChipPosition(0, 0, 0);
149 if (m_phase == 1) {
150 if (detNb == 0 || detNb == 3) {
151 ChipPosition.SetX(-chipPosition.Y());
152 ChipPosition.SetY(-chipPosition.X());
153 ChipPosition.SetZ(chipPosition.Z() + m_z_DG / 2.);
154 }
155 if (detNb == 1 || detNb == 2) {
156 ChipPosition.SetX(chipPosition.Y());
157 ChipPosition.SetY(chipPosition.X());
158 ChipPosition.SetZ(chipPosition.Z() + m_z_DG / 2.);
159 }
160 }
161 if (m_phase == 2) {
162 ChipPosition.SetX(chipPosition.Y());
163 ChipPosition.SetY(chipPosition.X());
164 ChipPosition.SetZ(chipPosition.Z() + m_z_DG / 2);
165 }
166
167
168 //If new detector filled the chip
169 if (olddetNb != detNb && m_dchip_map.size() > 0 && m_dchip.size() < 20000 && oldtrkID != trkID) {
170 Pixelization();
171 olddetNb = detNb;
172 oldtrkID = trkID;
173 m_dchip_map.clear();
174 m_dchip.clear();
175 m_dchip_detNb_map.clear();
176 m_dchip_pdg_map.clear();
177 m_dchip_trkID_map.clear();
178 }
179
180 //check if ionization within sensitive volume
181 if ((-m_ChipColumnX < ChipPosition.X() && ChipPosition.X() < m_ChipColumnX) &&
182 (-m_ChipRowY < ChipPosition.Y() && ChipPosition.Y() < m_ChipRowY) &&
183 (0. < ChipPosition.Z() && ChipPosition.Z() < m_z_DG) &&
184 (m_lowerTimingCut < T0[detNb] && T0[detNb] < m_upperTimingCut)) {
185
186 //ionization energy
187 //MeV -> keV
188 const double ionEn = (edep - niel) * 1e3; // TODO: Use Unit constants instead of self made magic numbers
189 // check if enough energy to ionize if not break
190 // keV -> eV
191
192 //if ((ionEn * 1e3) < m_Workfct) continue; // TODO: Use Unit constants instead of self made magic numbers
194 // check if enough energy to ionize
195 //else if ((ionEn * 1e3) > m_Workfct) { // TODO: Use Unit constants instead of self made magic numbers
196 if ((ionEn * 1e3) > m_Workfct) { // TODO: Use Unit constants instead of self made magic numbers
197
198 const double meanEl = ionEn * 1e3 / m_Workfct;
199 const double sigma = sqrt(m_Fanofac * meanEl);
200 const int NbEle = (int)gRandom->Gaus(meanEl, sigma);
201 const double NbEle_real = NbEle - NbEle * m_GasAbs * chipPosition.Z();
202
203 // start loop on the number of electron-ion-pairs at each interaction point
204 for (int ie = 0; ie < (int)NbEle_real; ie++) {
205
206 //drift ionization to GEM 1 plane
207 double x_DG, y_DG, z_DG, t_DG;
208 Drift(ChipPosition.X(),
209 ChipPosition.Y(),
210 ChipPosition.Z(),
211 x_DG, y_DG, z_DG, t_DG, m_Dt_DG, m_Dl_DG, m_v_DG);
212
213 //calculate and scale 1st GEM gain
214 const double GEM_gain1 = gRandom->Gaus(m_GEMGain1, m_GEMGain1 * m_GEMGainRMS1) / m_ScaleGain1;
215
216 //calculate and scale 2nd GEM gain
217 const double GEM_gain2 = gRandom->Gaus(m_GEMGain2, m_GEMGain2 * m_GEMGainRMS2) / m_ScaleGain2;
218
220 // start loop on amplification
221 for (int ig1 = 0; ig1 < (int)GEM_gain1; ig1++) {
222 //1st GEM geometrical effect
223 //const ROOT::Math::XYVector GEM1(GEMGeo1(driftGap.X(), driftGap.Y()));
224 const ROOT::Math::XYVector GEM1(GEMGeo1(x_DG, y_DG));
225 //drift 1st amplication to 2nd GEM
226 double x_TG, y_TG, z_TG, t_TG;
227 Drift(GEM1.X(), GEM1.Y(), m_z_TG, x_TG, y_TG, z_TG, t_TG, m_Dt_TG, m_Dl_TG, m_v_TG);
228
230 // start loop on amplification
231 for (int ig2 = 0; ig2 < (int)GEM_gain2; ig2++) {
232 //2nd GEN geometrical effect
233 //const ROOT::Math::XYVector GEM2(GEMGeo2(transferGap.X(), transferGap.Y()));
234 const ROOT::Math::XYVector GEM2(GEMGeo2(x_TG, y_TG));
235 //drift 2nd amplification to chip
236 double x_CG, y_CG, z_CG, t_CG;
237 Drift(GEM2.X(), GEM2.Y(), m_z_CG, x_CG, y_CG, z_CG, t_CG, m_Dt_CG, m_Dl_CG, m_v_CG);
238
239 //determine col, row, and bc
240 int col = (int)((x_CG + m_ChipColumnX) / (2. * m_ChipColumnX / (double)m_ChipColumnNb));
241 int row = (int)((y_CG + m_ChipRowY) / (2. * m_ChipRowY / (double)m_ChipRowNb));
242 int pix = col + m_ChipColumnNb * row;
243 int quT = gRandom->Uniform(-1, 1);
244 int bci = (int)((t_DG + t_TG + t_CG - T0[detNb]) / (double)m_PixelTimeBin) + quT;
245 if (bci < 0)bci = 0;
246
247 //check if amplified drifted electron are within pixel boundaries
248 if ((0 <= col && col < m_ChipColumnNb) &&
249 (0 <= row && row < m_ChipRowNb) &&
250 (0 <= pix && pix < m_ChipColumnNb * m_ChipRowNb) &&
251 (0 <= bci && bci < MAXtSIZE)) {
252 //PixelFired[detNb] = true;
253 //store info into 3D array for each TPCs
255 //m_dchip_map[std::tuple<int, int, int>(detNb, col, row)] = 1;
256 //m_dchip[std::tuple<int, int, int, int>(detNb, col, row, bci)] += (int)(m_ScaleGain1 * m_ScaleGain2);
257 m_dchip_map[std::tuple<int, int>(col, row)] = 1;
258 m_dchip_detNb_map[std::tuple<int, int>(col, row)] = detNb;
259 m_dchip_pdg_map[std::tuple<int, int>(col, row)] = pdg;
260 m_dchip_trkID_map[std::tuple<int, int>(col, row)] = trkID;
261 m_dchip[std::tuple<int, int, int>(col, row, bci)] += (int)(m_ScaleGain1 * m_ScaleGain2);
262 }
263 }
264 }
265 }
266 }
267 }
268 }
269
270 //Pixelization of the 3D ionization cloud
271 /*for (int i = 0; i < m_nTPC; i++) {
272 if (m_lowerTimingCut < T0[i] && T0[i] < m_upperTimingCut && PixelFired[i]) {
273 Pixelization(i);
274
275 for (int j = 0; j < 80; j++) {
276 for (int k = 0; k < 336; k++) {
277 for (int l = 0; l < MAXtSIZE; l++) {
278 m_dchip[i][j][k][l] = 0;
279 }
280 }
281 }
282
283 }
284 }
285 */
286 if (m_dchip_map.size() > 0 && m_dchip.size() < 20000) {
287 //std::cout << " event size " << m_dchip_map.size() << " all " << m_dchip.size() << std::endl;
288 Pixelization();
289 }
290 m_dchip_map.clear();
291 m_dchip.clear();
292 m_dchip_detNb_map.clear();
293 m_dchip_pdg_map.clear();
294 m_dchip_trkID_map.clear();
295}
static const ChargedStable proton
proton particle
Definition: Const.h:663
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
double m_ChipRowY
Chip row y dimension.
std::map< std::tuple< int, int >, int > m_dchip_pdg_map
chip pdg map arrays
int m_LookAtRec
Flag 0/1 only look at nuclear recoils.
double m_Dl_CG
Longitudinal diffusion in collection gap.
double m_Dl_DG
Longitudinal diffusion in drift gap.
std::map< std::tuple< int, int >, int > m_dchip_trkID_map
chip track ID map arrays
ROOT::Math::XYVector GEMGeo1(double x1, double y1)
GEMazition of GEM1.
double m_v_DG
Drift velocity in drift gap.
double m_ChipColumnX
Chip column x dimension.
std::map< std::tuple< int, int, int >, int > m_dchip
chip store arrays
std::map< std::tuple< int, int >, int > m_dchip_detNb_map
chip Nb map arrays
double m_Dt_CG
Transverse diffusion in collection gap.
std::vector< float > m_TPCAngleZ
TPC angle Z.
std::map< std::tuple< int, int >, int > m_dchip_map
chip map arrays
double m_Dt_TG
Transverse diffusion in transfer gap.
std::vector< float > m_TPCAngleX
TPC angle X.
std::vector< ROOT::Math::XYZVector > m_TPCCenter
TPC coordinate.
double m_Dt_DG
Transverse diffusion in drift gap.
void Pixelization()
Produces the pixelization.
ROOT::Math::XYVector GEMGeo2(double x1, double y1)
GEMazition of GEM2.
double m_v_CG
Drift velocity in collection gap.
virtual void Drift(double, double, double, double &, double &, double &, double &, double, double, double)
Drift ionization Make the ionization drifting from (x,y,z) to GEM1 top plane.
double m_Dl_TG
Longitudinal diffusion in transfer gap.
double m_v_TG
Drift velocity in transfer gap.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ GEMGeo1()

ROOT::Math::XYVector GEMGeo1 ( double  x1,
double  y1 
)
private

GEMazition of GEM1.

Definition at line 314 of file TpcDigitizerModule.cc.

315{
316 static const double sqrt3o4 = std::sqrt(3. / 4.);
317 double x2 = 0;
318 double y2 = (int)(y1 / (sqrt3o4 * m_GEMpitch) + (y1 < 0 ? -0.5 : 0.5)) * sqrt3o4 * m_GEMpitch;
319 int yint = (int)(y1 / (sqrt3o4 * m_GEMpitch) + 0.5);
320 if (yint % 2) {
321 x2 = static_cast<int>(x1 / m_GEMpitch + (x1 < 0 ? -0.5 : 0.5)) * m_GEMpitch;
322 } else {
323 //everysecond row is shifted with half a pitch
324 x2 = (static_cast<int>(x1 / m_GEMpitch) + (x1 < 0 ? -0.5 : 0.5)) * m_GEMpitch;
325 }
326 return ROOT::Math::XYVector(x2, y2);
327}

◆ GEMGeo2()

ROOT::Math::XYVector GEMGeo2 ( double  x1,
double  y1 
)
private

GEMazition of GEM2.

Definition at line 329 of file TpcDigitizerModule.cc.

330{
331 static const double sqrt3o4 = std::sqrt(3. / 4.);
332 double x2 = (int)(x1 / (sqrt3o4 * m_GEMpitch) + (x1 < 0 ? -0.5 : 0.5)) * sqrt3o4 * m_GEMpitch;
333 double y2 = 0;
334 int yint = (int)(x1 / (sqrt3o4 * m_GEMpitch) + 0.5);
335 if (yint % 2) {
336 y2 = static_cast<int>(y1 / m_GEMpitch + (y1 < 0 ? -0.5 : 0.5)) * m_GEMpitch;
337 } else {
338 //everysecond row is shifted with half a pitch
339 y2 = (static_cast<int>(y1 / m_GEMpitch) + (y1 < 0 ? -0.5 : 0.5)) * m_GEMpitch;
340 }
341 return ROOT::Math::XYVector(x2, y2);
342}

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

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

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ 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;}
std::string m_description
The description of the module.
Definition: Module.h:511

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}
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.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

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

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

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

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ getXMLData()

void getXMLData ( )
private

reads data from MICROTPC.xml: tube location, drift data filename, sigma of impulse response function

Definition at line 659 of file TpcDigitizerModule.cc.

660{
661 //const GearDir& content;
662 GearDir content = GearDir("/Detector/DetectorComponent[@name=\"MICROTPC\"]/Content/");
663
664 //get the location of the tubes
665 BOOST_FOREACH(const GearDir & activeParams, content.getNodes("Active")) {
666
667 m_TPCCenter.push_back(ROOT::Math::XYZVector(activeParams.getLength("SensVol_x"),
668 activeParams.getLength("SensVol_y"),
669 activeParams.getLength("SensVol_z")));
670 m_TPCAngleX.push_back(activeParams.getLength("AngleX"));
671 m_TPCAngleZ.push_back(activeParams.getLength("AngleZ"));
672
673 m_nTPC++;
674 }
675 m_phase = content.getDouble("Phase");
676 m_LookAtRec = content.getDouble("LookAtRec");
677 m_GEMGain1 = content.getDouble("GEMGain1");
678 m_GEMGain2 = content.getDouble("GEMGain2");
679 m_GEMGainRMS1 = content.getDouble("GEMGainRMS1");
680 m_GEMGainRMS2 = content.getDouble("GEMGainRMS2");
681 m_ScaleGain1 = content.getDouble("ScaleGain1");
682 m_ScaleGain2 = content.getDouble("ScaleGain2");
683 m_GEMpitch = content.getDouble("GEMpitch");
684 m_PixelThreshold = content.getInt("PixelThreshold");
685 m_PixelThresholdRMS = content.getInt("PixelThresholdRMS");
686 m_PixelTimeBinNb = content.getInt("PixelTimeBinNb");
687 m_PixelTimeBin = content.getDouble("PixelTimeBin");
688 m_ChipColumnNb = content.getInt("ChipColumnNb");
689 m_ChipRowNb = content.getInt("ChipRowNb");
690 m_ChipColumnX = content.getDouble("ChipColumnX");
691 m_ChipRowY = content.getDouble("ChipRowY");
692 m_TOTA1 = content.getDouble("TOTA1");
693 m_TOTB1 = content.getDouble("TOTB1");
694 m_TOTC1 = content.getDouble("TOTC1");
695 m_TOTQ1 = content.getDouble("TOTQ1");
696 m_TOTA2 = content.getDouble("TOTA2");
697 m_TOTB2 = content.getDouble("TOTB2");
698 m_TOTC2 = content.getDouble("TOTC2");
699 m_TOTQ2 = content.getDouble("TOTQ2");
700 m_z_DG = content.getDouble("z_DG");
701 m_z_TG = content.getDouble("z_TG");
702 m_z_CG = content.getDouble("z_CG");
703 m_Dl_DG = content.getDouble("Dl_DG");
704 m_Dl_TG = content.getDouble("Dl_TG");
705 m_Dl_CG = content.getDouble("Dl_CG");
706 m_Dt_DG = content.getDouble("Dt_DG");
707 m_Dt_TG = content.getDouble("Dt_TG");
708 m_Dt_CG = content.getDouble("Dt_CG");
709 m_v_DG = content.getDouble("v_DG");
710 m_v_TG = content.getDouble("v_TG");
711 m_v_CG = content.getDouble("v_CG");
712 m_Workfct = content.getDouble("Workfct");
713 m_Fanofac = content.getDouble("Fanofac");
714 m_GasAbs = content.getDouble("GasAbs");
715
716 B2INFO("TpcDigitizer: Aquired tpc locations and gas parameters");
717 B2INFO(" from MICROTPC.xml. There are " << m_nTPC << " TPCs implemented");
718
719}
GearDir is the basic class used for accessing the parameter store.
Definition: GearDir.h:31
double getLength(const std::string &path="") const noexcept(false)
Get the parameter path as a double converted to the standard length unit.
Definition: Interface.h:259
int m_PixelTimeBinNb
Pixel time number of bin.
int m_PixelThresholdRMS
Pixel threshold RMS.

◆ 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
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

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

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

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

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

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

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

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

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

◆ initialize()

void initialize ( void  )
overridevirtual

Initialize the Module.

This method is called only once before the actual event processing starts.

Reimplemented from Module.

Definition at line 51 of file TpcDigitizerModule.cc.

52{
53 B2INFO("TpcDigitizer: Initializing");
54 m_microtpcHit.registerInDataStore();
55
56 //get xml data
57 getXMLData();
58
59 //converter: electron number to TOT part I
60 fctToT_Calib1 = new TF1("fctToT_Calib1", "[0]*(x/[3]+[1])/(x/[3]+[2])", 0., 100000.);
61 fctToT_Calib1->SetParameters(m_TOTA1, m_TOTB1, m_TOTC1, m_TOTQ1);
62 //converter: electron number to TOT part II
63 fctToT_Calib2 = new TF1("fctToT_Calib2", "[0]*(x/[3]+[1])/(x/[3]+[2])", 0., 100000.);
64 fctToT_Calib2->SetParameters(m_TOTA2, m_TOTB2, m_TOTC2, m_TOTQ2);
65 /*
66 for (int i = 0; i < m_nTPC; i++) {
67 for (int j = 0; j < 80; j++) {
68 for (int k = 0; k < 336; k++) {
69 for (int l = 0; l < MAXtSIZE; l++) {
70 m_dchip[i][j][k][l] = 0;
71 //dchip[j][k][l] = 0;
72 }
73 }
74 }
75 }
76 */
77}
TF1 * fctToT_Calib1
Define ToT calib 1.
void getXMLData()
reads data from MICROTPC.xml: tube location, drift data filename, sigma of impulse response function
TF1 * fctToT_Calib2
Define ToT calib 2.
StoreArray< MicrotpcHit > m_microtpcHit
Array for MicrotpcHit.

◆ Pixelization()

void Pixelization ( )
private

Produces the pixelization.

Definition at line 349 of file TpcDigitizerModule.cc.

350{
351 std::vector<int> t0;
352 std::vector<int> col;
353 std::vector<int> row;
354 std::vector<int> ToT;
355 std::vector<int> bci;
356 t0.clear();
357 col.clear();
358 row.clear();
359 ToT.clear();
360 bci.clear();
361 StoreArray<MicrotpcHit> microtpcHits;
362
363 for (auto& keyValuePair : m_dchip_map) {
364 const auto& key = keyValuePair.first;
365 //column
366 int i = std::get<0>(key);
367 //raw
368 int j = std::get<1>(key);
369
370 if (m_dchip_map[std::tuple<int, int>(i, j)] == 1) {
371
372 int k0 = 1e9;
373 const int quE = gRandom->Uniform(0, 2);
374 const double thresEl = m_PixelThreshold + gRandom->Uniform(-1.*m_PixelThresholdRMS, 1.*m_PixelThresholdRMS);
375 int kcounter = 0;
376 //determined t0 ie first time above pixel threshold
377 for (auto& keyValuePair2 : m_dchip) {
378 const auto& key2 = keyValuePair2.first;
379 int k = std::get<2>(key2);
380 if (m_dchip[std::tuple<int, int, int>(i, j, k)] > thresEl) {
381 if (k0 > k)k0 = k;
382 kcounter ++;
383 }
384 }
385 //std::cout<<"kcounter " << kcounter << std::endl;
386 //determined nb of bc per pixel
387 //if good t0
388 if (k0 != 1e9) {
389 int ik = 0;
390 int NbOfEl = 0;
391 for (auto& keyValuePair2 : m_dchip) {
392 const auto& key2 = keyValuePair2.first;
393 int k = std::get<2>(key2);
394 //sum up charge with 16 cycles
395 if (ik < 16) {
396 NbOfEl += m_dchip[std::tuple<int, int, int>(i, j, k)];
397 } else {
398 //calculate ToT
399 int tot = -1;
400 if (NbOfEl > thresEl && NbOfEl <= 45.*m_TOTQ1) {
401 tot = (int)fctToT_Calib1->Eval((double)NbOfEl) + quE;
402 } else if (NbOfEl > 45.*m_TOTQ1 && NbOfEl <= 900.*m_TOTQ1) {
403 tot = (int)fctToT_Calib2->Eval((double)NbOfEl);
404 } else if (NbOfEl > 800.*m_TOTQ1) {
405 tot = 13;
406 }
407 if (tot > 12) {
408 tot = 13;
409 }
410 if (tot >= 0) {
411 ToT.push_back(tot);
412 t0.push_back(k0);
413 col.push_back(i);
414 row.push_back(j);
415 bci.push_back(k0);
416 }
417 ik = 0;
418 NbOfEl = 0;
419 }
420 ik++;
421 }
422
423 if (kcounter < 16) {
424 //calculate ToT
425 int tot = -1;
426 if (NbOfEl > thresEl && NbOfEl <= 45.*m_TOTQ1) {
427 tot = (int)fctToT_Calib1->Eval((double)NbOfEl) + quE;
428 } else if (NbOfEl > 45.*m_TOTQ1 && NbOfEl <= 900.*m_TOTQ1) {
429 tot = (int)fctToT_Calib2->Eval((double)NbOfEl);
430 } else if (NbOfEl > 800.*m_TOTQ1) {
431 tot = 13;
432 }
433 if (tot > 12) {
434 tot = 13;
435 }
436 if (tot >= 0) {
437 ToT.push_back(tot);
438 t0.push_back(k0);
439 col.push_back(i);
440 row.push_back(j);
441 bci.push_back(k0);
442 }
443 }
444
445 }
446 } //end loop on row
447 } // end loop on col
448
449 //bool PixHit = false;
450 //if entry
451
452 if (bci.size() > 0) {
453 //std::cout << " size " << bci.size() << std::endl;
454 //PixHit = true;
455 //find start time
456 sort(t0.begin(), t0.end());
457
458 //loop on nb of hit
459 for (int j = 0; j < (int)bci.size(); j++) {
460 if ((bci[j] - t0[0]) > (m_PixelTimeBinNb - 1)) {
461 continue;
462 }
463 //create MicrotpcHit
464 microtpcHits.appendNew(MicrotpcHit(col[j] + 1, row[j] + 1, bci[j] - t0[0] + 1, ToT[j],
465 m_dchip_detNb_map[std::tuple<int, int>(col[j], row[j])],
466 m_dchip_pdg_map[std::tuple<int, int>(col[j], row[j])],
467 m_dchip_trkID_map[std::tuple<int, int>(col[j], row[j])]));
468 } //end if entry
469 }
470 //return PixHit;
471 /*
472 std::vector<int> t0[10];
473 std::vector<int> col[10];
474 std::vector<int> row[10];
475 std::vector<int> ToT[10];
476 std::vector<int> bci[10];
477
478 StoreArray<MicrotpcHit> microtpcHits;
479
480 for (auto& keyValuePair : m_dchip_map) {
481 const auto& key = keyValuePair.first;
482 //detector number
483 int detNb = std::get<0>(key);
484 //column
485 int i = std::get<1>(key);
486 //raw
487 int j = std::get<2>(key);
488
489 if (m_dchip_map[std::tuple<int, int, int>(detNb, i, j)] == 1) {
490
491 int k0 = -10;
492 const int quE = gRandom->Uniform(0, 2);
493 const double thresEl = m_PixelThreshold + gRandom->Uniform(-1.*m_PixelThresholdRMS, 1.*m_PixelThresholdRMS);
494 //determined t0 ie first time above pixel threshold
495 //for (int k = 0; k < MAXtSIZE; k++) {
496 for (auto& keyValuePair2 : m_dchip) {
497 const auto& key2 = keyValuePair2.first;
498 int k = std::get<3>(key2);
499 if (m_dchip[std::tuple<int, int, int, int>(detNb, i, j, k)] > thresEl) {
500 //if (m_dchip[detNb][i][j][k] > thresEl) {
501 k0 = k;
502 break;
503 }
504 }
505 //determined nb of bc per pixel
506
507 //if good t0
508 if (k0 != -10) {
509 int ik = 0;
510 int NbOfEl = 0;
511 //for (int k = k0; k < MAXtSIZE; k++) {
512 for (auto& keyValuePair2 : m_dchip) {
513 const auto& key2 = keyValuePair2.first;
514 int k = std::get<3>(key2);
515 //sum up charge with 16 cycles
516 if (ik < 16) {
517 NbOfEl += m_dchip[std::tuple<int, int, int, int>(detNb, i, j, k)];
518 //NbOfEl += m_dchip[detNb][i][j][k];
519 } else {
520 //calculate ToT
521 int tot = -1;
522 if (NbOfEl > thresEl && NbOfEl <= 45.*m_TOTQ1) {
523 tot = (int)fctToT_Calib1->Eval((double)NbOfEl) + quE;
524 } else if (NbOfEl > 45.*m_TOTQ1 && NbOfEl <= 900.*m_TOTQ1) {
525 tot = (int)fctToT_Calib2->Eval((double)NbOfEl);
526 } else if (NbOfEl > 800.*m_TOTQ1) {
527 tot = 14;
528 }
529 if (tot > 13) {
530 tot = 14;
531 }
532 if (tot >= 0) {
533 ToT[detNb].push_back(tot);
534 t0[detNb].push_back(k0);
535 col[detNb].push_back(i);
536 row[detNb].push_back(j);
537 bci[detNb].push_back(k0);
538 }
539 ik = 0;
540 NbOfEl = 0;
541 }
542 ik++;
543 }
544 }
545 } //end loop on row
546 //for (int k = 0; k < MAXtSIZE; k++) m_dchip[detNb][i][j][k] = 0;
547 } // end loop on col
548
549 //bool PixHit = false;
550 for (int i = 0; i < 10 ; i++) {
551 //if entry
552 if (bci[i].size() > 0) {
553 //PixHit = true;
554 //find start time
555 sort(t0[i].begin(), t0[i].end());
556
557 //loop on nb of hit
558 for (int j = 0; j < (int)bci[i].size(); j++) {
559 if ((bci[i][j] - t0[i][0]) > (m_PixelTimeBinNb - 1)) {
560 continue;
561 }
562 //create MicrotpcHit
563 microtpcHits.appendNew(MicrotpcHit(col[i][j], row[i][j], bci[i][j] - t0[i][0], ToT[i][j], i));
564 } //end on loop nb of hit
565 } //end if entry
566 }
567 //return PixHit;
568 */
569}
ClassMicrotpcHit - digitization simulated hit for the Microtpc detector.
Definition: MicrotpcHit.h:26
T * appendNew()
Construct a new T object at the end of the array.
Definition: StoreArray.h:246

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

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

215{
216 m_description = description;
217}

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

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

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

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

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

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

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

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

209{
210 m_propertyFlags = propertyFlags;
211}

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

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

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

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ terminate()

void terminate ( void  )
overridevirtual

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

Reimplemented from Module.

Definition at line 725 of file TpcDigitizerModule.cc.

726{
727}

Member Data Documentation

◆ fctToT_Calib1

TF1* fctToT_Calib1
private

Define ToT calib 1.

Definition at line 101 of file TpcDigitizerModule.h.

◆ fctToT_Calib2

TF1* fctToT_Calib2
private

Define ToT calib 2.

Definition at line 103 of file TpcDigitizerModule.h.

◆ m_ChipColumnNb

int m_ChipColumnNb
private

Chip column number.

Definition at line 123 of file TpcDigitizerModule.h.

◆ m_ChipColumnX

double m_ChipColumnX
private

Chip column x dimension.

Definition at line 127 of file TpcDigitizerModule.h.

◆ m_ChipRowNb

int m_ChipRowNb
private

Chip row number.

Definition at line 125 of file TpcDigitizerModule.h.

◆ m_ChipRowY

double m_ChipRowY
private

Chip row y dimension.

Definition at line 129 of file TpcDigitizerModule.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_dchip

std::map<std::tuple<int, int, int>, int> m_dchip
private

chip store arrays

Definition at line 182 of file TpcDigitizerModule.h.

◆ m_dchip_detNb_map

std::map<std::tuple<int, int>, int> m_dchip_detNb_map
private

chip Nb map arrays

Definition at line 190 of file TpcDigitizerModule.h.

◆ m_dchip_map

std::map<std::tuple<int, int>, int> m_dchip_map
private

chip map arrays

Definition at line 184 of file TpcDigitizerModule.h.

◆ m_dchip_pdg_map

std::map<std::tuple<int, int>, int> m_dchip_pdg_map
private

chip pdg map arrays

Definition at line 186 of file TpcDigitizerModule.h.

◆ m_dchip_trkID_map

std::map<std::tuple<int, int>, int> m_dchip_trkID_map
private

chip track ID map arrays

Definition at line 188 of file TpcDigitizerModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_Dl_CG

double m_Dl_CG
private

Longitudinal diffusion in collection gap.

Definition at line 167 of file TpcDigitizerModule.h.

◆ m_Dl_DG

double m_Dl_DG
private

Longitudinal diffusion in drift gap.

Definition at line 163 of file TpcDigitizerModule.h.

◆ m_Dl_TG

double m_Dl_TG
private

Longitudinal diffusion in transfer gap.

Definition at line 165 of file TpcDigitizerModule.h.

◆ m_Dt_CG

double m_Dt_CG
private

Transverse diffusion in collection gap.

Definition at line 161 of file TpcDigitizerModule.h.

◆ m_Dt_DG

double m_Dt_DG
private

Transverse diffusion in drift gap.

Definition at line 157 of file TpcDigitizerModule.h.

◆ m_Dt_TG

double m_Dt_TG
private

Transverse diffusion in transfer gap.

Definition at line 159 of file TpcDigitizerModule.h.

◆ m_Fanofac

double m_Fanofac
private

Fano factor.

Definition at line 177 of file TpcDigitizerModule.h.

◆ m_GasAbs

double m_GasAbs
private

Absorption in gas.

Definition at line 179 of file TpcDigitizerModule.h.

◆ m_GEMGain1

double m_GEMGain1
private

GEM 1 gain.

Definition at line 105 of file TpcDigitizerModule.h.

◆ m_GEMGain2

double m_GEMGain2
private

GEM 2 gain.

Definition at line 111 of file TpcDigitizerModule.h.

◆ m_GEMGainRMS1

double m_GEMGainRMS1
private

GEM 1 RMS.

Definition at line 107 of file TpcDigitizerModule.h.

◆ m_GEMGainRMS2

double m_GEMGainRMS2
private

GEM 2 RMS.

Definition at line 113 of file TpcDigitizerModule.h.

◆ m_GEMpitch

double m_GEMpitch
private

GEM pitch.

Definition at line 117 of file TpcDigitizerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_LookAtRec

int m_LookAtRec
private

Flag 0/1 only look at nuclear recoils.

Definition at line 192 of file TpcDigitizerModule.h.

◆ m_lowerTimingCut

double m_lowerTimingCut = 0
private

Lower timing cut.

Definition at line 203 of file TpcDigitizerModule.h.

◆ m_microtpcHit

StoreArray<MicrotpcHit> m_microtpcHit
private

Array for MicrotpcHit.

Definition at line 78 of file TpcDigitizerModule.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_nTPC

int m_nTPC = 0
private

number of detectors.

Read from MICROTPC.xml

Definition at line 194 of file TpcDigitizerModule.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_phase

Int_t m_phase
private

Phase.

Definition at line 99 of file TpcDigitizerModule.h.

◆ m_PixelThreshold

int m_PixelThreshold
private

Pixel threshold.

Definition at line 119 of file TpcDigitizerModule.h.

◆ m_PixelThresholdRMS

int m_PixelThresholdRMS
private

Pixel threshold RMS.

Definition at line 121 of file TpcDigitizerModule.h.

◆ m_PixelTimeBin

double m_PixelTimeBin
private

Pixel time bin.

Definition at line 133 of file TpcDigitizerModule.h.

◆ m_PixelTimeBinNb

int m_PixelTimeBinNb
private

Pixel time number of bin.

Definition at line 131 of file TpcDigitizerModule.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_ScaleGain1

double m_ScaleGain1
private

Scale GEM 1 gain.

Definition at line 109 of file TpcDigitizerModule.h.

◆ m_ScaleGain2

double m_ScaleGain2
private

Scale GEM 2 gain.

Definition at line 115 of file TpcDigitizerModule.h.

◆ m_TOTA1

double m_TOTA1
private

TOT factor A1.

Definition at line 135 of file TpcDigitizerModule.h.

◆ m_TOTA2

double m_TOTA2
private

TOT factor A2.

Definition at line 143 of file TpcDigitizerModule.h.

◆ m_TOTB1

double m_TOTB1
private

TOT factor B1.

Definition at line 137 of file TpcDigitizerModule.h.

◆ m_TOTB2

double m_TOTB2
private

TOT factor B2.

Definition at line 145 of file TpcDigitizerModule.h.

◆ m_TOTC1

double m_TOTC1
private

TOT factor C1.

Definition at line 139 of file TpcDigitizerModule.h.

◆ m_TOTC2

double m_TOTC2
private

TOT factor C2.

Definition at line 147 of file TpcDigitizerModule.h.

◆ m_TOTQ1

double m_TOTQ1
private

TOT factor Q1.

Definition at line 141 of file TpcDigitizerModule.h.

◆ m_TOTQ2

double m_TOTQ2
private

TOT factor Q2.

Definition at line 149 of file TpcDigitizerModule.h.

◆ m_TPCAngleX

std::vector<float> m_TPCAngleX
private

TPC angle X.

Definition at line 198 of file TpcDigitizerModule.h.

◆ m_TPCAngleZ

std::vector<float> m_TPCAngleZ
private

TPC angle Z.

Definition at line 200 of file TpcDigitizerModule.h.

◆ m_TPCCenter

std::vector<ROOT::Math::XYZVector> m_TPCCenter
private

TPC coordinate.

Definition at line 196 of file TpcDigitizerModule.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.

◆ m_upperTimingCut

double m_upperTimingCut = 1000000
private

Upper timing cut.

Definition at line 205 of file TpcDigitizerModule.h.

◆ m_v_CG

double m_v_CG
private

Drift velocity in collection gap.

Definition at line 173 of file TpcDigitizerModule.h.

◆ m_v_DG

double m_v_DG
private

Drift velocity in drift gap.

Definition at line 169 of file TpcDigitizerModule.h.

◆ m_v_TG

double m_v_TG
private

Drift velocity in transfer gap.

Definition at line 171 of file TpcDigitizerModule.h.

◆ m_Workfct

double m_Workfct
private

Work function.

Definition at line 175 of file TpcDigitizerModule.h.

◆ m_z_CG

double m_z_CG
private

z collection gap

Definition at line 155 of file TpcDigitizerModule.h.

◆ m_z_DG

double m_z_DG
private

z drift gap

Definition at line 151 of file TpcDigitizerModule.h.

◆ m_z_TG

double m_z_TG
private

z transfer gap

Definition at line 153 of file TpcDigitizerModule.h.

◆ olddetNb

int olddetNb = -1
private

Old detector counter.

Definition at line 208 of file TpcDigitizerModule.h.

◆ oldtrkID

int oldtrkID = -1
private

Old track ID.

Definition at line 211 of file TpcDigitizerModule.h.


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