Wiki source code of The FLASH HDF5 structure

Version 61.1 by sndueste on 2022/09/08 09:00
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 == 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 (% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
458 //always saved (PBD)//
459 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA1
460 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA1 (%%)
461 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
462 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
463
464 \\
465
466 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
467 //always saved (PBD)//
468 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
469 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR(%%)
470 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
471
472 \\
473
474 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
475 //always saved (PBD)//
476 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
477 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS(%%)
478 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
479
480 \\
481
482 (% 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}}(%%)
483 //always saved (PBD)//
484 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIME.absolute.SA1
485 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 (%%)
486 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
487 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
488
489 \\
490
491 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
492 //always saved (PBD)//
493 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
494 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(%%)
495 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
496
497 \\
498
499 (% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
500 //always saved (PBD)//
501 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
502 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(%%)
503 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
504
505 \\
506
507 \\
508
509 ===== electron beam profile =====
510
511 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}
512 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
513 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/OUT.PROF.CCCED{{/code}}
514 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}
515 desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)
516 units: pixel
517 \\
518
519 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}
520 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
521 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/CALIB.CONST.T{{/code}}
522 DAQ channel: = PBD.BEAM.PROF.ML/CCT=
523 desc: TDS calibration constant for the x-axis of the profiles: fs per pixel
524 units: fs per pixel
525 \\
526
527 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}
528 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
529 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/SOWS.W.CCTED{{/code}}
530 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}
531 desc: rms pulse width of the measures TDS electron bunch profile
532 units: fs
533
534 ===== electron bunch energy =====
535
536 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
537 //always saved (PBD)//
538 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
539 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
540 desc: electron bunch energy (average over the bunch train)
541 units: (% class="twikiNewLink" %)MeV(%%)
542 \\
543
544 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
545 //always saved (PBD)//
546 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
547 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
548 desc: electron bunch energy bunch resolved
549 units: (% class="twikiNewLink" %)MeV
550
551 \\
552
553 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
554 //always saved (PBD)//
555 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
556 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
557 desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
558 units: nm
559 \\
560
561 [[Contents>>doc:||anchor="Contents"]]
562
563 \\
564
565 ==== Timing information, rep rate etc.  (FLASH1) ====
566
567 ===== bunch repetition rate =====
568
569 {{code language="none"}}/FL1/Timing/repetition rate{{/code}}
570 //always saved (PBD)//
571 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
572 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
573 desc: repetition rate of the bunches / pulses within the burst (FLASH1)
574 units: kHz
575 \\
576
577 ===== set number of pulses =====
578
579 {{code language="none"}}/FL1/Timing/set number of bunches{{/code}}
580 //always saved (PBD)//
581 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH1{{/code}}
582 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_NUM{{/code}}
583 desc: Number of pulses set at the gun (FLASH1)
584 units:
585
586 ===== actual number of pulses =====
587
588 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
589 //always saved (PBD)//
590 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/NUMBEROFBUNCHES.FLASH1{{/code}}
591 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
592 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)
593 units:
594 \\
595
596 ===== actual pulse pattern recorded after the undulator =====
597
598 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
599 //always saved (PBD)//
600 DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}
601 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
602 desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)
603 units:
604 \\
605
606 ===== Train ID =====
607
608 {{code language="none"}}/Timing/train ID{{/code}}
609 //always saved (PBD)//
610 DOOCS prop : {{code language="none"}}none{{/code}}
611 DAQ channel: {{code language="none"}}none{{/code}}
612 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 !)
613 units:
614 \\
615
616 ===== Train time =====
617
618 {{code language="none"}}/Timing/train time{{/code}}
619 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
620 units: d h min s cs
621 \\
622
623 {{code language="none"}}/Timing/time stamp{{/code}}
624 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
625 second column: microseconds
626 third column: Train ID of FLASH
627 \\
628
629 [[Contents>>doc:||anchor="Contents"]]
630
631 \\
632
633 ==== Pump Probe Laser (FLASH1) ====
634
635 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}}
636
637 //always saved (PBD)//
638 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
639 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
640 desc: attenuation of the PPLaser (rotation of a waveplate)
641 units : 0 no transmission , 1: full transmission
642
643 \\
644
645 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}
646 //always saved (PBD)//
647 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
648 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
649 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
650 units : ps ( pos delay means IR comes later)
651
652 \\
653
654 {{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}
655 //always saved (PBD)//
656 DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}
657 DAQ channel: {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0:ENC.DELAY{{/code}}
658 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
659 units : ps ( pos delay means IR comes later)
660
661 \\
662
663 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}
664 //always saved (PBD)//
665 DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
666 DAQ channel: {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
667 desc: rms jitter of the GECCO (% class="twikiNewLink" %)TiSa(%%) Oscillator units: fs
668
669 \\
670
671 {{code language="none"}}/FL1/Experiment/Pump probe laser/streak camera delay time{{/code}}
672 //always saved (PBD)//
673 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
674 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
675 desc: delay time between the optical laser and the FEL units: ps
676
677 \\
678
679 [[Contents>>doc:||anchor="Contents"]]
680
681 \\
682
683 ==== User Data (FLASH1) ====
684
685 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.
686
687 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
688
689 The most common and permanently installed device used by experiment are our ADCs:
690
691 ===== GHz ADCs =====
692
693 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]]**
694 //saved on DEMAND in the user DAQ//
695 \\The HDF5 names for the ADC traces are depending on the beamline :
696 \\PG Beamline:
697 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH00/TD{{/code}}
698 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH01/TD{{/code}}
699 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH02/TD{{/code}}
700 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH03/TD{{/code}}
701
702 BL Beamlines:
703 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH00/TD{{/code}}
704 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH01/TD{{/code}}
705 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH02/TD{{/code}}
706 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH03/TD{{/code}}
707 \\{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH00/TD{{/code}}
708 {{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH01/TD{{/code}}
709 \\{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH02/TD{{/code}}
710 {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}
711
712 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
713 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.
714 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
715
716 In addition there are also additional parameters saved like:
717
718 * {{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.
719 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
720 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
721
722 ===== MHz ADCs =====
723
724 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
725 {{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}
726 DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD
727 DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02
728
729 In addition there are also additional parameters saved like:
730
731 * {{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.
732 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
733
734 [[Contents>>doc:||anchor="Contents"]]
735
736 \\
737
738 \\
739
740 \\
741
742 === FLASH2 ===
743
744 There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
745
746 ==== Beamline info (FLASH2) ====
747
748 {{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
749 (% style="color: rgb(0,0,0);" %)//always saved (PBD2)// (%%)
750 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
751 (% style="color: rgb(0,0,0);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
752 (% style="color: rgb(0,0,0);" %)desc: set pressure in the gas attenuator (%%)
753 (% style="color: rgb(0,0,0);" %)units: mbar(%%)
754 \\
755
756 {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
757 //always saved (PBD2)//
758 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
759 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
760 desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
761 units: none
762
763
764 {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
765 //always saved (PBD2)//
766 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
767 DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
768 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]]**
769 units: degree
770 \\
771
772 /FL2/Beamlines/Filter wheel/position wheel 2
773 always saved (PBD2)
774 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
775 DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
776 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]]
777 units: degree
778
779 \\
780
781 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
782
783 [[Contents>>doc:||anchor="Contents"]]
784
785 \\
786
787 \\
788
789 ==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
790
791 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
792 //always saved (PBD2)//
793 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
794 DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
795 desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
796 units : microJ
797
798 \\
799
800 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
801 //always saved (PBD2)//
802 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
803 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
804 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)
805 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]]**
806
807 {{info title="GMD pulse resolved data structure"}}
808 For every pulse in the pulse train the information is saved:
809
810
811 1. **Intensity per pulse** (a.u. (more or less µJ ))
812 1. Intensity per pulse (auxillary GMD) - not used
813 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
814 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
815 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)(%%))
816 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
817 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
818 1. Combined warning and error flags
819
820 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
821 file
822
823
824 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
825
826 \\
827 {{/info}}
828
829 \\
830
831 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 !
832
833 \\
834
835 Besides  pulse energy the GMD also provides information about the beam position
836
837 \\
838
839 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
840 //always saved (PBD2)//
841 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
842 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
843 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
844 units : mm
845
846 \\
847
848 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
849 //always saved (PBD2)//
850 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
851 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
852 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
853 units : mm
854
855 \\
856
857 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
858 always saved (PBD2)
859 DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
860 DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
861 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 ...)
862 units : mm   
863
864 (x=horizontal, y = vertial)
865
866 again the same parameter set is available for the **HALL GMD**
867
868 \\
869
870 \\
871
872 ==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====
873
874 for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**
875
876 (The OPIS hall is not installed yet ...)
877
878 \\
879
880 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
881 // saved opon request (PBD2)//
882 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
883 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
884 desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
885 units : eV
886
887 \\
888
889 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
890 // saved opon request (PBD2)//
891 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
892 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
893 desc : mean wavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
894 units : nm
895
896 \\
897
898 {{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}}
899 // saved opon request (PBD2)//
900 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
901 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
902 desc : The bunch number of the bunch used for the wavelength calculation
903 units :
904
905 \\
906
907 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"]])
908
909 \\
910
911 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 ...
912
913 \\
914
915 \\
916
917 ==== Electron Beam properties (FLASH2) ====
918
919 ===== bunch charge =====
920
921 {{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
922 //always saved (PBD2)//
923 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
924 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
925 desc: electron bunch charge FLASH2 (average value for each bunchtrain).
926 units: nC
927
928 \\
929
930 ===== electron bunch energy =====
931
932 {{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}}
933 //always saved (PBD2)//
934 DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}}
935 DAQ channel: (% style="color: rgb(94,108,132);" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%)
936 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
937
938 (% style="letter-spacing: 0.0px;" %)units: (% class="twikiNewLink" %)MeV
939
940 \\
941
942 (% style="color: rgb(94,108,132);font-weight: 600;letter-spacing: 0.0px;" %)
943 undulator settings
944
945 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
946 //always saved (PBD2)//
947 DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
948 DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
949 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 % ...
950 units: nm
951
952 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
953 //always saved (PBD2)//
954 DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
955 DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
956 desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
957 units: mm
958
959 The gap values are saved for all 12 undulators (Nr 3 to 14). Undulator 14 is the one closest to the experimental hall.
960
961 =====
962 arrival time (BAM) =====
963
964 {{info title="BAM information: updates 2022"}}
965 * 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"]]
966 * The data format of the BAM has been completely altered in the 2022 shutdown
967 * 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 ...
968 * 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)
969 * There has been also a renaming  (and relocation) of the BAMs.
970 ** acc:  4DBC3 → FL0.DBC2
971 ** FL1: 1SFELC →  FL1.SFELC
972 ** FL2: 8FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
973 * for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
974 * [[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]]
975 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
976 {{/info}}
977
978 \\
979
980 {{expand title="Discontinued BAM format (used until end 2021)"}}
981 (% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
982
983 {{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}
984 //always saved (PBD2)//
985 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}
986 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/8FL2XTDS.LOW_CHARGE_ARRIVAL_TIME{{/code}}
987 desc: Electron bunch arrival time measured with the BAM after the FLASH2 undulator (pulse resolved data)
988 units: ps (bigger numbers indicate later arrivaltime of the electrons)
989
990 **FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
991 //always saved (PBD2)//
992 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
993 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
994 desc: Electron bunch arrival time measured with the BAM  in the accelerator  (pulse resolved data)
995 units: ps (bigger numbers indicate later arrivaltime of the electrons)
996
997 \\
998
999 {{info title="BAM hints"}}
1000 * The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).
1001 * 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 
1002 ** 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
1003 * [[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]]
1004 * [[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"]]
1005 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
1006 {{/info}}
1007 {{/expand}}
1008
1009 (% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1010 //always saved (PBD)//
1011 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA2
1012 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.absolute.SA2(%%)
1013 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
1014 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1015
1016 \\
1017
1018 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1019 //always saved (PBD)//
1020 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
1021 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR(%%)
1022 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1023
1024 \\
1025
1026 (% style="color: rgb(255,102,0);" %)DBC2/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1027 //always saved (PBD)//
1028 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//2//(%%)
1029 DAQ channel: (% style="color: rgb(255,102,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS(%%)
1030 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
1031
1032 \\
1033
1034 (% 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}}(%%)
1035 //always saved (PBD)//
1036 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL2.SEED5(%%)/ARRIVAL_TIME.absolute.SA2
1037 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(%%)
1038 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
1039 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1040
1041 \\
1042
1043 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1044 //always saved (PBD)//
1045 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL2.SEED5(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
1046 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(%%)
1047 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1048
1049 \\
1050
1051 (% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/error{{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
1052 //always saved (PBD)//
1053 DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL2.SEED5(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//2//(%%)
1054 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(%%)
1055 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
1056
1057 \\
1058
1059 \\
1060
1061 [[Contents>>doc:||anchor="Contents"]]
1062
1063 \\
1064
1065 ==== Timing information, rep rate etc.  (FLASH2) ====
1066
1067 ===== start time of FLASH2 =====
1068
1069 {{code language="none"}}/FL2/Timing/start time flash2{{/code}}
1070 //always saved (PBD2)//
1071 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1072 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1073 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 ...)
1074 units: µs
1075
1076 ===== bunch repetition rate =====
1077
1078 {{code language="none"}}/FL2/Timing/repetition rate{{/code}}
1079 //always saved (PBD2)//
1080 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1081 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1082 desc: repetition rate of the bunches / pulses within the burst (FLASH2)
1083 units: kHz
1084
1085 ===== actual number of pulses =====
1086
1087 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
1088 //always saved (PBD2)//
1089 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1090 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1091 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)
1092 units:
1093 \\
1094
1095 ===== actual pulse pattern recorded after the undulator =====
1096
1097 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
1098 //always saved (PBD2)//
1099 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1100 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1101 desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
1102 units:
1103 \\
1104
1105 ===== Train ID =====
1106
1107 {{code language="none"}}/Timing/train ID{{/code}}
1108 //always saved (PBD2)//
1109 DOOCS prop : {{code language="none"}}none{{/code}}
1110 DAQ channel: {{code language="none"}}none{{/code}}
1111 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 !)
1112 units:
1113 \\
1114
1115 ===== Train time =====
1116
1117 //always saved (PBD2)
1118 //{{code language="none"}}/Timing/train time{{/code}}
1119 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
1120 units: d h min s cs
1121 \\
1122
1123 {{code language="none"}}/Timing/time stamp{{/code}}
1124
1125 //always saved (PBD2)//
1126 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
1127 second column: microseconds
1128 third column: Train ID of FLASH
1129 \\
1130
1131 [[Contents>>doc:||anchor="Contents"]]
1132
1133 \\
1134
1135 ==== User Data (FLASH2) ====
1136
1137 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.
1138
1139 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
1140
1141 The most common and permanently installed device used by experiment are our ADCs:
1142
1143 ===== GHz ADCs =====
1144
1145 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]]**
1146 //saved on DEMAND in the user DAQ//
1147 \\Up to now there are 4 channels available at FL24
1148 \\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}
1149 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}
1150 \\{{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}}
1151
1152 \\
1153
1154 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
1155 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.
1156 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}
1157
1158 In addition there are also additional parameters saved like:
1159
1160 * {{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.
1161 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1162 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
1163 * {{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.
1164
1165 ===== MHz ADCs =====
1166
1167 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
1168 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}
1169 DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD
1170 DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02
1171
1172 In addition there are also additional parameters saved like:
1173
1174 * {{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.
1175 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1176
1177 [[Contents>>doc:||anchor="Contents"]]
1178
1179 \\
1180
1181 \\
1182
1183 ==== Pump Probe Laser (FLASH2) ====
1184
1185 There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.
1186
1187
1188 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}//always saved (PBD2)//
1189 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1190 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1191 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1192 units : deg.
1193
1194 \\
1195
1196
1197 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}//always saved (PBD2)//
1198 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1199 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1200 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1201 units : deg.
1202
1203 \\
1204
1205 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}
1206 //always saved (PBD2)//
1207 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1208 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1209 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)
1210 units : ps )
1211
1212 \\
1213
1214 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}
1215 //always saved (PBD)//
1216 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1217 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1218 desc: rms jitter of the fs-Oscillator
1219 units: fs
1220
1221 [[Contents>>doc:||anchor="Contents"]]
1222
1223 \\
1224
1225 === "/uncategorized/" ===
1226
1227 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
1228
1229 \\
1230
1231 === HDF5 structure revisions ===
1232
1233 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:
1234
1235 \\
1236
1237 * All FLASH1 related HDF groups moved to group "/FL1", i.e. a new prefix "/FL1" is added to their HDF path.
1238 * 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".
1239 * A number of inconsistent names have been streamlined. The relevant changes are listed in the following table.
1240
1241 \\
1242
1243 (% class="wrapped" %)
1244 |=(((
1245 earlier HDF path (vers. 0.2)
1246 )))|=(((
1247 is now (vers. 0.3)
1248 )))
1249 |(((
1250 /Photon Diagnostic/GMD/Beam position/position BDA x
1251 )))|(((
1252 /FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal
1253 )))
1254 |(((
1255 /Photon Diagnostic/GMD/Beam position/position BDA y
1256 )))|(((
1257 /FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical
1258 )))
1259 |(((
1260 /Photon Diagnostic/GMD/Beam position/position tunnel x
1261 )))|(((
1262 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal
1263 )))
1264 |(((
1265 /Photon Diagnostic/GMD/Beam position/position tunnel y
1266 )))|(((
1267 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical
1268 )))
1269 |(((
1270 /Experiment/Pump probe laser/BPM/position x
1271 )))|(((
1272 /FL1/Experiment/Pump probe laser/BPM/position horizontal
1273 )))
1274 |(((
1275 /Experiment/Pump probe laser/BPM/position y
1276 )))|(((
1277 /FL1/Experiment/Pump probe laser/BPM/position vertical
1278 )))
1279 |(((
1280 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall horizontal
1281 )))|(((
1282 /FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal
1283 )))
1284 |(((
1285 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall vertical
1286 )))|(((
1287 /FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical
1288 )))
1289 |(((
1290 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel horizontal
1291 )))|(((
1292 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal
1293 )))
1294 |(((
1295 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel vertical
1296 )))|(((
1297 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical
1298 )))
1299 |(((
1300 /FL2/Photon Diagnostic/GMD/Average energy/hall
1301 )))|(((
1302 /FL2/Photon Diagnostic/GMD/Average energy/energy hall
1303 )))
1304 |(((
1305 /FL2/Photon Diagnostic/GMD/Average energy/hall (raw)
1306 )))|(((
1307 /FL2/Photon Diagnostic/GMD/Average energy/energy hall (raw)
1308 )))
1309 |(((
1310 /FL2/Photon Diagnostic/GMD/Average energy/tunnel
1311 )))|(((
1312 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel
1313 )))
1314 |(((
1315 /FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)
1316 )))|(((
1317 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel (raw)
1318 )))
1319 |(((
1320 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall x
1321 )))|(((
1322 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal
1323 )))
1324 |(((
1325 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall y
1326 )))|(((
1327 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical
1328 )))
1329 |(((
1330 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel x
1331 )))|(((
1332 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal
1333 )))
1334 |(((
1335 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel y
1336 )))|(((
1337 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical
1338 )))
1339
1340 \\
1341
1342 [[Contents>>doc:||anchor="Contents"]]
1343
1344 \\
1345 {{/layout-cell}}
1346 {{/layout-section}}
1347 {{/layout}}