Changes for page The FLASH HDF5 structure

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

From version 8.1
edited by sndueste
on 2019/09/16 11:56
Change comment: There is no comment for this version
To version 49.1
edited by sndueste
on 2021/02/17 16:29
Change comment: There is no comment for this version

Summary

Details

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