Wiki source code of The FLASH HDF5 structure

Last modified by sndueste on 2025/09/10 11:43

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