Wiki source code of The FLASH HDF5 structure

Version 58.1 by sndueste on 2022/09/07 17:20

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