Wiki source code of The FLASH HDF5 structure

Version 106.2 by sndueste on 2026-01-09 15:30

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