Wiki source code of The FLASH HDF5 structure

Version 93.5 by sndueste on 2025/05/19 16:48

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