Wiki source code of The FLASH HDF5 structure

Version 93.2 by sndueste on 2025/05/19 16:44

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