Wiki source code of The FLASH HDF5 structure

Version 96.1 by sndueste on 2025/05/19 17:06

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