FANGS ATLAS FE-I4B ASIC chip digitizer. More...

#include <FANGSDigitizerModule.h>

Inheritance diagram for FANGSDigitizerModule:

Collaboration diagram for FANGSDigitizerModule:

[legend]

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
	FANGSDigitizerModule ()
	Constructor: Sets the description, the properties and the parameters of the module.

virtual void	initialize () override
	Initialize the Module. More...

virtual void	beginRun () override
	Called when entering a new run.

virtual void	event () override
	This method is the core of the module. More...

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 (__attribute__((unused)) bool outputFiles)
	Return a list of output filenames for this modules. 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...

LogConfig &	getLogConfig ()
	Returns the log system configuration.

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

void	setLogLevel (int logLevel)
	Configure the log level.

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

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

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level. 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 ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)

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

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

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). 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 ModuleParamList &	getParamList () 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< PathElement >	clone () 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
void	getXMLData ()
	array for FANGSHit More...

void	Pixelization ()
	Produces the pixelization.

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

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

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects. 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< FANGSHit >	m_fangsHit

TF1 *	fctToT_Calib1
	Define ToT calib 1.

TF1 *	fctToT_Calib2
	Define ToT calib 2.

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_Workfct
	Work function.

double	m_Fanofac
	Fano factor.

double	m_sensor_width
	sensor width

double	m_v_sensor
	Drift velocity in sensor.

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_nFANGS = 15
	number of detectors. More...

double	m_lowerTimingCut = 0
	Lower timing cut.

double	m_upperTimingCut = 1000000
	Upper timing cut.

int	olddetNb = -1
	Old detector counter.

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

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

FANGS ATLAS FE-I4B ASIC chip digitizer.

Creates FANGSHits from FANGSSimHits

Definition at line 40 of file FANGSDigitizerModule.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 79 of file Module.h.

Member Function Documentation

◆ 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 181 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 441 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 422 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 98 of file Module.cc.

◆ event()

