Wiki source code of The FLASH HDF5 structure

Version 19.1 by sndueste on 2019/09/18 10:20

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