Documentation of libsbsdig » History » Version 98

Eric Fuchey, 03/02/2021 04:46 PM

1 1 Eric Fuchey
h1. Documentation of libsbsdig
3 70 Eric Fuchey
5 36 Eric Fuchey
This page concerns the new version of libsbsdig which is currently being developped. The documentation for the old version of libsbsdig has been saved at:
8 1 Eric Fuchey
h2. Overview
10 41 Eric Fuchey
This page is maintained by the UConn group (Eric Fuchey + Andrew Puckett) and as of February 14, 2020 is specific to the *sbsdig_lw* branch of libsbsdig on github.
11 1 Eric Fuchey
h2. Purpose
14 52 Eric Fuchey
This page documents the libsbsdig code, which purpose is to process the Monte Carlo simulations of the SBS experiments produced by G4SBS [] to produce ADCs or TDCs.
15 37 Eric Fuchey
It is a standalone program which can run with a limited number of outputs (see section on usage).
16 52 Eric Fuchey
These produce files which can be analyzed with SBS-offline [].
17 1 Eric Fuchey
h2. Getting the code and building the program
h3. Prerequisites
22 54 Eric Fuchey
* Working ROOT [] installation. ROOT 6 is strongly recommended.
* Working G4SBS [] installation.
24 1 Eric Fuchey
h3. Downloading the repository
The code is hosted on a github repository owned by JLab. To clone via ssh (preferred method on JLab batch farm), do: 
28 5 Eric Fuchey
29 1 Eric Fuchey
bq. git clone
For this method to work, the ssh public key on the machine where you want to get the code must be added to your github account (see [ Guide] to generating ssh keys and adding to your account.)
33 51 Eric Fuchey
Cloning the repository defaults to the "master" branch. _As of August, 18th, 2020, the master branch still contains the old version of the code_.
34 72 Eric Fuchey
*Beware that the current version of libsbsdig is not on the "master" branch, but on the "sbsdig_lw".*
35 71 Eric Fuchey
To obtain the new version of the code currently being developped on the "sbsdig_lw" branch, do:
37 36 Eric Fuchey
bq. git checkout sbsdig_lw
39 1 Eric Fuchey
h3. Building and installing the library
42 92 Eric Fuchey
Create a "build" directory that is parallel to the "libsbsdig" source directory (this is not strictly required, but the build directory must be separate from the "libsbsdig" directory in any case). 
43 2 Eric Fuchey
You also need to have setup an installation path e.g. /path/to/libsbsdig-install
44 93 Eric Fuchey
For instance, you can create it parallel to your libsbsdig directory (with the mkdir command), even though it is not strictly required
46 2 Eric Fuchey
*NB*: similarly to the build directory, the /path/to/libsbsdig-install directory shall '''not''' be the same as the source directory!
_The following instructions assume that "build" is parallel to "libsbsdig":_
48 9 Eric Fuchey
If successful, the libsbsdig library and several other files and folders will be created in the "build" and the "install" directory.
49 1 Eric Fuchey
50 2 Eric Fuchey
To build and install, the procedure needs to be completed. From scratch:
bq. mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/libsbsdig-install ../libsbsdig
make install
56 1 Eric Fuchey
57 3 Eric Fuchey
Then, the following line should be added in the OS login configuration file to take advantage of this functionality:
58 91 Eric Fuchey
* source /path/to/libsbsdig-install/bin/ (or source /path/to/libsbsdig-install/bin/sbsdigenv.csh on the batch farm)
59 1 Eric Fuchey
60 13 Eric Fuchey
h2. How to use the digitization library
61 1 Eric Fuchey
62 37 Eric Fuchey
When sbsdig is installed in your machine, you can run the program using up to 4 arguments:
63 1 Eric Fuchey
64 98 Eric Fuchey
bq. sbsdig db_gmn_conf.dat gmn13.5_elastic_ex.txt 100000
65 33 Eric Fuchey
66 1 Eric Fuchey
These arguments have to come in this sequence, and while not all arguments are mandatory to provide, one cannot skip an argument unless they want to skip all following arguments.
67 78 Eric Fuchey
*The first argument is a database containing the list of detectors to digitize, and the parameters for the digitization. An example of such parameters is attached (db_gmn_conf.dat)
*The second argument is a list of "signal" files to digitize. It is mandatory to provide. An example is provided in the files attached.
69 1 Eric Fuchey
This file contains a list of input files for the program to run on. Hence, it has to contain g4sbs files that you have permission to modify. In the example file sbsdig gmn13.5_elastic_ex.txt attached, you may want to 
70 98 Eric Fuchey
*The third argument is the number of process. It has a default value of "-1" (=2^64-1) so it can be left unprovided.
72 78 Eric Fuchey
*The fourth argument is a files containing the background histograms extracted from min-bias beam-on-target simulations Beware these histograms have to have a certain name. An example file and macros are attached
73 73 Eric Fuchey
It can be ignored if one seeks to digitize signal with no background. An example is provided in the files attached.
74 78 Eric Fuchey
*The fifth argument is the fraction of luminosity with respect to the experiment nominal luminosity, which determines the quantity of background to add to the signal. It's default value is zero, so it can be ignored if one seeks to digitize signal with no background.
75 25 Eric Fuchey
76 79 Eric Fuchey
h2. Input files documentation
78 80 Eric Fuchey
h3. Configuration file
79 1 Eric Fuchey
80 81 Eric Fuchey
This part describes the expected parameters for the configuration file (first argument for sbsdig). 
These parameters are presented as follows: name (expected type): nature of the 
82 1 Eric Fuchey
83 81 Eric Fuchey
* Rseed (int): seed for random number generator
* TriggerJitter (float): global trigger jitter for all detectors in ns
85 1 Eric Fuchey
86 81 Eric Fuchey
* detectors_list (strings, may take several arguments): list of detectors to digitize
Currently implemented:
hcal (hadron calorimeter, "pmt" type detector)
bbps (Big Bite calorimeter preshower, "pmt" type detector)
bbsh (Big Bite calorimeter shower, "pmt" type detector)
grinch (BigBite GRINCH cherenkov, "pmt" type detector)
bbhodo (BigBite timing hodoscope, "pmt" type detector)
93 1 Eric Fuchey
bbgem (BigBite GEM tracker, "gem" type detector)
94 96 Eric Fuchey
ecal (GEp electromagnetic calorimeter, "pmt" type detector)
cdet (coordinate detector for GEp electron arm, "pmt" type detector)
ft (GEp front tracker, "gem" type detector)
fpp1 (GEp focal plane polarimeter 1, "gem" type detector)
fpp2 (GEp focal plane polarimeter 2, "gem" type detector)
99 89 Eric Fuchey
GEnRP detectors being added...
101 79 Eric Fuchey
102 88 Eric Fuchey
h4. Parameters for "pmt" type detector (name "det")
103 83 Eric Fuchey
104 88 Eric Fuchey
* NChan_det (int) number of PMTs
* gatewidth_det (float) size of the data acquisition window in ns 
* gain_det (float) PMT gain
* ped_det (float) channel pedestal mean
* pedsigma_det (channel)  channel pedestal sigma
* trigoffset_det (float) trigger offset to have the signal centered properly around zero
* ADCconv_det (float) fC/ADC channels conversion factor
* ADCbits_det (int) number of bits to store the ADC value
* TDCconv_det (float) ns/TDC channels conversion factor
* TDCbits_det (int) number of bits to store the TDC value
* sigmapulse_det (float) full width half max of PMT pulse
115 84 Eric Fuchey
116 86 Eric Fuchey
h4. Parameters for "gem" type detector (of name "detgem")
117 1 Eric Fuchey
118 97 Eric Fuchey
* NPlanes_detgem (int): number of GEM modules x number of readout planes (usually 2) included in the tracker;
119 1 Eric Fuchey
* gatewidth_detgem (float): size data acquisition window for the in ns;
120 97 Eric Fuchey
* nlayers_detgem (int): number of GEM layers (ensemble of GEM modules at a same z)
* detgem_layer_z (array of floats): z value of each layer (should match number of layers); 
122 95 Eric Fuchey
* layer_detgem (int): layer to which the plane/module/readout belongs; _array needs to be same size as NPlanes_detgem_
123 90 Eric Fuchey
* nstrips_detgem (array of ints): number of strips for each plane/module/readout; _array needs to be same size as NPlanes_detgem_
* offset_detgem (array of floats): geometrical offset in transport coordinate for each plane/module in meters (alternatively x, y); _array needs to be same size as NPlanes_detgem_
* RO_angle_detgem (array of floats): angle of readout in degrees, with respect to transport coordinate x; _array needs to be same size as NPlanes_detgem_
* triggeroffset_detgem (array of floats): trigger offsets for all planes in ns _array needs to equal to NPlanes_detgem/2_
* ZsupThr_detgem (float): zero suppression threshold for GEMs in ADC channels;
* commonmode_array_detgem (float or array of floats) "common mode" (APV pedestal) value/array for BBGEMs in ADC channels; one can provide only one value which will be used for all strips or an array of values for a more realistic simulation
129 82 Eric Fuchey
130 1 Eric Fuchey
h2. Root output documentation
131 39 Eric Fuchey
The new digitization library will expand the TTree object from the input file to add ADC and TDC values.
133 55 Eric Fuchey
The input tree structure from G4SBS has already been described in detail in the G4SBS documentation [].
134 56 Eric Fuchey
The basic idea is that for each detector in the input tree, a set of branches will be added.
There are several types of detectors in G4SBS (GEM, CAL, RICH), but there is not always a defined extension for a G4SBS detector type.
(NB: I'm voluntarilly omitting ECAL, 
For the purpose of the digitization, it is more convenient to define the following types of detectors:
* GEM: GEM trackers. Corresponds unambiguously to GEM detector type in G4SBS. Read out by MPD (sampling ADC) modules.
* Cher: Cherenkov detectors (example: GRINCH). Corresponds unambiguously to RICH detector type in G4SBS. Read out by TDC modules (with optional ADCs).
* Scint: Scintillator timing detectors (example: Timing Hodoscope). Corresponds to CAL detector type in G4SBS. Read out by TDC modules (with optional ADCs).
* Cal: Calorimeter (example: BBPS, BBSH). Corresponds to CAL detector type in G4SBS. Read out by ADC modules.
* HCal: Hadron Calorimeter. Corresponds to CAL detector type in G4SBS. Read out by FADC (sampling ADC) modules with TDCs.
144 57 Eric Fuchey
145 62 Eric Fuchey
h4. (proposed) data structure extension for "Cal" detector types:
146 57 Eric Fuchey
* nchan (int): number of channels (firing?)
148 66 Eric Fuchey
* chan (std::vector<int>) channel number
149 57 Eric Fuchey
* adc (std::vector<int>) unencoded pedestal subtracted ADC value
151 62 Eric Fuchey
h4. (proposed) data structure extension for "Scint", "Cher" detector types:
152 57 Eric Fuchey
* nchan (int): number of channels (firing?)
154 66 Eric Fuchey
* chan (std::vector<int>) channel number
155 57 Eric Fuchey
* adc (std::vector<int>) unencoded pedestal subtracted ADC value
* tdc_l (std::vector<int>) unencoded leading TDC value
* tdc_t (std::vector<int>) unencoded trailing TDC value
159 61 Eric Fuchey
h4. (proposed) data structure extension for "HCal" detector types:
160 57 Eric Fuchey
* nchan (int): number of channels (firing?)
162 67 Eric Fuchey
* chan (std::vector<int>) channel number
163 57 Eric Fuchey
* adc_i (i = 0 -> 19) (std::vector<int>) unencoded pedestal subtracted ADC values for sample i
164 62 Eric Fuchey
* tdc (std::vector<int>) unencoded TDC value
165 1 Eric Fuchey
166 79 Eric Fuchey
h4. (proposed) data structure extension for "GEMs" detector types:
167 1 Eric Fuchey
* nstrips (int) number of strips (firing?)
169 79 Eric Fuchey
* module (std::vector<int>) module number
170 66 Eric Fuchey
* strips (std::vector<int>) strip number
171 69 Eric Fuchey
* adc_i (i = 0 -> 5) (std::vector<int>) unencoded pedestal subtracted ADC values for sample i