void event ( )

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 70 of file FANGSDigitizerModule.cc.

 {
   StoreArray<MCParticle> mcParticles;
   StoreArray<FANGSSimHit> FANGSSimHits;
   m_nFANGS = 15;
   std::vector<double> T0(m_nFANGS,
                          m_upperTimingCut);
  
   //Find the start time
   for (const auto& FANGSSimHit : FANGSSimHits) {
     const int lad = FANGSSimHit.getLadder();
     const int sen = FANGSSimHit.getSensor();
     const int detNb = (lad - 1) * 5 + sen - 1;
     const TVector3 trackPosition =  FANGSSimHit.getLocalPosEntry();
     const double z = trackPosition.Y() + m_sensor_width / 2.; //cm
     if (z < T0[detNb]) {
       T0[detNb] = z;
     }
   }
  
   for (auto& val : T0) {
     if (m_lowerTimingCut < val && val < m_upperTimingCut) {
       val = val / m_v_sensor; //cm / (cm / ns) = ns
     } else {
       val = -1.;
     }
   }
  
   //loop on all entries to store in 3D the ionization for each FANGS
   for (const auto& FANGSSimHit : FANGSSimHits) {
  
     const int lad = FANGSSimHit.getLadder();
     const int sen = FANGSSimHit.getSensor();
     const int detNb = (lad - 1) * 5 + sen - 1;
     const TVector3 simHitPosition =  FANGSSimHit.getLocalPosEntry();
     const double edep = FANGSSimHit.getEnergyDep() * 1e9; //GeV to eV
  
     const TVector3 chipPosition(//cm
       simHitPosition.X(),
       simHitPosition.Z(),
       simHitPosition.Y() + m_sensor_width / 2.);
  
     //If new detector filled the chip
     if (olddetNb != detNb && m_dchip_map.size() > 0) {
       Pixelization();
       olddetNb = detNb;
       m_dchip_map.clear();
       m_dchip.clear();
       m_dchip_detNb_map.clear();
       m_dchip_pdg_map.clear();
       m_dchip_trkID_map.clear();
     }
  
     // There is some issue with these cuts! please check, remove for now!
     //check if ionization within sensitive volume
     /*if ((-m_ChipColumnX < chipPosition.X() && chipPosition.X() < m_ChipColumnX) &&
         (-m_ChipRowY < chipPosition.Y() && chipPosition.Y() <  m_ChipRowY) &&
         (0. < chipPosition.Z() && chipPosition.Z() <  m_sensor_width) &&
         (m_lowerTimingCut < T0[detNb] && T0[detNb] < m_upperTimingCut)) {*/
     if (1) {
  
       if (edep <  m_Workfct) break;
       // check if enough energy to ionize
       else if (edep >  m_Workfct) {
  
         const double meanEl = edep / m_Workfct;
         const double sigma = sqrt(m_Fanofac * meanEl);
         const int NbEle = (int)gRandom->Gaus(meanEl, sigma);
  
         int col = (int)((chipPosition.X() + m_ChipColumnX) / (2. * m_ChipColumnX / (double)m_ChipColumnNb));
         int row = (int)((chipPosition.Y() + m_ChipRowY) / (2. * m_ChipRowY / (double)m_ChipRowNb));
         int pix = col +  m_ChipColumnNb * row;
         int quT = gRandom->Uniform(-1, 1);
         int bci = (int)((chipPosition.Z() / m_v_sensor - T0[detNb]) / (double)m_PixelTimeBin) + quT;
         if (bci < 0)bci = 0;
  
         //check if amplified drifted electron are within pixel boundaries
         if ((0 <= col && col < m_ChipColumnNb) &&
             (0 <= row && row < m_ChipRowNb) &&
             (0 <= pix && pix < m_ChipColumnNb * m_ChipRowNb)  &&
             (0 <= bci && bci < MAXtSIZE)) {
           //store info into 3D array for each FANGSs
           m_dchip_map[std::tuple<int, int>(col, row)] = 1;
           m_dchip_detNb_map[std::tuple<int, int>(col, row)] = detNb;
           m_dchip_pdg_map[std::tuple<int, int>(col, row)] = FANGSSimHit.getPDG();
           m_dchip_trkID_map[std::tuple<int, int>(col, row)] = FANGSSimHit.gettrkID();
           m_dchip[std::tuple<int, int, int>(col, row, bci)] += (int)(NbEle);
         }
       }
     }
   }
  
   if (m_dchip_map.size() > 0) Pixelization();
   m_dchip_map.clear();
   m_dchip.clear();
   m_dchip_detNb_map.clear();
   m_dchip_pdg_map.clear();
   m_dchip_trkID_map.clear();
 }

◆ 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 135 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 115 of file Module.cc.

◆ getFileNames()

virtual std::vector<std::string> getFileNames ( __attribute__((unused)) 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.

Definition at line 136 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 189 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 281 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 383 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 43 of file Module.cc.

◆ getXMLData()

void getXMLData ( )

private

array for FANGSHit

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

Definition at line 288 of file FANGSDigitizerModule.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

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

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

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

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

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

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

Definition at line 81 of file Module.cc.

◆ initialize()

void initialize ( )

overridevirtual

Initialize the Module.

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

Reimplemented from Module.

Definition at line 50 of file FANGSDigitizerModule.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 216 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

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

name	The name of the module

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

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

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

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

Definition at line 251 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

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

value The value of the return value.

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

value The value of the return value.

Definition at line 222 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 50 of file Module.cc.

Member Data Documentation

◆ m_nFANGS

int m_nFANGS = 15

private

number of detectors.

Read from MICROFANGS.xml

Definition at line 139 of file FANGSDigitizerModule.h.

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

beast/fangs/modules/include/FANGSDigitizerModule.h
beast/fangs/modules/src/FANGSDigitizerModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ evalCondition()

◆ event()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ getXMLData()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ m_nFANGS