Wiki source code of The FLASH HDF5 structure

Version 90.1 by sndueste on 2025/04/24 13:27

Show last authors
1 {{layout}}
2 {{layout-section ac:type="single"}}
3 {{layout-cell}}
4 == Contents ==
5
6
7
8 {{toc/}}
9
10
11 == General information about HDF5 ==
12
13 HDF5 is a data format maintained by the HDF group. For detailed general information see [[here>>url:https://portal.hdfgroup.org/display/support||shape="rect"]]
14
15 To download the HDF5 Viewer click [[here>>url:https://portal.hdfgroup.org/display/support/Download+HDFView||shape="rect"]]
16
17 For use on the DESY Maxwell or PAL (max-fsc or pal) **hdfview** is available in the xray module :
18 {{code language="none"}}> module load xray{{/code}}
19 {{code language="none"}}> hdfview{{/code}}
20
21 or you can use
22
23 {{code language="none"}}
24 > silx view
25 {{/code}}
26
27
28 [[Contents>>doc:||anchor="Contents"]]
29
30 == The FLASH HDF5 format ==
31
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 gaps,  users have to decide how to treat missing values. DAQ channels are spread across various files with one file name pattern for each DAQ. This means users have to assemble data from different files if necessary.
33
34 The hierarchy is realized using a human readable named HDF tree with each DAQ channel containing the data sets "//value//" and "//index//". Additionally, the HDF group //zraw// contains a tree of the original DAQ channel names.
35
36 Reference implementation, which follows the concept of Python libraries like Pandas, Xarray, or Dask, is given below.
37
38 {{expand title="Discontinued HDF formats"}}
39 === Comparison to FLASH's deprecated HDF formats ===
40
41 Before 2021, FLASH provided two different HDF formats formally known as //near-online// and //offline// HDF files.
42
43 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.
44
45 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.
46
47 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.
48
49
50 **HDF5 example files (old format)**
51
52 Here we have a few HDF5 samples (User data combined with Photon diagnostics data) from a few beamtimes showing the different kind options.
53
54 [[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"]]
55
56
57 [[~[~[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"]]
58
59
60
61 {{/expand}}
62
63 === HDF examples: ===
64 {{/layout-cell}}
65 {{/layout-section}}
66
67 {{layout-section ac:type="three_equal"}}
68 {{layout-cell}}
69 * ADC data as example for **fast** **data** (10 Hz):            
70
71 [[image:attach:image2020-11-16_15-26-28.png||height="250"]]
72 {{/layout-cell}}
73
74 {{layout-cell}}
75 * The //average// FEL pulse energy as example for the **slow** **data**. Here the data is not saved with 10 Hz  - thus not for every FEL pulse train.  The data is typically saved with 1 Hz if the values are changing (like the FEL energy) and every about 20 sec if there is no change for longer time ( e.g. motor set values). Thus to use the data together with the "fast" one, one has to interpolate the data as explained in the examples in the repos below show (e.g. {{code language="none"}}df['GMD_T_average'] = df['GMD_T_average'].interpolate(method='linear'){{/code}})
76
77 ( as example only every 10th train ID is listed in the HDF group "index")
78
79 [[image:attach:image2020-11-16_15-31-45.png||height="250"]]
80 {{/layout-cell}}
81
82 {{layout-cell}}
83 * (((
84 //zraw// group contains the **original DAQ (DOOCS) names**
85 )))
86
87 of the properties saved in the DESY internal raw format. (For experts)
88
89
90 [[image:attach:image2020-11-16_16-26-3.png||height="400"]]
91 {{/layout-cell}}
92 {{/layout-section}}
93
94 {{layout-section ac:type="single"}}
95 {{layout-cell}}
96 {{info}}
97 === There are different options that help you to work with the FLASH HDF5 data in Python ===
98
99 * The currently developed option for large data sets: [[the FAB package>>url:https://hasfcpkg.desy.de/fab/fab.html||shape="rect"]] ... see below
100 * and for smaller projects:  (% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]
101
102 (% class="Object" %)See also the collection of Demo data and sample scripts : [[doc:FS-FLASH USER tmp.Data Acquisition and controls 1.DAQ and controls overview.Offline data analysis (DAQ).Collection of HDF5 sample data from different beamlines.WebHome]] and [[doc:FS-FLASH USER tmp.Data Acquisition and controls 1.DAQ and controls overview.Offline data analysis (DAQ).DEMO - Working with FLASH data.WebHome]]
103 {{/info}}
104 {{/layout-cell}}
105 {{/layout-section}}
106
107 {{layout-section ac:type="single"}}
108 {{layout-cell}}
109
110
111 == Complete list of recordable parameters ==
112
113 The complete list for the relation between DOOCS names and HDF5 names for the recordable parameters can be found in [[DESY's Repository>>url:https://stash.desy.de/projects/CS/repos/pah/browse/src/camp/data/channel2HdfName.dat||shape="rect"]].
114
115 == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
116
117 {{id name="DOOCSparameters"/}}
118
119 Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0.
120
121
122 === FLASH1 ===
123
124 ==== Beamline info (FLASH1) ====
125
126 {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}
127 //always saved (PBD)//
128 DOOCS prop : {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
129 DAQ channel: {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
130 desc: set pressure in the gas attenuator
131 units: mbar
132
133 {{code language="none"}}/FL1/Beamlines/BL/Fast shutter/open{{/code}}
134 //always saved (PBD)//
135 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER/CH00.TD{{/code}}
136 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER{{/code}}
137 desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
138 units: none
139
140 {{code language="none"}}/FL1/Beamlines/PG/Fast shutter/open{{/code}}
141 //always saved (PBD)//
142 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER/CH00.TD{{/code}}
143 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER{{/code}}
144 desc: PG Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
145 units: none
146
147 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 1{{/code}}
148 //always saved (PBD)//
149 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
150 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
151 desc: Position of the BL filter wheel 1 - to correlate with the filter material please look [[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
152 units: degree
153
154 {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 2{{/code}}
155 //always saved (PBD)//
156 DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
157 DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
158 desc: Position of the BL filter wheel 2 - to correlate with the filter material please look [[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
159 units: degree
160
161 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 1{{/code}}
162 //always saved (PBD)//
163 DOOCS prop : = TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS=
164 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}
165 desc: Position of the PG filter wheel 1
166 units: degree
167
168 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 2{{/code}}
169 //always saved (PBD)//
170 DOOCS prop : {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
171 DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
172 desc: Position of the PG filter wheel 2
173 units: degree
174
175 {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 3{{/code}}
176 //always saved (PBD)//
177 DOOCS prop : {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
178 DAQ channel: {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}
179 desc: Position of the PG filter wheel 3
180 units: degree
181
182
183
184 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
185
186 [[Contents>>doc:||anchor="Contents"]]
187
188
189 ==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====
190
191 {{expand title="Discontinued GMD format (used until 2021)"}}
192 (% style="color:#000000" %)**Discontinued GMD data recording / evaluation  (VME + PhotonFlux ML server)**
193
194 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
195 //always saved (PBD)//
196
197 (% style="color:#000000" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)
198 (% style="color:#000000" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)
199 desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator (ion current)
200 units : microJ
201
202 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
203 //always saved (PBD)//
204
205 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}
206 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}
207 desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL
208 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
209
210 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel (raw){{/code}}
211 //always saved (PBD)//
212 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT14/VAL{{/code}}
213 DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.FF{{/code}}
214 desc :Energy per pulse Tunnel (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
215 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
216
217 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}
218 //always saved (PBD)//
219
220 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}
221 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}
222 desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)
223 units : microJ
224
225 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}
226 //always saved (PBD)//
227
228 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}
229 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}
230 desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL
231 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
232
233 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA (raw){{/code}}
234 //always saved (PBD)//
235 DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT15/VAL{{/code}}
236 DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}
237 desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
238 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
239 {{/expand}}
240
241
242 (% style="color:#000000; letter-spacing:0px" %)**NEW (since 2021) GMD data recording / evaluation  (same format as FLASH2 and XFEL)**
243
244 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
245 //always saved (PBD)//
246 (% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
247 (% style="color:#000000" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
248
249 desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator
250 units : microJ
251
252
253 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
254 //always saved (PBD)//
255
256 (% style="color:#000000" %)DOOCS prop : 
257 {{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}}
258
259 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)
260 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
261
262 {{info title="GMD pulse resolved data structure"}}
263 For every pulse in the pulse train the information is saved:
264
265 1. **Intensity per pulse** (a.u. (more or less µJ ))
266 1. Intensity per pulse (auxillary GMD) - not used
267 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
268 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
269 1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color:#000000" %)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)(%%))
270 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
271 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
272 1. Combined warning and error flags
273
274 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
275 file
276
277
278 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
279
280
281 {{/info}}
282
283 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 !
284
285
286 Besides  pulse energy the GMD also provides information about the beam position
287
288 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}
289 //always saved (PBD)//
290 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
291 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}
292 desc :Beam position of the photon Beam determined by the GMD (BDA, x=horizontal)
293 units : mm
294
295 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical{{/code}}
296 //always saved (PBD)//
297 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
298 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}
299 desc :Beam position of the photon Beam determined by the GMD (BDA, y=vertical)
300 units : mm
301
302 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal{{/code}}
303 //always saved (PBD)//
304 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
305 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}
306 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, x=horizontal)
307 units : mm
308
309 {{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical{{/code}}
310 //always saved (PBD)//
311 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
312 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}
313 desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)
314 units : mm
315
316
317 ==== Spectrometer (FLASH1) ====
318
319 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}
320 _always saved (when Spectrum is measured !!) (PBD) _
321 DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}
322 DAQ channel: {{code language="none"}}PBD.PHOTONWL.ML/WAVE_LENGTH{{/code}}
323 desc : XUV Spectrum measured with the "tunnel spectrometer"
324 units :
325
326 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength start value{{/code}}
327 _always saved (when Spectrum is measured !!) (PBD) _
328 DOOCS prop : {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
329 DAQ channel: {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}
330 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
331 units : nm
332
333 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength increment{{/code}}
334 _always saved (when Spectrum is measured !!) (PBD) _
335 DOOCS prop : ==
336 DAQ channel: ==
337 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"
338 units : nm
339
340 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy{{/code}}
341 //saved on DEMAND (PBD spectrometer stream)//
342 DOOCS prop : ==
343 DAQ channel: {{code language="none"}}PBD.PHOTONEN.ML/PHOTON_ENERGY{{/code}}
344 desc : XUV Spectrum in eV measured with the "PG2 spectrometer"
345 units :
346
347 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy start value{{/code}}
348 //saved on DEMAND (PBD spectrometer stream)//
349 DOOCS prop : ==
350 DAQ channel: ==
351 desc : start value (in eV) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
352 units : eV
353
354 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy increment{{/code}}
355 //saved on DEMAND (PBD spectrometer stream)//
356 DOOCS prop : ==
357 DAQ channel: ==
358 desc : increment value (in eV) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
359 units : eV
360
361 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength{{/code}}
362 //saved on DEMAND (PBD spectrometer stream)//
363 DOOCS prop : ==
364 DAQ channel: {{code language="none"}}PHOTONEN.ML/PHOTON_WAVE_LEN{{/code}}
365 desc : XUV Spectrum in nm measured with the "PG2 spectrometer"
366 units :
367
368 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength increment{{/code}}
369 //saved on DEMAND (PBD spectrometer stream)//
370 DOOCS prop : ==
371 DAQ channel: ==
372 desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"
373 units : nm
374
375 {{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength start value{{/code}}
376 //saved on DEMAND (PBD spectrometer stream)//
377 DOOCS prop : ==
378 DAQ channel: ==
379 desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"
380 units : nm
381
382 [[Contents>>doc:||anchor="Contents"]]
383
384 ==== Electron Beam properties (FLASH1) ====
385
386 ===== bunch charge =====
387
388 {{code language="none"}}/FL1/Electron Diagnostic/Bunch charge/after undulator{{/code}}
389 //always saved (PBD)//
390 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/CHARGE.FLASH1{{/code}}
391 DAQ channel: {{code language="none"}}FLASH.DIAG/TOROID/12EXP{{/code}}
392 desc: electron bunch charge (FLASH1)
393 units: nC
394
395 =====
396 arrival time (BAM) =====
397
398 {{info title="BAM information: updates 2022 (status 2025)"}}
399 * see: [[Info collection about the BAMs and how to use the BAM data>>doc:FS-FLASH USER tmp.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]
400 * The data format of the BAM has been completely altered in the 2022 shutdown
401 * before 2022 BAMs were always saving the arrival time information for each 1µs bucked regardless if there were electrons in the accelerator or not. IN addition the arrival times for  FL1 and FL2 were saved in the same parameter ...
402 * THIS is now different. There are new parameters saving only the arrival times for pulses that go to FL1 and to FL2 (in detail: first time slot of the accelerator and second)
403 * There has been also a renaming  (and relocation) of the BAMs.
404 ** acc:  4DBC3 → FL0.DBC2
405 ** FL1: 1SFELC →  FL1.SFELC
406 ** FL2: FL2XTDS → (% style="color:#172b4d" %)FL2.SEED5
407 * for more Info: [[LINK to detailed infos from MSK>>doc:SDiag.How-to articles.BAM Data Structure.WebHome||shape="rect"]]
408 * [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]
409 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
410 {{/info}}
411
412 {{expand title="Discontinued BAM format (used until end 2021)"}}
413 (% style="color:#000000" %)**Discontinued BAM data recording **
414
415 {{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
416 //always saved (PBD)//
417 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
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)
421
422
423 {{code language="none"}}/FL1/Electron Diagnostic/BAM/1SFELC/electron bunch arrival time (low charge){{/code}}
424 //always saved (PBD)//
425 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/1SFELC/LOW_CHARGE_ARRIVAL_TIME{{/code}}
426 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/1SFELC.LOW_CHARGE_ARRIVAL_TIME{{/code}}
427 desc: Electron bunch arrival time measured with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.
428 units: ps (bigger numbers indicate later arrival time of the electrons)
429 {{/expand}}
430
431 ====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======
432
433 (% style="color:#ff6600" %)**DBC2**/electron bunch arrival time  (HDF5 name not yet implemented - see zraw)(%%)
434 //always saved (PBD)//
435 {{code language="none"}}/FL1/Electron Diagnostic/BAM/ {{/code}}DOOCS prop : FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
436 DAQ (% style="color:#000000" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP (%%)
437 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). The property contains only the arrival time of the bunches sent to FL1 (e.g. if there are 30 bunches in FL1 the first 30 values are the arrival time the remaining numbers  still may have arbitrary numbers looking like a signal which they are not ). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
438
439 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
440
441
442 (% style="color:#ff6600" %)DBC2/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
443 //always saved (PBD)//
444 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE
445 DAQ channel: (% style="color:#000000" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE (%%)
446 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 1 in the first part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
447 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
448
449
450 (% style="color:#ff6600" %)DBC2/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
451 //always saved (PBD)//
452 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color:#000000" %)E.bamError.1(%%)
453 DAQ channel: (% style="color:#000000" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR.1(%%)
454 desc:(% style="letter-spacing:0.0px" %) status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
455
456
457 (% style="color:#ff6600" %)DBC2/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
458 //always saved (PBD)//
459 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color:#000000" %)E..bamStatus.//1//(%%)
460 DAQ channel(% style="color:#000000" %): FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.1(%%)
461 desc: (% style="letter-spacing:0.0px" %) status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
462
463
464 ====== **BAM FL1.SFELC**{{code language="none"}}{{/code}} ======
465
466 (% style="font-family:SFMono-Medium,~"SF Mono~",~"Segoe UI Mono~",~"Roboto Mono~",~"Ubuntu Mono~",Menlo,Courier,monospace; letter-spacing:0.0px" %)/FL1/Electron Diagnostic/BAM/**SFELC**(% style="color:#ff6600" %)/electron bunch arrival time  (HDF5 name not yet implemented - see zraw)
467
468 //always saved (PBD)//
469 (% style="color:#172b4d" %)**FL1.SFELC**(%%)
470 (% style="color:#000000" %)channel: FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
471 {{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ {{/code}}(% style="letter-spacing:0.0px" %)desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.. The property contains only the arrival time of the bunches sent to FL1 (e.g. if there are 30 bunches in FL1 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
472 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
473
474
475
476 (% style="color:#172b4d" %)SFELC(% style="color:#ff6600" %)/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
477 //always saved (PBD)//
478 DOOCS prop : FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(%%)/ARRIVAL_TIME.ABSOLUTE
479 DAQ channel:** **(% style="color:#000000" %)FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.ABSOLUTE (%%)
480 desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020. Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 1 in the first part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
481 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
482
483
484 (% style="color:#172b4d" %)SFELC(% style="color:#ff6600" %)/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
485 //always saved (PBD)//
486 DOOCS prop : FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color:#000000" %)E.bamError(%%)
487 DAQ channel(% style="color:#000000" %): FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMERROR(%%)
488 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
489
490
491 (% style="color:#172b4d" %)SFELC(% style="color:#ff6600" %)/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
492 //always saved (PBD)//
493 DOOCS prop : FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color:#000000" %)E..bamStatus.//1//(%%)
494 DAQ chann(% style="color:#000000" %)el: FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMSTATUS.1(%%)
495 desc: status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
496
497
498
499 ===== electron beam profile =====
500
501 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}
502 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
503 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/OUT.PROF.CCCED{{/code}}
504 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}
505 desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)
506 units: pixel
507
508 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}
509 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
510 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/CALIB.CONST.T{{/code}}
511 DAQ channel: = PBD.BEAM.PROF.ML/CCT=
512 desc: TDS calibration constant for the x-axis of the profiles: fs per pixel
513 units: fs per pixel
514
515 {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}
516 //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
517 DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/SOWS.W.CCTED{{/code}}
518 DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}
519 desc: rms pulse width of the measures TDS electron bunch profile
520 units: fs
521
522 ===== electron bunch energy =====
523
524 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}
525 //always saved (PBD)//
526 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
527 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
528 desc: electron bunch energy (average over the bunch train)
529 units: (% class="twikiNewLink" %)MeV
530
531 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
532 //always saved (PBD)//
533 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}
534 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}
535 desc: electron bunch energy bunch resolved
536 units: (% class="twikiNewLink" %)MeV
537
538
539 {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}
540 //always saved (PBD)//
541 DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}
542 DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
543 desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
544 units: nm
545
546 [[Contents>>doc:||anchor="Contents"]]
547
548
549 ==== Timing information, rep rate etc.  (FLASH1) ====
550
551 ===== bunch repetition rate =====
552
553 {{code language="none"}}/FL1/Timing/repetition rate{{/code}}
554 //always saved (PBD)//
555 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
556 DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
557 desc: repetition rate of the bunches / pulses within the burst (FLASH1)
558 units: kHz
559
560 ===== set number of pulses =====
561
562 (% style="color:#ff6600" %)(HDF5 name not yet implemented - see zraw)(% style="color:#ff0000" %){{code language="none"}}/FL1/Timing/set number of bunches {{/code}}(%%)
563 //always saved (PBD)//
564 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}
565 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}
566 desc: Number of bunches set in the control (timing) system.  The property contains 4 numbers. the last one is the number of pulses (see also [[doc:FLASH.Timing properties]] (internal link)).  If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated and thus the actual number of pulses may be smaller than the set one 
567 units:
568
569 ===== actual number of pulses =====
570
571 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
572 //always saved (PBD)//
573 DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/NUMBEROFBUNCHES.FLASH1{{/code}}
574 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
575 desc: Number of bunches measured BEHIND the undulator. If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated this is the actual number that created XUV radiation.The number is calculated by the DAQ middle layer server, (FLASH1)
576 units:
577
578 ===== actual pulse pattern recorded after the undulator =====
579
580 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
581 //always saved (PBD)//
582 DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}
583 DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
584 desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)
585 units:
586
587 ===== Train ID =====
588
589 {{code language="none"}}/Timing/train ID{{/code}}
590 //always saved (PBD)//
591 DOOCS prop : {{code language="none"}}none{{/code}}
592 DAQ channel: {{code language="none"}}none{{/code}}
593 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 !)
594 units:
595
596 ===== (% style="color:#e67e22" %)Train time(%%) =====
597
598 (% style="color:#e67e22" %){{code language="none"}}/Timing/train time{{/code}}
599 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
600 units: d h min s cs
601
602 (% style="color:#e67e22" %){{code language="none"}}/Timing/time stamp{{/code}}
603 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
604 second column: microseconds
605 third column: Train ID of FLASH
606
607 currently it is saved as Unix time in
608
609 |(((
610 /zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time
611
612 {{expand title="Timestamp help for python" expanded="false"}}
613 import time
614
615 # epoch time is found in /zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time #!!! a leading 1 has to be added !!!
616 # The time and date of the start of the data taking in the HDF file is encoded in the filename - to roughly check the time
617 epoch_time = 1709051499.17 # Replace with your epoch time
618
619 formatted_time = time.strftime('%Y-%m-%d %H:%M:%S', time.gmtime(epoch_time))
620 print(formatted_time)
621 {{/expand}}
622
623
624 )))
625
626 [[Contents>>doc:||anchor="Contents"]]
627
628
629 ==== Pump Probe Laser (FLASH1) ====
630
631 **PIGLET (PG laser)**
632
633 **{{code language="none"}}/FL1/Experiment/Pump probe laser{{/code}}**
634
635 {{info width="30%"}}
636 list of saved parameters status May 2024 (up to now the parameters can be found in /zraw/ ... )
637
638 Download the PDF:
639
640 {{view-file att--filename="FSLADAQ-DAQParameterlistPiGLET.pdf"}}{{/view-file}}
641
642
643
644 {{/info}}
645
646 {{expand title="Parameters used until 2021"}}
647 {{code language="none"}}
648 /FL1/Experiment/Pump probe laser/laser attenuation
649 {{/code}}
650
651 //always saved (PBD)//
652 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
653 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}
654 desc: attenuation of the PPLaser (rotation of a waveplate)
655 units : 0 no transmission , 1: full transmission
656
657
658 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}
659 //always saved (PBD)//
660 DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
661 DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}
662 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
663 units : ps ( pos delay means IR comes later)
664
665
666 {{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}
667 //always saved (PBD)//
668 DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}
669 DAQ channel: {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0:ENC.DELAY{{/code}}
670 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
671 units : ps ( pos delay means IR comes later)
672
673
674 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}
675 //always saved (PBD)//
676 DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
677 DAQ channel: {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}
678 desc: rms jitter of the GECCO (% class="twikiNewLink" %)TiSa(%%) Oscillator units: fs
679
680
681 {{code language="none"}}/FL1/Experiment/Pump probe laser/streak camera delay time{{/code}}
682 //always saved (PBD)//
683 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
684 DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
685 desc: delay time between the optical laser and the FEL units: ps
686 {{/expand}}
687
688
689 [[Contents>>doc:||anchor="Contents"]]
690
691
692 ==== User Data (FLASH1) ====
693
694 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 of slow properties (motor positions etc) for user experiments. For details please ask your local contact.
695
696 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
697
698 The most common and permanently installed device used by experiment are our ADCs:
699
700 ===== GHz ADCs =====
701
702 ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FS-FLASH USER tmp.Data Acquisition and controls 1.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**
703 //saved on DEMAND in the user DAQ//
704 \\The HDF5 names for the ADC traces are depending on the beamline :
705 \\PG Beamline:
706 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH00/TD{{/code}}
707 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH01/TD{{/code}}
708 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH02/TD{{/code}}
709 {{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH03/TD{{/code}}
710
711 BL Beamlines:
712 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH00/TD{{/code}}
713 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH01/TD{{/code}}
714 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH02/TD{{/code}}
715 {{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH03/TD{{/code}}
716 \\{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH00/TD{{/code}}
717 {{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH01/TD{{/code}}
718 \\{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH02/TD{{/code}}
719 {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}
720
721 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
722 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}} contains only the grouped spectra. To read the ADC trace with an online analysis program the {{code language="none"}}CH00.DAQ.TD{{/code}} is used preferably.
723 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
724
725 In addition there are also additional parameters saved like:
726
727 * {{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.
728 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
729 * {{code language="none"}}error (ADC):{{/code}}0 indicates that there was no error
730
731 ===== MHz ADCs =====
732
733 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
734 {{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}
735 DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD
736 DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02
737
738 In addition there are also additional parameters saved like:
739
740 * {{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.
741 * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
742
743 [[Contents>>doc:||anchor="Contents"]]
744
745
746
747
748 === FLASH2 ===
749
750 There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
751
752 ==== Beamline info (FLASH2) ====
753
754 {{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
755 (% style="color:#000000" %)//always saved (PBD2)// (%%)
756 (% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
757 (% style="color:#000000" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
758 (% style="color:#000000" %)desc: set pressure in the gas attenuator (%%)
759 (% style="color:#000000" %)units: mbar
760
761 {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
762 //always saved (PBD2)//
763 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
764 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
765 desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
766 units: none
767
768
769 {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
770 //always saved (PBD2)//
771 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
772 DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
773 desc: Position of the BL filter wheel 1 - to correlate with the filter material please look **[[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**
774 units: degree
775
776 /FL2/Beamlines/Filter wheel/position wheel 2
777 always saved (PBD2)
778 DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
779 DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
780 desc: Position of the BL filter wheel 2 - to correlate with the filter material please look [[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]
781 units: degree
782
783
784 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
785
786 [[Contents>>doc:||anchor="Contents"]]
787
788
789
790 ==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
791
792 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
793 //always saved (PBD2)//
794 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
795 DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
796 desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
797 units : microJ
798
799
800 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
801 //always saved (PBD2)//
802 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
803 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
804 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)
805 units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**
806
807 {{info title="GMD pulse resolved data structure"}}
808 For every pulse in the pulse train the information is saved:
809
810 1. **Intensity per pulse** (a.u. (more or less µJ ))
811 1. Intensity per pulse (auxillary GMD) - not used
812 1. Position horizontal (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
813 1. Position vertical (mm, for a single pulse the position information may be very noisy  - talk to your local contact)
814 1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color:#000000" %)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)(%%))
815 1. Position horizontal sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
816 1. Position vertical sigma  (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)
817 1. Combined warning and error flags
818
819 The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this 
820 file
821
822
823 [[image:attach:image2021-2-9_10-51-6.png||height="250"]]
824
825
826 {{/info}}
827
828
829 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 !
830
831
832 Besides  pulse energy the GMD also provides information about the beam position
833
834
835 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
836 //always saved (PBD2)//
837 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
838 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
839 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
840 units : mm
841
842
843 {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
844 //always saved (PBD2)//
845 DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
846 DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
847 desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
848 units : mm
849
850
851 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
852 always saved (PBD2)
853 DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
854 DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
855 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 ...)
856 units : mm   
857
858 (x=horizontal, y = vertial)
859
860 again the same parameter set is available for the **HALL GMD**
861
862
863
864 ==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====
865
866 for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**
867
868 (The OPIS hall is not installed yet ...)
869
870
871 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
872 // saved opon request (PBD2)//
873 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
874 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
875 desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
876 units : eV
877
878
879 {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
880 // saved opon request (PBD2)//
881 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
882 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
883 desc : mean wavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
884 units : nm
885
886
887 {{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}}
888 // saved opon request (PBD2)//
889 DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
890 DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
891 desc : The bunch number of the bunch used for the wavelength calculation
892 units :
893
894
895 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 saving the complete ADC trace of the TOF setup. This is a huge amount of data and needs processing. This has to be performed after the beamtime in close contact to [[Markus Braune>>mailto:markus.braune@desy.de||shape="rect"]] ( responsible for [[OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]])
896
897
898 In case OPIS was not operating there is still information 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 ...
899
900
901
902 ==== Electron Beam properties (FLASH2) ====
903
904 ===== bunch charge =====
905
906 {{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
907 //always saved (PBD2)//
908 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
909 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
910 desc: electron bunch charge FLASH2 (average value for each bunchtrain).
911 units: nC
912
913
914 ===== electron bunch energy =====
915
916 {{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}}
917 //always saved (PBD2)//
918 DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}}
919 DAQ channel: (% style="color:#5e6c84" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%)
920 desc: electron bunch energy measured behind the undulator. Data is saved with 10 Hz - BUT (for computation reasons) only the energy of the FIRST bunch is recorded. The data is also available for (% style="color:#5e6c84" %)extraction and septum  in the beginning of FLASH2
921
922 (% style="letter-spacing:0.0px" %)units: (% class="twikiNewLink" %)MeV
923
924
925 (% style="color: rgb(94, 108, 132); font-weight: 600; letter-spacing: 0px;" %)
926 ===== undulator settings =====
927
928 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
929 //always saved (PBD2)//
930 DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
931 DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
932 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 % ...
933 units: nm
934
935 {{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
936 //always saved (PBD2)//
937 DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
938 DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
939 desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
940 units: mm
941
942 The gap values are saved for all 12 undulators (Nr 3 to 14). Undulator 14 is the one closest to the experimental hall.
943
944 =====
945 arrival time (BAM) =====
946
947 {{info title="BAM information: updates 2022 (status 2025)"}}
948 * see: [[Info collection about the BAMs and how to use the BAM data>>doc:FS-FLASH USER tmp.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]
949 * The data format of the BAM has been completely altered in the 2022 shutdown
950 * before 2022 BAMs were always saving the arrival time information for each 1µs bucked regardless if there were electrons in the accelerator or not. IN addition the arrival times for  FL1 and FL2 were saved in the same parameter ...
951 * THIS is now different. There are new parameters saving only the arrival times for pulses that go to FL1 and to FL2 (in detail: first time slot of the accelerator and second)
952 * There has been also a renaming  (and relocation) of the BAMs.
953 ** acc:  4DBC3 → FL0.DBC2
954 ** FL1: 1SFELC →  FL1.SFELC
955 ** FL2: FL2XTDS → (% style="color:#172b4d" %)FL2.SEED5
956 * for more Info: [[LINK to detailed infos from MSK>>doc:SDiag.How-to articles.BAM Data Structure.WebHome||shape="rect"]]
957 * [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]
958 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
959 {{/info}}
960
961 {{expand title="Discontinued BAM format (used until end 2021)"}}
962 (% style="color:#000000" %)**Discontinued BAM data recording **
963
964 {{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}
965 //always saved (PBD2)//
966 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}
967 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/8FL2XTDS.LOW_CHARGE_ARRIVAL_TIME{{/code}}
968 desc: Electron bunch arrival time measured with the BAM after the FLASH2 undulator (pulse resolved data)
969 units: ps (bigger numbers indicate later arrivaltime of the electrons)
970
971 **FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
972 //always saved (PBD2)//
973 DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
974 DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}
975 desc: Electron bunch arrival time measured with the BAM  in the accelerator  (pulse resolved data)
976 units: ps (bigger numbers indicate later arrivaltime of the electrons)
977
978 {{info title="BAM hints"}}
979 * The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).
980 * 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 
981 ** 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
982 * [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments >>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]
983 * [[LINK to detailed infos from MSK (may only work inside DESY network~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|height="12" width="13"~]~]>>url:http://www.desy.de/~~mbock/pages/BAM_daq_channel_descriptions.html||shape="rect"]]
984 * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
985 {{/info}}
986 {{/expand}}
987
988
989 ====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======
990
991 (% style="color:#ff6600" %)**DBC2**/electron bunch arrival time  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}
992
993 {{code language="none"}}
994 /zraw/FLASH.SDIAG/BAM.DAQ/FL0.DBC2.ARRIVAL_TIME.ABSOLUTE.SA2.COMP/dGroup/
995 {{/code}}
996
997 //always saved (PBD)//
998 **FL0.DBC2**
999 (% style="color:#000000" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA2.COMP
1000 {{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA2.COMPDAQ {{/code}}(% style="letter-spacing:0.0px" %)desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). The property contains only the arrival time of the bunches sent to FL2 (e.g. if there are 30 bunches in FL2 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not0). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
1001 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1002
1003
1004 (% style="color:#ff6600" %)DBC2/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}
1005
1006 {{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.DBC2.ARRIVAL_TIME.ABSOLUTE.SA2/dGroup/{{/code}}
1007 //always saved (PBD)//
1008 {{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE{{/code}}
1009 (% style="color:#000000" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel: {{/code}}(%%)
1010 desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 2 in the second part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
1011 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1012
1013
1014 DBC2/error (% style="color:#f39c12" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/
1015 //always saved (PBD)//
1016 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.bamError.2
1017 DAQ channel: FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR.2
1018 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1019
1020 DBC2/status  (% style="color:#e67e22" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/
1021 //always saved (PBD)//
1022 DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.bamStatus.//2//
1023 DAQ channel: FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.2
1024 desc:  status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
1025
1026
1027
1028 ====== **BAM FL2.SEED5**{{code language="none"}}{{/code}} ======
1029
1030 /FL2/Electron Diagnostic/BAM/**SEED5**(% style="color:#ff6600" %)/electron bunch arrival time  (HDF5 name not yet implemented - see zraw)
1031
1032 (% style="color:#000000" %){{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.SEED5.ARRIVAL_TIME.ABSOLUTE.SA2.COMP/dGroup/{{/code}}
1033
1034 //always saved (PBD)//
1035 (% style="color:#172b4d" %)**FL2.SEED5**(%%)
1036 (% style="color:#000000" %)channel: FLASH.SDIAG/BAM/(% style="color:#172b4d" %)**FL2.SEED5**(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
1037 {{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ {{/code}}(%%)desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.. The property contains only the arrival time of the bunches sent to FL2 (e.g. if there are 30 bunches in FL2 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
1038 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1039
1040
1041
1042 (% style="color:#172b4d" %)SEED5(% style="color:#ff6600" %)/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}
1043
1044 (% style="color:#000000" %){{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.SEED5.ARRIVAL_TIME.ABSOLUTE.SA2/dGroup/{{/code}}(%%)
1045 //always saved (PBD)//
1046 (% style="color:#172b4d" %)**FL2.SEED5**{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE{{/code}}(%%)
1047 **~ **(% style="color:#000000" %)FLASH.SDIAG/BAM/(% style="color:#172b4d" %)**FL2.SEED5**(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel:{{/code}}(%%)
1048 desc: Electron bunch arrival time measured  with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020. Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 2 in the second part. they may be separated by several "0" values if the reprate is different from 1 MHz ...  - It shows a very good correlation to the arrival time  of the XUV pulses in the experiment (see help). 
1049 units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
1050
1051
1052 FL2.SEED5/error (% style="color:#f39c12" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/
1053 //always saved (PBD)//
1054 DOOCS prop : FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.bamError.2
1055 DAQ channel: FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.BAMERROR.2
1056 desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
1057
1058 FL2.SEED5/status  (% style="color:#e67e22" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/
1059 //always saved (PBD)//
1060 DOOCS prop : FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.bamStatus.//2//
1061 DAQ channel: FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.BAMSTATUS.2
1062 desc:  status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting;  mostly check for bit 0 == 1 is sufficient
1063
1064
1065 [[Contents>>doc:||anchor="Contents"]]
1066
1067
1068 ==== Timing information, rep rate etc.  (FLASH2) ====
1069
1070 ===== start time of FLASH2 =====
1071
1072 {{code language="none"}}/FL2/Timing/start time flash2{{/code}}
1073 //always saved (PBD2)//
1074 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1075 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}
1076 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 ...)
1077 units: µs
1078
1079 ===== bunch repetition rate =====
1080
1081 {{code language="none"}}/FL2/Timing/repetition rate{{/code}}
1082 //always saved (PBD2)//
1083 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1084 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}
1085 desc: repetition rate of the bunches / pulses within the burst (FLASH2)
1086 units: kHz
1087
1088
1089 ===== set number of pulses =====
1090
1091 (% style="color:#ff6600" %)(HDF5 name not yet implemented - see zraw)(% style="color:#ff0000" %){{code language="none"}}/FL2/Timing/set number of bunches {{/code}}(%%)
1092 //always saved (PBD2)//
1093 DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.2 [4th number]{{/code}}
1094 DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.2 [4th number]{{/code}}
1095 desc: Number of bunches set in the control (timing) system.  The property contains 4 numbers. the last one is the number of pulses (see also [[doc:FLASH.Timing properties]] (internal link)).  If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated and thus the actual number of pulses may be smaller than the set one 
1096 units:
1097
1098 ===== actual number of pulses =====
1099
1100 {{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}
1101 //always saved (PBD2)//
1102 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1103 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1104 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)
1105 units:
1106
1107 ===== actual pulse pattern recorded after the undulator =====
1108
1109 {{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}
1110 //always saved (PBD2)//
1111 DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1112 DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1113 desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
1114 units:
1115
1116 ===== Train ID =====
1117
1118 {{code language="none"}}/Timing/train ID{{/code}}
1119 //always saved (PBD2)//
1120 DOOCS prop : {{code language="none"}}none{{/code}}
1121 DAQ channel: {{code language="none"}}none{{/code}}
1122 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 !)
1123 units:
1124
1125 ===== Train time =====
1126
1127 //always saved (PBD2)//
1128 {{code language="none"}}/Timing/train time{{/code}}
1129 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
1130 units: d h min s cs
1131
1132 {{code language="none"}}
1133 /Timing/time stamp
1134 {{/code}}
1135
1136 //always saved (PBD2)//
1137 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
1138 second column: microseconds
1139 third column: Train ID of FLASH
1140
1141 [[Contents>>doc:||anchor="Contents"]]
1142
1143
1144 ==== User Data (FLASH2) ====
1145
1146 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.
1147
1148 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
1149
1150 The most common and permanently installed device used by experiment are our ADCs:
1151
1152 ===== GHz ADCs =====
1153
1154 ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FS-FLASH USER tmp.Data Acquisition and controls 1.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**
1155 //saved on DEMAND in the user DAQ//
1156 \\Up to now there are 4 channels available at FL24
1157 \\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}
1158 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}
1159 \\{{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}}
1160
1161
1162 DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
1163 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.
1164 DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}
1165
1166 In addition there are also additional parameters saved like:
1167
1168 * {{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.
1169 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1170 * {{code language="none"}}error (ADC):{{/code}}0 indicates that there was no error
1171 * {{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.
1172
1173 ===== MHz ADCs =====
1174
1175 similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:
1176 {{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}
1177 DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD
1178 DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02
1179
1180 In addition there are also additional parameters saved like:
1181
1182 * {{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.
1183 * {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
1184
1185 [[Contents>>doc:||anchor="Contents"]]
1186
1187
1188
1189 ==== Pump Probe Laser (FLASH2) ====
1190
1191 {{info width="30%"}}
1192 list of saved parameters status May 2024 (up to now the parameters can be found in /zraw/ ... )
1193
1194 [[attach:FSLADAQ-DAQParameterlistULGAN-2.pdf||target="_blank"]]
1195
1196 [[attach:FSLADAQ-DAQParameterlistFL23-2.pdf||target="_blank"]]
1197
1198 [[attach:FSLADAQ-DAQParameterlistFL24-2.pdf||target="_blank"]]
1199
1200
1201 {{view-file att--filename="FSLADAQ-DAQParameterlistFL23-2.pdf"}}{{/view-file}}
1202
1203
1204 {{view-file att--filename="FSLADAQ-DAQParameterlistFL23-2.pdf"}}{{/view-file}}
1205
1206
1207 {{view-file att--filename="FSLADAQ-DAQParameterlistFL24-2.pdf"}}{{/view-file}}
1208
1209
1210 {{/info}}
1211
1212 {{expand title="Laser parameters used until 2023"}}
1213 These are the parameters that can be saved in the FL2 User DAQ for the FL2 PP laser//** FOR BEAMLINE FL24**//
1214
1215 **User delay**
1216
1217 Delay (set value):
1218
1219 {{code language="none"}}
1220 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR
1221 {{/code}}
1222
1223 Delay (readback):
1224
1225 {{code language="none"}}
1226 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD
1227 {{/code}}
1228
1229 (% style="letter-spacing:0.0px" %)Delay (encoder readback):
1230
1231 {{code language="none"}}
1232 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.ENCODER_POSITION.RD
1233 {{/code}}
1234
1235 OXC. jitter:
1236
1237 {{code language="none"}}
1238 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD
1239 {{/code}}
1240
1241
1242
1243 **FL24 Pulse resolved energy:**
1244
1245 OPCPA output (photodiode signal raw ADC trace 16000 samples):
1246
1247 {{code language="none"}}
1248 /zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH23.TD/dGroup
1249 {{/code}}
1250
1251 (% style="letter-spacing:0.0px" %)Upper breadboard Photodiode (THG) burst (photodiode signal raw ADC trace 16000 samples)::
1252
1253 {{code language="none"}}
1254 /zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH26.TD/dGroup
1255 {{/code}}
1256
1257 Upper breadboard Photodiode (THG) energy (analyzed signal. integration over pulses in the ADC trace. contains for each laser pulse the pulse energy in a.u.)
1258
1259 {{code language="none"}}
1260 /zraw/FLASH.LASER/MOD24.PES/FL24_userPD/dGroup
1261 {{/code}}
1262
1263
1264 **FL24 LAM (Laser Arrivaltime Monitor)  pulse resolved data:**
1265
1266 Signal of Photodiode1  - for experts only... (analyzed signal. integration over pulses in the ADC trace. )
1267
1268 {{code language="none"}}
1269 /zraw/FLASH.LASER/MOD24.PES/LAM.PD1/dGroup
1270 {{/code}}
1271
1272 Signal of Photodiode2  - for experts only...  (analyzed signal. integration over pulses in the ADC trace.)
1273
1274 {{code language="none"}}
1275 /zraw/FLASH.LASER/MOD24.PES/LAM.PD2/dGroup
1276 {{/code}}
1277
1278 "Actual" LAM Signal - to be calibrated ......  (analyzed signal. integration over pulses in the ADC trace.)
1279
1280 {{code language="none"}}
1281 /zraw/FLASH.LASER/MOD24.PES/LAM.PDBAL/dGroup
1282 {{/code}}
1283
1284 The delay feedback(% style="letter-spacing:0.0px" %)
1285
1286 {{code language="none"}}
1287 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26 
1288 {{/code}}
1289
1290 The LAM delay feedback(% style="letter-spacing:0.0px" %) (the pulse energy signal, which is saved in the above but maybe it’s good to have this also as slow, in the case these two numbers are not the same the sysdc was active instead of the LAM):
1291
1292 {{code language="none"}}
1293 FLASH.LASER/MOD24.PES/LAM.PDBAL/PULSEENERGY.MEAN
1294 {{/code}}
1295
1296 LAM Delay line act:
1297
1298 {{code language="none"}}FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.1.POSITION.RD{{/code}}
1299 LAM Delay line set:
1300
1301 {{code language="none"}}
1302 FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.1.POSITION_SET.WR
1303 {{/code}}
1304
1305 LAM Delay line encoder:
1306
1307 {{code language="none"}}
1308 FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.1.ENCODER_POSITION.RD
1309 {{/code}}
1310
1311 Temperature feedback:
1312
1313 {{code language="none"}}
1314 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE24
1315 {{/code}}
1316
1317 **Feedback mode** (if this is not =1 the delay FB is not active, then it’s either temp feedback controlled or failsave, maybe it’s good to have):
1318
1319 {{code language="none"}}
1320 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.INTS/INTEGER30
1321 {{/code}}
1322
1323
1324 **FL24 Attenuator angle:**
1325
1326 {{code language="none"}}
1327 FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS
1328 {{/code}}
1329
1330 **FL24 Polarization control:**
1331
1332 {{code language="none"}}
1333 FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS
1334 {{/code}}
1335
1336 **SysDC delay error:**
1337
1338 {{code language="none"}}
1339 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26
1340 {{/code}}
1341
1342
1343 **Timing error: (these two need to be observed and both=0 means no error)**
1344
1345 {{code language="none"}}
1346 FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm
1347 {{/code}}
1348
1349 {{code language="none"}}
1350 FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN
1351 {{/code}}
1352
1353 **Laser error status:**
1354
1355
1356 **FL24 Virtual camera X and Y history, beam size: (use slow data)**
1357
1358 {{code language="none"}}
1359 FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.X
1360 {{/code}}
1361
1362 {{code language="none"}}
1363 FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.Y
1364 {{/code}}
1365
1366 {{code language="none"}}
1367 FLASH.LASER/MOD24.CAM/UV.14.VF/ROI_SPECTRUM.X.SIG
1368 {{/code}}
1369
1370 {{expand title="Parameters used until 2021"}}
1371 //{{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}always saved (PBD2)//
1372 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1373 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
1374 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1375 units : deg.
1376
1377
1378
1379 //{{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}always saved (PBD2)//
1380 DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1381 DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}
1382 desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)
1383 units : deg.
1384
1385
1386 {{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}
1387 //always saved (PBD2)//
1388 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1389 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}
1390 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)
1391 units : ps )
1392
1393
1394 {{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}
1395 //always saved (PBD)//
1396 DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1397 DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
1398 desc: rms jitter of the fs-Oscillator
1399 units: fs
1400 {{/expand}}
1401
1402
1403 ==== FL 26 Pump Probe Laser (FLASH2) ====
1404
1405 These are the parameters that can be saved in the FL2 User DAQ for the FL2 PP laser//** FOR BEAMLINE FL26**//
1406
1407
1408 **User delay**
1409
1410 Delay (set value):
1411
1412 {{code language="none"}}
1413 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR
1414 {{/code}}
1415
1416 Delay (readback):
1417
1418 {{code language="none"}}
1419 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD
1420 {{/code}}
1421
1422 Delay (encoder readback):
1423
1424 {{code language="none"}}
1425 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.ENCODER_POSITION.RD
1426 {{/code}}
1427
1428 OXC. jitter:
1429
1430 {{code language="none"}}
1431 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD
1432 {{/code}}
1433
1434
1435 **Parameters for FL26**
1436
1437 (% class="wrapped" %)
1438 |(((
1439 FL2PPL FL26 REMI Attenuation: HWP motor current position
1440 )))|(((
1441 FLASH.FEL/FLAPP2BEAMLINES/MOTOR11.FL26B/FPOS
1442 )))
1443 |(((
1444 FL2PPL FL26 REMI Polarization: linear polarization angle
1445 )))|(((
1446 FLASH.FEL/FLAPP2BEAMLINES/MOTOR12.FL26B/FPOS
1447 )))
1448 |(((
1449 FL2PPL FL26 REMI Diagnostics: NIR spectrum
1450 )))|(((
1451 FLASH.LASER/MOD26.SPECT/REMI/DAQ_CHANNEL
1452 )))
1453 |(((
1454 FL2PPL FL26 REMI Diagnostics: photo diode input MOD2.6 - pulse energy mean
1455 )))|(((
1456 FLASH.LASER/MOD26.PES/RE_OUT/PULSEENERGY.MEAN
1457 )))
1458 |(((
1459 FL2PPL FL26 REMI Diagnostics: photo diode input MOD2.6 - intra burst pulse energy
1460 )))|(((
1461 FLASH.LASER/MOD26.PES/RE_OUT/DAQ_CHANNEL
1462 )))
1463 |(((
1464 FL2PPL FL26 REMI Diagnostics: photo diode input MOD2.6 - raw adc
1465 )))|(((
1466 FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH04.TD
1467 )))
1468 |(((
1469 FL2PPL FL26 REMI Diagnostics: photo diode input REMI - pulse energy mean
1470 )))|(((
1471 FLASH.LASER/MOD26.PES/INC_BOX/PULSEENERGY.MEAN
1472 )))
1473 |(((
1474 FL2PPL FL26 REMI Diagnostics: photo diode input REMI - intra burst pulse energy
1475 )))|(((
1476 FLASH.LASER/MOD26.PES/INC_BOX/DAQ_CHANNEL
1477 )))
1478 |(((
1479 FL2PPL FL26 REMI Diagnostics: photo diode input REMI - raw adc
1480 )))|(((
1481 FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH05.TD
1482 )))
1483 |(((
1484 FL2PPL FL26 REMI In coupling: filter wheel 1 position
1485 )))|(((
1486 FLASH/MOD26.FW1/FLASH2MOD26/pos
1487 )))
1488 |(((
1489 FL2PPL FL26 REMI In coupling: filter wheel 2 position
1490 )))|(((
1491 FLASH/MOD26.FW2/FLASH2MOD26/pos
1492 )))
1493 |(((
1494 FL2PPL FL26 REMI: Energy meter REMI incoupling breadboard
1495 )))|(((
1496 FLASH.LASER/MOD26.OPHIRE/REINC.54/DAQ_CHANNEL
1497 )))
1498 |(((
1499 FL2PPL FL26 REMI Incoupling: focusing lens position
1500 )))|(((
1501 FLASH.FEL/FLAPP2BEAMLINES/MOTOR3.FL26B/FPOS
1502 )))
1503 |(((
1504 FL2PPL FL26 REMI Incoupling: nearfield
1505 )))|(((
1506 FLASH.LASER/MOD26.CAM/REINC.21.NF/DAQ_CHANNEL
1507 )))
1508 |(((
1509 FL2PPL FL26 REMI Incoupling: focus
1510 )))|(((
1511 FLASH.LASER/MOD26.CAM/REINC.22.FF/DAQ_CHANNEL
1512 )))
1513 |(((
1514 FL2PPL FL26 REMI Drift: relative arrival time intra burst LAM balanced - calb. in the PES
1515 )))|(((
1516 FLASH.LASER/MOD26.PES/LAM_DIFF/DAQ_CHANNEL
1517 )))
1518 |(((
1519 FL2PPL FL26 REMI Drift: forward signal (PD1)  raw
1520 )))|(((
1521 FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH00.TD
1522 )))
1523 |(((
1524 FL2PPL FL26 REMI Drift: backward signal (PD2) raw
1525 )))|(((
1526 FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH01.TD
1527 )))
1528 |(((
1529 FL2PPL FL26 REMI Drift: mean relative burst arrival time - avarage of the calib value
1530 )))|(((
1531 FLASH.LASER/MOD26.PES/LAM_DIFF/PULSEENERGY.MEAN
1532 )))
1533 |(((
1534 FL2PPL FL26 REMI Drift: delay line position (ODL of the LAM REMI)
1535 )))|(((
1536 FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL26B/FPOS
1537 )))
1538 |(((
1539 FL2PPL FL26 Laser Hutch: delay line position (ODL of the osc. Sync / user delay)
1540 )))|(((
1541 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD
1542 )))
1543 |(((
1544 FL2PPL FL26 REMI Drift: delay line encoder position (ODL REMI raw value)
1545 )))|(((
1546 FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.0.ENCODER_POSITION.RD
1547 )))
1548 |(((
1549 Jiiter between oscillator and MLO (inloop jitter osc. Sync)
1550 )))|(((
1551 FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD
1552 )))
1553 |(((
1554 Temperature controlled fiber (PWM signal to the temperature controlled fiber delay sysdc)
1555 )))|(((
1556 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE23
1557 )))
1558 |(((
1559 Temperature controlled fiber (Temp of the fiber delay sysdc)
1560 )))|(((
1561 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE24
1562 )))
1563 |(((
1564 Sydc feedback data if LAM is not activated (sysdc delay)
1565 )))|(((
1566 FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26
1567 )))
1568 {{/expand}}
1569
1570
1571
1572 === "/uncategorized/" ===
1573
1574 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
1575
1576
1577 === HDF5 structure revisions ===
1578
1579 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:
1580
1581
1582 * All FLASH1 related HDF groups moved to group "/FL1", i.e. a new prefix "/FL1" is added to their HDF path.
1583 * The ambigious term "pulse" has been replaced by "train" to refer to "pulse train". Most notably, the dataset "/Timing/pulse ID" has changed to "/Timing/train ID".
1584 * A number of inconsistent names have been streamlined. The relevant changes are listed in the following table.
1585
1586 (% class="wrapped" %)
1587 |=(((
1588 earlier HDF path (vers. 0.2)
1589 )))|=(((
1590 is now (vers. 0.3)
1591 )))
1592 |(((
1593 /Photon Diagnostic/GMD/Beam position/position BDA x
1594 )))|(((
1595 /FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal
1596 )))
1597 |(((
1598 /Photon Diagnostic/GMD/Beam position/position BDA y
1599 )))|(((
1600 /FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical
1601 )))
1602 |(((
1603 /Photon Diagnostic/GMD/Beam position/position tunnel x
1604 )))|(((
1605 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal
1606 )))
1607 |(((
1608 /Photon Diagnostic/GMD/Beam position/position tunnel y
1609 )))|(((
1610 /FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical
1611 )))
1612 |(((
1613 /Experiment/Pump probe laser/BPM/position x
1614 )))|(((
1615 /FL1/Experiment/Pump probe laser/BPM/position horizontal
1616 )))
1617 |(((
1618 /Experiment/Pump probe laser/BPM/position y
1619 )))|(((
1620 /FL1/Experiment/Pump probe laser/BPM/position vertical
1621 )))
1622 |(((
1623 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall horizontal
1624 )))|(((
1625 /FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal
1626 )))
1627 |(((
1628 /FL2/Photon Diagnostic/GMD/Beam position/Average/position hall vertical
1629 )))|(((
1630 /FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical
1631 )))
1632 |(((
1633 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel horizontal
1634 )))|(((
1635 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal
1636 )))
1637 |(((
1638 /FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel vertical
1639 )))|(((
1640 /FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical
1641 )))
1642 |(((
1643 /FL2/Photon Diagnostic/GMD/Average energy/hall
1644 )))|(((
1645 /FL2/Photon Diagnostic/GMD/Average energy/energy hall
1646 )))
1647 |(((
1648 /FL2/Photon Diagnostic/GMD/Average energy/hall (raw)
1649 )))|(((
1650 /FL2/Photon Diagnostic/GMD/Average energy/energy hall (raw)
1651 )))
1652 |(((
1653 /FL2/Photon Diagnostic/GMD/Average energy/tunnel
1654 )))|(((
1655 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel
1656 )))
1657 |(((
1658 /FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)
1659 )))|(((
1660 /FL2/Photon Diagnostic/GMD/Average energy/energy tunnel (raw)
1661 )))
1662 |(((
1663 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall x
1664 )))|(((
1665 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal
1666 )))
1667 |(((
1668 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall y
1669 )))|(((
1670 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical
1671 )))
1672 |(((
1673 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel x
1674 )))|(((
1675 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal
1676 )))
1677 |(((
1678 /FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel y
1679 )))|(((
1680 /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical
1681 )))
1682
1683 [[Contents>>doc:||anchor="Contents"]]
1684
1685
1686 {{/layout-cell}}
1687 {{/layout-section}}
1688 {{/layout}}