Wiki source code of The FLASH HDF5 structure

Version 92.1 by sndueste on 2025/04/24 13:31

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