Changes for page The FLASH HDF5 structure

Last modified by sndueste on 2025/02/06 10:55

From version 33.1
edited by sndueste
on 2020/10/28 11:26
Change comment: There is no comment for this version
To version 40.1
edited by sndueste
on 2021/02/09 14:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,9 +8,9 @@
8 8  
9 9  == General information about HDF5 ==
10 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"]]
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://portal.hdfgroup.org/display/support||shape="rect"]]
12 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"]]
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://portal.hdfgroup.org/display/support/Download+HDFView||shape="rect"]]
14 14  
15 15  For use on the DESY Maxwell or PAL (max-fsc or pal) **hdfview** is available in the xray module :
16 16  {{code language="none"}}> module load xray{{/code}}
... ... @@ -18,25 +18,73 @@
18 18  
19 19  [[Contents>>doc:||anchor="Contents"]]
20 20  
21 -== FLASH HDF5 structure ==
21 +== The new (starting 2021) HDF5 format ==
22 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:
23 +\\
24 24  
25 +FLASH provides a conversion of its data acquisition (DAQ) to the commonly used [[HDF5>>url:https://www.hdfgroup.org/solutions/hdf5/||shape="rect"]] format. Correlated  data are mapped by a primary index called **train ID**. Every data set has an individual index of train IDs to identify the data even when data are missing or deviate in update rate.If the data set of choice contains gaps,  users have to decide how to treat missing values. DAQ channels are spread across various files with one file name pattern for each DAQ. This means users have to assemble data from different files if necessary.
26 +
27 +The hierarchy is realized using a human readable named HDF tree with each DAQ channel containing the data sets "//value//" and "//index//". Additionally, the HDF group //zraw// contains a tree of the original DAQ channel names.
28 +
29 +Reference implementation, which follows the concept of Python libraries like Pandas, Xarray, or Dask, is given below.
30 +
31 +\\
32 +
33 +{{expand title="Discontinued HDF formats"}}
34 +== Comparison to FLASH's deprecated HDF formats ==
35 +
36 +Before 2021, FLASH provided two different HDF formats formally known as //near-online// and //offline// HDF files.
37 +
38 +All data sets were aligned by the same global index by filling in missing data. Fast DAQ channels  (pulse synchronous data - update 10 Hz) are filled in by NaN or 0, slow channels (not pulse synchronous data - update e.g. 1 Hz ) are interpolated by the DAQs libraries, by keeping the value constant up to the next change.
39 +
40 +While the near-online HDF files were converted live during the beamtime, the offline HDF files were manually compiled weeks/months later. Near-online HDF files were used by a provided API [[BeamtimeDaqAccess>>url:https://confluence.desy.de/display/FLASHUSER/Near-Online+data+analysis#Near-Onlinedataanalysis-BriefUserGuidetoBeamtimeDAQAccess||shape="rect"]], which also searches for DAQ channels in files. With assembled files "by run", all DAQ channels were existing in the same HDF file. While shorter runs usually fitted into one file, longer runs still had to be aggregated over several files. The creation of the assembled type of files still involves the use of fairly unstable DAQ Mex-functions As the environment required for using the Mex-functions is already deprecated, its continued existence is uncertain.
41 +
42 +The HDF hierarchy is almost identical in all formats. While in the the recent format each DAQ channel contains the data sets "value" and "index", the deprecated format had one data set for each DAQ channel. The deprecated formats supplies no time axis parameters for spectra data types.
43 +{{/expand}}
44 +
45 +== HDF excerpt: ==
46 +
47 +\\
48 +
49 +ADC data as example for **fast** **data** (10 Hz):
50 +
51 +\\
52 +
53 +[[image:attach:image2020-11-16_15-26-28.png||height="250"]]
54 +
55 +\\
56 +
57 +{{info title="Sample scripts in python"}}
58 +== Reference implementation (Python) ==
59 +
60 +[[~[~[image:attach:binder_badge.png~|~|thumbnail="true" width="120"~]~]>>url:https://mybinder.org/v2/git/https%3A%2F%2Fgitlab.desy.de%2Fchristopher.passow%2Fflash-daq-hdf/master||shape="rect"]]
61 +
62 +(% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]
63 +{{/info}}
64 +
65 +\\
66 +
67 +\\
68 +
69 +== The discontinued (till 2021) FLASH HDF5 structure ==
70 +
71 +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 organized according to train IDs. The general structure is:
72 +
25 25  * Electron Diagnostic
26 26  * Photon Diagnostics
27 27  * Beamlines
28 28  * Experiment
29 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]]
78 +[[image:attach:HDF5_structure.jpg||height="400"]]
31 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]]
80 +A detailed description of (most) channels can be found in the lower part of the hdf5 viewer:
81 +[[image:attach:HDF5_structure_desc.jpg||thumbnail="true" height="250"]]
34 34  
35 35  [[Contents>>doc:||anchor="Contents"]]
36 36  
37 37  \\
38 38  
39 -== HDF5 example files ==
87 +=== HDF5 example files ===
40 40  
41 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 42  
... ... @@ -54,8 +54,6 @@
54 54  
55 55  \\
56 56  
57 -\\
58 -
59 59  == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
60 60  
61 61  {{id name="DOOCSparameters"/}}
... ... @@ -139,23 +139,29 @@
139 139  \\
140 140  
141 141  
142 -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
188 +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
143 143  
144 144  [[Contents>>doc:||anchor="Contents"]]
145 145  
146 146  \\
147 147  
148 -==== 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) ====
194 +==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====
149 149  
196 +\\
197 +
198 +(% style="color: rgb(0,0,0);" %)**Discontinued GMD data recording / evaluation  (VME + PhotonFlux ML server)**
199 +
150 150  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
151 -//always saved (PBD)//
152 -DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}}
153 -DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}
154 -desc : calibrated average SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
201 +//always saved (PBD)//
202 +
203 +(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)
204 +(% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)
205 +desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator (ion current)
155 155  units : microJ
156 156  
157 157  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
158 -//always saved (PBD)//
209 +//always saved (PBD)//
210 +
159 159  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}
160 160  DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}
161 161  desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL
... ... @@ -169,7 +169,8 @@
169 169  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]]**
170 170  
171 171  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}
172 -//always saved (PBD)//
224 +//always saved (PBD)//
225 +
173 173  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}
174 174  DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}
175 175  desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)
... ... @@ -176,7 +176,8 @@
176 176  units : microJ
177 177  
178 178  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}
179 -//always saved (PBD)//
232 +//always saved (PBD)//
233 +
180 180  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}
181 181  DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}
182 182  desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL
... ... @@ -189,6 +189,57 @@
189 189  desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
190 190  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]]**
191 191  
246 +\\
247 +
248 +(% style="color: rgb(0,0,0);" %)**NEW (2021) GMD data recording / evaluation  (MTCA, analog to FLASH2 and XFEL)**
249 +
250 +{{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
251 +//always saved (PBD)//
252 +(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
253 +(% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
254 +
255 +desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator
256 +units : microJ
257 +
258 +\\
259 +
260 +{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
261 +//always saved (PBD)//
262 +
263 +(% style="color: rgb(0,0,0);" %)DOOCS prop : 
264 +{{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}
265 +
266 +desc : Energy per pulse measured in the Tunnel.  In addition measurement errors and beam position are included for EACH pulse in the pulse train  !! (see below)
267 +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]]**
268 +
269 +{{info title="GMD pulse resolved data structure"}}
270 +For every pulse in the pulse train the information is saved:
271 +
272 +
273 +1. **Intensity per pulse** (a.u. (more or less µJ ))
274 +1. Intensity per pulse (auxillary GMD) - not used
275 +1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
276 +1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
277 +1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color: rgb(0,0,0);" %)This parameter gives an indication of the error of the measurement of the pulse energy. This takes signal to noise,  detector resolution, uncertainties in crossection etc into account. (it is NOT the measurement of the statistical fluctuation of the SASE pulses)(%%))
278 +1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
279 +1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
280 +1. Combined warning and error flags
281 +
282 +The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
283 +file
284 +
285 +
286 +[[image:attach:image2021-2-9_10-51-6.png||height="250"]]
287 +
288 +\\
289 +{{/info}}
290 +
291 +All values for the GMD are also available for the** BDA GMD **which is located in the experimental hall down stream the gas attenuator. If the attenuator is on the ratio between BDA and Tunnel signal shows the attenuation. **BUT NOTE** that the filter units  are downstream the GMD. So if filters  are used this influence is NOT measured by the GMD BDA !
292 +
293 +\\
294 +
295 +Besides  pulse energy the GMD also provides information about the beam position
296 +
192 192  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}
193 193  //always saved (PBD)//
194 194  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
... ... @@ -217,6 +217,10 @@
217 217  desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)
218 218  units : mm
219 219  
325 +\\
326 +
327 +==== Spectrometer (FLASH1) ====
328 +
220 220  {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}
221 221  _always saved (when Spectrum is measured !!) (PBD) _
222 222  DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}
... ... @@ -347,7 +347,7 @@
347 347  ===== electron bunch energy =====
348 348  
349 349  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
350 -_always saved (PBD)
459 +//always saved (PBD)//
351 351  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
352 352  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
353 353  desc: electron bunch energy (average over the bunch train)
... ... @@ -355,7 +355,7 @@
355 355  \\
356 356  
357 357  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
358 -_always saved (PBD)
467 +//always saved (PBD)//
359 359  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
360 360  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
361 361  desc: electron bunch energy bunch resolved
... ... @@ -364,7 +364,7 @@
364 364  \\
365 365  
366 366  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
367 -_always saved (PBD)
476 +//always saved (PBD)//
368 368  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
369 369  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
370 370  desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
... ... @@ -558,12 +558,12 @@
558 558  
559 559  ==== Beamline info (FLASH2) ====
560 560  
561 -(% style="color: rgb(255,153,0);" %)(not yet available){{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}(%%)
562 -(% style="color: rgb(193,199,208);" %)//always saved (PBD2)// (%%)
563 -(% style="color: rgb(193,199,208);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
564 -(% style="color: rgb(193,199,208);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
565 -(% style="color: rgb(193,199,208);" %)desc: set pressure in the gas attenuator (%%)
566 -(% style="color: rgb(193,199,208);" %)units: mbar(%%)
670 +{{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
671 +(% style="color: rgb(0,0,0);" %)//always saved (PBD2)// (%%)
672 +(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
673 +(% style="color: rgb(0,0,0);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
674 +(% style="color: rgb(0,0,0);" %)desc: set pressure in the gas attenuator (%%)
675 +(% style="color: rgb(0,0,0);" %)units: mbar(%%)
567 567  \\
568 568  
569 569  {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
... ... @@ -582,11 +582,13 @@
582 582  units: degree
583 583  \\
584 584  
694 +/FL2/Beamlines/Filter wheel/position wheel 2
695 +always saved (PBD2)
696 +DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
697 +DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
698 +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]]
699 +units: degree
585 585  
586 -//always saved (PBD2)//
587 -\\\\**[[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**
588 -{{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}}
589 -
590 590  \\
591 591  
592 592  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
... ... @@ -608,40 +608,37 @@
608 608  
609 609  \\
610 610  
611 -(% style="color: rgb(255,204,0);" %)average Sigma    to be included in
612 -
613 -(% style="color: rgb(193,199,208);" %){{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel uncertainty{{/code}} (%%)
614 -(% style="color: rgb(193,199,208);" %)//always saved (PBD2)// (%%)
615 -(% style="color: rgb(193,199,208);" %)DOOCS prop : FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ.SIGMA (%%)
616 -(% style="color: rgb(193,199,208);" %)DAQ channel: FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ.SIGMA (%%)
617 -(% 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)(%%)
618 -(% style="color: rgb(193,199,208);" %)units : microJ
619 -
620 -\\
621 -
622 -\\
623 -
624 624  {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
625 625  //always saved (PBD2)//
626 626  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
627 627  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
628 -desc : Energy per pulse measured in the Tunnel  (in fromt of the gas attenuator and the apertures in the Hall)
726 +desc : Energy per pulse measured in the Tunnel  (in front of the gas attenuator and the apertures in the Hall) In addition measurement errors and beam position are included for EACH pulse in the pulse train  !! (see below)
629 629  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]]**
630 630  
631 -\\
729 +{{info title="GMD pulse resolved data structure"}}
730 +For every pulse in the pulse train the information is saved:
731 +
632 632  
633 -\\
733 +1. **Intensity per pulse** (a.u. (more or less µJ ))
734 +1. Intensity per pulse (auxillary GMD) - not used
735 +1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
736 +1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
737 +1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color: rgb(0,0,0);" %)This parameter gives an indication of the error of the measurement of the pulse energy. This takes signal to noise,  detector resolution, uncertainties in crossection etc into account. (it is NOT the measurement of the statistical fluctuation of the SASE pulses)(%%))
738 +1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
739 +1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
740 +1. Combined warning and error flags
634 634  
635 -{{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel uncertainty (sigma){{/code}}
636 -//always saved (PBD2)//
637 -DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.SIGMA.TD{{/code}}
638 -DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL:4{{/code}}
639 -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)(%%)
640 -units : a.u. (more or less µJ - related to the value of the pulse energy )
742 +The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
743 +file
641 641  
745 +
746 +[[image:attach:image2021-2-9_10-51-6.png||height="250"]]
642 642  
643 -{{code language="none"}}{{/code}}
748 +\\
749 +{{/info}}
644 644  
751 +\\
752 +
645 645  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 !
646 646  
647 647  \\
... ... @@ -668,13 +668,15 @@
668 668  
669 669  \\
670 670  
779 +/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
780 +always saved (PBD2)
781 +DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
782 +DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
783 +desc: Besides the well calibrated averaged beam position information there is also the option to measure the beam position on a single bunch level. HOWEVER this methide needs a perfectly adjusted signal level (talk to your local contact !!) and also then the signal to noise is rather small and one needs some averaging ... BUT with this option one can determine if there was a spatial slope on a burst (say forst bunches were lower than the last ones or so ...)
784 +units : mm   
671 671  
672 -//always saved (PBD2)//
673 -\\\\{{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
674 -{{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}}
786 +(x=horizontal, y = vertial)
675 675  
676 -{{code language="none"}}(x=horizontal, y = vertial){{/code}}
677 -
678 678  again the same parameter set is available for the **HALL GMD**
679 679  
680 680  \\
... ... @@ -1075,65 +1075,6 @@
1075 1075  
1076 1076  \\
1077 1077  
1078 -=== Samples how to read HDF5 with Matlab ===
1079 -
1080 -The examples apply to HDF files with HDF tree version before vers. 0.3.0.
1081 -
1082 -(% 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
1083 -
1084 -(% 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
1085 -
1086 -(% style="color: rgb(0,128,0);" %)% read a Number per 10 Hz pulse train:
1087 -
1088 -(% class="code" %)
1089 -(((
1090 -FEL_Wavelength_energy_server=h5read(hdf5file,'/Photon Diagnostic/Wavelength/Calculated by energy/wavelength' );
1091 -)))
1092 -
1093 -(% 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');
1094 -
1095 -(% 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)
1096 -
1097 -\\
1098 -
1099 -(% class="code" %)
1100 -(((
1101 -Start_event= 500 ; % define the first 10 Hz event
1102 - Number_of_events = 20; % how many 10 Hz events to load
1103 -)))
1104 -
1105 -(% style="color: rgb(0,128,0);" %)% read only part of the data:
1106 -
1107 -(% class="code" %)
1108 -(((
1109 -Gotthard_data=h5read(hdf5file,'/Experiment/Gotthard1/BL.0',[2 650 Start_event],[50 85 Number_of_events]);
1110 -)))
1111 -
1112 -(% 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 ]
1113 -
1114 -(% class="code" %)
1115 -(((
1116 -VLS_Spectrum=h5read(hdf5file,'/Photon Diagnostic/Wavelength/VLS online spectrometer/PCO.ROI.X',[400 Start_event],[200 Number_of_events] );
1117 -
1118 -)))
1119 -
1120 -(% 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 ]
1121 -
1122 -(% style="color: rgb(0,128,0);" %)%GMD data
1123 -
1124 -(% class="code" %)
1125 -(((
1126 -GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA',[1 Start_event],[40 Number_of_events] );
1127 -)))
1128 -
1129 -[[Contents>>doc:||anchor="Contents"]]
1130 -
1131 -=== How to read HDF5 with Python via FLASHH5 ===
1132 -
1133 -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.
1134 -
1135 -\\
1136 -
1137 1137  == HDF5 and DOOCS ==
1138 1138  
1139 1139  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