Wiki source code of The FLASH HDF5 structure

Version 79.1 by sndueste on 2024/04/25 16:51

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