Wiki source code of The FLASH HDF5 structure

Version 94.1 by sndueste on 2025/05/19 16:53

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