Changes for page The FLASH HDF5 structure

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

From version 46.1
edited by sndueste
on 2021/02/10 10:13
Change comment: There is no comment for this version
To version 4.1
edited by sendels
on 2019/08/09 12:45
Change comment: added links

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sndueste
1 +XWiki.sendels
Content
... ... @@ -1,19 +4,33 @@
1 -{{layout}}
2 -{{layout-section ac:type="single"}}
3 -{{layout-cell}}
4 4  == Contents ==
5 5  
3 +\\
6 6  
5 +* [[General information about HDF5>>doc:||anchor="General information about HDF5"]]
6 +* [[FLASH HDF5 structure>>doc:||anchor="FLASH HDF5 structure"]]
7 +* [[Most popular FLASH parameters and their names in HDF5>>doc:||anchor="Most popular FLASH parameters and their names in HDF5"]]
8 +** [[FLASH1>>doc:||anchor="FLASH1"]]
9 +*** [[Beamline info (FLASH1)>>doc:||anchor="Beamline info (FLASH1)"]]
10 +*** [[Photon Diagnostics SASE / Spectrometer (FLASH1)>>doc:||anchor="Photon Diagnostics SASE / Spectrometer (FLASH1)"]]
11 +*** [[Electron Beam properties (FLASH1)>>doc:||anchor="Electron Beam properties (FLASH1)"]]
12 +*** [[Timing information, rep rate etc.(FLASH1)>>doc:||anchor="Timing information, rep rate etc.(FLASH1)"]]
13 +*** [[Pump Probe Laser (FLASH1)>>doc:||anchor="Pump Probe Laser (FLASH1)"]]
14 +*** [[User Data (FLASH1)>>doc:||anchor="User Data (FLASH1)"]]
15 +** [[FLASH2>>doc:||anchor="FLASH2"]]
16 +** [[HDF5 structure revisions>>doc:||anchor="HDF5 structure revisions"]]
17 +* [[Example code showing how to access HDF5 files>>doc:||anchor="Example code showing how to access HDF5 files"]]
18 +** [[Samples how to read HDF5 with Matlab>>doc:||anchor="Samples how to read HDF5 with Matlab"]]
19 +** [[How to read HDF5 with Python via FLASHH5>>doc:||anchor="How to read HDF5 with Python via FLASHH5"]]
20 +* [[HDF5 and DOOCS>>doc:||anchor="HDF5 and DOOCS"]]
7 7  
8 -{{toc/}}
22 +\\
9 9  
10 10  \\
11 11  
12 12  == General information about HDF5 ==
13 13  
14 -HDF5 is a data format maintained by the HDF group. For detailed general information see [[here~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://portal.hdfgroup.org/display/support||shape="rect"]]
28 +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"]]
15 15  
16 -To download the HDF5 Viewer click [[here~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://portal.hdfgroup.org/display/support/Download+HDFView||shape="rect"]]
30 +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"]]
17 17  
18 18  For use on the DESY Maxwell or PAL (max-fsc or pal) **hdfview** is available in the xray module :
19 19  {{code language="none"}}> module load xray{{/code}}
... ... @@ -21,109 +21,37 @@
21 21  
22 22  [[Contents>>doc:||anchor="Contents"]]
23 23  
24 -== The FLASH HDF5 format ==
38 +== FLASH HDF5 structure ==
25 25  
26 -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 gapsusers 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.
40 +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:
27 27  
28 -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.
42 +* Electron Diagnostic
43 +* Photon Diagnostics
44 +* Beamlines
45 +* Experiment
46 +* Timing
47 +[[~[~[image:url:http://hasfweb.desy.de/pub/Setup/HDF5main/HDF5_structure.jpg~|~|alt="HDF5_structure.jpg" width="700" height="500"~]~]>>attach:HDF5_structure.jpg]]
29 29  
30 -Reference implementation, which follows the concept of Python libraries like Pandas, Xarray, or Dask, is given below.
49 +A detailled description of (most) channels can be found in the lower part of the hdf5 viewer:
50 +[[~[~[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]]
31 31  
32 -\\
52 +[[Contents>>doc:||anchor="Contents"]]
33 33  
34 -{{expand title="Discontinued HDF formats"}}
35 -== Comparison to FLASH's deprecated HDF formats ==
36 -
37 -Before 2021, FLASH provided two different HDF formats formally known as //near-online// and //offline// HDF files.
38 -
39 -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.
40 -
41 -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.
42 -
43 -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.
44 -
45 45  \\
46 46  
47 -**HDF5 example files (old format)**
56 +== Most popular FLASH parameters and their names in HDF5 ==
48 48  
49 -Here we have a few HDF5 samples (User data combined with Photon diagnostics data) from a few beamtimes showing the different kind options.
58 +The compleate 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"]].
59 +The most common and often used ones are summarized below:
50 50  
51 -[[image:attach:image2019-10-21_17-2-50.png||thumbnail="true" width="300"]] [[download HDF5 (Images @ FL2)>>url:https://desycloud.desy.de/index.php/s/nyEgeCWJFC4gao2||shape="rect"]]
61 +Note, the HDF group and dataset names apply to our HDF tree version since vers. 0.3.0.
52 52  
53 53  \\
54 54  
55 -[[~[~[image:attach:image2019-10-22_10-52-27.png~|~|thumbnail="true" width="300"~]~]download HDF5 (GHz ADC and OPIS @ FL2)>>url:https://desycloud.desy.de/index.php/s/AeA2kPNNnZgX95A||shape="rect"]]
65 +=== FLASH1 ===
56 56  
57 57  \\
58 58  
59 -\\
60 -{{/expand}}
61 -
62 -=== HDF examples: ===
63 -{{/layout-cell}}
64 -{{/layout-section}}
65 -
66 -{{layout-section ac:type="three_equal"}}
67 -{{layout-cell}}
68 -* ADC data as example for **fast** **data** (10 Hz):           
69 -
70 -\\
71 -
72 -[[image:attach:image2020-11-16_15-26-28.png||height="250"]]
73 -{{/layout-cell}}
74 -
75 -{{layout-cell}}
76 -* The //average// FEL pulse energy as example for the **slow** **data** (different e.g. 1 Hz):
77 -
78 - ( every 10th train ID is listed in the HDF group "index")
79 -
80 -\\
81 -
82 -[[image:attach:image2020-11-16_15-31-45.png||height="250"]]
83 -{{/layout-cell}}
84 -
85 -{{layout-cell}}
86 -* (((
87 -//zraw// group contains the **original DAQ (DOOCS) names**
88 -)))
89 -
90 - of the properties saved in the DESY internal raw format. (For experts)
91 -
92 -\\
93 -
94 -[[image:attach:image2020-11-16_16-26-3.png||height="400"]]
95 -{{/layout-cell}}
96 -{{/layout-section}}
97 -
98 -{{layout-section ac:type="single"}}
99 -{{layout-cell}}
100 -{{info title="Sample scripts in python"}}
101 -=== Reference implementation (Python) ===
102 -
103 -[[~[~[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"]]
104 -
105 -(% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]
106 -{{/info}}
107 -{{/layout-cell}}
108 -{{/layout-section}}
109 -
110 -{{layout-section ac:type="single"}}
111 -{{layout-cell}}
112 -== Complete list of recordable parameters ==
113 -
114 -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"]].
115 -\\
116 -
117 -== Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
118 -
119 -{{id name="DOOCSparameters"/}}
120 -
121 -Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0.
122 -
123 -\\
124 -
125 -=== FLASH1 ===
126 -
127 127  ==== Beamline info (FLASH1) ====
128 128  
129 129  {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}
... ... @@ -154,7 +154,7 @@
154 154  //always saved (PBD)//
155 155  DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
156 156  DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
157 -desc: Position of the BL filter wheel 1 - to correlate with the filter material please look [[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
99 +desc: Position of the BL filterwheel 1 - to correlate with the filter material please look [[here>>doc:FLASH.Filter history (BL filterwheel 12)]]
158 158  units: degree
159 159  \\
160 160  
... ... @@ -162,7 +162,7 @@
162 162  //always saved (PBD)//
163 163  DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
164 164  DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
165 -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]]
107 +desc: Position of the BL filterwheel 2 - to correlate with the filter material please look [[here>>doc:FLASH.Filter history (BL filterwheel 12)]]
166 166  units: degree
167 167  \\
168 168  
... ... @@ -170,7 +170,7 @@
170 170  //always saved (PBD)//
171 171  DOOCS prop : = TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS=
172 172  DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}
173 -desc: Position of the PG filter wheel 1
115 +desc: Position of the PG filterwheel 1
174 174  units: degree
175 175  \\
176 176  
... ... @@ -178,7 +178,7 @@
178 178  //always saved (PBD)//
179 179  DOOCS prop : {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
180 180  DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
181 -desc: Position of the PG filter wheel 2
123 +desc: Position of the PG filterwheel 2
182 182  units: degree
183 183  \\
184 184  
... ... @@ -186,39 +186,27 @@
186 186  //always saved (PBD)//
187 187  DOOCS prop : {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
188 188  DAQ channel: {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
189 -desc: Position of the PG filter wheel 3
131 +desc: Position of the PG filterwheel 3
190 190  units: degree
191 -
192 192  \\
193 193  
194 -
195 -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
196 -
197 197  [[Contents>>doc:||anchor="Contents"]]
198 198  
199 -\\
137 +==== Photon Diagnostics SASE / Spectrometer (FLASH1) ====
200 200  
201 -==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====
202 -
203 -\\
204 -
205 -(% style="color: rgb(0,0,0);" %)**Discontinued GMD data recording / evaluation  (VME + PhotonFlux ML server)**
206 -
207 207  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
208 -//always saved (PBD)//
209 -
210 -(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)
211 -(% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)
212 -desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator (ion current)
140 +//always saved (PBD)//
141 +DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}}
142 +DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}
143 +desc : calibrated average SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
213 213  units : microJ
214 214  
215 215  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
216 -//always saved (PBD)//
217 -
147 +//always saved (PBD)//
218 218  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}
219 219  DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}
220 220  desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL
221 -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]]**
151 +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]]
222 222  
223 223  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel (raw){{/code}}
224 224  //always saved (PBD)//
... ... @@ -225,11 +225,10 @@
225 225  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT14/VAL{{/code}}
226 226  DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.FF{{/code}}
227 227  desc :Energy per pulse Tunnel (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
228 -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]]**
158 +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]]
229 229  
230 230  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}
231 -//always saved (PBD)//
232 -
161 +//always saved (PBD)//
233 233  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}
234 234  DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}
235 235  desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)
... ... @@ -236,12 +236,11 @@
236 236  units : microJ
237 237  
238 238  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}
239 -//always saved (PBD)//
240 -
168 +//always saved (PBD)//
241 241  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}
242 242  DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}
243 243  desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL
244 -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]]**
172 +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]]
245 245  
246 246  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA (raw){{/code}}
247 247  //always saved (PBD)//
... ... @@ -248,64 +248,13 @@
248 248  DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT15/VAL{{/code}}
249 249  DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}
250 250  desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
251 -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]]**
179 +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]]
252 252  
253 -\\
254 -
255 -(% style="color: rgb(0,0,0);" %)**NEW (2021) GMD data recording / evaluation  (MTCA, analog to FLASH2 and XFEL)**
256 -
257 -{{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
258 -//always saved (PBD)//
259 -(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
260 -(% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
261 -
262 -desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator
263 -units : microJ
264 -
265 -\\
266 -
267 -{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
268 -//always saved (PBD)//
269 -
270 -(% style="color: rgb(0,0,0);" %)DOOCS prop : 
271 -{{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}}
272 -
273 -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)
274 -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]]**
275 -
276 -{{info title="GMD pulse resolved data structure"}}
277 -For every pulse in the pulse train the information is saved:
278 -
279 -
280 -1. **Intensity per pulse** (a.u. (more or less µJ ))
281 -1. Intensity per pulse (auxillary GMD) - not used
282 -1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
283 -1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
284 -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)(%%))
285 -1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
286 -1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
287 -1. Combined warning and error flags
288 -
289 -The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
290 -file
291 -
292 -
293 -[[image:attach:image2021-2-9_10-51-6.png||height="250"]]
294 -
295 -\\
296 -{{/info}}
297 -
298 -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 !
299 -
300 -\\
301 -
302 -Besides  pulse energy the GMD also provides information about the beam position
303 -
304 304  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}
305 305  //always saved (PBD)//
306 306  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
307 307  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
308 -desc :Beam position of the photon Beam determined by the GMD (BDA, x=horizontal)
185 +desc :Beam position of the photon Beam determined by the [[GMD>>doc:FLASH.Gas Monitor Detector]] (BDA, x=horizontal)
309 309  units : mm
310 310  
311 311  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical{{/code}}
... ... @@ -312,7 +312,7 @@
312 312  //always saved (PBD)//
313 313  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
314 314  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
315 -desc :Beam position of the photon Beam determined by the GMD (BDA, y=vertical)
192 +desc :Beam position of the photon Beam determined by the [[GMD>>doc:FLASH.Gas Monitor Detector]] (BDA, y=vertical)
316 316  units : mm
317 317  
318 318  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal{{/code}}
... ... @@ -319,7 +319,7 @@
319 319  //always saved (PBD)//
320 320  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
321 321  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
322 -desc :Beam position of the photon Beam determined by the GMD (TUNNEL, x=horizontal)
199 +desc :Beam position of the photon Beam determined by the [[GMD>>doc:FLASH.Gas Monitor Detector]] (TUNNEL, x=horizontal)
323 323  units : mm
324 324  
325 325  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical{{/code}}
... ... @@ -326,13 +326,9 @@
326 326  //always saved (PBD)//
327 327  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
328 328  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
329 -desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)
206 +desc :Beam position of the photon Beam determined by the [[GMD>>doc:FLASH.Gas Monitor Detector]] (TUNNEL, y=vertical)
330 330  units : mm
331 331  
332 -\\
333 -
334 -==== Spectrometer (FLASH1) ====
335 -
336 336  {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}
337 337  _always saved (when Spectrum is measured !!) (PBD) _
338 338  DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}
... ... @@ -400,6 +400,8 @@
400 400  
401 401  ==== Electron Beam properties (FLASH1) ====
402 402  
276 +\\
277 +
403 403  ===== bunch charge =====
404 404  
405 405  {{code language="none"}}/FL1/Electron Diagnostic/Bunch charge/after undulator{{/code}}
... ... @@ -408,31 +408,20 @@
408 408  DAQ channel: {{code language="none"}}FLASH.DIAG/TOROID/12EXP{{/code}}
409 409  desc: electron bunch charge (FLASH1)
410 410  units: nC
286 +\\
411 411  
412 -=====
413 -arrival time =====
288 +\\
414 414  
290 +===== arrival time =====
291 +
415 415  {{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
416 416  //always saved (PBD)//
417 417  DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
418 418  DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
419 -desc: Electron bunch arrival time measured with the BAM inside the accelerator - however shows a very good correlation to the arrivaltime  of the XUV pulses in the experiment (pulse resolved data).
420 -units: ps (bigger numbers indicate later arrivaltime of the electrons)
296 +desc: Electron bunch arrival time measured with the BAM (more or less) before the undulator (pulse resolved data)
297 +units: ps (bigger numbers indicate later arrivaltime of the electrons)
298 +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://mskwiki/index.php?title=BAM-DAQ_Channels||shape="rect"]]
421 421  
422 -{{code language="none"}}/FL1/Electron Diagnostic/BAM/1SFELC/electron bunch arrival time (low charge){{/code}}
423 -//always saved (PBD)//
424 -DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/1SFELC/LOW_CHARGE_ARRIVAL_TIME{{/code}}
425 -DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/1SFELC.LOW_CHARGE_ARRIVAL_TIME{{/code}}
426 -desc: Electron bunch arrival time measured with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.
427 -units: ps (bigger numbers indicate later arrivaltime of the electrons)
428 -
429 -{{info title="BAM hints"}}
430 -* besides the arrivaltime from FLASH1 there is also the FLASH2/3 electron arrival time saved.In case of doubt ask your local contact
431 -* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments >>doc:FLASHUSER.Additional helpful things.FLASH beamlines and instruments references.WebHome]]
432 -* [[LINK to detailed infos from MSK (may only work inside DESY network~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:http://www.desy.de/~~mbock/pages/BAM_daq_channel_descriptions.html||shape="rect"]]
433 -* a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
434 -{{/info}}
435 -
436 436  \\
437 437  
438 438  ===== electron beam profile =====
... ... @@ -459,11 +459,14 @@
459 459  DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}
460 460  desc: rms pulse width of the measures TDS electron bunch profile
461 461  units: fs
326 +\\
462 462  
328 +\\
329 +
463 463  ===== electron bunch energy =====
464 464  
465 465  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
466 -//always saved (PBD)//
333 +_always saved (PBD)
467 467  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
468 468  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
469 469  desc: electron bunch energy (average over the bunch train)
... ... @@ -471,16 +471,17 @@
471 471  \\
472 472  
473 473  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
474 -//always saved (PBD)//
341 +_always saved (PBD)
475 475  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
476 476  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
477 477  desc: electron bunch energy bunch resolved
478 -units: (% class="twikiNewLink" %)MeV
345 +units: (% class="twikiNewLink" %)MeV(%%)
346 +\\
479 479  
480 480  \\
481 481  
482 482  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
483 -//always saved (PBD)//
351 +_always saved (PBD)
484 484  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
485 485  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
486 486  desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
... ... @@ -491,8 +491,10 @@
491 491  
492 492  \\
493 493  
494 -==== Timing information, rep rate etc.  (FLASH1) ====
362 +==== Timing information, rep rate etc.(FLASH1) ====
495 495  
364 +\\
365 +
496 496  ===== bunch repetition rate =====
497 497  
498 498  {{code language="none"}}/FL1/Timing/repetition rate{{/code}}
... ... @@ -503,6 +503,8 @@
503 503  units: kHz
504 504  \\
505 505  
376 +\\
377 +
506 506  ===== set number of pulses =====
507 507  
508 508  {{code language="none"}}/FL1/Timing/set number of bunches{{/code}}
... ... @@ -511,7 +511,10 @@
511 511  DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_NUM{{/code}}
512 512  desc: Number of pulses set at the gun (FLASH1)
513 513  units:
386 +\\
514 514  
388 +\\
389 +
515 515  ===== actual number of pulses =====
516 516  
517 517  {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
... ... @@ -522,6 +522,8 @@
522 522  units:
523 523  \\
524 524  
400 +\\
401 +
525 525  ===== actual pulse pattern recorded after the undulator =====
526 526  
527 527  {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
... ... @@ -532,6 +532,8 @@
532 532  units:
533 533  \\
534 534  
412 +\\
413 +
535 535  ===== Train ID =====
536 536  
537 537  {{code language="none"}}/Timing/train ID{{/code}}
... ... @@ -538,14 +538,16 @@
538 538  //always saved (PBD)//
539 539  DOOCS prop : {{code language="none"}}none{{/code}}
540 540  DAQ channel: {{code language="none"}}none{{/code}}
541 -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 !)
420 +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 !)
542 542  units:
543 543  \\
544 544  
424 +\\
425 +
545 545  ===== Train time =====
546 546  
547 547  {{code language="none"}}/Timing/train time{{/code}}
548 -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
429 +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
549 549  units: d h min s cs
550 550  \\
551 551  
... ... @@ -561,16 +561,12 @@
561 561  
562 562  ==== Pump Probe Laser (FLASH1) ====
563 563  
564 -{{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}}
565 -
566 -//always saved (PBD)//
445 +{{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}} //always saved (PBD)//
567 567  DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
568 568  DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
569 569  desc: attenuation of the PPLaser (rotation of a waveplate)
570 570  units : 0 no transmission , 1: full transmission
571 571  
572 -\\
573 -
574 574  {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}
575 575  //always saved (PBD)//
576 576  DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
... ... @@ -578,8 +578,6 @@
578 578  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
579 579  units : ps ( pos delay means IR comes later)
580 580  
581 -\\
582 -
583 583  {{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}
584 584  //always saved (PBD)//
585 585  DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}
... ... @@ -587,8 +587,6 @@
587 587  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
588 588  units : ps ( pos delay means IR comes later)
589 589  
590 -\\
591 -
592 592  {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}
593 593  //always saved (PBD)//
594 594  DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
... ... @@ -611,15 +611,11 @@
611 611  
612 612  ==== User Data (FLASH1) ====
613 613  
614 -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.
487 +\\
615 615  
616 -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
617 -
618 -The most common and permanently installed device used by experiment are our ADCs:
619 -
620 620  ===== GHz ADCs =====
621 621  
622 -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]]**
491 +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]]
623 623  //saved on DEMAND in the user DAQ//
624 624  \\The HDF5 names for the ADC traces are depending on the beamline :
625 625  \\PG Beamline:
... ... @@ -642,437 +642,220 @@
642 642  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.
643 643  DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
644 644  
645 -In addition there are also additional parameters saved like:
514 +in addition there are also additional parameters saved like:
646 646  
647 -* {{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.
648 -* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
649 -* {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
516 +* sample frequency (in MHz)
517 +* error (state)
518 +* offset
650 650  
520 +~|
521 +
651 651  ===== MHz ADCs =====
652 652  
653 -similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
524 +similar to the GHz ADCs the MHz ASDsa re saved with HDF5 names like:
654 654  {{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}
655 655  DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD
656 656  DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02
657 657  
658 -In addition there are also additional parameters saved like:
529 +\\
659 659  
660 -* {{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.
661 -* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
662 -
663 663  [[Contents>>doc:||anchor="Contents"]]
664 664  
665 -\\
666 -
667 -\\
668 -
669 -\\
670 -
671 671  === FLASH2 ===
672 672  
673 -There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
674 -
675 -==== Beamline info (FLASH2) ====
676 -
677 -{{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
678 -(% style="color: rgb(0,0,0);" %)//always saved (PBD2)// (%%)
679 -(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
680 -(% style="color: rgb(0,0,0);" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
681 -(% style="color: rgb(0,0,0);" %)desc: set pressure in the gas attenuator (%%)
682 -(% style="color: rgb(0,0,0);" %)units: mbar(%%)
683 683  \\
684 684  
685 -{{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
686 -//always saved (PBD2)//
687 -DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
688 -DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
689 -desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
690 -units: none
537 +(% class="wrapped" %)
538 +|=(((
539 +DAQ name
540 +)))|=(((
541 +HDF5 name
542 +)))
543 +|(((
544 +FLASH.UTIL/FL2.UND.MOTOR/FL2SASE3/GAP
545 +)))|(((
546 +/FL2/Electron Diagnostic/Undulator setting/SASE03 gap
547 +)))
548 +|(((
549 +FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP
550 +)))|(((
551 +/FL2/Electron Diagnostic/Undulator setting/SASE14 gap
552 +)))
553 +|(((
554 +TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH
555 +)))|(((
556 +/FL2/Electron Diagnostic/Undulator setting/set wavelength
557 +)))
558 +|(((
559 +FLASH.FEL/XGM.PHOTONFLUX/FL2.HALL/PHOTONFLUX.UJ
560 +)))|(((
561 +/FL2/Photon Diagnostic/GMD/Average energy/hall
562 +)))
563 +|(((
564 +FLASH.FEL/XGM.PHOTONFLUX/FL2.HALL/PHOTONFLUX
565 +)))|(((
566 +/FL2/Photon Diagnostic/GMD/Average energy/hall (raw)
567 +)))
568 +|(((
569 +FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ
570 +)))|(((
571 +/FL2/Photon Diagnostic/GMD/Average energy/tunnel
572 +)))
573 +|(((
574 +FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX
575 +)))|(((
576 +/FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)
577 +)))
578 +|(((
579 +FLASH.FEL/XGM.POSMON/FL2.HALL/IX.POS
580 +)))|(((
581 +/FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal
582 +)))
583 +|(((
584 +FLASH.FEL/XGM.POSMON/FL2.HALL/IY.POS
585 +)))|(((
586 +/FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical
587 +)))
588 +|(((
589 +FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS
590 +)))|(((
591 +/FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal
592 +)))
593 +|(((
594 +FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS
595 +)))|(((
596 +/FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical
597 +)))
598 +|(((
599 +FLASH.FEL/XGM.BPM/FL2.HALL:0
600 +)))|(((
601 +/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal
602 +)))
603 +|(((
604 +FLASH.FEL/XGM.BPM/FL2.HALL:1
605 +)))|(((
606 +/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical
607 +)))
608 +|(((
609 +FLASH.FEL/XGM.BPM/FL2.TUNNEL:0
610 +)))|(((
611 +/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal
612 +)))
613 +|(((
614 +FLASH.FEL/XGM.BPM/FL2.TUNNEL:1
615 +)))|(((
616 +/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical
617 +)))
618 +|(((
619 +FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL:1
620 +)))|(((
621 +/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy aux tunnel
622 +)))
623 +|(((
624 +FLASH.FEL/XGM.INTENSITY/FL2.HALL
625 +)))|(((
626 +/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy hall
627 +)))
628 +|(((
629 +FLASH.FEL/XGM.INTENSITY/FL2.HALL:0
630 +)))|(((
631 +/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy hall
632 +)))
633 +|(((
634 +FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL
635 +)))|(((
636 +/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel
637 +)))
638 +|(((
639 +FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL:0
640 +)))|(((
641 +/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel
642 +)))
643 +|(((
644 +FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042
645 +)))|(((
646 +/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean phtoton energy
647 +)))
648 +|(((
649 +FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040
650 +)))|(((
651 +/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelengt
652 +)))
653 +|(((
654 +FLASH.FEL/ADC.ADQ/OPIS1.CH02
655 +)))|(((
656 +/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Raw data/CH02
657 +)))
658 +|(((
659 +FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2
660 +)))|(((
661 +/FL2/Electron Diagnostic/Bunch charge/after undulator
662 +)))
663 +|(((
664 +FLASH.DIAG/PBD2.TOROID.ML/3GUN/CHARGE.FLASH2
665 +)))|(((
666 +/FL2/Electron Diagnostic/Bunch charge/at gun
667 +)))
668 +|(((
669 +FLASH.FEL/FL20T.PH.MOTOR/MOTOR1.MOT1/FPOS
670 +)))|(((
671 +/FL2/Beamlines/Tunnel Apertures/position aperture1 horizontal
672 +)))
673 +|(((
674 +FLASH.FEL/FL20T.PH.MOTOR/MOTOR2.MOT1/FPOS
675 +)))|(((
676 +/FL2/Beamlines/Tunnel Apertures/position aperture1 vertical
677 +)))
678 +|(((
679 +FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER
680 +)))|(((
681 +/FL2/Beamlines/FL20/Shutter/channel 0
682 +)))
683 +|(((
684 +FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00
685 +)))|(((
686 +/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD
687 +)))
688 +|(((
689 +FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH00
690 +)))|(((
691 +/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH0/TD
692 +)))
693 +|(((
694 +FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD
695 +)))|(((
696 +/FL2/Experiment/Pump probe laser/Synchronization/timing jitter RMS
697 +)))
698 +|(((
699 +FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/LOCK_STATUS.VALUE.RD
700 +)))|(((
701 +/FL2/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO
702 +)))
703 +|(((
704 +FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD
705 +)))|(((
706 +/FL2/Experiment/Pump probe laser/laser delay readback
707 +)))
708 +|(((
709 +FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION_SET.WR
710 +)))|(((
711 +/FL2/Experiment/Pump probe laser/laser delay set value
712 +)))
713 +|(((
714 +FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS
715 +)))|(((
716 +/FL2/Experiment/Pump probe laser/FL24/attenuator position
717 +)))
718 +|(((
719 +FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/POS
720 +)))|(((
721 +/FL2/Experiment/Pump probe laser/FL24/polarization position
722 +)))
691 691  
692 -
693 -{{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
694 -//always saved (PBD2)//
695 -DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
696 -DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
697 -desc: Position of the BL filter wheel 1 - to correlate with the filter material please look **[[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**
698 -units: degree
699 699  \\
700 700  
701 -/FL2/Beamlines/Filter wheel/position wheel 2
702 -always saved (PBD2)
703 -DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
704 -DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
705 -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]]
706 -units: degree
707 -
708 -\\
709 -
710 -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
711 -
712 712  [[Contents>>doc:||anchor="Contents"]]
713 713  
714 -\\
715 -
716 -\\
717 -
718 -==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
719 -
720 -{{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
721 -//always saved (PBD2)//
722 -DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
723 -DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
724 -desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
725 -units : microJ
726 -
727 -\\
728 -
729 -{{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
730 -//always saved (PBD2)//
731 -DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
732 -DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
733 -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)
734 -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]]**
735 -
736 -{{info title="GMD pulse resolved data structure"}}
737 -For every pulse in the pulse train the information is saved:
738 -
739 -
740 -1. **Intensity per pulse** (a.u. (more or less µJ ))
741 -1. Intensity per pulse (auxillary GMD) - not used
742 -1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
743 -1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
744 -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)(%%))
745 -1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
746 -1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
747 -1. Combined warning and error flags
748 -
749 -The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
750 -file
751 -
752 -
753 -[[image:attach:image2021-2-9_10-51-6.png||height="250"]]
754 -
755 -\\
756 -{{/info}}
757 -
758 -\\
759 -
760 -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 !
761 -
762 -\\
763 -
764 -Besides  pulse energy the GMD also provides information about the beam position
765 -
766 -\\
767 -
768 -{{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
769 -//always saved (PBD2)//
770 -DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
771 -DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
772 -desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
773 -units : mm
774 -
775 -\\
776 -
777 -{{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
778 -//always saved (PBD2)//
779 -DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
780 -DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
781 -desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
782 -units : mm
783 -
784 -\\
785 -
786 -/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
787 -always saved (PBD2)
788 -DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
789 -DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
790 -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 ...)
791 -units : mm   
792 -
793 -(x=horizontal, y = vertial)
794 -
795 -again the same parameter set is available for the **HALL GMD**
796 -
797 -\\
798 -
799 -\\
800 -
801 -==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====
802 -
803 -for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**
804 -
805 -(The OPIS hall is not installed yet ...)
806 -
807 -\\
808 -
809 -{{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
810 -// saved opon request (PBD2)//
811 -DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
812 -DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
813 -desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
814 -units : eV
815 -
816 -\\
817 -
818 -{{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
819 -// saved opon request (PBD2)//
820 -DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
821 -DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
822 -desc : meanwavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
823 -units : nm
824 -
825 -\\
826 -
827 -{{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}}
828 -// saved opon request (PBD2)//
829 -DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
830 -DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
831 -desc : The bunch number of the bunch used for the wavelength calculation
832 -units :
833 -
834 -\\
835 -
836 -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"]])
837 -
838 -\\
839 -
840 -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 ...
841 -
842 -\\
843 -
844 -\\
845 -
846 -==== Electron Beam properties (FLASH2) ====
847 -
848 -===== bunch charge =====
849 -
850 -{{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
851 -//always saved (PBD2)//
852 -DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
853 -DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
854 -desc: electron bunch charge FLASH2 (average value for each bunchtrain).
855 -units: nC
856 -
857 -\\
858 -
859 -===== undulator settings =====
860 -
861 -{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
862 -//always saved (PBD2)//
863 -DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
864 -DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
865 -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 % ...
866 -units: nm
867 -
868 -{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
869 -//always saved (PBD2)//
870 -DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
871 -DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
872 -desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
873 -units: mm
874 -
875 -The gap values are saved for all 12 undulators (Nr 3 to 14). Undulator 14 is the one closest to the experimental hall.
876 -
877 -=====
878 -arrival time =====
879 -
880 -{{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}
881 -//always saved (PBD2)//
882 -DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}
883 -DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/8FL2XTDS.LOW_CHARGE_ARRIVAL_TIME{{/code}}
884 -desc: Electron bunch arrival time measured with the BAM after the FLASH2 undulator (pulse resolved data)
885 -units: ps (bigger numbers indicate later arrivaltime of the electrons)
886 -
887 -**FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
888 -//always saved (PBD2)//
889 -DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
890 -DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
891 -desc: Electron bunch arrival time measured with the BAM  in the accelerator  (pulse resolved data)
892 -units: ps (bigger numbers indicate later arrivaltime of the electrons)
893 -
894 -\\
895 -
896 -{{info title="BAM hints"}}
897 -* The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).
898 -* The BAM 8FL2XTDS measures only for FLASH2 BUT has the same data structure as the other BAMS ... thus there are also (random) values in in the  FLASH1 time slot 
899 -** Structure: The first values are for FLASH1 bunches. After a gap of about 70 micros ( 70 colums)  with  as entry for the switching between FLASH 1 and 2 the values for the electrons used in FLASH2 start.  The start time of FLASH2 is also recorded in the DAQ. FLASH1 start time is for historic reasons 700. thus if e.g. the start time of FLASH2 ( property name see below) is 1200 it means that FLASH starts at column 500 (1200-700) ... .In case of doubt ask your local contact
900 -* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments >>doc:FLASHUSER.Additional helpful things.FLASH beamlines and instruments references.WebHome]]
901 -* [[LINK to detailed infos from MSK (may only work inside DESY network~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:http://www.desy.de/~~mbock/pages/BAM_daq_channel_descriptions.html||shape="rect"]]
902 -* a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
903 -{{/info}}
904 -
905 -
906 -[[Contents>>doc:||anchor="Contents"]]
907 -
908 -\\
909 -
910 -==== Timing information, rep rate etc.  (FLASH2) ====
911 -
912 -===== start time of FLASH2 =====
913 -
914 -{{code language="none"}}/FL2/Timing/start time flash2{{/code}}
915 -//always saved (PBD2)//
916 -DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
917 -DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
918 -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 ...)
919 -units: µs
920 -
921 -===== bunch repetition rate =====
922 -
923 -{{code language="none"}}/FL2/Timing/repetition rate{{/code}}
924 -//always saved (PBD2)//
925 -DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
926 -DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
927 -desc: repetition rate of the bunches / pulses within the burst (FLASH2)
928 -units: kHz
929 -
930 -===== actual number of pulses =====
931 -
932 -{{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
933 -//always saved (PBD2)//
934 -DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
935 -DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
936 -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)
937 -units:
938 -\\
939 -
940 -===== actual pulse pattern recorded after the undulator =====
941 -
942 -{{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
943 -//always saved (PBD2)//
944 -DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
945 -DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
946 -desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
947 -units:
948 -\\
949 -
950 -===== Train ID =====
951 -
952 -{{code language="none"}}/Timing/train ID{{/code}}
953 -//always saved (PBD2)//
954 -DOOCS prop : {{code language="none"}}none{{/code}}
955 -DAQ channel: {{code language="none"}}none{{/code}}
956 -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 !)
957 -units:
958 -\\
959 -
960 -===== Train time =====
961 -
962 -//always saved (PBD2)
963 -//{{code language="none"}}/Timing/train time{{/code}}
964 -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
965 -units: d h min s cs
966 -\\
967 -
968 -{{code language="none"}}/Timing/time stamp{{/code}}
969 -
970 -//always saved (PBD2)//
971 -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
972 -second column: microseconds
973 -third column: Train ID of FLASH
974 -\\
975 -
976 -[[Contents>>doc:||anchor="Contents"]]
977 -
978 -\\
979 -
980 -==== User Data (FLASH2) ====
981 -
982 -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.
983 -
984 -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
985 -
986 -The most common and permanently installed device used by experiment are our ADCs:
987 -
988 -===== GHz ADCs =====
989 -
990 -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]]**
991 -//saved on DEMAND in the user DAQ//
992 -\\Up to now there are 4 channels available at FL24
993 -\\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}
994 -{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}
995 -\\{{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}}
996 -
997 -\\
998 -
999 -DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
1000 -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.
1001 -DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}
1002 -
1003 -In addition there are also additional parameters saved like:
1004 -
1005 -* {{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.
1006 -* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1007 -* {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
1008 -* {{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.
1009 -
1010 -===== MHz ADCs =====
1011 -
1012 -similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
1013 -{{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}
1014 -DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD
1015 -DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02
1016 -
1017 -In addition there are also additional parameters saved like:
1018 -
1019 -* {{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.
1020 -* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1021 -
1022 -[[Contents>>doc:||anchor="Contents"]]
1023 -
1024 -\\
1025 -
1026 -\\
1027 -
1028 -==== Pump Probe Laser (FLASH2) ====
1029 -
1030 -There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.
1031 -
1032 -
1033 -{{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}//always saved (PBD2)//
1034 -DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1035 -DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1036 -desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1037 -units : deg.
1038 -
1039 -\\
1040 -
1041 -
1042 -{{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}//always saved (PBD2)//
1043 -DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1044 -DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1045 -desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1046 -units : deg.
1047 -
1048 -\\
1049 -
1050 -{{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}
1051 -//always saved (PBD2)//
1052 -DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1053 -DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1054 -desc: delay of the Pump probe laser - measured by the read back position of the motor. There is also the set value available ( upto now these values are only updating every 1-2 seconds. There is no fast encoder property as on FLASH1 available)
1055 -units : ps )
1056 -
1057 -\\
1058 -
1059 -{{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}
1060 -//always saved (PBD)//
1061 -DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1062 -DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1063 -desc: rms jitter of the fs-Oscillator
1064 -units: fs
1065 -
1066 -[[Contents>>doc:||anchor="Contents"]]
1067 -
1068 -\\
1069 -
1070 -=== "/uncategorized/" ===
1071 -
1072 - If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with their DOOCS names
1073 -
1074 -\\
1075 -
1076 1076  === HDF5 structure revisions ===
1077 1077  
1078 1078  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:
... ... @@ -1187,6 +1187,72 @@
1187 1187  [[Contents>>doc:||anchor="Contents"]]
1188 1188  
1189 1189  \\
1190 -{{/layout-cell}}
1191 -{{/layout-section}}
1192 -{{/layout}}
842 +
843 +== Example code showing how to access HDF5 files ==
844 +
845 +\\
846 +
847 +=== Samples how to read HDF5 with Matlab ===
848 +
849 +The examples apply to HDF files with HDF tree version before vers. 0.3.0.
850 +
851 +(% 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
852 +
853 +(% 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
854 +
855 +(% style="color: rgb(0,128,0);" %)% read a Number per 10 Hz pulse train:
856 +
857 +(% class="code" %)
858 +(((
859 +FEL_Wavelength_energy_server=h5read(hdf5file,'/Photon Diagnostic/Wavelength/Calculated by energy/wavelength' );
860 +)))
861 +
862 +(% 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');
863 +
864 +(% 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)
865 +
866 +\\
867 +
868 +(% class="code" %)
869 +(((
870 +Start_event= 500 ; % define the first 10 Hz event
871 + Number_of_events = 20; % how many 10 Hz events to load
872 +)))
873 +
874 +(% style="color: rgb(0,128,0);" %)% read only part of the data:
875 +
876 +(% class="code" %)
877 +(((
878 +Gotthard_data=h5read(hdf5file,'/Experiment/Gotthard1/BL.0',[2 650 Start_event],[50 85 Number_of_events]);
879 +)))
880 +
881 +(% 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 ]
882 +
883 +(% class="code" %)
884 +(((
885 +VLS_Spectrum=h5read(hdf5file,'/Photon Diagnostic/Wavelength/VLS online spectrometer/PCO.ROI.X',[400 Start_event],[200 Number_of_events] );
886 +
887 +)))
888 +
889 +(% 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 ]
890 +
891 +(% style="color: rgb(0,128,0);" %)%GMD data
892 +
893 +(% class="code" %)
894 +(((
895 +GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA',[1 Start_event],[40 Number_of_events] );
896 +)))
897 +
898 +[[Contents>>doc:||anchor="Contents"]]
899 +
900 +=== How to read HDF5 with Python via FLASHH5 ===
901 +
902 +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.
903 +
904 +\\
905 +
906 +== HDF5 and DOOCS ==
907 +
908 +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
909 +
910 +[[Contents>>doc:||anchor="Contents"]]