Wiki source code of The FLASH HDF5 structure

Version 28.1 by sndueste on 2019/10/22 08:53
Show last authors
1 == Contents ==
2
3
4
5 {{toc/}}
6
7 \\
8
9 == General information about HDF5 ==
10
11 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://www.hdfgroup.org/HDF5/||shape="rect"]]
12
13 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://support.hdfgroup.org/products/java/hdfview/index.html||shape="rect"]]
14
15 For use on the DESY Maxwell or PAL (max-fsc or pal) **hdfview** is available in the xray module :
16 {{code language="none"}}> module load xray{{/code}}
17 {{code language="none"}}> hdfview{{/code}}
18
19 [[Contents>>doc:||anchor="Contents"]]
20
21 == FLASH HDF5 structure ==
22
23 The photon diagnostic, electron diagnostic and beamline information as well as the information about the pump-probe laser and the infrastructure offered for users (GHz/MHz ADCs) can be included in one HDF5 file which is organised according to train IDs. The general structure is:
24
25 * Electron Diagnostic
26 * Photon Diagnostics
27 * Beamlines
28 * Experiment
29 * Timing
30 [[~[~[image:url:http://hasfweb.desy.de/pub/Setup/HDF5main/HDF5_structure.jpg~|~|alt="HDF5_structure.jpg" width="700" height="500"~]~]>>attach:HDF5_structure.jpg]]
31
32 A detailled description of (most) channels can be found in the lower part of the hdf5 viewer:
33 [[~[~[image:url:http://hasfweb.desy.de/pub/Setup/HDF5main/HDF5_structure_desc.jpg~|~|alt="HDF5_structure_desc.jpg" width="341" height="413"~]~]>>attach:HDF5_structure_desc.jpg]]
34
35 [[Contents>>doc:||anchor="Contents"]]
36
37 \\
38
39 == HDF5 example files ==
40
41 Here we have a few HDF5 samples (User data combined with Photon diagnostics data) from a few beamtimes showing the different kind options.
42
43 Example 1:  Images saved at FLASH2
44
45 \\
46
47 [[image:attach:image2019-10-21_17-2-50.png||thumbnail="true" height="150"]] [[download HDF5 (Images)>>url:https://desycloud.desy.de/index.php/s/nyEgeCWJFC4gao2||shape="rect"]]
48
49 \\
50
51 \\
52
53 [[download HDF5 (GHz ADC and OPIS)>>url:https://desycloud.desy.de/index.php/s/AeA2kPNNnZgX95A||shape="rect"]]
54
55 \\
56
57 \\
58
59 [[Contents>>doc:||anchor="Contents"]]
60
61 \\
62
63 \\
64
65 == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
66
67 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"]].
68 The most common and often used ones are summarized below:
69
70 Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0.
71
72 \\
73
74 === FLASH1 ===
75
76 \\
77
78 ==== Beamline info (FLASH1) ====
79
80 {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}
81 //always saved (PBD)//
82 DOOCS prop : {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
83 DAQ channel: {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
84 desc: set pressure in the gas attenuator
85 units: mbar
86 \\
87
88 {{code language="none"}}/FL1/Beamlines/BL/Fast shutter/open{{/code}}
89 //always saved (PBD)//
90 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER/CH00.TD{{/code}}
91 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER{{/code}}
92 desc: BL Beamline Fast shutter state
93 units: none
94 \\
95
96 {{code language="none"}}/FL1/Beamlines/PG/Fast shutter/open{{/code}}
97 //always saved (PBD)//
98 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER/CH00.TD{{/code}}
99 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER{{/code}}
100 desc: PG Beamline Fast shutter state
101 units: none
102 \\
103
104 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 1{{/code}}
105 //always saved (PBD)//
106 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
107 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
108 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]]
109 units: degree
110 \\
111
112 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 2{{/code}}
113 //always saved (PBD)//
114 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
115 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
116 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]]
117 units: degree
118 \\
119
120 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 1{{/code}}
121 //always saved (PBD)//
122 DOOCS prop : = TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS=
123 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}
124 desc: Position of the PG filter wheel 1
125 units: degree
126 \\
127
128 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 2{{/code}}
129 //always saved (PBD)//
130 DOOCS prop : {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
131 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
132 desc: Position of the PG filter wheel 2
133 units: degree
134 \\
135
136 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 3{{/code}}
137 //always saved (PBD)//
138 DOOCS prop : {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
139 DAQ channel: {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
140 desc: Position of the PG filter wheel 3
141 units: degree
142
143 \\
144
145
146 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
147
148 [[Contents>>doc:||anchor="Contents"]]
149
150 \\
151
152 ==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) / Spectrometer (FLASH1) ====
153
154 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
155 //always saved (PBD)//
156 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}}
157 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}
158 desc : calibrated average SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
159 units : microJ
160
161 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
162 //always saved (PBD)//
163 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}
164 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}
165 desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL
166 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]]**
167
168 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel (raw){{/code}}
169 //always saved (PBD)//
170 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT14/VAL{{/code}}
171 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.FF{{/code}}
172 desc :Energy per pulse Tunnel (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
173 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]]**
174
175 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}
176 //always saved (PBD)//
177 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}
178 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}
179 desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)
180 units : microJ
181
182 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}
183 //always saved (PBD)//
184 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}
185 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}
186 desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL
187 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]]**
188
189 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA (raw){{/code}}
190 //always saved (PBD)//
191 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT15/VAL{{/code}}
192 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}
193 desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
194 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]]**
195
196 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}
197 //always saved (PBD)//
198 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
199 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
200 desc :Beam position of the photon Beam determined by the GMD (BDA, x=horizontal)
201 units : mm
202
203 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical{{/code}}
204 //always saved (PBD)//
205 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
206 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
207 desc :Beam position of the photon Beam determined by the GMD (BDA, y=vertical)
208 units : mm
209
210 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal{{/code}}
211 //always saved (PBD)//
212 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
213 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
214 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, x=horizontal)
215 units : mm
216
217 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical{{/code}}
218 //always saved (PBD)//
219 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
220 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
221 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)
222 units : mm
223
224 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}
225 _always saved (when Spectrum is measured !!) (PBD) _
226 DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}
227 DAQ channel: {{code language="none"}}PBD.PHOTONWL.ML/WAVE_LENGTH{{/code}}
228 desc : XUV Spectrum measured with the "tunnel spectrometer"
229 units :
230
231 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength start value{{/code}}
232 _always saved (when Spectrum is measured !!) (PBD) _
233 DOOCS prop : {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
234 DAQ channel: {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
235 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
236 units : nm
237
238 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength increment{{/code}}
239 _always saved (when Spectrum is measured !!) (PBD) _
240 DOOCS prop : ==
241 DAQ channel: ==
242 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
243 units : nm
244
245 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy{{/code}}
246 //saved on DEMAND (PBD spectrometer stream)//
247 DOOCS prop : ==
248 DAQ channel: {{code language="none"}}PBD.PHOTONEN.ML/PHOTON_ENERGY{{/code}}
249 desc : XUV Spectrum in eV measured with the "PG2 spectrometer"
250 units :
251
252 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy start value{{/code}}
253 //saved on DEMAND (PBD spectrometer stream)//
254 DOOCS prop : ==
255 DAQ channel: ==
256 desc : start value (in eV) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
257 units : eV
258
259 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy increment{{/code}}
260 //saved on DEMAND (PBD spectrometer stream)//
261 DOOCS prop : ==
262 DAQ channel: ==
263 desc : increment value (in eV) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
264 units : eV
265
266 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength{{/code}}
267 //saved on DEMAND (PBD spectrometer stream)//
268 DOOCS prop : ==
269 DAQ channel: {{code language="none"}}PHOTONEN.ML/PHOTON_WAVE_LEN{{/code}}
270 desc : XUV Spectrum in nm measured with the "PG2 spectrometer"
271 units :
272
273 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength increment{{/code}}
274 //saved on DEMAND (PBD spectrometer stream)//
275 DOOCS prop : ==
276 DAQ channel: ==
277 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
278 units : nm
279
280 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength start value{{/code}}
281 //saved on DEMAND (PBD spectrometer stream)//
282 DOOCS prop : ==
283 DAQ channel: ==
284 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
285 units : nm
286
287 [[Contents>>doc:||anchor="Contents"]]
288
289 ==== Electron Beam properties (FLASH1) ====
290
291 ===== bunch charge =====
292
293 {{code language="none"}}/FL1/Electron Diagnostic/Bunch charge/after undulator{{/code}}
294 //always saved (PBD)//
295 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/CHARGE.FLASH1{{/code}}
296 DAQ channel: {{code language="none"}}FLASH.DIAG/TOROID/12EXP{{/code}}
297 desc: electron bunch charge (FLASH1)
298 units: nC
299
300 =====
301 arrival time =====
302
303 {{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
304 //always saved (PBD)//
305 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
306 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
307 desc: Electron bunch arrival time measured with the BAM (more or less) before the undulator (pulse resolved data)
308 units: ps (bigger numbers indicate later arrivaltime of the electrons)
309 note: besides the arivaltime from FLASH1 there is also the FLASH2/3 electron arrival time saved. [[LINK to detailled 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"]] and to a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
310
311 ===== electron beam profile =====
312
313 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}
314 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
315 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/OUT.PROF.CCCED{{/code}}
316 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}
317 desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)
318 units: pixel
319 \\
320
321 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}
322 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
323 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/CALIB.CONST.T{{/code}}
324 DAQ channel: = PBD.BEAM.PROF.ML/CCT=
325 desc: TDS calibration constant for the x-axis of the profiles: fs per pixel
326 units: fs per pixel
327 \\
328
329 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}
330 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
331 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/SOWS.W.CCTED{{/code}}
332 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}
333 desc: rms pulse width of the measures TDS electron bunch profile
334 units: fs
335
336 ===== electron bunch energy =====
337
338 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
339 _always saved (PBD)
340 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
341 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
342 desc: electron bunch energy (average over the bunch train)
343 units: (% class="twikiNewLink" %)MeV(%%)
344 \\
345
346 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
347 _always saved (PBD)
348 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
349 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
350 desc: electron bunch energy bunch resolved
351 units: (% class="twikiNewLink" %)MeV
352
353 \\
354
355 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
356 _always saved (PBD)
357 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
358 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
359 desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
360 units: nm
361 \\
362
363 [[Contents>>doc:||anchor="Contents"]]
364
365 \\
366
367 ==== Timing information, rep rate etc.  (FLASH1) ====
368
369 ===== bunch repetition rate =====
370
371 {{code language="none"}}/FL1/Timing/repetition rate{{/code}}
372 //always saved (PBD)//
373 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
374 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
375 desc: repetition rate of the bunches / pulses within the burst (FLASH1)
376 units: kHz
377 \\
378
379 ===== set number of pulses =====
380
381 {{code language="none"}}/FL1/Timing/set number of bunches{{/code}}
382 //always saved (PBD)//
383 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH1{{/code}}
384 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_NUM{{/code}}
385 desc: Number of pulses set at the gun (FLASH1)
386 units:
387
388 ===== actual number of pulses =====
389
390 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
391 //always saved (PBD)//
392 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/NUMBEROFBUNCHES.FLASH1{{/code}}
393 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
394 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)
395 units:
396 \\
397
398 ===== actual pulse pattern recorded after the undulator =====
399
400 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
401 //always saved (PBD)//
402 DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}
403 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
404 desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH1)
405 units:
406 \\
407
408 ===== Train ID =====
409
410 {{code language="none"}}/Timing/train ID{{/code}}
411 //always saved (PBD)//
412 DOOCS prop : {{code language="none"}}none{{/code}}
413 DAQ channel: {{code language="none"}}none{{/code}}
414 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 !)
415 units:
416 \\
417
418 ===== Train time =====
419
420 {{code language="none"}}/Timing/train time{{/code}}
421 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
422 units: d h min s cs
423 \\
424
425 {{code language="none"}}/Timing/time stamp{{/code}}
426 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
427 second column: microseconds
428 third column: Train ID of FLASH
429 \\
430
431 [[Contents>>doc:||anchor="Contents"]]
432
433 \\
434
435 ==== Pump Probe Laser (FLASH1) ====
436
437 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}}
438
439 //always saved (PBD)//
440 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
441 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
442 desc: attenuation of the PPLaser (rotation of a waveplate)
443 units : 0 no transmission , 1: full transmission
444
445 \\
446
447 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}
448 //always saved (PBD)//
449 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
450 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
451 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
452 units : ps ( pos delay means IR comes later)
453
454 \\
455
456 {{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}
457 //always saved (PBD)//
458 DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}
459 DAQ channel: {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0:ENC.DELAY{{/code}}
460 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
461 units : ps ( pos delay means IR comes later)
462
463 \\
464
465 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}
466 //always saved (PBD)//
467 DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
468 DAQ channel: {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
469 desc: rms jitter of the GECCO (% class="twikiNewLink" %)TiSa(%%) Oscillator units: fs
470
471 \\
472
473 {{code language="none"}}/FL1/Experiment/Pump probe laser/streak camera delay time{{/code}}
474 //always saved (PBD)//
475 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
476 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
477 desc: delaytime between the optical laser and the FEL units: ps
478
479 \\
480
481 [[Contents>>doc:||anchor="Contents"]]
482
483 \\
484
485 ==== User Data (FLASH1) ====
486
487 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.
488
489 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
490
491 The most common and permanently installed device used by experiment are our ADCs:
492
493 ===== GHz ADCs =====
494
495 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]]**
496 //saved on DEMAND in the user DAQ//
497 \\The HDF5 names for the ADC traces are depending on the beamline :
498 \\PG Beamline:
499 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH00/TD{{/code}}
500 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH01/TD{{/code}}
501 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH02/TD{{/code}}
502 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH03/TD{{/code}}
503
504 BL Beamlines:
505 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH00/TD{{/code}}
506 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH01/TD{{/code}}
507 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH02/TD{{/code}}
508 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH03/TD{{/code}}
509 \\{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH00/TD{{/code}}
510 {{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH01/TD{{/code}}
511 \\{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH02/TD{{/code}}
512 {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}
513
514 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
515 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.
516 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
517
518 In addition there are also additional parameters saved like:
519
520 * {{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.
521 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
522 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
523
524 ===== MHz ADCs =====
525
526 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
527 {{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}
528 DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD
529 DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02
530
531 In addition there are also additional parameters saved like:
532
533 * {{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.
534 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
535
536 [[Contents>>doc:||anchor="Contents"]]
537
538 \\
539
540 \\
541
542 \\
543
544 === FLASH2 ===
545
546 There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
547
548 ==== Beamline info (FLASH2) ====
549
550 (% style="color: rgb(255,153,0);" %)(not yet available){{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}(%%)
551 (% style="color: rgb(193,199,208);" %)//always saved (PBD2)// (%%)
552 (% style="color: rgb(193,199,208);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
553 (% style="color: rgb(193,199,208);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
554 (% style="color: rgb(193,199,208);" %)desc: set pressure in the gas attenuator (%%)
555 (% style="color: rgb(193,199,208);" %)units: mbar(%%)
556 \\
557
558 {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
559 //always saved (PBD2)//
560 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
561 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
562 desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
563 units: none
564
565
566 {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
567 //always saved (PBD2)//
568 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
569 DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
570 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]]**
571 units: degree
572 \\
573
574
575 //always saved (PBD2)//
576 \\\\**[[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**
577 {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 2 DOOCS prop : FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS desc: Position of the BL filter wheel 2 - to correlate with the filter material please look units: degree{{/code}}
578
579 \\
580
581 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
582
583 [[Contents>>doc:||anchor="Contents"]]
584
585 \\
586
587 \\
588
589 ==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
590
591 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
592 //always saved (PBD2)//
593 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
594 DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
595 desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
596 units : microJ
597
598 \\
599
600 (% style="color: rgb(255,204,0);" %)average Sigma    to be included in
601
602 (% style="color: rgb(193,199,208);" %){{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel uncertainty{{/code}} (%%)
603 (% style="color: rgb(193,199,208);" %)//always saved (PBD2)// (%%)
604 (% style="color: rgb(193,199,208);" %)DOOCS prop : FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ.SIGMA (%%)
605 (% style="color: rgb(193,199,208);" %)DAQ channel: FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ.SIGMA (%%)
606 (% style="color: rgb(193,199,208);" %)desc :  This parameter gives an indication of the error of the measurement of the average 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)(%%)
607 (% style="color: rgb(193,199,208);" %)units : microJ
608
609 \\
610
611 \\
612
613 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
614 //always saved (PBD2)//
615 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
616 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
617 desc : Energy per pulse measured in the Tunnel  (in fromt of the gas attenuator and the apertures in the Hall)
618 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]]**
619
620 \\
621
622 \\
623
624 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel uncertainty (sigma){{/code}}
625 //always saved (PBD2)//
626 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.SIGMA.TD{{/code}}
627 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL:4{{/code}}
628 desc :(% 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)(%%)
629 units : a.u. (more or less µJ - related to the value of the pulse energy )
630
631
632 {{code language="none"}}{{/code}}
633
634 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 !
635
636 \\
637
638 Besides  pulse energy the GMD also provides information about the beam position
639
640 \\
641
642 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
643 //always saved (PBD2)//
644 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
645 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
646 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
647 units : mm
648
649 \\
650
651 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
652 //always saved (PBD2)//
653 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
654 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
655 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
656 units : mm
657
658 \\
659
660
661 //always saved (PBD2)//
662 \\\\{{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TDDAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2 desc: {{/code}}Besides the well calibrated averaged beam position information there is also the option
663 {{code language="none"}}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 ...)units : mm    {{/code}}
664
665 {{code language="none"}}(x=horizontal, y = vertial){{/code}}
666
667 again the same parameter set is available for the **HALL GMD**
668
669 \\
670
671 \\
672
673 ==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====
674
675 for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**
676
677 (The OPIS hall is not installed yet ...)
678
679 \\
680
681 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
682 // saved opon request (PBD2)//
683 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
684 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
685 desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
686 units : eV
687
688 \\
689
690 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
691 // saved opon request (PBD2)//
692 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
693 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
694 desc : meanwavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
695 units : nm
696
697 \\
698
699 {{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}}
700 // saved opon request (PBD2)//
701 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
702 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
703 desc : The bunch number of the bunch used for the wavelength calculation
704 units :
705
706 \\
707
708 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 savng the compleate 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"]] ( respobsible for [[OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]])
709
710 \\
711
712 In case OPIS was not operating there is still informaton 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 ...
713
714 \\
715
716 \\
717
718 ==== Electron Beam properties (FLASH2) ====
719
720 ===== bunch charge =====
721
722 {{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
723 //always saved (PBD2)//
724 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
725 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
726 desc: electron bunch charge FLASH2 (average value for each bunchtrain).
727 units: nC
728
729 \\
730
731 ===== undulator settings =====
732
733 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
734 //always saved (PBD2)//
735 DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
736 DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
737 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 % ...
738 units: nm
739
740 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
741 //always saved (PBD2)//
742 DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
743 DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
744 desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
745 units: mm
746
747 The gap values are saved for all 12 undulators (Nr 3 to 14). Undulator 14 is the one closest to the experimental hall.
748
749 =====
750 arrival time =====
751
752 **FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
753 //always saved (PBD2)//
754 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
755 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
756 desc: Electron bunch arrival time measured with the BAM (more or less) before the undulator (pulse resolved data)
757 units: ps (bigger numbers indicate later arrivaltime of the electrons)
758
759 The BAM measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !). The first values are for FLASH1 bunches.
760 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) ...
761
762 Docu for BAM:  [[LINK to detailled 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"]] and to a recent [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
763
764
765 [[Contents>>doc:||anchor="Contents"]]
766
767 \\
768
769 ==== Timing information, rep rate etc.  (FLASH2) ====
770
771 ===== start time of FLASH2 =====
772
773 {{code language="none"}}/FL2/Timing/start time flash2{{/code}}
774 //always saved (PBD2)//
775 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
776 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
777 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 ...)
778 units: µs
779
780 ===== bunch repetition rate =====
781
782 {{code language="none"}}/FL2/Timing/repetition rate{{/code}}
783 //always saved (PBD2)//
784 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
785 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
786 desc: repetition rate of the bunches / pulses within the burst (FLASH2)
787 units: kHz
788
789 ===== actual number of pulses =====
790
791 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
792 //always saved (PBD2)//
793 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
794 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
795 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)
796 units:
797 \\
798
799 ===== actual pulse pattern recorded after the undulator =====
800
801 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
802 //always saved (PBD2)//
803 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
804 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
805 desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
806 units:
807 \\
808
809 ===== Train ID =====
810
811 {{code language="none"}}/Timing/train ID{{/code}}
812 //always saved (PBD2)//
813 DOOCS prop : {{code language="none"}}none{{/code}}
814 DAQ channel: {{code language="none"}}none{{/code}}
815 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 !)
816 units:
817 \\
818
819 ===== Train time =====
820
821 //always saved (PBD2)
822 //{{code language="none"}}/Timing/train time{{/code}}
823 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
824 units: d h min s cs
825 \\
826
827 {{code language="none"}}/Timing/time stamp{{/code}}
828
829 //always saved (PBD2)//
830 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
831 second column: microseconds
832 third column: Train ID of FLASH
833 \\
834
835 [[Contents>>doc:||anchor="Contents"]]
836
837 \\
838
839 ==== User Data (FLASH2) ====
840
841 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.
842
843 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
844
845 The most common and permanently installed device used by experiment are our ADCs:
846
847 ===== GHz ADCs =====
848
849 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]]**
850 //saved on DEMAND in the user DAQ//
851 \\Up to now there are 4 channels available at FL24
852 \\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}
853 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}
854 \\{{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}}
855
856 \\
857
858 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
859 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.
860 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}
861
862 In addition there are also additional parameters saved like:
863
864 * {{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.
865 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
866 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
867 * {{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.
868
869 ===== MHz ADCs =====
870
871 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
872 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}
873 DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD
874 DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02
875
876 In addition there are also additional parameters saved like:
877
878 * {{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.
879 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
880
881 [[Contents>>doc:||anchor="Contents"]]
882
883 \\
884
885 \\
886
887 ==== Pump Probe Laser (FLASH2) ====
888
889 There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.
890
891
892 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}//always saved (PBD2)//
893 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
894 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
895 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
896 units : deg.
897
898 \\
899
900
901 {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}//always saved (PBD2)//
902 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
903 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
904 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
905 units : deg.
906
907 \\
908
909 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}
910 //always saved (PBD2)//
911 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
912 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
913 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)
914 units : ps )
915
916 \\
917
918 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}
919 //always saved (PBD)//
920 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
921 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
922 desc: rms jitter of the fs-Oscillator
923 units: fs
924
925 [[Contents>>doc:||anchor="Contents"]]
926
927 \\
928
929 === "/uncategorized/" ===
930
931 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
932
933 \\
934
935 === HDF5 structure revisions ===
936
937 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:
938
939 \\
940
941 * All FLASH1 related HDF groups moved to group "/FL1", i.e. a new prefix "/FL1" is added to their HDF path.
942 * 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".
943 * A number of inconsistent names have been streamlined. The relevant changes are listed in the following table.
944
945 \\
946
947 (% class="wrapped" %)
948 |=(((
949 earlier HDF path (vers. 0.2)
950 )))|=(((
951 is now (vers. 0.3)
952 )))
953 |(((
954 /Photon Diagnostic/GMD/Beam position/position BDA x
955 )))|(((
956 /FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal
957 )))
958 |(((
959 /Photon Diagnostic/GMD/Beam position/position BDA y
960 )))|(((
961 /FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical
962 )))
963 |(((
964 /Photon Diagnostic/GMD/Beam position/position tunnel x
965 )))|(((
966 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal
967 )))
968 |(((
969 /Photon Diagnostic/GMD/Beam position/position tunnel y
970 )))|(((
971 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical
972 )))
973 |(((
974 /Experiment/Pump probe laser/BPM/position x
975 )))|(((
976 /FL1/Experiment/Pump probe laser/BPM/position horizontal
977 )))
978 |(((
979 /Experiment/Pump probe laser/BPM/position y
980 )))|(((
981 /FL1/Experiment/Pump probe laser/BPM/position vertical
982 )))
983 |(((
984 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall horizontal
985 )))|(((
986 /FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal
987 )))
988 |(((
989 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall vertical
990 )))|(((
991 /FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical
992 )))
993 |(((
994 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel horizontal
995 )))|(((
996 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal
997 )))
998 |(((
999 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel vertical
1000 )))|(((
1001 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical
1002 )))
1003 |(((
1004 /FL2/Photon Diagnostic/GMD/Average energy/hall
1005 )))|(((
1006 /FL2/Photon Diagnostic/GMD/Average energy/energy hall
1007 )))
1008 |(((
1009 /FL2/Photon Diagnostic/GMD/Average energy/hall (raw)
1010 )))|(((
1011 /FL2/Photon Diagnostic/GMD/Average energy/energy hall (raw)
1012 )))
1013 |(((
1014 /FL2/Photon Diagnostic/GMD/Average energy/tunnel
1015 )))|(((
1016 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel
1017 )))
1018 |(((
1019 /FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)
1020 )))|(((
1021 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel (raw)
1022 )))
1023 |(((
1024 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall x
1025 )))|(((
1026 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal
1027 )))
1028 |(((
1029 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall y
1030 )))|(((
1031 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical
1032 )))
1033 |(((
1034 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel x
1035 )))|(((
1036 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal
1037 )))
1038 |(((
1039 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel y
1040 )))|(((
1041 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical
1042 )))
1043
1044 \\
1045
1046 [[Contents>>doc:||anchor="Contents"]]
1047
1048 \\
1049
1050 == Example code showing how to access HDF5 files ==
1051
1052 \\
1053
1054 === Samples how to read HDF5 with Matlab ===
1055
1056 The examples apply to HDF files with HDF tree version before vers. 0.3.0.
1057
1058 (% style="color: rgb(0,128,0);" %)%% read in the needed data p=path; path(p,'D:\mess-daten\DAQ-data\hdf5\Gotthard') % add the actual folder to the path hdf5file='FLASH1_EXP-2016-03-16T1420.h5'; % data with Gotthard and VLS
1059
1060 (% style="color: rgb(0,128,0);" %)% h5disp(hdf5file,'/','min') % to get an idea what is in the file % h5info(hdf5file,'/Experiment/Gotthard1/BL.0') % get info about the individual channel
1061
1062 (% style="color: rgb(0,128,0);" %)% read a Number per 10 Hz pulse train:
1063
1064 (% class="code" %)
1065 (((
1066 FEL_Wavelength_energy_server=h5read(hdf5file,'/Photon Diagnostic/Wavelength/Calculated by energy/wavelength' );
1067 )))
1068
1069 (% style="color: rgb(0,128,0);" %)% read in a 1D array (spectrum) %GMD data GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA');
1070
1071 (% style="color: rgb(0,128,0);" %)% This reads in all the data . One can also limit the amount of data read to a subset of the data stored in the file. e.g. for image Data (Gotthard)
1072
1073 \\
1074
1075 (% class="code" %)
1076 (((
1077 Start_event= 500 ; % define the first 10 Hz event
1078 Number_of_events = 20; % how many 10 Hz events to load
1079 )))
1080
1081 (% style="color: rgb(0,128,0);" %)% read only part of the data:
1082
1083 (% class="code" %)
1084 (((
1085 Gotthard_data=h5read(hdf5file,'/Experiment/Gotthard1/BL.0',[2 650 Start_event],[50 85 Number_of_events]);
1086 )))
1087
1088 (% style="color: rgb(0,128,0);" %)% start stop increment "manual" for 2 D data : [start bunch number in Gotthard data start pixelin spectrum start sample in 10 Hz trains], % [number of bunches in the Gotthard data number of points in the spectrum number of spectra ]
1089
1090 (% class="code" %)
1091 (((
1092 VLS_Spectrum=h5read(hdf5file,'/Photon Diagnostic/Wavelength/VLS online spectrometer/PCO.ROI.X',[400 Start_event],[200 Number_of_events] );
1093
1094 )))
1095
1096 (% style="color: rgb(0,128,0);" %)% start stop increment "manual" for 1D data : [start sample in the spectrum start sample in 10 Hz trains],[number of points in the spectrum number of spectra ]
1097
1098 (% style="color: rgb(0,128,0);" %)%GMD data
1099
1100 (% class="code" %)
1101 (((
1102 GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA',[1 Start_event],[40 Number_of_events] );
1103 )))
1104
1105 [[Contents>>doc:||anchor="Contents"]]
1106
1107 === How to read HDF5 with Python via FLASHH5 ===
1108
1109 With [[FlashH5>>doc:FLASHUSER.FLASHH5 for easier access of FLASH's HDF5 files]] we provide h5py based examples to access and evaluate FLASH's HDF5 files.
1110
1111 \\
1112
1113 == HDF5 and DOOCS ==
1114
1115 Here is an outdated [[list with the available properties that are always saved (PBD) for FLASH1 as>>attach:FLASH1__DaqChannel2HdfNamePbd.xlsx]] HDF5 names and the corresponding DOOCS names
1116
1117 [[Contents>>doc:||anchor="Contents"]]