Changes for page The FLASH HDF5 structure
Last modified by sndueste on 2025/02/06 10:55
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,6 +4,3 @@ 1 -{{layout}} 2 -{{layout-section ac:type="single"}} 3 -{{layout-cell}} 4 4 == Contents == 5 5 6 6 ... ... @@ -19,38 +19,27 @@ 19 19 {{code language="none"}}> module load xray{{/code}} 20 20 {{code language="none"}}> hdfview{{/code}} 21 21 22 -or you can use 23 - 24 -{{code language="none"}}> silx view{{/code}} 25 - 26 -\\ 27 - 28 28 [[Contents>>doc:||anchor="Contents"]] 29 29 30 -== The FLASH HDF5 format ==21 +== The current FLASH HDF5 structure == 31 31 32 - FLASHprovides a conversionof itsdata acquisition(DAQ) tohecommonlyused [[HDF5>>url:https://www.hdfgroup.org/solutions/hdf5/||shape="rect"]] format. Correlateddata are mapped by a primary indexcalled**trainID**. Everydataset has an individualdexoftrain IDstoidentifythe dataevenwhendataaremissingordeviateinupdaterate.If thedatasetofchoicecontains gaps,users havetodecidehow to treatmissing values.DAQchannelsarespreadacross variousfileswith one filename patternforeachDAQ. Thismeans users have to assembledata from differentfilesif necessary.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 organized according to train IDs. The general structure is: 33 33 34 -The hierarchy is realized using a human readable named HDF tree with each DAQ channel containing the data sets "//value//" and "//index//". Additionally, the HDF group //zraw// contains a tree of the original DAQ channel names. 25 +* Electron Diagnostic 26 +* Photon Diagnostics 27 +* Beamlines 28 +* Experiment 29 +* Timing 30 +[[image:attach:HDF5_structure.jpg||height="400"]] 35 35 36 -Reference implementation, which follows the concept of Python libraries like Pandas, Xarray, or Dask, is given below. 32 +A detailed description of (most) channels can be found in the lower part of the hdf5 viewer: 33 +[[image:attach:HDF5_structure_desc.jpg||thumbnail="true" height="250"]] 37 37 38 - \\35 +[[Contents>>doc:||anchor="Contents"]] 39 39 40 -{{expand title="Discontinued HDF formats"}} 41 -=== Comparison to FLASH's deprecated HDF formats === 42 - 43 -Before 2021, FLASH provided two different HDF formats formally known as //near-online// and //offline// HDF files. 44 - 45 -All data sets were aligned by the same global index by filling in missing data. Fast DAQ channels (pulse synchronous data - update 10 Hz) are filled in by NaN or 0, slow channels (not pulse synchronous data - update e.g. 1 Hz ) are interpolated by the DAQs libraries, by keeping the value constant up to the next change. 46 - 47 -While the near-online HDF files were converted live during the beamtime, the offline HDF files were manually compiled weeks/months later. Near-online HDF files were used by a provided API [[BeamtimeDaqAccess>>url:https://confluence.desy.de/display/FLASHUSER/Near-Online+data+analysis#Near-Onlinedataanalysis-BriefUserGuidetoBeamtimeDAQAccess||shape="rect"]], which also searches for DAQ channels in files. With assembled files "by run", all DAQ channels were existing in the same HDF file. While shorter runs usually fitted into one file, longer runs still had to be aggregated over several files. The creation of the assembled type of files still involves the use of fairly unstable DAQ Mex-functions As the environment required for using the Mex-functions is already deprecated, its continued existence is uncertain. 48 - 49 -The HDF hierarchy is almost identical in all formats. While in the the recent format each DAQ channel contains the data sets "value" and "index", the deprecated format had one data set for each DAQ channel. The deprecated formats supplies no time axis parameters for spectra data types. 50 - 51 51 \\ 52 52 53 - **HDF5 example files(old format)**39 +=== HDF5 example files === 54 54 55 55 Here we have a few HDF5 samples (User data combined with Photon diagnostics data) from a few beamtimes showing the different kind options. 56 56 ... ... @@ -63,67 +63,26 @@ 63 63 \\ 64 64 65 65 \\ 66 -{{/expand}} 67 67 68 -=== HDF examples: === 69 -{{/layout-cell}} 70 -{{/layout-section}} 53 +[[Contents>>doc:||anchor="Contents"]] 71 71 72 -{{layout-section ac:type="three_equal"}} 73 -{{layout-cell}} 74 -* ADC data as example for **fast** **data** (10 Hz): 75 - 76 76 \\ 77 77 78 -[[image:attach:image2020-11-16_15-26-28.png||height="250"]] 79 -{{/layout-cell}} 57 +== The new (starting 2021) HDF5 format == 80 80 81 -{{layout-cell}} 82 -* The //average// FEL pulse energy as example for the **slow** **data** (different e.g. 1 Hz): 59 +Here is [[some documentation on the changes of the HDF5 format>>doc:FLASHUSER.HDF5 format]] that well be available in 2021 (work in progress) 83 83 84 - ( every 10th train ID is listed in the HDF group "index") 85 - 86 86 \\ 87 87 88 -[[image:attach:image2020-11-16_15-31-45.png||height="250"]] 89 -{{/layout-cell}} 90 - 91 -{{layout-cell}} 92 -* ((( 93 -//zraw// group contains the **original DAQ (DOOCS) names** 94 -))) 95 - 96 - of the properties saved in the DESY internal raw format. (For experts) 97 - 98 98 \\ 99 99 100 -[[image:attach:image2020-11-16_16-26-3.png||height="400"]] 101 -{{/layout-cell}} 102 -{{/layout-section}} 103 - 104 -{{layout-section ac:type="single"}} 105 -{{layout-cell}} 106 -{{info title="Sample scripts in python"}} 107 -=== Sample scripts / Reference implementation (Python) === 108 - 109 -[[~[~[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"]] 110 - 111 -(% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]] 112 -{{/info}} 113 -{{/layout-cell}} 114 -{{/layout-section}} 115 - 116 -{{layout-section ac:type="single"}} 117 -{{layout-cell}} 118 -== Complete list of recordable parameters == 119 - 120 -The complete list for the relation between DOOCS names and HDF5 names for the recordable parameters can be found in [[DESY's Repository~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://stash.desy.de/projects/CS/repos/pah/browse/src/camp/data/channel2HdfName.dat||shape="rect"]]. 121 -\\ 122 - 123 123 == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ == 124 124 125 125 {{id name="DOOCSparameters"/}} 126 126 69 +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"]]. 70 +The most common and often used ones are summarized below: 71 + 127 127 Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0. 128 128 129 129 \\ ... ... @@ -130,6 +130,8 @@ 130 130 131 131 === FLASH1 === 132 132 78 +\\ 79 + 133 133 ==== Beamline info (FLASH1) ==== 134 134 135 135 {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}} ... ... @@ -211,7 +211,7 @@ 211 211 (% style="color: rgb(0,0,0);" %)**Discontinued GMD data recording / evaluation (VME + PhotonFlux ML server)** 212 212 213 213 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}} 214 -//always saved (PBD)// 161 +//always saved (PBD)//\\ 215 215 216 216 (% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%) 217 217 (% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%) ... ... @@ -469,7 +469,7 @@ 469 469 ===== electron bunch energy ===== 470 470 471 471 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}} 472 - //always saved (PBD)//419 +_always saved (PBD) 473 473 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}} 474 474 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}} 475 475 desc: electron bunch energy (average over the bunch train) ... ... @@ -477,7 +477,7 @@ 477 477 \\ 478 478 479 479 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}} 480 - //always saved (PBD)//427 +_always saved (PBD) 481 481 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}} 482 482 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}} 483 483 desc: electron bunch energy bunch resolved ... ... @@ -486,7 +486,7 @@ 486 486 \\ 487 487 488 488 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}} 489 - //always saved (PBD)//436 +_always saved (PBD) 490 490 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}} 491 491 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}} 492 492 desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1) ... ... @@ -534,7 +534,7 @@ 534 534 //always saved (PBD)// 535 535 DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}} 536 536 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}} 537 -desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1) 484 +desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH1) 538 538 units: 539 539 \\ 540 540 ... ... @@ -607,7 +607,7 @@ 607 607 //always saved (PBD)// 608 608 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}} 609 609 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}} 610 -desc: delay 557 +desc: delaytime between the optical laser and the FEL units: ps 611 611 612 612 \\ 613 613 ... ... @@ -617,7 +617,7 @@ 617 617 618 618 ==== User Data (FLASH1) ==== 619 619 620 -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 ofslow properties (motor positions etc) for user experiments. For details please ask your local contact.567 +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. 621 621 622 622 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 623 623 ... ... @@ -645,13 +645,13 @@ 645 645 {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}} 646 646 647 647 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD or CH00.DAQ.TD{{/code}} 648 -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}} con tains only the grouped spectra. To read the ADC trace with an online analysis program the {{code language="none"}}CH00.DAQ.TD{{/code}} is used preferably.595 +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. 649 649 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}} 650 650 651 651 In addition there are also additional parameters saved like: 652 652 653 653 * {{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. 654 -* {{code language="none"}}number of samples{{/code}}: total number of sam ples recorded for each 10 Hz trigger601 +* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger 655 655 * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error 656 656 657 657 ===== MHz ADCs ===== ... ... @@ -664,7 +664,7 @@ 664 664 In addition there are also additional parameters saved like: 665 665 666 666 * {{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. 667 -* {{code language="none"}}number of samples{{/code}}: total number of sam ples recorded for each 10 Hz trigger614 +* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger 668 668 669 669 [[Contents>>doc:||anchor="Contents"]] 670 670 ... ... @@ -680,12 +680,12 @@ 680 680 681 681 ==== Beamline info (FLASH2) ==== 682 682 683 -{{code language="none"}}/FL2/Beamlines/Attenuator/pressure 684 -(% style="color: rgb( 0,0,0);" %)//always saved (PBD2)// (%%)685 -(% style="color: rgb( 0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)686 -(% style="color: rgb( 0,0,0);" %)DAQ channel: {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)687 -(% style="color: rgb( 0,0,0);" %)desc: set pressure in the gas attenuator (%%)688 -(% style="color: rgb( 0,0,0);" %)units: mbar(%%)630 +(% style="color: rgb(255,153,0);" %)(not yet available){{code language="none"}}/FL2/Beamlines/Attenuator/pressure {{/code}}(%%) 631 +(% style="color: rgb(193,199,208);" %)//always saved (PBD2)// (%%) 632 +(% style="color: rgb(193,199,208);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%) 633 +(% style="color: rgb(193,199,208);" %)DAQ channel: {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%) 634 +(% style="color: rgb(193,199,208);" %)desc: set pressure in the gas attenuator (%%) 635 +(% style="color: rgb(193,199,208);" %)units: mbar(%%) 689 689 \\ 690 690 691 691 {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}} ... ... @@ -704,13 +704,11 @@ 704 704 units: degree 705 705 \\ 706 706 707 -/FL2/Beamlines/Filter wheel/position wheel 2 708 -always saved (PBD2) 709 -DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}} 710 -DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}} 711 -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]] 712 -units: degree 713 713 655 +//always saved (PBD2)// 656 +\\\\**[[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]** 657 +{{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}} 658 + 714 714 \\ 715 715 716 716 NOTE: Aperture positions in the beamline as well as the positions of the beam steering mirrors are also saved. for more Info contact your local contact ... ... @@ -789,15 +789,13 @@ 789 789 790 790 \\ 791 791 792 -/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x 793 -always saved (PBD2) 794 -DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD 795 -DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2 796 -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 ...) 797 -units : mm 798 798 799 -(x=horizontal, y = vertial) 738 +//always saved (PBD2)// 739 +\\\\{{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 740 +{{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}} 800 800 742 +{{code language="none"}}(x=horizontal, y = vertial){{/code}} 743 + 801 801 again the same parameter set is available for the **HALL GMD** 802 802 803 803 \\ ... ... @@ -825,7 +825,7 @@ 825 825 // saved opon request (PBD2)// 826 826 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}} 827 827 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}} 828 -desc : mean 771 +desc : meanwavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy) 829 829 units : nm 830 830 831 831 \\ ... ... @@ -839,11 +839,11 @@ 839 839 840 840 \\ 841 841 842 -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 sav ing the complete ADC trace of the TOF setup. This is a huge amount of data and needs processing. This has to be performed after the beamtime in close contact to [[Markus Braune>>mailto:markus.braune@desy.de||shape="rect"]] ( responsible for [[OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]])785 +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"]]) 843 843 844 844 \\ 845 845 846 -In case OPIS was not operating there is still informat ion 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 ...789 +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 ... 847 847 848 848 \\ 849 849 ... ... @@ -862,21 +862,8 @@ 862 862 863 863 \\ 864 864 865 -===== electronbunchenergy=====808 +===== undulator settings ===== 866 866 867 -{{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}} 868 -//always saved (PBD2)// 869 -DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}} 870 -DAQ channel: (% style="color: rgb(94,108,132);" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%) 871 -desc: electron bunch energy measured behind the undulator. Data is saved with 10 Hz - BUT (for computation reasons) only the energy of the FIRST bunch is recorded. The data is also available for (% style="color: rgb(94,108,132);" %)extraction and septum in the beginning of FLASH2 872 - 873 -(% style="letter-spacing: 0.0px;" %)units: (% class="twikiNewLink" %)MeV 874 - 875 -\\ 876 - 877 -(% style="color: rgb(94,108,132);font-weight: 600;letter-spacing: 0.0px;" %) 878 -undulator settings 879 - 880 880 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}} 881 881 //always saved (PBD2)// 882 882 DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}} ... ... @@ -1206,6 +1206,68 @@ 1206 1206 [[Contents>>doc:||anchor="Contents"]] 1207 1207 1208 1208 \\ 1209 -{{/layout-cell}} 1210 -{{/layout-section}} 1211 -{{/layout}} 1139 + 1140 +== Example code showing how to access HDF5 files == 1141 + 1142 +\\ 1143 + 1144 +=== Samples how to read HDF5 with Matlab === 1145 + 1146 +The examples apply to HDF files with HDF tree version before vers. 0.3.0. 1147 + 1148 +(% 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 1149 + 1150 +(% 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 1151 + 1152 +(% style="color: rgb(0,128,0);" %)% read a Number per 10 Hz pulse train: 1153 + 1154 +(% class="code" %) 1155 +((( 1156 +FEL_Wavelength_energy_server=h5read(hdf5file,'/Photon Diagnostic/Wavelength/Calculated by energy/wavelength' ); 1157 +))) 1158 + 1159 +(% 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'); 1160 + 1161 +(% 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) 1162 + 1163 +\\ 1164 + 1165 +(% class="code" %) 1166 +((( 1167 +Start_event= 500 ; % define the first 10 Hz event 1168 + Number_of_events = 20; % how many 10 Hz events to load 1169 +))) 1170 + 1171 +(% style="color: rgb(0,128,0);" %)% read only part of the data: 1172 + 1173 +(% class="code" %) 1174 +((( 1175 +Gotthard_data=h5read(hdf5file,'/Experiment/Gotthard1/BL.0',[2 650 Start_event],[50 85 Number_of_events]); 1176 +))) 1177 + 1178 +(% 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 ] 1179 + 1180 +(% class="code" %) 1181 +((( 1182 +VLS_Spectrum=h5read(hdf5file,'/Photon Diagnostic/Wavelength/VLS online spectrometer/PCO.ROI.X',[400 Start_event],[200 Number_of_events] ); 1183 + 1184 +))) 1185 + 1186 +(% 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 ] 1187 + 1188 +(% style="color: rgb(0,128,0);" %)%GMD data 1189 + 1190 +(% class="code" %) 1191 +((( 1192 +GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA',[1 Start_event],[40 Number_of_events] ); 1193 +))) 1194 + 1195 +[[Contents>>doc:||anchor="Contents"]] 1196 + 1197 +\\ 1198 + 1199 +== HDF5 and DOOCS == 1200 + 1201 +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 1202 + 1203 +[[Contents>>doc:||anchor="Contents"]]