Wiki source code of The FLASH HDF5 structure

Version 65.1 by sndueste on 2022/11/07 14:35
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** (different e.g. 1 Hz):
83
84 ( every 10th train ID is listed in the HDF group "index")
85
86 \\
87
88 [[image:attach:image2020-11-16_15-31-45.png||height="250"]]
89 {{/layout-cell}}
90
91 {{layout-cell}}
92 * (((
93 //zraw// group contains the **original DAQ (DOOCS) names**
94 )))
95
96 of the properties saved in the DESY internal raw format. (For experts)
97
98 \\
99
100 [[image:attach:image2020-11-16_16-26-3.png||height="400"]]
101 {{/layout-cell}}
102 {{/layout-section}}
103
104 {{layout-section ac:type="single"}}
105 {{layout-cell}}
106 {{info}}
107 === Reference implementation (Python) ===
108
109 (imperative)  (% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]
110
111 (% class="Object" %)(object oriented) [[https:~~/~~/gitlab.desy.de/christopher.passow/fdh-builder>>url:https://gitlab.desy.de/christopher.passow/fdh-builder.git||shape="rect"]]
112 {{/info}}
113 {{/layout-cell}}
114 {{/layout-section}}
115
116 {{layout-section ac:type="single"}}
117 {{layout-cell}}
118
119
120 == Complete list of recordable parameters ==
121
122 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"]].
123 \\
124
125 == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
126
127 {{id name="DOOCSparameters"/}}
128
129 Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0.
130
131 \\
132
133 === FLASH1 ===
134
135 ==== Beamline info (FLASH1) ====
136
137 {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}
138 //always saved (PBD)//
139 DOOCS prop : {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
140 DAQ channel: {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
141 desc: set pressure in the gas attenuator
142 units: mbar
143 \\
144
145 {{code language="none"}}/FL1/Beamlines/BL/Fast shutter/open{{/code}}
146 //always saved (PBD)//
147 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER/CH00.TD{{/code}}
148 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER{{/code}}
149 desc: BL Beamline Fast shutter state
150 units: none
151 \\
152
153 {{code language="none"}}/FL1/Beamlines/PG/Fast shutter/open{{/code}}
154 //always saved (PBD)//
155 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER/CH00.TD{{/code}}
156 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER{{/code}}
157 desc: PG Beamline Fast shutter state
158 units: none
159 \\
160
161 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 1{{/code}}
162 //always saved (PBD)//
163 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
164 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
165 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]]
166 units: degree
167 \\
168
169 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 2{{/code}}
170 //always saved (PBD)//
171 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
172 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
173 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]]
174 units: degree
175 \\
176
177 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 1{{/code}}
178 //always saved (PBD)//
179 DOOCS prop : = TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS=
180 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}
181 desc: Position of the PG filter wheel 1
182 units: degree
183 \\
184
185 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 2{{/code}}
186 //always saved (PBD)//
187 DOOCS prop : {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
188 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
189 desc: Position of the PG filter wheel 2
190 units: degree
191 \\
192
193 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 3{{/code}}
194 //always saved (PBD)//
195 DOOCS prop : {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
196 DAQ channel: {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
197 desc: Position of the PG filter wheel 3
198 units: degree
199
200 \\
201
202
203 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
204
205 [[Contents>>doc:||anchor="Contents"]]
206
207 \\
208
209 ==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====
210
211 {{expand title="Discontinued GMD format (used until 2021)"}}
212 (% style="color: rgb(0,0,0);" %)**Discontinued GMD data recording / evaluation  (VME + PhotonFlux ML server)**
213
214 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
215 //always saved (PBD)//
216
217 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)
218 (% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)
219 desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator (ion current)
220 units : microJ
221
222 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
223 //always saved (PBD)//
224
225 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}
226 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}
227 desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL
228 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]]**
229
230 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel (raw){{/code}}
231 //always saved (PBD)//
232 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT14/VAL{{/code}}
233 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.FF{{/code}}
234 desc :Energy per pulse Tunnel (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
235 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]]**
236
237 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}
238 //always saved (PBD)//
239
240 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}
241 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}
242 desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)
243 units : microJ
244
245 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}
246 //always saved (PBD)//
247
248 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}
249 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}
250 desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL
251 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]]**
252
253 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA (raw){{/code}}
254 //always saved (PBD)//
255 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT15/VAL{{/code}}
256 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}
257 desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
258 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]]**
259 {{/expand}}
260
261 \\
262
263 (% style="letter-spacing: 0px; color: rgb(0, 0, 0)" %)**NEW (since 2021) GMD data recording / evaluation  (same format as FLASH2 and XFEL)**
264
265 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
266 //always saved (PBD)//
267 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
268 (% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
269
270 desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator
271 units : microJ
272
273 \\
274
275 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
276 //always saved (PBD)//
277
278 (% style="color: rgb(0,0,0);" %)DOOCS prop : 
279 {{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}}
280
281 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)
282 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]]**
283
284 {{info title="GMD pulse resolved data structure"}}
285 For every pulse in the pulse train the information is saved:
286
287
288 1. **Intensity per pulse** (a.u. (more or less µJ ))
289 1. Intensity per pulse (auxillary GMD) - not used
290 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
291 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
292 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)(%%))
293 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
294 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
295 1. Combined warning and error flags
296
297 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
298 file
299
300
301 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
302
303 \\
304 {{/info}}
305
306 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 !
307
308 \\
309
310 Besides  pulse energy the GMD also provides information about the beam position
311
312 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}
313 //always saved (PBD)//
314 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
315 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
316 desc :Beam position of the photon Beam determined by the GMD (BDA, x=horizontal)
317 units : mm
318
319 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical{{/code}}
320 //always saved (PBD)//
321 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
322 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
323 desc :Beam position of the photon Beam determined by the GMD (BDA, y=vertical)
324 units : mm
325
326 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal{{/code}}
327 //always saved (PBD)//
328 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
329 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
330 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, x=horizontal)
331 units : mm
332
333 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical{{/code}}
334 //always saved (PBD)//
335 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
336 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
337 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)
338 units : mm
339
340 \\
341
342 ==== Spectrometer (FLASH1) ====
343
344 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}
345 _always saved (when Spectrum is measured !!) (PBD) _
346 DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}
347 DAQ channel: {{code language="none"}}PBD.PHOTONWL.ML/WAVE_LENGTH{{/code}}
348 desc : XUV Spectrum measured with the "tunnel spectrometer"
349 units :
350
351 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength start value{{/code}}
352 _always saved (when Spectrum is measured !!) (PBD) _
353 DOOCS prop : {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
354 DAQ channel: {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
355 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
356 units : nm
357
358 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength increment{{/code}}
359 _always saved (when Spectrum is measured !!) (PBD) _
360 DOOCS prop : ==
361 DAQ channel: ==
362 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
363 units : nm
364
365 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy{{/code}}
366 //saved on DEMAND (PBD spectrometer stream)//
367 DOOCS prop : ==
368 DAQ channel: {{code language="none"}}PBD.PHOTONEN.ML/PHOTON_ENERGY{{/code}}
369 desc : XUV Spectrum in eV measured with the "PG2 spectrometer"
370 units :
371
372 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy start value{{/code}}
373 //saved on DEMAND (PBD spectrometer stream)//
374 DOOCS prop : ==
375 DAQ channel: ==
376 desc : start value (in eV) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
377 units : eV
378
379 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy increment{{/code}}
380 //saved on DEMAND (PBD spectrometer stream)//
381 DOOCS prop : ==
382 DAQ channel: ==
383 desc : increment value (in eV) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
384 units : eV
385
386 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength{{/code}}
387 //saved on DEMAND (PBD spectrometer stream)//
388 DOOCS prop : ==
389 DAQ channel: {{code language="none"}}PHOTONEN.ML/PHOTON_WAVE_LEN{{/code}}
390 desc : XUV Spectrum in nm measured with the "PG2 spectrometer"
391 units :
392
393 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength increment{{/code}}
394 //saved on DEMAND (PBD spectrometer stream)//
395 DOOCS prop : ==
396 DAQ channel: ==
397 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
398 units : nm
399
400 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength start value{{/code}}
401 //saved on DEMAND (PBD spectrometer stream)//
402 DOOCS prop : ==
403 DAQ channel: ==
404 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
405 units : nm
406
407 [[Contents>>doc:||anchor="Contents"]]
408
409 ==== Electron Beam properties (FLASH1) ====
410
411 ===== bunch charge =====
412
413 {{code language="none"}}/FL1/Electron Diagnostic/Bunch charge/after undulator{{/code}}
414 //always saved (PBD)//
415 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/CHARGE.FLASH1{{/code}}
416 DAQ channel: {{code language="none"}}FLASH.DIAG/TOROID/12EXP{{/code}}
417 desc: electron bunch charge (FLASH1)
418 units: nC
419
420 =====
421 arrival time (BAM) =====
422
423 {{info title="BAM information: updates 2022"}}
424 * 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"]]
425 * The data format of the BAM has been completely altered in the 2022 shutdown
426 * 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 ...
427 * 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)
428 * There has been also a renaming  (and relocation) of the BAMs.
429 ** acc:  4DBC3 → FL0.DBC2
430 ** FL1: 1SFELC →  FL1.SFELC
431 ** FL2: FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
432 * for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
433 * [[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]]
434 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
435 {{/info}}
436
437 \\
438
439 {{expand title="Discontinued BAM format (used until end 2021)"}}
440 (% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
441
442 {{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
443 //always saved (PBD)//
444 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
445 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
446 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).
447 units: ps (bigger numbers indicate later arrivaltime of the electrons)
448
449 \\
450
451 {{code language="none"}}/FL1/Electron Diagnostic/BAM/1SFELC/electron bunch arrival time (low charge){{/code}}
452 //always saved (PBD)//
453 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/1SFELC/LOW_CHARGE_ARRIVAL_TIME{{/code}}
454 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/1SFELC.LOW_CHARGE_ARRIVAL_TIME{{/code}}
455 desc: Electron bunch arrival time measured with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.
456 units: ps (bigger numbers indicate later arrival time of the electrons)
457 {{/expand}}
458
459 (% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
460 //always saved (PBD)//
461 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA1
462 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA1 (%%)
463 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2) - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).  The SA1 indicates the data is recorded for the first time slot at FLASh, typically used for FLASH1
464 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
465
466 \\
467
468 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
469 //always saved (PBD)//
470 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
471 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR(%%)
472 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
473
474 \\
475
476 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
477 //always saved (PBD)//
478 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
479 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS(%%)
480 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
481
482 \\
483
484 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/electron bunch arrival time{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
485 //always saved (PBD)//
486 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIME.absolute.SA1
487 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(255, 102, 0); color: rgb(23, 43, 77)" %)FL1.SFELC(% style="color: rgb(255,102,0);" %)/ARRIVAL_TIME.absolute.SA1 (%%)
488 desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.  The SA1 indicates the data is recorded for the first time slot at FLASh, typically used for FLASH1
489 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
490
491 \\
492
493 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
494 //always saved (PBD)//
495 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
496 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(255, 102, 0); color: rgb(23, 43, 77)" %)FL1.SFELC(% style="color: rgb(255,102,0);" %)/ARRIVAL_TIME.BAMERROR(%%)
497 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
498
499 \\
500
501 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
502 //always saved (PBD)//
503 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
504 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(255, 102, 0); color: rgb(23, 43, 77)" %)FL1.SFELC(% style="color: rgb(255,102,0);" %)/ARRIVAL_TIME.BAMSTATUS(%%)
505 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
506
507 \\
508
509 \\
510
511 ===== electron beam profile =====
512
513 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}
514 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
515 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/OUT.PROF.CCCED{{/code}}
516 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}
517 desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)
518 units: pixel
519 \\
520
521 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}
522 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
523 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/CALIB.CONST.T{{/code}}
524 DAQ channel: = PBD.BEAM.PROF.ML/CCT=
525 desc: TDS calibration constant for the x-axis of the profiles: fs per pixel
526 units: fs per pixel
527 \\
528
529 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}
530 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
531 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/SOWS.W.CCTED{{/code}}
532 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}
533 desc: rms pulse width of the measures TDS electron bunch profile
534 units: fs
535
536 ===== electron bunch energy =====
537
538 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
539 //always saved (PBD)//
540 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
541 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
542 desc: electron bunch energy (average over the bunch train)
543 units: (% class="twikiNewLink" %)MeV(%%)
544 \\
545
546 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
547 //always saved (PBD)//
548 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
549 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
550 desc: electron bunch energy bunch resolved
551 units: (% class="twikiNewLink" %)MeV
552
553 \\
554
555 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
556 //always saved (PBD)//
557 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
558 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
559 desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
560 units: nm
561 \\
562
563 [[Contents>>doc:||anchor="Contents"]]
564
565 \\
566
567 ==== Timing information, rep rate etc.  (FLASH1) ====
568
569 ===== bunch repetition rate =====
570
571 {{code language="none"}}/FL1/Timing/repetition rate{{/code}}
572 //always saved (PBD)//
573 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
574 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
575 desc: repetition rate of the bunches / pulses within the burst (FLASH1)
576 units: kHz
577 \\
578
579 ===== set number of pulses =====
580
581 {{code language="none"}}/FL1/Timing/set number of bunches{{/code}}
582 //always saved (PBD)//
583 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH1{{/code}}
584 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_NUM{{/code}}
585 desc: Number of pulses set at the gun (FLASH1)
586 units:
587
588 ===== actual number of pulses =====
589
590 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
591 //always saved (PBD)//
592 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/NUMBEROFBUNCHES.FLASH1{{/code}}
593 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
594 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)
595 units:
596 \\
597
598 ===== actual pulse pattern recorded after the undulator =====
599
600 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
601 //always saved (PBD)//
602 DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}
603 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
604 desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)
605 units:
606 \\
607
608 ===== Train ID =====
609
610 {{code language="none"}}/Timing/train ID{{/code}}
611 //always saved (PBD)//
612 DOOCS prop : {{code language="none"}}none{{/code}}
613 DAQ channel: {{code language="none"}}none{{/code}}
614 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 !)
615 units:
616 \\
617
618 ===== Train time =====
619
620 {{code language="none"}}/Timing/train time{{/code}}
621 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
622 units: d h min s cs
623 \\
624
625 {{code language="none"}}/Timing/time stamp{{/code}}
626 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
627 second column: microseconds
628 third column: Train ID of FLASH
629 \\
630
631 [[Contents>>doc:||anchor="Contents"]]
632
633 \\
634
635 ==== Pump Probe Laser (FLASH1) ====
636
637 **PIGLET (PG laser)**
638
639 **{{code language="none"}}/FL1/Experiment/Pump probe laser{{/code}}**
640
641 FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/DIAG1out/PULSEENERGY.MEAN 
642 FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/PG1_incoupl/PULSEENERGY.MEAN 
643 FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/PG2_incoupl/PULSEENERGY.MEAN 
644
645
646 FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.ENCODER_POSITION.RD 
647 FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.ENCODER_POSITION_RAW.RD 
648 FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.POSITION.RD
649
650 \\
651
652 {{expand title="Parameters used until 2021"}}
653 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}}
654
655 //always saved (PBD)//
656 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
657 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
658 desc: attenuation of the PPLaser (rotation of a waveplate)
659 units : 0 no transmission , 1: full transmission
660
661 \\
662
663 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}
664 //always saved (PBD)//
665 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
666 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
667 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
668 units : ps ( pos delay means IR comes later)
669
670 \\
671
672 {{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}
673 //always saved (PBD)//
674 DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}
675 DAQ channel: {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0:ENC.DELAY{{/code}}
676 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
677 units : ps ( pos delay means IR comes later)
678
679 \\
680
681 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}
682 //always saved (PBD)//
683 DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
684 DAQ channel: {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
685 desc: rms jitter of the GECCO (% class="twikiNewLink" %)TiSa(%%) Oscillator units: fs
686
687 \\
688
689 {{code language="none"}}/FL1/Experiment/Pump probe laser/streak camera delay time{{/code}}
690 //always saved (PBD)//
691 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
692 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
693 desc: delay time between the optical laser and the FEL units: ps
694 {{/expand}}
695
696 \\
697
698 \\
699
700 \\
701
702 [[Contents>>doc:||anchor="Contents"]]
703
704 \\
705
706 ==== User Data (FLASH1) ====
707
708 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.
709
710 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
711
712 The most common and permanently installed device used by experiment are our ADCs:
713
714 ===== GHz ADCs =====
715
716 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]]**
717 //saved on DEMAND in the user DAQ//
718 \\The HDF5 names for the ADC traces are depending on the beamline :
719 \\PG Beamline:
720 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH00/TD{{/code}}
721 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH01/TD{{/code}}
722 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH02/TD{{/code}}
723 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH03/TD{{/code}}
724
725 BL Beamlines:
726 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH00/TD{{/code}}
727 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH01/TD{{/code}}
728 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH02/TD{{/code}}
729 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH03/TD{{/code}}
730 \\{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH00/TD{{/code}}
731 {{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH01/TD{{/code}}
732 \\{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH02/TD{{/code}}
733 {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}
734
735 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
736 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.
737 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
738
739 In addition there are also additional parameters saved like:
740
741 * {{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.
742 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
743 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
744
745 ===== MHz ADCs =====
746
747 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
748 {{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}
749 DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD
750 DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02
751
752 In addition there are also additional parameters saved like:
753
754 * {{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.
755 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
756
757 [[Contents>>doc:||anchor="Contents"]]
758
759 \\
760
761 \\
762
763 \\
764
765 === FLASH2 ===
766
767 There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
768
769 ==== Beamline info (FLASH2) ====
770
771 {{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
772 (% style="color: rgb(0,0,0);" %)//always saved (PBD2)// (%%)
773 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
774 (% style="color: rgb(0,0,0);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
775 (% style="color: rgb(0,0,0);" %)desc: set pressure in the gas attenuator (%%)
776 (% style="color: rgb(0,0,0);" %)units: mbar(%%)
777 \\
778
779 {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
780 //always saved (PBD2)//
781 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
782 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
783 desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
784 units: none
785
786
787 {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
788 //always saved (PBD2)//
789 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
790 DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
791 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]]**
792 units: degree
793 \\
794
795 /FL2/Beamlines/Filter wheel/position wheel 2
796 always saved (PBD2)
797 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
798 DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
799 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]]
800 units: degree
801
802 \\
803
804 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
805
806 [[Contents>>doc:||anchor="Contents"]]
807
808 \\
809
810 \\
811
812 ==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
813
814 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
815 //always saved (PBD2)//
816 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
817 DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
818 desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
819 units : microJ
820
821 \\
822
823 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
824 //always saved (PBD2)//
825 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
826 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
827 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)
828 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]]**
829
830 {{info title="GMD pulse resolved data structure"}}
831 For every pulse in the pulse train the information is saved:
832
833
834 1. **Intensity per pulse** (a.u. (more or less µJ ))
835 1. Intensity per pulse (auxillary GMD) - not used
836 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
837 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
838 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)(%%))
839 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
840 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
841 1. Combined warning and error flags
842
843 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
844 file
845
846
847 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
848
849 \\
850 {{/info}}
851
852 \\
853
854 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 !
855
856 \\
857
858 Besides  pulse energy the GMD also provides information about the beam position
859
860 \\
861
862 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
863 //always saved (PBD2)//
864 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
865 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
866 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
867 units : mm
868
869 \\
870
871 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
872 //always saved (PBD2)//
873 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
874 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
875 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
876 units : mm
877
878 \\
879
880 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
881 always saved (PBD2)
882 DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
883 DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
884 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 ...)
885 units : mm   
886
887 (x=horizontal, y = vertial)
888
889 again the same parameter set is available for the **HALL GMD**
890
891 \\
892
893 \\
894
895 ==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====
896
897 for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**
898
899 (The OPIS hall is not installed yet ...)
900
901 \\
902
903 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
904 // saved opon request (PBD2)//
905 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
906 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
907 desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
908 units : eV
909
910 \\
911
912 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
913 // saved opon request (PBD2)//
914 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
915 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
916 desc : mean wavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
917 units : nm
918
919 \\
920
921 {{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}}
922 // saved opon request (PBD2)//
923 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
924 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
925 desc : The bunch number of the bunch used for the wavelength calculation
926 units :
927
928 \\
929
930 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"]])
931
932 \\
933
934 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 ...
935
936 \\
937
938 \\
939
940 ==== Electron Beam properties (FLASH2) ====
941
942 ===== bunch charge =====
943
944 {{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
945 //always saved (PBD2)//
946 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
947 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
948 desc: electron bunch charge FLASH2 (average value for each bunchtrain).
949 units: nC
950
951 \\
952
953 ===== electron bunch energy =====
954
955 {{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}}
956 //always saved (PBD2)//
957 DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}}
958 DAQ channel: (% style="color: rgb(94,108,132);" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%)
959 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
960
961 (% style="letter-spacing: 0.0px;" %)units: (% class="twikiNewLink" %)MeV
962
963 \\
964
965 (% style="color: rgb(94,108,132);font-weight: 600;letter-spacing: 0.0px;" %)
966 undulator settings
967
968 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
969 //always saved (PBD2)//
970 DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
971 DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
972 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 % ...
973 units: nm
974
975 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
976 //always saved (PBD2)//
977 DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
978 DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
979 desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
980 units: mm
981
982 The gap values are saved for all 12 undulators (Nr 3 to 14). Undulator 14 is the one closest to the experimental hall.
983
984 =====
985 arrival time (BAM) =====
986
987 {{info title="BAM information: updates 2022"}}
988 * 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"]]
989 * The data format of the BAM has been completely altered in the 2022 shutdown
990 * 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 ...
991 * 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)
992 * There has been also a renaming  (and relocation) of the BAMs.
993 ** acc:  4DBC3 → FL0.DBC2
994 ** FL1: 1SFELC →  FL1.SFELC
995 ** FL2: 8FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
996 * for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
997 * [[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]]
998 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
999 {{/info}}
1000
1001 \\
1002
1003 {{expand title="Discontinued BAM format (used until end 2021)"}}
1004 (% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
1005
1006 {{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}
1007 //always saved (PBD2)//
1008 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}
1009 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/8FL2XTDS.LOW_CHARGE_ARRIVAL_TIME{{/code}}
1010 desc: Electron bunch arrival time measured with the BAM after the FLASH2 undulator (pulse resolved data)
1011 units: ps (bigger numbers indicate later arrivaltime of the electrons)
1012
1013 **FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
1014 //always saved (PBD2)//
1015 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
1016 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
1017 desc: Electron bunch arrival time measured with the BAM  in the accelerator  (pulse resolved data)
1018 units: ps (bigger numbers indicate later arrivaltime of the electrons)
1019
1020 \\
1021
1022 {{info title="BAM hints"}}
1023 * The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).
1024 * 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 
1025 ** 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
1026 * [[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]]
1027 * [[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"]]
1028 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
1029 {{/info}}
1030 {{/expand}}
1031
1032 (% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1033 //always saved (PBD)//
1034 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA2
1035 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA2(%%)
1036 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2) - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).  The SA2 indicates the data is recorded for the second time slot at FLASH, typically used for FLASH2
1037 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1038
1039 \\
1040
1041 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1042 //always saved (PBD)//
1043 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
1044 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR(%%)
1045 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1046
1047 \\
1048
1049 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1050 //always saved (PBD)//
1051 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//2//(%%)
1052 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS(%%)
1053 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
1054
1055 \\
1056
1057 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/electron bunch arrival time{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1058 //always saved (PBD)//
1059 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL2.SEED5(%%)/ARRIVAL_TIME.absolute.SA2
1060 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(255, 102, 0); color: rgb(23, 43, 77)" %)FL2.SEED5(% style="color: rgb(255,102,0);" %)/ARRIVAL_TIME.absolute.SA2(%%)
1061 desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.  The SA2 indicates the data is recorded for the first time slot at FLASH, typically used for FLASH2
1062 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1063
1064 \\
1065
1066 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1067 //always saved (PBD)//
1068 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL2.SEED5(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
1069 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(255, 102, 0); color: rgb(23, 43, 77)" %)FL2.SEED5(% style="color: rgb(255,102,0);" %)/ARRIVAL_TIME.BAMERROR(%%)
1070 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1071
1072 \\
1073
1074 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1075 //always saved (PBD)//
1076 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL2.SEED5(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//2//(%%)
1077 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(255, 102, 0); color: rgb(23, 43, 77)" %)FL2.SEED5(% style="color: rgb(255,102,0);" %)/ARRIVAL_TIME.BAMSTATUS(%%)
1078 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
1079
1080 \\
1081
1082 \\
1083
1084 [[Contents>>doc:||anchor="Contents"]]
1085
1086 \\
1087
1088 ==== Timing information, rep rate etc.  (FLASH2) ====
1089
1090 ===== start time of FLASH2 =====
1091
1092 {{code language="none"}}/FL2/Timing/start time flash2{{/code}}
1093 //always saved (PBD2)//
1094 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1095 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1096 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 ...)
1097 units: µs
1098
1099 ===== bunch repetition rate =====
1100
1101 {{code language="none"}}/FL2/Timing/repetition rate{{/code}}
1102 //always saved (PBD2)//
1103 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1104 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1105 desc: repetition rate of the bunches / pulses within the burst (FLASH2)
1106 units: kHz
1107
1108 ===== actual number of pulses =====
1109
1110 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
1111 //always saved (PBD2)//
1112 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1113 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1114 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)
1115 units:
1116 \\
1117
1118 ===== actual pulse pattern recorded after the undulator =====
1119
1120 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
1121 //always saved (PBD2)//
1122 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1123 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1124 desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
1125 units:
1126 \\
1127
1128 ===== Train ID =====
1129
1130 {{code language="none"}}/Timing/train ID{{/code}}
1131 //always saved (PBD2)//
1132 DOOCS prop : {{code language="none"}}none{{/code}}
1133 DAQ channel: {{code language="none"}}none{{/code}}
1134 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 !)
1135 units:
1136 \\
1137
1138 ===== Train time =====
1139
1140 //always saved (PBD2)
1141 //{{code language="none"}}/Timing/train time{{/code}}
1142 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
1143 units: d h min s cs
1144 \\
1145
1146 {{code language="none"}}/Timing/time stamp{{/code}}
1147
1148 //always saved (PBD2)//
1149 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
1150 second column: microseconds
1151 third column: Train ID of FLASH
1152 \\
1153
1154 [[Contents>>doc:||anchor="Contents"]]
1155
1156 \\
1157
1158 ==== User Data (FLASH2) ====
1159
1160 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.
1161
1162 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
1163
1164 The most common and permanently installed device used by experiment are our ADCs:
1165
1166 ===== GHz ADCs =====
1167
1168 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]]**
1169 //saved on DEMAND in the user DAQ//
1170 \\Up to now there are 4 channels available at FL24
1171 \\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}
1172 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}
1173 \\{{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}}
1174
1175 \\
1176
1177 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
1178 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.
1179 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}
1180
1181 In addition there are also additional parameters saved like:
1182
1183 * {{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.
1184 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1185 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
1186 * {{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.
1187
1188 ===== MHz ADCs =====
1189
1190 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
1191 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}
1192 DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD
1193 DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02
1194
1195 In addition there are also additional parameters saved like:
1196
1197 * {{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.
1198 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1199
1200 [[Contents>>doc:||anchor="Contents"]]
1201
1202 \\
1203
1204 \\
1205
1206 ==== Pump Probe Laser (FLASH2) ====
1207
1208 There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.
1209
1210 \\
1211
1212 **User delay**
1213
1214 Delay (set value):
1215
1216 {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR{{/code}}
1217
1218 Delay (encoder readback):
1219
1220 {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD{{/code}}
1221
1222 OXC. jitter:
1223
1224 {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD{{/code}}
1225
1226 \\
1227
1228 **Pulse resolved energy:**
1229
1230 1a) OPCPA output:
1231
1232 {{code language="none"}}FLASH.LASER/TAMC532DMA/ULGAN1/CH23.TD{{/code}}
1233
1234 1b) OPCPA energy from PES (only fast channel):
1235
1236 FLASH.LASER/CPUULGAN1.PULSEENERGY/OPCPA_Output/DAQ_CHANNEL
1237
1238 2a) Upper breadboard Photodiode (THG) burst:
1239
1240 {{code language="none"}}FLASH.LASER/TAMC532DMA/ULGAN1/CH26.TD{{/code}}
1241
1242 2b) Upper breadboard Photodiode (THG) energy (in-coupling user photodiode, fast)
1243
1244 {{code language="none"}}FLASH.LASER/MOD24.PES/FL24_userPD/DAQ_CHANNEL{{/code}}
1245
1246 \\
1247
1248 **Attenuator angle:**
1249
1250 {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1251
1252 **Polarization control:**
1253
1254 {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS{{/code}}
1255
1256 **SysDC delay error:**
1257
1258 {{code language="none"}}FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26{{/code}}
1259
1260 \\
1261
1262 **Timing error: (these two need to be observed and both=0 means no error)**
1263
1264 {{code language="none"}}FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm{{/code}}
1265
1266 {{code language="none"}}FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN{{/code}}
1267
1268 **Laser error status:**
1269
1270 \\
1271
1272 **Virtual camera X and Y history, beam size: (use slow data)**
1273
1274 {{code language="none"}}FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.X{{/code}}
1275
1276 {{code language="none"}}FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.Y{{/code}}
1277
1278 {{code language="none"}}FLASH.LASER/MOD24.CAM/UV.14.VF/ROI_SPECTRUM.X.SIG{{/code}}
1279
1280 \\
1281
1282 {{expand title="Parameters used until 2021"}}
1283
1284 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}//always saved (PBD2)//
1285 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1286 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1287 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1288 units : deg.
1289
1290 \\
1291
1292
1293 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}//always saved (PBD2)//
1294 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1295 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1296 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1297 units : deg.
1298
1299 \\
1300
1301 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}
1302 //always saved (PBD2)//
1303 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1304 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1305 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)
1306 units : ps )
1307
1308 \\
1309
1310 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}
1311 //always saved (PBD)//
1312 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1313 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1314 desc: rms jitter of the fs-Oscillator
1315 units: fs
1316 {{/expand}}
1317
1318 [[Contents>>doc:||anchor="Contents"]]
1319
1320 \\
1321
1322 === "/uncategorized/" ===
1323
1324 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
1325
1326 \\
1327
1328 === HDF5 structure revisions ===
1329
1330 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:
1331
1332 \\
1333
1334 * All FLASH1 related HDF groups moved to group "/FL1", i.e. a new prefix "/FL1" is added to their HDF path.
1335 * 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".
1336 * A number of inconsistent names have been streamlined. The relevant changes are listed in the following table.
1337
1338 \\
1339
1340 (% class="wrapped" %)
1341 |=(((
1342 earlier HDF path (vers. 0.2)
1343 )))|=(((
1344 is now (vers. 0.3)
1345 )))
1346 |(((
1347 /Photon Diagnostic/GMD/Beam position/position BDA x
1348 )))|(((
1349 /FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal
1350 )))
1351 |(((
1352 /Photon Diagnostic/GMD/Beam position/position BDA y
1353 )))|(((
1354 /FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical
1355 )))
1356 |(((
1357 /Photon Diagnostic/GMD/Beam position/position tunnel x
1358 )))|(((
1359 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal
1360 )))
1361 |(((
1362 /Photon Diagnostic/GMD/Beam position/position tunnel y
1363 )))|(((
1364 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical
1365 )))
1366 |(((
1367 /Experiment/Pump probe laser/BPM/position x
1368 )))|(((
1369 /FL1/Experiment/Pump probe laser/BPM/position horizontal
1370 )))
1371 |(((
1372 /Experiment/Pump probe laser/BPM/position y
1373 )))|(((
1374 /FL1/Experiment/Pump probe laser/BPM/position vertical
1375 )))
1376 |(((
1377 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall horizontal
1378 )))|(((
1379 /FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal
1380 )))
1381 |(((
1382 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall vertical
1383 )))|(((
1384 /FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical
1385 )))
1386 |(((
1387 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel horizontal
1388 )))|(((
1389 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal
1390 )))
1391 |(((
1392 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel vertical
1393 )))|(((
1394 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical
1395 )))
1396 |(((
1397 /FL2/Photon Diagnostic/GMD/Average energy/hall
1398 )))|(((
1399 /FL2/Photon Diagnostic/GMD/Average energy/energy hall
1400 )))
1401 |(((
1402 /FL2/Photon Diagnostic/GMD/Average energy/hall (raw)
1403 )))|(((
1404 /FL2/Photon Diagnostic/GMD/Average energy/energy hall (raw)
1405 )))
1406 |(((
1407 /FL2/Photon Diagnostic/GMD/Average energy/tunnel
1408 )))|(((
1409 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel
1410 )))
1411 |(((
1412 /FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)
1413 )))|(((
1414 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel (raw)
1415 )))
1416 |(((
1417 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall x
1418 )))|(((
1419 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal
1420 )))
1421 |(((
1422 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall y
1423 )))|(((
1424 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical
1425 )))
1426 |(((
1427 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel x
1428 )))|(((
1429 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal
1430 )))
1431 |(((
1432 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel y
1433 )))|(((
1434 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical
1435 )))
1436
1437 \\
1438
1439 [[Contents>>doc:||anchor="Contents"]]
1440
1441 \\
1442 {{/layout-cell}}
1443 {{/layout-section}}
1444 {{/layout}}