Wiki source code of The FLASH HDF5 structure

Version 74.1 by sndueste on 2023/05/05 08:29

Show last authors
1 {{layout}}
2 {{layout-section ac:type="single"}}
3 {{layout-cell}}
4 == Contents ==
5
6
7
8 {{toc/}}
9
10 \\
11
12 == General information about HDF5 ==
13
14 HDF5 is a data format maintained by the HDF group. For detailed general information see [[here~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://portal.hdfgroup.org/display/support||shape="rect"]]
15
16 To download the HDF5 Viewer click [[here~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://portal.hdfgroup.org/display/support/Download+HDFView||shape="rect"]]
17
18 For use on the DESY Maxwell or PAL (max-fsc or pal) **hdfview** is available in the xray module :
19 {{code language="none"}}> module load xray{{/code}}
20 {{code language="none"}}> hdfview{{/code}}
21
22 or you can use
23
24 {{code language="none"}}> silx view{{/code}}
25
26 \\
27
28 [[Contents>>doc:||anchor="Contents"]]
29
30 == The FLASH HDF5 format ==
31
32 FLASH provides a conversion of its data acquisition (DAQ) to the commonly used [[HDF5>>url:https://www.hdfgroup.org/solutions/hdf5/||shape="rect"]] format. Correlated  data are mapped by a primary index called **train ID**. Every data set has an individual index of train IDs to identify the data even when data are missing or deviate in update rate. If the data set of choice contains gaps,  users have to decide how to treat missing values. DAQ channels are spread across various files with one file name pattern for each DAQ. This means users have to assemble data from different files if necessary.
33
34 The hierarchy is realized using a human readable named HDF tree with each DAQ channel containing the data sets "//value//" and "//index//". Additionally, the HDF group //zraw// contains a tree of the original DAQ channel names.
35
36 Reference implementation, which follows the concept of Python libraries like Pandas, Xarray, or Dask, is given below.
37
38 \\
39
40 {{expand title="Discontinued HDF formats"}}
41 === Comparison to FLASH's deprecated HDF formats ===
42
43 Before 2021, FLASH provided two different HDF formats formally known as //near-online// and //offline// HDF files.
44
45 All data sets were aligned by the same global index by filling in missing data. Fast DAQ channels  (pulse synchronous data - update 10 Hz) are filled in by NaN or 0, slow channels (not pulse synchronous data - update e.g. 1 Hz ) are interpolated by the DAQs libraries, by keeping the value constant up to the next change.
46
47 While the near-online HDF files were converted live during the beamtime, the offline HDF files were manually compiled weeks/months later. Near-online HDF files were used by a provided API [[BeamtimeDaqAccess>>url:https://confluence.desy.de/display/FLASHUSER/Near-Online+data+analysis#Near-Onlinedataanalysis-BriefUserGuidetoBeamtimeDAQAccess||shape="rect"]], which also searches for DAQ channels in files. With assembled files "by run", all DAQ channels were existing in the same HDF file. While shorter runs usually fitted into one file, longer runs still had to be aggregated over several files. The creation of the assembled type of files still involves the use of fairly unstable DAQ Mex-functions As the environment required for using the Mex-functions is already deprecated, its continued existence is uncertain.
48
49 The HDF hierarchy is almost identical in all formats. While in the the recent format each DAQ channel contains the data sets "value" and "index", the deprecated format had one data set for each DAQ channel. The deprecated formats supplies no time axis parameters for spectra data types.
50
51 \\
52
53 **HDF5 example files (old format)**
54
55 Here we have a few HDF5 samples (User data combined with Photon diagnostics data) from a few beamtimes showing the different kind options.
56
57 [[image:attach:image2019-10-21_17-2-50.png||thumbnail="true" width="300"]] [[download HDF5 (Images @ FL2)>>url:https://desycloud.desy.de/index.php/s/nyEgeCWJFC4gao2||shape="rect"]]
58
59 \\
60
61 [[~[~[image:attach:image2019-10-22_10-52-27.png~|~|thumbnail="true" width="300"~]~]download HDF5 (GHz ADC and OPIS @ FL2)>>url:https://desycloud.desy.de/index.php/s/AeA2kPNNnZgX95A||shape="rect"]]
62
63 \\
64
65 \\
66 {{/expand}}
67
68 === HDF examples: ===
69 {{/layout-cell}}
70 {{/layout-section}}
71
72 {{layout-section ac:type="three_equal"}}
73 {{layout-cell}}
74 * ADC data as example for **fast** **data** (10 Hz):           
75
76 \\
77
78 [[image:attach:image2020-11-16_15-26-28.png||height="250"]]
79 {{/layout-cell}}
80
81 {{layout-cell}}
82 * The //average// FEL pulse energy as example for the **slow** **data**. Here the data is not saved with 10 Hz  - thus not for every FEL pulse train.  The data is typically saved with 1 Hz if the values are changing (like the FEL energy) and every about 20 sec if there is no change for longer time ( e.g. motor set values). Thus to use the data together with the "fast" one, one has to interpolate the data as explained in the examples in the repos below show (e.g. {{code language="none"}}df['GMD_T_average'] = df['GMD_T_average'].interpolate(method='linear'){{/code}})
83
84 ( as example only every 10th train ID is listed in the HDF group "index")
85
86 [[image:attach:image2020-11-16_15-31-45.png||height="250"]]
87 {{/layout-cell}}
88
89 {{layout-cell}}
90 * (((
91 //zraw// group contains the **original DAQ (DOOCS) names**
92 )))
93
94 of the properties saved in the DESY internal raw format. (For experts)
95
96 \\
97
98 [[image:attach:image2020-11-16_16-26-3.png||height="400"]]
99 {{/layout-cell}}
100 {{/layout-section}}
101
102 {{layout-section ac:type="single"}}
103 {{layout-cell}}
104 {{info}}
105 === Reference implementation (Python) ===
106
107 (imperative)  (% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]
108
109 (% class="Object" %)(object oriented) [[https:~~/~~/gitlab.desy.de/christopher.passow/fdh-builder>>url:https://gitlab.desy.de/christopher.passow/fdh-builder.git||shape="rect"]]
110 {{/info}}
111 {{/layout-cell}}
112 {{/layout-section}}
113
114 {{layout-section ac:type="single"}}
115 {{layout-cell}}
116
117
118 == Complete list of recordable parameters ==
119
120 The complete list for the relation between DOOCS names and HDF5 names for the recordable parameters can be found in [[DESY's Repository~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://stash.desy.de/projects/CS/repos/pah/browse/src/camp/data/channel2HdfName.dat||shape="rect"]].
121 \\
122
123 == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
124
125 {{id name="DOOCSparameters"/}}
126
127 Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0.
128
129 \\
130
131 === FLASH1 ===
132
133 ==== Beamline info (FLASH1) ====
134
135 {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}
136 //always saved (PBD)//
137 DOOCS prop : {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
138 DAQ channel: {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
139 desc: set pressure in the gas attenuator
140 units: mbar
141 \\
142
143 {{code language="none"}}/FL1/Beamlines/BL/Fast shutter/open{{/code}}
144 //always saved (PBD)//
145 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER/CH00.TD{{/code}}
146 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER{{/code}}
147 desc: BL Beamline Fast shutter state
148 units: none
149 \\
150
151 {{code language="none"}}/FL1/Beamlines/PG/Fast shutter/open{{/code}}
152 //always saved (PBD)//
153 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER/CH00.TD{{/code}}
154 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER{{/code}}
155 desc: PG Beamline Fast shutter state
156 units: none
157 \\
158
159 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 1{{/code}}
160 //always saved (PBD)//
161 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
162 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
163 desc: Position of the BL filter wheel 1 - to correlate with the filter material please look [[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
164 units: degree
165 \\
166
167 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 2{{/code}}
168 //always saved (PBD)//
169 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
170 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
171 desc: Position of the BL filter wheel 2 - to correlate with the filter material please look [[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
172 units: degree
173 \\
174
175 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 1{{/code}}
176 //always saved (PBD)//
177 DOOCS prop : = TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS=
178 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}
179 desc: Position of the PG filter wheel 1
180 units: degree
181 \\
182
183 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 2{{/code}}
184 //always saved (PBD)//
185 DOOCS prop : {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
186 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
187 desc: Position of the PG filter wheel 2
188 units: degree
189 \\
190
191 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 3{{/code}}
192 //always saved (PBD)//
193 DOOCS prop : {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
194 DAQ channel: {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
195 desc: Position of the PG filter wheel 3
196 units: degree
197
198 \\
199
200
201 NOTE: Aperture positions in the beamline as well as the positions of the beam steering mirrors are also saved. For more Info contact your local contact
202
203 [[Contents>>doc:||anchor="Contents"]]
204
205 \\
206
207 ==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====
208
209 {{expand title="Discontinued GMD format (used until 2021)"}}
210 (% style="color: rgb(0,0,0);" %)**Discontinued GMD data recording / evaluation  (VME + PhotonFlux ML server)**
211
212 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
213 //always saved (PBD)//
214
215 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)
216 (% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)
217 desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator (ion current)
218 units : microJ
219
220 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
221 //always saved (PBD)//
222
223 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}
224 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}
225 desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL
226 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
227
228 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel (raw){{/code}}
229 //always saved (PBD)//
230 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT14/VAL{{/code}}
231 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.FF{{/code}}
232 desc :Energy per pulse Tunnel (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
233 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
234
235 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}
236 //always saved (PBD)//
237
238 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}
239 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}
240 desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)
241 units : microJ
242
243 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}
244 //always saved (PBD)//
245
246 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}
247 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}
248 desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL
249 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
250
251 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA (raw){{/code}}
252 //always saved (PBD)//
253 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT15/VAL{{/code}}
254 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}
255 desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
256 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
257 {{/expand}}
258
259 \\
260
261 (% style="letter-spacing: 0px; color: rgb(0, 0, 0)" %)**NEW (since 2021) GMD data recording / evaluation  (same format as FLASH2 and XFEL)**
262
263 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
264 //always saved (PBD)//
265 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
266 (% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
267
268 desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator
269 units : microJ
270
271 \\
272
273 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
274 //always saved (PBD)//
275
276 (% style="color: rgb(0,0,0);" %)DOOCS prop : 
277 {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}
278
279 desc : Energy per pulse measured in the Tunnel.  In addition measurement errors and beam position are included for EACH pulse in the pulse train  !! (see below)
280 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
281
282 {{info title="GMD pulse resolved data structure"}}
283 For every pulse in the pulse train the information is saved:
284
285
286 1. **Intensity per pulse** (a.u. (more or less µJ ))
287 1. Intensity per pulse (auxillary GMD) - not used
288 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
289 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
290 1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color: rgb(0,0,0);" %)This parameter gives an indication of the error of the measurement of the pulse energy. This takes signal to noise,  detector resolution, uncertainties in crossection etc into account. (it is NOT the measurement of the statistical fluctuation of the SASE pulses)(%%))
291 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
292 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
293 1. Combined warning and error flags
294
295 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
296 file
297
298
299 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
300
301 \\
302 {{/info}}
303
304 All values for the GMD are also available for the** BDA GMD **which is located in the experimental hall down stream the gas attenuator. If the attenuator is on the ratio between BDA and Tunnel signal shows the attenuation. **BUT NOTE** that the filter units  are downstream the GMD. So if filters  are used this influence is NOT measured by the GMD BDA !
305
306 \\
307
308 Besides  pulse energy the GMD also provides information about the beam position
309
310 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}
311 //always saved (PBD)//
312 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
313 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
314 desc :Beam position of the photon Beam determined by the GMD (BDA, x=horizontal)
315 units : mm
316
317 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical{{/code}}
318 //always saved (PBD)//
319 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
320 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
321 desc :Beam position of the photon Beam determined by the GMD (BDA, y=vertical)
322 units : mm
323
324 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal{{/code}}
325 //always saved (PBD)//
326 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
327 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
328 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, x=horizontal)
329 units : mm
330
331 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical{{/code}}
332 //always saved (PBD)//
333 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
334 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
335 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)
336 units : mm
337
338 \\
339
340 ==== Spectrometer (FLASH1) ====
341
342 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}
343 _always saved (when Spectrum is measured !!) (PBD) _
344 DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}
345 DAQ channel: {{code language="none"}}PBD.PHOTONWL.ML/WAVE_LENGTH{{/code}}
346 desc : XUV Spectrum measured with the "tunnel spectrometer"
347 units :
348
349 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength start value{{/code}}
350 _always saved (when Spectrum is measured !!) (PBD) _
351 DOOCS prop : {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
352 DAQ channel: {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
353 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
354 units : nm
355
356 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength increment{{/code}}
357 _always saved (when Spectrum is measured !!) (PBD) _
358 DOOCS prop : ==
359 DAQ channel: ==
360 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
361 units : nm
362
363 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy{{/code}}
364 //saved on DEMAND (PBD spectrometer stream)//
365 DOOCS prop : ==
366 DAQ channel: {{code language="none"}}PBD.PHOTONEN.ML/PHOTON_ENERGY{{/code}}
367 desc : XUV Spectrum in eV measured with the "PG2 spectrometer"
368 units :
369
370 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy start value{{/code}}
371 //saved on DEMAND (PBD spectrometer stream)//
372 DOOCS prop : ==
373 DAQ channel: ==
374 desc : start value (in eV) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
375 units : eV
376
377 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy increment{{/code}}
378 //saved on DEMAND (PBD spectrometer stream)//
379 DOOCS prop : ==
380 DAQ channel: ==
381 desc : increment value (in eV) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
382 units : eV
383
384 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength{{/code}}
385 //saved on DEMAND (PBD spectrometer stream)//
386 DOOCS prop : ==
387 DAQ channel: {{code language="none"}}PHOTONEN.ML/PHOTON_WAVE_LEN{{/code}}
388 desc : XUV Spectrum in nm measured with the "PG2 spectrometer"
389 units :
390
391 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength increment{{/code}}
392 //saved on DEMAND (PBD spectrometer stream)//
393 DOOCS prop : ==
394 DAQ channel: ==
395 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
396 units : nm
397
398 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength start value{{/code}}
399 //saved on DEMAND (PBD spectrometer stream)//
400 DOOCS prop : ==
401 DAQ channel: ==
402 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
403 units : nm
404
405 [[Contents>>doc:||anchor="Contents"]]
406
407 ==== Electron Beam properties (FLASH1) ====
408
409 ===== bunch charge =====
410
411 {{code language="none"}}/FL1/Electron Diagnostic/Bunch charge/after undulator{{/code}}
412 //always saved (PBD)//
413 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/CHARGE.FLASH1{{/code}}
414 DAQ channel: {{code language="none"}}FLASH.DIAG/TOROID/12EXP{{/code}}
415 desc: electron bunch charge (FLASH1)
416 units: nC
417
418 =====
419 arrival time (BAM) =====
420
421 {{info title="BAM information: updates 2022"}}
422 * see: [[Info collection about the BAMs and how to use the BAM data>>url:https://confluence.desy.de/display/FLASHUSER/Info+collection+for+the+BAM||shape="rect"]]
423 * The data format of the BAM has been completely altered in the 2022 shutdown
424 * before 2022 BAMs were always saving the arrival time information for each 1µs bucked regardless if there were electrons in the accelerator or not. IN addition the arrival times for  FL1 and FL2 were saved in the same parameter ...
425 * THIS is now different. There are new parameters saving only the arrival times for pulses that go to FL1 and to FL2 (in detail: first time slot of the accelerator and second)
426 * There has been also a renaming  (and relocation) of the BAMs.
427 ** acc:  4DBC3 → FL0.DBC2
428 ** FL1: 1SFELC →  FL1.SFELC
429 ** FL2: FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
430 * for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
431 * [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FLASHUSER.Additional helpful things.FLASH beamlines and instruments references.WebHome]]
432 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
433 {{/info}}
434
435 \\
436
437 {{expand title="Discontinued BAM format (used until end 2021)"}}
438 (% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
439
440 {{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
441 //always saved (PBD)//
442 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
443 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
444 desc: Electron bunch arrival time measured with the BAM inside the accelerator - however shows a very good correlation to the arrivaltime  of the XUV pulses in the experiment (pulse resolved data).
445 units: ps (bigger numbers indicate later arrivaltime of the electrons)
446
447 \\
448
449 {{code language="none"}}/FL1/Electron Diagnostic/BAM/1SFELC/electron bunch arrival time (low charge){{/code}}
450 //always saved (PBD)//
451 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/1SFELC/LOW_CHARGE_ARRIVAL_TIME{{/code}}
452 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/1SFELC.LOW_CHARGE_ARRIVAL_TIME{{/code}}
453 desc: Electron bunch arrival time measured with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.
454 units: ps (bigger numbers indicate later arrival time of the electrons)
455 {{/expand}}
456
457 ====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======
458
459 (% style="color: rgb(255,102,0);" %)**DBC2**/electron bunch arrival time  (HDF5 name not yet implemented - see zraw)(%%)
460 //always saved (PBD)//
461 {{code language="none"}}/FL1/Electron Diagnostic/BAM/ {{/code}}DOOCS prop : FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
462 DAQ (% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP (%%)
463 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). The property contains only the arrival time of the bunches sent to FL1 (e.g. if there are 30 bunches in FL1 the first 30 values are the arrival time the remaining numbers  still may have arbitrary numbers looking like a signal which they are not ). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
464
465 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
466
467 \\
468
469 (% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
470 //always saved (PBD)//
471 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE
472 DAQ channel: (% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE (%%)
473 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 1 in the first part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
474 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
475
476 \\
477
478 (% style="color: rgb(255,102,0);" %)DBC2/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
479 //always saved (PBD)//
480 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
481 DAQ channel: (% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR(%%)
482 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
483
484 \\
485
486 (% style="color: rgb(255,102,0);" %)DBC2/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
487 //always saved (PBD)//
488 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
489 DAQ channel(% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.1(%%)
490 desc: (% style="letter-spacing: 0.0px;" %) status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
491
492 \\
493
494 ====== **BAM FL1.SFELC**{{code language="none"}}{{/code}} ======
495
496 (% style="font-family: SFMono-Medium , ~"SF Mono~" , ~"Segoe UI Mono~" , ~"Roboto Mono~" , ~"Ubuntu Mono~" , Menlo , Courier , monospace;letter-spacing: 0.0px;" %)/FL1/Electron Diagnostic/BAM/**SFELC**(% style="color: rgb(255,102,0);" %)/electron bunch arrival time  (HDF5 name not yet implemented - see zraw)
497
498 //always saved (PBD)//
499 (% style="color: rgb(23,43,77);" %)**FL1.SFELC**(%%)
500 (% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)FL1.SFELC(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
501 {{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ {{/code}}(% style="letter-spacing: 0.0px;" %)desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.. The property contains only the arrival time of the bunches sent to FL1 (e.g. if there are 30 bunches in FL1 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
502 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
503
504 \\
505
506 \\
507
508 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
509 //always saved (PBD)//
510 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIME.ABSOLUTE
511 DAQ channel:** **(% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.ABSOLUTE (%%)
512 desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020. Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 1 in the first part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
513 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
514
515 \\
516
517 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
518 //always saved (PBD)//
519 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
520 DAQ channel(% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMERROR(%%)
521 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
522
523 \\
524
525 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
526 //always saved (PBD)//
527 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
528 DAQ chann(% style="color: rgb(0,0,0);" %)el: FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMSTATUS.1(%%)
529 desc: status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
530
531 \\
532
533 \\
534
535 ===== electron beam profile =====
536
537 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}
538 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
539 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/OUT.PROF.CCCED{{/code}}
540 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}
541 desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)
542 units: pixel
543 \\
544
545 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}
546 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
547 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/CALIB.CONST.T{{/code}}
548 DAQ channel: = PBD.BEAM.PROF.ML/CCT=
549 desc: TDS calibration constant for the x-axis of the profiles: fs per pixel
550 units: fs per pixel
551 \\
552
553 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}
554 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
555 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/SOWS.W.CCTED{{/code}}
556 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}
557 desc: rms pulse width of the measures TDS electron bunch profile
558 units: fs
559
560 ===== electron bunch energy =====
561
562 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
563 //always saved (PBD)//
564 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
565 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
566 desc: electron bunch energy (average over the bunch train)
567 units: (% class="twikiNewLink" %)MeV(%%)
568 \\
569
570 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
571 //always saved (PBD)//
572 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
573 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
574 desc: electron bunch energy bunch resolved
575 units: (% class="twikiNewLink" %)MeV
576
577 \\
578
579 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
580 //always saved (PBD)//
581 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
582 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
583 desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
584 units: nm
585 \\
586
587 [[Contents>>doc:||anchor="Contents"]]
588
589 \\
590
591 ==== Timing information, rep rate etc.  (FLASH1) ====
592
593 ===== bunch repetition rate =====
594
595 {{code language="none"}}/FL1/Timing/repetition rate{{/code}}
596 //always saved (PBD)//
597 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
598 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
599 desc: repetition rate of the bunches / pulses within the burst (FLASH1)
600 units: kHz
601 \\
602
603 ===== set number of pulses =====
604
605 (% style="color: rgb(255, 0, 0); color: rgb(255, 102, 0)" %)(HDF5 name not yet implemented - see zraw)(% style="color: rgb(255,0,0);" %){{code language="none"}}/FL1/Timing/set number of bunches {{/code}}(%%)
606 //always saved (PBD)//
607 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}
608 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}
609 desc: Number of bunches set in the control (timing) system.  The property contains 4 numbers. the last one is the number of pulses (see also [[doc:FLASH.Timing properties]] (internal link)).  If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated and thus the actual number of pulses may be smaller than the set one 
610 units:
611
612 ===== actual number of pulses =====
613
614 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
615 //always saved (PBD)//
616 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/NUMBEROFBUNCHES.FLASH1{{/code}}
617 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
618 desc: Number of bunches measured BEHIND the undulator. If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated this is the actual number that created XUV radiation.The number is calculated by the DAQ middle layer server, (FLASH1)
619 units:
620 \\
621
622 ===== actual pulse pattern recorded after the undulator =====
623
624 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
625 //always saved (PBD)//
626 DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}
627 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
628 desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)
629 units:
630 \\
631
632 ===== Train ID =====
633
634 {{code language="none"}}/Timing/train ID{{/code}}
635 //always saved (PBD)//
636 DOOCS prop : {{code language="none"}}none{{/code}}
637 DAQ channel: {{code language="none"}}none{{/code}}
638 desc: Each 10 Hz burst has its unique train ID. For the HDF5 data set the ID is the same for all parameters with the same index (note camera images may be shifted by 1 ID - talk to the experts !)
639 units:
640 \\
641
642 ===== Train time =====
643
644 {{code language="none"}}/Timing/train time{{/code}}
645 desc:Local time as array of day, hour, minute, second, and centisecond. This data set is meant for visualization purposes only. For correlations use the train ID or the Unix time of the time stamp
646 units: d h min s cs
647 \\
648
649 {{code language="none"}}/Timing/time stamp{{/code}}
650 desc:first column: Local time in unix time. To get day, hour, minute, second you can use unix: e.g. date ~-~-date='@1553617729' or matlab, python etc
651 second column: microseconds
652 third column: Train ID of FLASH
653 \\
654
655 [[Contents>>doc:||anchor="Contents"]]
656
657 \\
658
659 ==== Pump Probe Laser (FLASH1) ====
660
661 **PIGLET (PG laser)**
662
663 **{{code language="none"}}/FL1/Experiment/Pump probe laser{{/code}}**
664
665 FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/DIAG1out/PULSEENERGY.MEAN 
666 FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/PG1_incoupl/PULSEENERGY.MEAN 
667 FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/PG2_incoupl/PULSEENERGY.MEAN 
668 FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.ENCODER_POSITION.RD 
669 FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.ENCODER_POSITION_RAW.RD 
670 FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.POSITION.RD
671
672 **BL - Hidra laser **
673
674 Property,Units,Description
675 FLASH.LASER/MODBL.CAM/BL1.13.AC/DAQ_CHANNEL,'AU','FL1HIDRAPP1 Autocorrelation (IR) ROI readout'
676 FLASH.LASER/MODBL.CAM/BL1.14.VF/DAQ_CHANNEL,'AU','FL1HIDRAPP1 Virtual Focus Camera (IR) ROI readout'
677 FLASH.LASER/MODBL.SENSORBOARD/PDTRIG_CAMP/DAQ_CHANNEL,'au','FL1PPL Energy channels'
678 FLASH.LASER/MODBL.SPECT/CAMP_IR/DAQ_CHANNEL,'au','FL1PPL BL Table Spectrum'
679 FLASH.LASER/HIDRAPP1.SPECTRUM_ANALYSIS/CAMP_IR/DAQ_CHANNEL,'au','FL1PPL Spectrum Analysis'
680 FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/FMC0.MD22.1.POSITION.RD,'ps','FL1PPL Optical Delay Line (act)'
681 FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/FMC0.MD22.1.POSITION_SET.WR,'ps','FL1PPL Optical Delay Line (set)'
682 FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/FMC0.MD22.1.ENCODER_POSITION.RD,'ps','FL1PPL Optical Delay Line (Encoder Readback)'
683 FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP_Delayline/FPOS,'ps','FL1PPL NIR delay BL1 table (act)'
684 FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP_Delayline/FPOS.SET,'ps','FL1PPL NIR delay BL1 table (set)'
685 FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP.ATT/FPOS,'degree','FL1PPL Transmission degree (act)'
686 FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP.ATT/FPOS.SET,'degree','FL1PPL Transmission degree (set)'
687 FLASH.FEL/FLAPPBEAMLINES.MOTOR/Camp_Focus_Lens/FPOS,'mm','FL1PPL Focus Mirror Stage Position (act)'
688 FLASH.FEL/FLAPPBEAMLINES.MOTOR/Camp_Focus_Lens/FPOS.SET,'mm','FL1PPL Focus Mirror Stage Position (set)'
689 FLASH.LASER/MODBL.FEEDFWD/BL1_Att/INPUT.Y,'%','FL1PPL Transmission rate'
690 FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/CURRENT_INPUT_JITTER.RD,'fs','FL1PPL Sync. Jitter'
691 FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/LOCK_STATUS.VALUE.RD,'au','FL1PPL Sync. Status'
692
693 \\
694
695 \\
696
697 {{expand title="Parameters used until 2021"}}
698 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}}
699
700 //always saved (PBD)//
701 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
702 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
703 desc: attenuation of the PPLaser (rotation of a waveplate)
704 units : 0 no transmission , 1: full transmission
705
706 \\
707
708 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}
709 //always saved (PBD)//
710 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
711 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
712 desc: delay of the Pump probe laser - measured by the read back position of the motor. only read out every secound ... better use the encoder
713 units : ps ( pos delay means IR comes later)
714
715 \\
716
717 {{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}
718 //always saved (PBD)//
719 DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}
720 DAQ channel: {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0:ENC.DELAY{{/code}}
721 subsystem: {{code language="none"}}DELLINE.ENC{{/code}} desc : delay of the Pump probe laser - measured by an encoder. The position is read out with 10Hz train synchronized and should be used to determine the actual laser delay (the motor position is only read out about every second
722 units : ps ( pos delay means IR comes later)
723
724 \\
725
726 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}
727 //always saved (PBD)//
728 DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
729 DAQ channel: {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
730 desc: rms jitter of the GECCO (% class="twikiNewLink" %)TiSa(%%) Oscillator units: fs
731
732 \\
733
734 {{code language="none"}}/FL1/Experiment/Pump probe laser/streak camera delay time{{/code}}
735 //always saved (PBD)//
736 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
737 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
738 desc: delay time between the optical laser and the FEL units: ps
739 {{/expand}}
740
741 \\
742
743 [[Contents>>doc:||anchor="Contents"]]
744
745 \\
746
747 ==== User Data (FLASH1) ====
748
749 The data saved specifically for detectors at an experiment will show up in /Experiment/ there is a large number of options for cameras or monitoring of slow properties (motor positions etc) for user experiments. For details please ask your local contact.
750
751 NOTE: If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with the DOOCS names
752
753 The most common and permanently installed device used by experiment are our ADCs:
754
755 ===== GHz ADCs =====
756
757 ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FLASHUSER.Data Acquisition and controls.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**
758 //saved on DEMAND in the user DAQ//
759 \\The HDF5 names for the ADC traces are depending on the beamline :
760 \\PG Beamline:
761 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH00/TD{{/code}}
762 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH01/TD{{/code}}
763 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH02/TD{{/code}}
764 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH03/TD{{/code}}
765
766 BL Beamlines:
767 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH00/TD{{/code}}
768 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH01/TD{{/code}}
769 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH02/TD{{/code}}
770 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH03/TD{{/code}}
771 \\{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH00/TD{{/code}}
772 {{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH01/TD{{/code}}
773 \\{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH02/TD{{/code}}
774 {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}
775
776 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
777 here the {{code language="none"}}CH00.TD{{/code}} is the full ADC trace as it is sampled ( typically several 100.000 samples per pulse train) while the {{code language="none"}}CH00.DAQ.TD{{/code}} trace only has the number of samples which are sent to the DAQ OR if //grouping// is activated the {{code language="none"}}CH00.DAQ.TD{{/code}} contains only the grouped spectra. To read the ADC trace with an online analysis program the {{code language="none"}}CH00.DAQ.TD{{/code}} is used preferably.
778 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
779
780 In addition there are also additional parameters saved like:
781
782 * {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.
783 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
784 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
785
786 ===== MHz ADCs =====
787
788 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
789 {{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}
790 DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD
791 DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02
792
793 In addition there are also additional parameters saved like:
794
795 * {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.
796 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
797
798 [[Contents>>doc:||anchor="Contents"]]
799
800 \\
801
802 \\
803
804 \\
805
806 === FLASH2 ===
807
808 There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
809
810 ==== Beamline info (FLASH2) ====
811
812 {{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
813 (% style="color: rgb(0,0,0);" %)//always saved (PBD2)// (%%)
814 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
815 (% style="color: rgb(0,0,0);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
816 (% style="color: rgb(0,0,0);" %)desc: set pressure in the gas attenuator (%%)
817 (% style="color: rgb(0,0,0);" %)units: mbar(%%)
818 \\
819
820 {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
821 //always saved (PBD2)//
822 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
823 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
824 desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
825 units: none
826
827
828 {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
829 //always saved (PBD2)//
830 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
831 DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
832 desc: Position of the BL filter wheel 1 - to correlate with the filter material please look **[[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**
833 units: degree
834 \\
835
836 /FL2/Beamlines/Filter wheel/position wheel 2
837 always saved (PBD2)
838 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
839 DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
840 desc: Position of the BL filter wheel 2 - to correlate with the filter material please look [[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
841 units: degree
842
843 \\
844
845 NOTE: Aperture positions in the beamline as well as the positions of the beam steering mirrors are also saved. for more Info contact your local contact
846
847 [[Contents>>doc:||anchor="Contents"]]
848
849 \\
850
851 \\
852
853 ==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
854
855 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
856 //always saved (PBD2)//
857 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
858 DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
859 desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
860 units : microJ
861
862 \\
863
864 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
865 //always saved (PBD2)//
866 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
867 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
868 desc : Energy per pulse measured in the Tunnel  (in front of the gas attenuator and the apertures in the Hall) In addition measurement errors and beam position are included for EACH pulse in the pulse train  !! (see below)
869 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
870
871 {{info title="GMD pulse resolved data structure"}}
872 For every pulse in the pulse train the information is saved:
873
874
875 1. **Intensity per pulse** (a.u. (more or less µJ ))
876 1. Intensity per pulse (auxillary GMD) - not used
877 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
878 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
879 1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color: rgb(0,0,0);" %)This parameter gives an indication of the error of the measurement of the pulse energy. This takes signal to noise,  detector resolution, uncertainties in crossection etc into account. (it is NOT the measurement of the statistical fluctuation of the SASE pulses)(%%))
880 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
881 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
882 1. Combined warning and error flags
883
884 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
885 file
886
887
888 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
889
890 \\
891 {{/info}}
892
893 \\
894
895 All values for the GMD are also available for the** HALL GMD **which is located in the experimental hall down stream the gas attenuator. If the attenuator is on the ratio between Hall and Tunnel signal shows the attenuation. **BUT NOTE** that the filter unit and the Aperture 4 are downstream the GMD. So if filters and aperture are used this influence is NOT measured by the GMD hall !
896
897 \\
898
899 Besides  pulse energy the GMD also provides information about the beam position
900
901 \\
902
903 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
904 //always saved (PBD2)//
905 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
906 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
907 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
908 units : mm
909
910 \\
911
912 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
913 //always saved (PBD2)//
914 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
915 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
916 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
917 units : mm
918
919 \\
920
921 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
922 always saved (PBD2)
923 DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
924 DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
925 desc: Besides the well calibrated averaged beam position information there is also the option to measure the beam position on a single bunch level. HOWEVER this methide needs a perfectly adjusted signal level (talk to your local contact !!) and also then the signal to noise is rather small and one needs some averaging ... BUT with this option one can determine if there was a spatial slope on a burst (say forst bunches were lower than the last ones or so ...)
926 units : mm   
927
928 (x=horizontal, y = vertial)
929
930 again the same parameter set is available for the **HALL GMD**
931
932 \\
933
934 \\
935
936 ==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====
937
938 for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**
939
940 (The OPIS hall is not installed yet ...)
941
942 \\
943
944 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
945 // saved opon request (PBD2)//
946 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
947 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
948 desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
949 units : eV
950
951 \\
952
953 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
954 // saved opon request (PBD2)//
955 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
956 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
957 desc : mean wavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
958 units : nm
959
960 \\
961
962 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/number of analyzed bunch        (in older version this can be found in OPIS tunnel/Expert stuff/General operation parameters/){{/code}}
963 // saved opon request (PBD2)//
964 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
965 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
966 desc : The bunch number of the bunch used for the wavelength calculation
967 units :
968
969 \\
970
971 If Opis is running typically on the the averaged data is saved. For several experiments it may make sense to save the information for each single bunch. This is up to now done by saving the complete ADC trace of the TOF setup. This is a huge amount of data and needs processing. This has to be performed after the beamtime in close contact to [[Markus Braune>>mailto:markus.braune@desy.de||shape="rect"]] ( responsible for [[OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]])
972
973 \\
974
975 In case OPIS was not operating there is still information about the **set wavelength** for the undulators (see below) which may differ by up to 5 % from the actual wavelength due to different settings in the FEL ...
976
977 \\
978
979 \\
980
981 ==== Electron Beam properties (FLASH2) ====
982
983 ===== bunch charge =====
984
985 {{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
986 //always saved (PBD2)//
987 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
988 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
989 desc: electron bunch charge FLASH2 (average value for each bunchtrain).
990 units: nC
991
992 \\
993
994 ===== electron bunch energy =====
995
996 {{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}}
997 //always saved (PBD2)//
998 DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}}
999 DAQ channel: (% style="color: rgb(94,108,132);" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%)
1000 desc: electron bunch energy measured behind the undulator. Data is saved with 10 Hz - BUT (for computation reasons) only the energy of the FIRST bunch is recorded. The data is also available for (% style="color: rgb(94,108,132);" %)extraction and septum  in the beginning of FLASH2
1001
1002 (% style="letter-spacing: 0.0px;" %)units: (% class="twikiNewLink" %)MeV
1003
1004 \\
1005
1006 (% style="color: rgb(94,108,132);font-weight: 600;letter-spacing: 0.0px;" %)
1007 undulator settings
1008
1009 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
1010 //always saved (PBD2)//
1011 DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
1012 DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
1013 desc: Set value for the anticipated wavelength . This parameter is used to set the undulator gap. It may however deviate from the actual wavelength by several % ...
1014 units: nm
1015
1016 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
1017 //always saved (PBD2)//
1018 DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
1019 DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
1020 desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
1021 units: mm
1022
1023 The gap values are saved for all 12 undulators (Nr 3 to 14). Undulator 14 is the one closest to the experimental hall.
1024
1025 =====
1026 arrival time (BAM) =====
1027
1028 {{info title="BAM information: updates 2022"}}
1029 * see: [[Info collection about the BAMs and how to use the BAM data>>url:https://confluence.desy.de/display/FLASHUSER/Info+collection+for+the+BAM||shape="rect"]]
1030 * The data format of the BAM has been completely altered in the 2022 shutdown
1031 * before 2022 BAMs were always saving the arrival time information for each 1µs bucked regardless if there were electrons in the accelerator or not. I addition the arrival times for  FL1 and FL2 were saved in the same parameter ...
1032 * THIS is now different. There are new parameters saving only the arrival times for pulses that go to FL1 and to FL2 (in detail: first time slot of the accelerator and second)
1033 * There has been also a renaming  (and relocation) of the BAMs.
1034 ** acc:  4DBC3 → FL0.DBC2
1035 ** FL1: 1SFELC →  FL1.SFELC
1036 ** FL2: 8FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
1037 * for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
1038 * [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FLASHUSER.Additional helpful things.FLASH beamlines and instruments references.WebHome]]
1039 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
1040 {{/info}}
1041
1042 \\
1043
1044 {{expand title="Discontinued BAM format (used until end 2021)"}}
1045 (% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
1046
1047 {{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}
1048 //always saved (PBD2)//
1049 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}
1050 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/8FL2XTDS.LOW_CHARGE_ARRIVAL_TIME{{/code}}
1051 desc: Electron bunch arrival time measured with the BAM after the FLASH2 undulator (pulse resolved data)
1052 units: ps (bigger numbers indicate later arrivaltime of the electrons)
1053
1054 **FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
1055 //always saved (PBD2)//
1056 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
1057 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
1058 desc: Electron bunch arrival time measured with the BAM  in the accelerator  (pulse resolved data)
1059 units: ps (bigger numbers indicate later arrivaltime of the electrons)
1060
1061 \\
1062
1063 {{info title="BAM hints"}}
1064 * The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).
1065 * The BAM 8FL2XTDS measures only for FLASH2 BUT has the same data structure as the other BAMS ... thus there are also (random) values in in the  FLASH1 time slot 
1066 ** Structure: The first values are for FLASH1 bunches. After a gap of about 70 micros ( 70 colums)  with  as entry for the switching between FLASH 1 and 2 the values for the electrons used in FLASH2 start.  The start time of FLASH2 is also recorded in the DAQ. FLASH1 start time is for historic reasons 700. thus if e.g. the start time of FLASH2 ( property name see below) is 1200 it means that FLASH starts at column 500 (1200-700) ... .In case of doubt ask your local contact
1067 * [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments >>doc:FLASHUSER.Additional helpful things.FLASH beamlines and instruments references.WebHome]]
1068 * [[LINK to detailed infos from MSK (may only work inside DESY network~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:http://www.desy.de/~~mbock/pages/BAM_daq_channel_descriptions.html||shape="rect"]]
1069 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
1070 {{/info}}
1071 {{/expand}}
1072
1073 \\
1074
1075 ====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======
1076
1077 (% style="color: rgb(255,102,0);" %)**DBC2**/electron bunch arrival time  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}
1078
1079 {{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.DBC2.ARRIVAL_TIME.ABSOLUTE.SA2.COMP/dGroup/{{/code}}
1080
1081 //always saved (PBD)//
1082 **FL0.DBC2**
1083 (% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA2.COMP
1084 {{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA2.COMPDAQ {{/code}}(% style="letter-spacing: 0.0px;" %)desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). The property contains only the arrival time of the bunches sent to FL2 (e.g. if there are 30 bunches in FL2 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not0). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
1085 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1086
1087 \\
1088
1089 (% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}
1090
1091 {{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.DBC2.ARRIVAL_TIME.ABSOLUTE.SA2/dGroup/{{/code}}
1092 //always saved (PBD)//
1093 {{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE{{/code}}
1094 (% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel: {{/code}}(%%)
1095 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 2 in the second part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
1096 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1097
1098 \\
1099
1100 (% style="color: rgb(255,102,0);" %)DBC2/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
1101 //always saved (PBD)//
1102 (% style="color: rgb(0,0,0);" %)E.bamError{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM{{/code}}(%%)
1103 (% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR{{code language="none"}}DAQ channel: {{/code}}(%%)
1104 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1105
1106 \\
1107
1108 (% style="color: rgb(255,102,0);" %)DBC2/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
1109 //always saved (PBD)//
1110 (% style="color: rgb(0,0,0);" %)E..bamStatus.//2//{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM{{/code}}(%%)
1111 (% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.2{{code language="none"}}DAQ channel{{/code}}(%%)
1112 desc: status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
1113
1114 \\
1115
1116 ====== **BAM FL2.SEED5**{{code language="none"}}{{/code}} ======
1117
1118 /FL2/Electron Diagnostic/BAM/**SEED5**(% style="color: rgb(255,102,0);" %)/electron bunch arrival time  (HDF5 name not yet implemented - see zraw)
1119
1120 (% style="color: rgb(0,0,0);" %){{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.SEED5.ARRIVAL_TIME.ABSOLUTE.SA2.COMP/dGroup/{{/code}}
1121
1122 //always saved (PBD)//
1123 (% style="color: rgb(23,43,77);" %)**FL2.SEED5**(%%)
1124 (% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
1125 {{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ {{/code}}(%%)desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.. The property contains only the arrival time of the bunches sent to FL2 (e.g. if there are 30 bunches in FL2 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
1126 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1127
1128 \\
1129
1130 \\
1131
1132 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}
1133
1134 (% style="color: rgb(0,0,0);" %){{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.SEED5.ARRIVAL_TIME.ABSOLUTE.SA2/dGroup/{{/code}}(%%)
1135 //always saved (PBD)//
1136 (% style="color: rgb(23,43,77);" %)**FL2.SEED5**{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE{{/code}}(%%)
1137 **~ **(% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel:{{/code}}(%%)
1138 desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020. Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 2 in the second part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
1139 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1140
1141 \\
1142
1143 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
1144 //always saved (PBD)//
1145 (% style="color: rgb(23,43,77);" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)E.bamError{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIM{{/code}}(%%)
1146 (% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.BAMERROR{{code language="none"}}DAQ channel{{/code}}(%%)
1147 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1148
1149 \\
1150
1151 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
1152 //always saved (PBD)//
1153 (% style="color: rgb(23,43,77);" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)E.bamStatus.//2//{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIM{{/code}}(%%)
1154 (% style="color: rgb(0,0,0);" %)el: FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.BAMSTATUS.2{{code language="none"}}DAQ chann{{/code}}(%%)
1155 desc: status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
1156
1157 \\
1158
1159 [[Contents>>doc:||anchor="Contents"]]
1160
1161 \\
1162
1163 ==== Timing information, rep rate etc.  (FLASH2) ====
1164
1165 ===== start time of FLASH2 =====
1166
1167 {{code language="none"}}/FL2/Timing/start time flash2{{/code}}
1168 //always saved (PBD2)//
1169 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1170 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1171 desc: The max 600 µs acceleration time of FLASH is devided between FLASH1 and FLASH2. This 600 µs window starts with FLASH1 (up to now)  at a time"label" of 700 µs (for historic reasons). Thus the first bunch of FLASH 1 comes at "700" and the last possibel bunch comes at 1300 (700+600). After FLASH1 train is over ther is a about 70µs switching time with no bunches. Then comes the first FLASH2 bunch.  Thus if e.g. the start time of FLASH2 is 1200 it means that FLASH2 starts at column 500 (1200-700)  in the HDF5 files. (However for yet unknown reasons this may change by 2-3 colums ...)
1172 units: µs
1173
1174 ===== bunch repetition rate =====
1175
1176 {{code language="none"}}/FL2/Timing/repetition rate{{/code}}
1177 //always saved (PBD2)//
1178 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1179 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1180 desc: repetition rate of the bunches / pulses within the burst (FLASH2)
1181 units: kHz
1182
1183 \\
1184
1185 ===== set number of pulses =====
1186
1187 (% style="color: rgb(255, 0, 0); color: rgb(255, 102, 0)" %)(HDF5 name not yet implemented - see zraw)(% style="color: rgb(255,0,0);" %){{code language="none"}}/FL2/Timing/set number of bunches {{/code}}(%%)
1188 //always saved (PBD2)//
1189 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.2 [4th number]{{/code}}
1190 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.2 [4th number]{{/code}}
1191 desc: Number of bunches set in the control (timing) system.  The property contains 4 numbers. the last one is the number of pulses (see also [[doc:FLASH.Timing properties]] (internal link)).  If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated and thus the actual number of pulses may be smaller than the set one 
1192 units:
1193
1194 ===== actual number of pulses =====
1195
1196 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
1197 //always saved (PBD2)//
1198 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1199 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1200 desc: Number of bunches measured BEHIND the undulator. If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated this is the actual number that created XUV radiation.The number is calculated by the DAQ middle layer server, (FLASH2)
1201 units:
1202 \\
1203
1204 ===== actual pulse pattern recorded after the undulator =====
1205
1206 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
1207 //always saved (PBD2)//
1208 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1209 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1210 desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
1211 units:
1212 \\
1213
1214 ===== Train ID =====
1215
1216 {{code language="none"}}/Timing/train ID{{/code}}
1217 //always saved (PBD2)//
1218 DOOCS prop : {{code language="none"}}none{{/code}}
1219 DAQ channel: {{code language="none"}}none{{/code}}
1220 desc: Each 10 Hz burst has its unique train ID. For the HDF5 dataset the ID is the same for all parameters with the same index (note camera images may be shifted by 1 ID - talk to the experts !)
1221 units:
1222 \\
1223
1224 ===== Train time =====
1225
1226 //always saved (PBD2)
1227 //{{code language="none"}}/Timing/train time{{/code}}
1228 desc:Local time as array of day, hour, minute, second, and centisecond. This dataset is meant for visualisation purposes only. For correlations use the train ID or the Unix time of the time stamp
1229 units: d h min s cs
1230 \\
1231
1232 {{code language="none"}}/Timing/time stamp{{/code}}
1233
1234 //always saved (PBD2)//
1235 desc: first column: Local time in unix time. To get day, hour, minute, second you can use unix: e.g. date ~-~-date='@1553617729' or matlab, python etc
1236 second column: microseconds
1237 third column: Train ID of FLASH
1238 \\
1239
1240 [[Contents>>doc:||anchor="Contents"]]
1241
1242 \\
1243
1244 ==== User Data (FLASH2) ====
1245
1246 The data saved specifically for detectors at an experiment will show up in /Experiment/ there is a large number of options for cameras or monitoring pslow properties (motor positons etc) for user experiments. For details please ask your local contact.
1247
1248 NOTE: If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with the DOOCS names
1249
1250 The most common and permanently installed device used by experiment are our ADCs:
1251
1252 ===== GHz ADCs =====
1253
1254 ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FLASHUSER.Data Acquisition and controls.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**
1255 //saved on DEMAND in the user DAQ//
1256 \\Up to now there are 4 channels available at FL24
1257 \\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}
1258 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}
1259 \\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH02/TD{{/code}}{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH03/TD{{/code}}
1260
1261 \\
1262
1263 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
1264 here the {{code language="none"}}CH00.TD{{/code}} is the full ADC trace as it is sampled ( typically several 100.000 samples per pulse train) while the {{code language="none"}}CH00.DAQ.TD{{/code}} trace only has the number of samples which are sent to the DAQ OR if //grouping// is activated the {{code language="none"}}CH00.DAQ.TD{{/code}} conatins only the grouped spectra. To read the ADC trace with an online analysis program the {{code language="none"}}CH00.DAQ.TD{{/code}} is used preferablly.
1265 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}
1266
1267 In addition there are also additional parameters saved like:
1268
1269 * {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.
1270 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1271 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
1272 * {{code language="none"}}/CH0-CH3/offset{{/code}}: To use the full dynamic range of the ADC one can shift the base line . This offset is saved here.
1273
1274 ===== MHz ADCs =====
1275
1276 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
1277 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}
1278 DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD
1279 DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02
1280
1281 In addition there are also additional parameters saved like:
1282
1283 * {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.
1284 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1285
1286 [[Contents>>doc:||anchor="Contents"]]
1287
1288 \\
1289
1290 \\
1291
1292 ==== Pump Probe Laser (FLASH2) ====
1293
1294 There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.
1295
1296 \\
1297
1298 **User delay**
1299
1300 Delay (set value):
1301
1302 {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR{{/code}}
1303
1304 Delay (encoder readback):
1305
1306 {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD{{/code}}
1307
1308 OXC. jitter:
1309
1310 {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD{{/code}}
1311
1312 \\
1313
1314 **Pulse resolved energy:**
1315
1316 OPCPA output (photodiode signal raw ADC trace 16000 samples):
1317
1318 {{code language="none"}}/zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH23.TD/dGroup{{/code}}
1319
1320 (% style="letter-spacing: 0.0px;" %)Upper breadboard Photodiode (THG) burst (photodiode signal raw ADC trace 16000 samples)::
1321
1322 {{code language="none"}}/zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH26.TD/dGroup{{/code}}
1323
1324 Upper breadboard Photodiode (THG) energy (analyzed signal. integration over pulses in the ADC trace. contains for each laser pulse the pulse energy in a.u.)
1325
1326 {{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/FL24_userPD/dGroup{{/code}}
1327
1328 \\
1329
1330 **LAM (Laser Arrivaltime Monitor)  pulse resolved data:**
1331
1332 Signal of Photodiode1  - for experts only... (analyzed signal. integration over pulses in the ADC trace. )
1333
1334 {{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/LAM.PD1/dGroup{{/code}}
1335
1336 Signal of Photodiode2  - for experts only...  (analyzed signal. integration over pulses in the ADC trace.)
1337
1338 {{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/LAM.PD2/dGroup{{/code}}
1339
1340 "Actual" LAM Signal - to be calibrated ......  (analyzed signal. integration over pulses in the ADC trace.)
1341
1342 {{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/LAM.PDBAL/dGroup{{/code}}
1343
1344 \\
1345
1346 **Attenuator angle:**
1347
1348 {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1349
1350 **Polarization control:**
1351
1352 {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS{{/code}}
1353
1354 **SysDC delay error:**
1355
1356 {{code language="none"}}FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26{{/code}}
1357
1358 \\
1359
1360 **Timing error: (these two need to be observed and both=0 means no error)**
1361
1362 {{code language="none"}}FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm{{/code}}
1363
1364 {{code language="none"}}FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN{{/code}}
1365
1366 **Laser error status:**
1367
1368 \\
1369
1370 **Virtual camera X and Y history, beam size: (use slow data)**
1371
1372 {{code language="none"}}FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.X{{/code}}
1373
1374 {{code language="none"}}FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.Y{{/code}}
1375
1376 {{code language="none"}}FLASH.LASER/MOD24.CAM/UV.14.VF/ROI_SPECTRUM.X.SIG{{/code}}
1377
1378 \\
1379
1380 {{expand title="Parameters used until 2021"}}
1381
1382 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}//always saved (PBD2)//
1383 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1384 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1385 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1386 units : deg.
1387
1388 \\
1389
1390
1391 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}//always saved (PBD2)//
1392 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1393 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1394 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1395 units : deg.
1396
1397 \\
1398
1399 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}
1400 //always saved (PBD2)//
1401 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1402 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1403 desc: delay of the Pump probe laser - measured by the read back position of the motor. There is also the set value available ( upto now these values are only updating every 1-2 seconds. There is no fast encoder property as on FLASH1 available)
1404 units : ps )
1405
1406 \\
1407
1408 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}
1409 //always saved (PBD)//
1410 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1411 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1412 desc: rms jitter of the fs-Oscillator
1413 units: fs
1414 {{/expand}}
1415
1416 [[Contents>>doc:||anchor="Contents"]]
1417
1418 \\
1419
1420 === "/uncategorized/" ===
1421
1422 If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with their DOOCS names
1423
1424 \\
1425
1426 === HDF5 structure revisions ===
1427
1428 Starting with Beamblock 4, August 2018, the hierarchy of the HDF group names have been adapted to reflect the new situation at FLASH. FLASH2 is operating for users quite some time now. Therefore, both accelerators appear equally in their respective HDF groups, namely "/FL1" and "/FL2". The root group of proper, by run organised HDF files have an attribute called "version". This version attribute has changed from "0.2.x" to "0.3.x". The changes in detail:
1429
1430 \\
1431
1432 * All FLASH1 related HDF groups moved to group "/FL1", i.e. a new prefix "/FL1" is added to their HDF path.
1433 * The ambigious term "pulse" has been replaced by "train" to refer to "pulse train". Most notably, the dataset "/Timing/pulse ID" has changed to "/Timing/train ID".
1434 * A number of inconsistent names have been streamlined. The relevant changes are listed in the following table.
1435
1436 \\
1437
1438 (% class="wrapped" %)
1439 |=(((
1440 earlier HDF path (vers. 0.2)
1441 )))|=(((
1442 is now (vers. 0.3)
1443 )))
1444 |(((
1445 /Photon Diagnostic/GMD/Beam position/position BDA x
1446 )))|(((
1447 /FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal
1448 )))
1449 |(((
1450 /Photon Diagnostic/GMD/Beam position/position BDA y
1451 )))|(((
1452 /FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical
1453 )))
1454 |(((
1455 /Photon Diagnostic/GMD/Beam position/position tunnel x
1456 )))|(((
1457 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal
1458 )))
1459 |(((
1460 /Photon Diagnostic/GMD/Beam position/position tunnel y
1461 )))|(((
1462 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical
1463 )))
1464 |(((
1465 /Experiment/Pump probe laser/BPM/position x
1466 )))|(((
1467 /FL1/Experiment/Pump probe laser/BPM/position horizontal
1468 )))
1469 |(((
1470 /Experiment/Pump probe laser/BPM/position y
1471 )))|(((
1472 /FL1/Experiment/Pump probe laser/BPM/position vertical
1473 )))
1474 |(((
1475 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall horizontal
1476 )))|(((
1477 /FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal
1478 )))
1479 |(((
1480 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall vertical
1481 )))|(((
1482 /FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical
1483 )))
1484 |(((
1485 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel horizontal
1486 )))|(((
1487 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal
1488 )))
1489 |(((
1490 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel vertical
1491 )))|(((
1492 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical
1493 )))
1494 |(((
1495 /FL2/Photon Diagnostic/GMD/Average energy/hall
1496 )))|(((
1497 /FL2/Photon Diagnostic/GMD/Average energy/energy hall
1498 )))
1499 |(((
1500 /FL2/Photon Diagnostic/GMD/Average energy/hall (raw)
1501 )))|(((
1502 /FL2/Photon Diagnostic/GMD/Average energy/energy hall (raw)
1503 )))
1504 |(((
1505 /FL2/Photon Diagnostic/GMD/Average energy/tunnel
1506 )))|(((
1507 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel
1508 )))
1509 |(((
1510 /FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)
1511 )))|(((
1512 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel (raw)
1513 )))
1514 |(((
1515 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall x
1516 )))|(((
1517 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal
1518 )))
1519 |(((
1520 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall y
1521 )))|(((
1522 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical
1523 )))
1524 |(((
1525 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel x
1526 )))|(((
1527 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal
1528 )))
1529 |(((
1530 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel y
1531 )))|(((
1532 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical
1533 )))
1534
1535 \\
1536
1537 [[Contents>>doc:||anchor="Contents"]]
1538
1539 \\
1540 {{/layout-cell}}
1541 {{/layout-section}}
1542 {{/layout}}