The FLASH HDF5 structure

1

== Contents ==

2

== General information about HDF5 and how to look on it ==

9

10

HDF5 is a data format maintained by the HDF group. For detailed general information see [[here>>url:https://portal.hdfgroup.org/display/support||shape="rect"]]

11

12

The easiest way to look at the HDF5 files from your beamtime is to use the Jupyter notebook interface to Maxwell: [[https:~~/~~/max-jhub.desy.de/>>https://max-jhub.desy.de/]]

13

14

The file content can be browsed by double clicking on the file.

15

16

Typically the Jupyter notebook starts at your home directory and you have to create a (soft) link to your beamtime folder: open a terminal window (File->New-> Terminal) and create the link via :

17

18

{{code language="none"}}> ln -sn beamtime path linkname

19

e.g.

20

> ln -sn /asap3/flash/gpfs/fl23/2025/data/11024321/ ~/beamtime_11024321 {{/code}}

21

Then a “beamtime_11024321” folder should appear in your home directory.

Alternativaly you can also use a conventional HDF viewer:

26

27

To download the HDF5 Viewer click [[here>>url:https://portal.hdfgroup.org/display/support/Download+HDFView||shape="rect"]]

28

29

For use on the DESY Maxwell or PAL (max-fsc or pal) **hdfview** is available in the xray module :

30

{{code language="none"}}> module load xray{{/code}}

31

{{code language="none"}}> hdfview{{/code}}

or you can use

> silx view

[[Contents>>doc:||anchor="Contents"]]

41

42

== The FLASH HDF5 format ==

43

44

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.

45

46

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.

47

48

Reference implementation, which follows the concept of Python libraries like Pandas, Xarray, or Dask, is given below.

49

50

51

=== Comparison to FLASH's deprecated HDF formats ===

52

53

Before 2021, FLASH provided two different HDF formats formally known as //near-online// and //offline// HDF files.

54

55

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.

56

57

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.

58

59

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.

60

61

62

**HDF5 example files (old format)**

63

64

Here we have a few HDF5 samples (User data combined with Photon diagnostics data) from a few beamtimes showing the different kind options.

65

66

[[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"]]

67

68

69

[[~[~[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"]]

=== HDF examples: ===

76

77

* ADC data as example for **fast** **data** (10 Hz):

78

79

[[image:attach:image2020-11-16_15-26-28.png||height="250"]]

80

81

* 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}})

82

83

( as example only every 10th train ID is listed in the HDF group "index")

84

85

[[image:attach:image2020-11-16_15-31-45.png||height="250"]]

86

87

* (((

88

//zraw// group contains the **original DAQ (DOOCS) names**

89

)))

90

91

of the properties saved in the DESY internal raw format. (For experts)

92

93

94

[[image:attach:image2020-11-16_16-26-3.png||height="400"]]

95

96

97

=== There are different options that help you to work with the FLASH HDF5 data in Python ===

98

99

* The currently developed option for large data sets: [[the FAB package>>url:https://hasfcpkg.desy.de/fab/fab.html||shape="rect"]] ... see below

100

* and for smaller projects: (% class="Object" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]

101

102

(% class="Object" %)See also the collection of Demo data and sample scripts : [[Collection of HDF5 sample data from different beamlines>>doc:FLASHUSER.Offline data analysis (DAQ).Collection of HDF5 sample data from different beamlines.WebHome]] and [[DEMO - Working with FLASH data>>doc:FLASHUSER.Offline data analysis (DAQ).DEMO - Working with FLASH data.WebHome]]

== Complete list of recordable parameters ==

108

109

The complete list for the relation between DOOCS names and HDF5 names for the recordable parameters can be found in [[DESY's Repository>>url:https://stash.desy.de/projects/CS/repos/pah/browse/src/camp/data/channel2HdfName.dat||shape="rect"]].

110

111

== Most popular FLASH parameters and their names in HDF5, DOOCS and (.raw) DAQ ==

=== FLASH1 ===

In the Shutdown 2024 / 2025 the complete photon diagnostic and experiment control was renewed and thus the Doocs names and also some HDF5 names had to be changed. The new naming will be documented here as soon as the systems are online again.

120

121

The previously used naming scheme (2024 and before) can be found here:

122

123

{{expand expanded="false" title="FLASH1 naming scheme used until 2024"}}

124

==== (% id="cke_bm_8853497S" style="display:none" %) (%%)Beamline info (FLASH1) ====

125

126

{{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}

127

//always saved (PBD)//

128

DOOCS prop : {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}

129

DAQ channel: {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}

130

desc: set pressure in the gas attenuator

131

units: mbar

132

133

{{code language="none"}}/FL1/Beamlines/BL/Fast shutter/open{{/code}}

134

//always saved (PBD)//

135

DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER/CH00.TD{{/code}}

136

DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/BL.SHUTTER{{/code}}

137

desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)

138

units: none

139

140

{{code language="none"}}/FL1/Beamlines/PG/Fast shutter/open{{/code}}

141

//always saved (PBD)//

142

DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER/CH00.TD{{/code}}

143

DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL1FS/PG.SHUTTER{{/code}}

144

desc: PG Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)

145

units: none

146

147

{{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 1{{/code}}

148

//always saved (PBD)//

149

DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}

150

DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}

151

desc: Position of the BL filter wheel 1 - to correlate with the filter material please look [[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]

152

units: degree

153

154

{{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 2{{/code}}

155

//always saved (PBD)//

156

DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}

157

DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}

158

desc: Position of the BL filter wheel 2 - to correlate with the filter material please look [[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]

159

units: degree

160

161

{{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 1{{/code}}

162

//always saved (PBD)//

163

DOOCS prop : = TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS=

164

DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}

165

desc: Position of the PG filter wheel 1

166

units: degree

167

168

{{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 2{{/code}}

169

//always saved (PBD)//

170

DOOCS prop : {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}

171

DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}

172

desc: Position of the PG filter wheel 2

173

units: degree

174

175

{{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 3{{/code}}

176

//always saved (PBD)//

177

DOOCS prop : {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}

178

DAQ channel: {{code language="none"}}TTF2.FEL/PGFILTERS/PGFILTERS/FW.MOTOR.POS{{/code}}

179

desc: Position of the PG filter wheel 3

units: degree

NOTE: Aperture positions in the beamline as well as the positions of the beam steering mirrors are also saved. For more Info contact your local contact

185

186

[[Contents>>doc:||anchor="Contents"]]

187

188

189

==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====

190

191

192

(% style="color:#000000" %)**Discontinued GMD data recording / evaluation (VME + PhotonFlux ML server)**

193

194

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}

195

//always saved (PBD)//

196

197

(% style="color:#000000" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)

198

(% style="color:#000000" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)

199

desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator (ion current)

200

units : microJ

201

202

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}

203

//always saved (PBD)//

204

205

DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT34/VAL{{/code}}

206

DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.USER{{/code}}

207

desc :Energy per pulse Tunnel (from e-) - the values are set to "0" if there was no SASE beam in the FEL

208

units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

209

210

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel (raw){{/code}}

211

//always saved (PBD)//

212

DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT14/VAL{{/code}}

213

DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENERGYPULSE.FF{{/code}}

214

desc :Energy per pulse Tunnel (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise

215

units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

216

217

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy BDA{{/code}}

218

//always saved (PBD)//

219

220

DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT05/VAL{{/code}}

221

DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENPULSEIC{{/code}}

222

desc : calibrated average SASE Energy/pulse measured in the BDA (in the experimental hall) after the attenuator (ion current)

223

units : microJ

224

225

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA{{/code}}

226

//always saved (PBD)//

227

228

DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT35/VAL{{/code}}

229

DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.USER{{/code}}

230

desc :Energy per pulse BDA (from e-) - the values are set to "0" if there was no SASE beam in the FEL

231

units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision) **[[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

232

233

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA (raw){{/code}}

234

//always saved (PBD)//

235

DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT15/VAL{{/code}}

236

DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}

237

desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise

238

units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

(% style="color:#000000; letter-spacing:0px" %)**NEW (since 2021) GMD data recording / evaluation (same format as FLASH2 and XFEL)**

243

244

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}

245

//always saved (PBD)//

246

(% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)

247

(% style="color:#000000" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}

248

249

desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator

units : microJ

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}

254

//always saved (PBD)//

255

256

(% style="color:#000000" %)DOOCS prop : (%%)

257

(% style="color:#000000" %){{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}

258

259

desc : Energy per pulse measured in the Tunnel. In addition measurement errors and beam position are included for EACH pulse in the pulse train !! (see below)

260

units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

261

262

263

For every pulse in the pulse train the information is saved:

264

265

1. **Intensity per pulse** (a.u. (more or less µJ ))

266

1. Intensity per pulse (auxillary GMD) - not used

267

1. Position horizontal (mm, for a single pulse the position information may be very noisy - talk to your local contact)

268

1. Position vertical (mm, for a single pulse the position information may be very noisy - talk to your local contact)

269

1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color:#000000" %)This parameter gives an indication of the error of the measurement of the pulse energy. This takes signal to noise, detector resolution, uncertainties in crossection etc into account. (it is NOT the measurement of the statistical fluctuation of the SASE pulses)(%%))

270

1. Position horizontal sigma (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)

271

1. Position vertical sigma (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)

272

1. Combined warning and error flags

273

274

The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this

275

file

276

277

[[image:image2021-2-9_10-51-6.png]]

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 !

283

284

285

Besides pulse energy the GMD also provides information about the beam position

286

287

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal{{/code}}

288

//always saved (PBD)//

289

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}

290

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IX.POS{{/code}}

291

desc :Beam position of the photon Beam determined by the GMD (BDA, x=horizontal)

292

units : mm

293

294

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical{{/code}}

295

//always saved (PBD)//

296

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}

297

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.BDA/IY.POS{{/code}}

298

desc :Beam position of the photon Beam determined by the GMD (BDA, y=vertical)

299

units : mm

300

301

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal{{/code}}

302

//always saved (PBD)//

303

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}

304

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IX.POS{{/code}}

305

desc :Beam position of the photon Beam determined by the GMD (TUNNEL, x=horizontal)

306

units : mm

307

308

{{code language="none"}}/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical{{/code}}

309

//always saved (PBD)//

310

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}

311

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL1.TUNNEL/IY.POS{{/code}}

312

desc :Beam position of the photon Beam determined by the GMD (TUNNEL, y=vertical)

units : mm

==== Spectrometer (FLASH1) ====

317

318

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength{{/code}}

319

_always saved (when Spectrum is measured !!) (PBD) _

320

DOOCS prop : {{code language="none"}}TTF2.EXP/PHOTONWL.ML/WAVE_LENGTH/VAL.TD{{/code}}

321

DAQ channel: {{code language="none"}}PBD.PHOTONWL.ML/WAVE_LENGTH{{/code}}

322

desc : XUV Spectrum measured with the "tunnel spectrometer"

323

units :

324

325

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength start value{{/code}}

326

_always saved (when Spectrum is measured !!) (PBD) _

327

DOOCS prop : {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}

328

DAQ channel: {{code language="none"}}TTF2.EXP/PBD.PHOTONWL.ML/BSTART/VAL{{/code}}

329

desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"

330

units : nm

331

332

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/Tunnelspectrometer/wavelength increment{{/code}}

333

_always saved (when Spectrum is measured !!) (PBD) _

334

DOOCS prop : ==

335

DAQ channel: ==

336

desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "tunnel spectrometer"

337

units : nm

338

339

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy{{/code}}

340

//saved on DEMAND (PBD spectrometer stream)//

341

DOOCS prop : ==

342

DAQ channel: {{code language="none"}}PBD.PHOTONEN.ML/PHOTON_ENERGY{{/code}}

343

desc : XUV Spectrum in eV measured with the "PG2 spectrometer"

344

units :

345

346

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy start value{{/code}}

347

//saved on DEMAND (PBD spectrometer stream)//

348

DOOCS prop : ==

349

DAQ channel: ==

350

desc : start value (in eV) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"

351

units : eV

352

353

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon energy increment{{/code}}

354

//saved on DEMAND (PBD spectrometer stream)//

355

DOOCS prop : ==

356

DAQ channel: ==

357

desc : increment value (in eV) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"

358

units : eV

359

360

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength{{/code}}

361

//saved on DEMAND (PBD spectrometer stream)//

362

DOOCS prop : ==

363

DAQ channel: {{code language="none"}}PHOTONEN.ML/PHOTON_WAVE_LEN{{/code}}

364

desc : XUV Spectrum in nm measured with the "PG2 spectrometer"

365

units :

366

367

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength increment{{/code}}

368

//saved on DEMAND (PBD spectrometer stream)//

369

DOOCS prop : ==

370

DAQ channel: ==

371

desc : start value (in nm) for the wavelength axis of the XUV Spectrum measured with the "PG2 spectrometer"

372

units : nm

373

374

{{code language="none"}}/FL1/Photon Diagnostic/Wavelength/PG2 spectrometer/photon wavelength start value{{/code}}

375

//saved on DEMAND (PBD spectrometer stream)//

376

DOOCS prop : ==

377

DAQ channel: ==

378

desc : increment value (in nm) for each pixel for the wavelength axis of the XUV Spectrum measured with the "PG spectrometer"

379

units : nm

380

381

[[Contents>>doc:||anchor="Contents"]]

382

383

==== Electron Beam properties (FLASH1) ====

384

385

===== bunch charge =====

386

387

{{code language="none"}}/FL1/Electron Diagnostic/Bunch charge/after undulator{{/code}}

388

//always saved (PBD)//

389

DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/CHARGE.FLASH1{{/code}}

390

DAQ channel: {{code language="none"}}FLASH.DIAG/TOROID/12EXP{{/code}}

391

desc: electron bunch charge (FLASH1)

units: nC

=====

arrival time (BAM) =====

396

397

398

* see: [[Info collection about the BAMs and how to use the BAM data>>doc:FS-FLASH USER tmp.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]

399

* The data format of the BAM has been completely altered in the 2022 shutdown

400

* 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 ...

401

* 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)

402

* There has been also a renaming (and relocation) of the BAMs.

403

** acc: 4DBC3 → FL0.DBC2

404

** FL1: 1SFELC → FL1.SFELC

405

** FL2: FL2XTDS → (% style="color:#172b4d" %)FL2.SEED5

406

* for more Info: [[LINK to detailed infos from MSK>>doc:SDiag.How-to articles.BAM Data Structure.WebHome||shape="rect"]]

407

* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]

408

* a recent [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]

(% style="color:#000000" %)**Discontinued BAM data recording **

413

414

{{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}

415

//always saved (PBD)//

416

DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}

417

DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}

418

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).

419

units: ps (bigger numbers indicate later arrivaltime of the electrons)

420

421

422

{{code language="none"}}/FL1/Electron Diagnostic/BAM/1SFELC/electron bunch arrival time (low charge){{/code}}

423

//always saved (PBD)//

424

DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/1SFELC/LOW_CHARGE_ARRIVAL_TIME{{/code}}

425

DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/1SFELC.LOW_CHARGE_ARRIVAL_TIME{{/code}}

426

desc: Electron bunch arrival time measured with the BAM before the undulator (pulse resolved data). This one was newly installed in 2020.

427

units: ps (bigger numbers indicate later arrival time of the electrons)

428

429

430

====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======

431

432

(% style="color:#ff6600" %)**DBC2**/electron bunch arrival time (HDF5 name not yet implemented - see zraw)(%%)

433

//always saved (PBD)//

434

{{code language="none"}}/FL1/Electron Diagnostic/BAM/ {{/code}}DOOCS prop : FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP

435

DAQ (% style="color:#000000" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP (%%)

436

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).

437

438

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

439

440

441

(% style="color:#ff6600" %)DBC2/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)

442

//always saved (PBD)//

443

DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE

444

DAQ channel: (% style="color:#000000" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE (%%)

445

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).

446

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

447

448

449

(% style="color:#ff6600" %)DBC2/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)

450

//always saved (PBD)//

451

DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color:#000000" %)E.bamError.1(%%)

452

DAQ channel: (% style="color:#000000" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR.1(%%)

453

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

454

455

456

(% style="color:#ff6600" %)DBC2/status (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)

457

//always saved (PBD)//

458

DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color:#000000" %)E..bamStatus.//1//(%%)

459

DAQ channel(% style="color:#000000" %): FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.1(%%)

460

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

461

462

463

====== **BAM FL1.SFELC**{{code language="none"}}{{/code}} ======

464

465

(% 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)

466

467

//always saved (PBD)//

468

(% style="color:#172b4d" %)**FL1.SFELC**(%%)

469

(% style="color:#000000" %)channel: FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP(%%)

470

(% style="color:#000000" %){{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ {{/code}}(% style="letter-spacing:0.0px" %)desc: Electron bunch arrival time measured with the BAM before the undulator (pulse resolved data). This one was newly installed in 2020.. The property contains only the arrival time of the bunches sent to FL1 (e.g. if there are 30 bunches in FL1 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time of the XUV pulses in the experiment (see help).

471

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

(% 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}}(%%)

476

//always saved (PBD)//

477

DOOCS prop : FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(%%)/ARRIVAL_TIME.ABSOLUTE

478

DAQ channel:** **(% style="color:#000000" %)FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.ABSOLUTE (%%)

479

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).

480

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

481

482

483

(% style="color:#172b4d" %)SFELC(% style="color:#ff6600" %)/error (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)

484

//always saved (PBD)//

485

DOOCS prop : FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color:#000000" %)E.bamError(%%)

486

DAQ channel(% style="color:#000000" %): FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMERROR(%%)

487

desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!

488

489

490

(% style="color:#172b4d" %)SFELC(% style="color:#ff6600" %)/status (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)

491

//always saved (PBD)//

492

DOOCS prop : FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color:#000000" %)E..bamStatus.//1//(%%)

493

DAQ chann(% style="color:#000000" %)el: FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMSTATUS.1(%%)

494

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

===== electron beam profile =====

499

500

{{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}

501

//always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//

502

DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/OUT.PROF.CCCED{{/code}}

503

DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}

504

desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)

505

units: pixel

506

507

{{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}

508

//always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//

509

DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/CALIB.CONST.T{{/code}}

510

DAQ channel: = PBD.BEAM.PROF.ML/CCT=

511

desc: TDS calibration constant for the x-axis of the profiles: fs per pixel

512

units: fs per pixel

513

514

{{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}

515

//always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//

516

DOOCS prop : {{code language="none"}}TTF2.DAQ/BEAM.PROF.ML/BEAM.PROF/SOWS.W.CCTED{{/code}}

517

DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/PROFWIDTHCCTED{{/code}}

518

desc: rms pulse width of the measures TDS electron bunch profile

519

units: fs

520

521

===== electron bunch energy =====

522

523

{{code language="none"}}/FL1/Electron Diagnostic/Electron energy/average electron energy{{/code}}

524

//always saved (PBD)//

525

DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}

526

DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}

527

desc: electron bunch energy (average over the bunch train)

528

units: (% class="twikiNewLink" %)MeV

529

530

{{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}

531

//always saved (PBD)//

532

DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_SPECT/VAL.TD{{/code}}

533

DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_SPECT{{/code}}

534

desc: electron bunch energy bunch resolved

535

units: (% class="twikiNewLink" %)MeV

536

537

538

{{code language="none"}}/FL1/Electron Diagnostic/Electron energy/wavelength bunch train average{{/code}}

539

//always saved (PBD)//

540

DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/LAMBDA_MEAN/VAL{{/code}}

541

DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}

542

desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)

543

units: nm

544

545

[[Contents>>doc:||anchor="Contents"]]

==== ====

==== Timing information, rep rate etc. (FLASH1) ====

552

553

===== bunch repetition rate =====

554

555

{{code language="none"}}/Timing/repetition rate{{/code}}

556

//always saved (PBD)//

557

DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}

558

DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}

559

desc: repetition rate of the bunches / pulses within the burst (FLASH1)

560

units: kHz

561

562

===== set number of pulses =====

563

564

(% style="color:#ff6600" %)(HDF5 name not yet implemented - see zraw)(% style="color:#ff0000" %){{code language="none"}}/Timing/set number of bunches {{/code}}(%%)

565

//always saved (PBD)//

566

DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}

567

DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}

568

desc: Number of bunches set in the control (timing) system. The property contains 4 numbers. the last one is the number of pulses (see also [[doc:FLASH.Timing properties]] (internal link)). If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated and thus the actual number of pulses may be smaller than the set one

569

units:

570

571

===== actual number of pulses =====

572

573

{{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}

574

//always saved (PBD)//

575

DOOCS prop : {{code language="none"}}FLASH.DIAG/TOROID.ML/12EXP/NUMBEROFBUNCHES.FLASH1{{/code}}

576

DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}

577

desc: Number of bunches measured BEHIND the undulator. If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated this is the actual number that created XUV radiation.The number is calculated by the DAQ middle layer server, (FLASH1)

578

units:

579

580

===== actual pulse pattern recorded after the undulator =====

581

582

{{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}

583

//always saved (PBD)//

584

DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}

585

DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}

586

desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)

units:

===== Train ID =====

{{code language="none"}}/Timing/train ID{{/code}}

592

//always saved (PBD)//

593

DOOCS prop : {{code language="none"}}none{{/code}}

594

DAQ channel: {{code language="none"}}none{{/code}}

595

desc: Each 10 Hz burst has its unique train ID. For the HDF5 data set the ID is the same for all parameters with the same index (note camera images may be shifted by 1 ID - talk to the experts !)

596

units:

597

598

===== (% style="color:#e67e22" %)Train time(%%) =====

599

600

(% style="color:#e67e22" %){{code language="none"}}/Timing/train time{{/code}}

601

desc:Local time as array of day, hour, minute, second, and centisecond. This data set is meant for visualization purposes only. For correlations use the train ID or the Unix time of the time stamp

602

units: d h min s cs

603

604

(% style="color:#e67e22" %){{code language="none"}}/Timing/time stamp{{/code}}

605

desc:first column: Local time in unix time. To get day, hour, minute, second you can use unix: e.g. date ~-~-date='@1553617729' or matlab, python etc

606

second column: microseconds

607

third column: Train ID of FLASH

608

609

currently it is saved as Unix time in : /zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time

import time

# epoch time is found in /zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time #!!! a leading 1 has to be added !!!

615

# The time and date of the start of the data taking in the HDF file is encoded in the filename - to roughly check the time

616

epoch_time = 1709051499.17 # Replace with your epoch time

617

618

formatted_time = time.strftime('%Y-%m-%d %H:%M:%S', time.gmtime(epoch_time))

619

print(formatted_time)

==== Pump Probe Laser (FLASH1) ====

626

627

**PIGLET (PG laser)**

628

629

**{{code language="none"}}/FL1/Experiment/Pump probe laser{{/code}}**

630

631

632

list of saved parameters status May 2024 (up to now the parameters can be found in /zraw/ ... )

Download the PDF:

/FL1/Experiment/Pump probe laser/laser attenuation

645

646

647

//always saved (PBD)//

648

DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}

649

DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/ROT2.CURRENT{{/code}}

650

desc: attenuation of the PPLaser (rotation of a waveplate)

651

units : 0 no transmission , 1: full transmission

652

653

654

{{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay{{/code}}

655

//always saved (PBD)//

656

DOOCS prop : {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}

657

DAQ channel: {{code language="none"}}TTF2.FEL/PPDELAYCAL/PPDELAYCAL/DLY1.CURRENT{{/code}}

658

desc: delay of the Pump probe laser - measured by the read back position of the motor. only read out every secound ... better use the encoder

659

units : ps ( pos delay means IR comes later)

660

661

662

{{code language="none"}}/FL1/Experiment/Pump probe laser/delay line IK220.0/ENC.DELAY{{/code}}

663

//always saved (PBD)//

664

DOOCS prop : {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0/ENC.DELAY{{/code}}

665

DAQ channel: {{code language="none"}}TTF2.FEL/DELLINE.ENC/IK220.0:ENC.DELAY{{/code}}

666

subsystem: {{code language="none"}}DELLINE.ENC{{/code}} desc : delay of the Pump probe laser - measured by an encoder. The position is read out with 10Hz train synchronized and should be used to determine the actual laser delay (the motor position is only read out about every second

667

units : ps ( pos delay means IR comes later)

668

669

670

{{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS GECCO{{/code}}

671

//always saved (PBD)//

672

DOOCS prop : {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}

673

DAQ channel: {{code language="none"}}FLASH.SYNC/F1PPL.LASER_LOCK/28C.F1PPL1.CONTROLLER/ADV_CTRL_MANAGER.0.PID_INPUT_JITTER.2.RD{{/code}}

674

desc: rms jitter of the GECCO (% class="twikiNewLink" %)TiSa(%%) Oscillator units: fs

675

676

677

{{code language="none"}}/FL1/Experiment/Pump probe laser/streak camera delay time{{/code}}

678

//always saved (PBD)//

679

DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}

680

DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}

681

desc: delay time between the optical laser and the FEL units: ps

[[Contents>>doc:||anchor="Contents"]]

686

687

688

==== User Data (FLASH1) ====

689

690

The data saved specifically for detectors at an experiment will show up in /Experiment/ there is a large number of options for cameras or monitoring of slow properties (motor positions etc) for user experiments. For details please ask your local contact.

691

692

NOTE: If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with the DOOCS names

693

694

The most common and permanently installed device used by experiment are our ADCs:

===== GHz ADCs =====

ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FS-FLASH USER tmp.Data Acquisition and controls 1.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**

699

//saved on DEMAND in the user DAQ//

700

\\The HDF5 names for the ADC traces are depending on the beamline :

701

\\PG Beamline:

702

{{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH00/TD{{/code}}

703

{{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH01/TD{{/code}}

704

{{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH02/TD{{/code}}

705

{{code language="none"}}/FL1/Experiment/PG/ADQ412 GHz ADC/CH03/TD{{/code}}

706

707

BL Beamlines:

708

{{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH00/TD{{/code}}

709

{{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH01/TD{{/code}}

710

{{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH02/TD{{/code}}

711

{{code language="none"}}/FL1/Experiment/BL1/ADQ412 GHz ADC/CH03/TD{{/code}}

712

\\{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH00/TD{{/code}}

713

{{code language="none"}}/FL1/Experiment/BL2/ADQ412 GHz ADC/CH01/TD{{/code}}

714

\\{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH02/TD{{/code}}

715

{{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}

716

717

DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD or CH00.DAQ.TD{{/code}}

718

here the {{code language="none"}}CH00.TD{{/code}} is the full ADC trace as it is sampled ( typically several 100.000 samples per pulse train) while the {{code language="none"}}CH00.DAQ.TD{{/code}} trace only has the number of samples which are sent to the DAQ OR if //grouping// is activated the {{code language="none"}}CH00.DAQ.TD{{/code}} contains only the grouped spectra. To read the ADC trace with an online analysis program the {{code language="none"}}CH00.DAQ.TD{{/code}} is used preferably.

719

DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}

720

721

In addition there are also additional parameters saved like:

722

723

* {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.

724

* {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger

725

* {{code language="none"}}error (ADC):{{/code}}0 indicates that there was no error

===== MHz ADCs =====

similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:

730

{{code language="none"}}/FL1/Experiment/BL1/SIS8300 100MHz ADC/CH2/TD{{/code}}

731

DOOCS prop : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02/CH00.TD

732

DAQ channel: : FLASH.FEL/ADC.SIS.BL1/EXP1.CH02

733

734

In addition there are also additional parameters saved like:

735

736

* {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.

737

* {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger

738

739

[[Contents>>doc:||anchor="Contents"]]

=== FLASH2 ===

There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs

746

747

==== Beamline info (FLASH2) ====

748

749

{{code language="none"}}/FL2/Beamlines/Attenuator/pressure {{/code}}

750

(% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)

751

(% style="color:#000000" %)DAQ channel: {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)

752

(% style="color:#000000" %)desc: set pressure in the gas attenuator (%%)

753

(% style="color:#000000" %)units: mbar

754

755

{{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}

756

DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}

757

DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}

758

desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)

units: none

{{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}

763

DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}

764

DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS

765

desc: Position of the BL filter wheel 1 - to correlate with the filter material please look **[[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**

766

units: degree

767

768

/FL2/Beamlines/Filter wheel/position wheel 2

769

DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}

770

DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}

771

desc: Position of the BL filter wheel 2 - to correlate with the filter material please look [[here>>doc:FS-FLASH USER tmp.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]

units: degree

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

776

777

[[Contents>>doc:||anchor="Contents"]]

==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====

782

783

{{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}

784

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}

785

DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}

786

desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)

units : microJ

{{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}

791

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}

792

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}

793

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)

794

units : a.u. (more or less µJ but need to be calibrated with the "Average energy" for good precision)** [[see here for help>>doc:FS-FLASH USER tmp.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

795

796

797

For every pulse in the pulse train the information is saved:

798

799

1. **Intensity per pulse** (a.u. (more or less µJ ))

800

1. Intensity per pulse (auxillary GMD) - not used

801

1. Position horizontal (mm, for a single pulse the position information may be very noisy - talk to your local contact)

802

1. Position vertical (mm, for a single pulse the position information may be very noisy - talk to your local contact)

803

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)(%%))

804

1. Position horizontal sigma (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)

805

1. Position vertical sigma (mm, indicates the error (RMS, sigma) of the measurement according to known uncertainties and signal to noise)

806

1. Combined warning and error flags

807

808

The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this

file

[[image:attach:image2021-2-9_10-51-6.png||height="250"]]

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 !

819

820

821

Besides pulse energy the GMD also provides information about the beam position

822

823

824

{{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}

825

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}

826

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}

827

desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)

units : mm

{{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}

832

DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}

833

DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}

834

desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)

units : mm

/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x

839

DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD

840

DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2

841

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 ...)

842

units : mm

843

844

(x=horizontal, y = vertial)

845

846

again the same parameter set is available for the **HALL GMD**

==== Photon Diagnostics OPIS[[ >>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]](FLASH2) ====

851

852

for more info see:** [[ OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]]**

853

854

(The OPIS hall is not installed yet ...)

855

856

857

{{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}

858

DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}

859

DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}

860

desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)

units : eV

{{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}

865

DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}

866

DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}

867

desc : mean wavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)

units : nm

{{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}}

872

DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}

873

DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}

874

desc : The bunch number of the bunch used for the wavelength calculation

875

units :

876

877

{{expand expanded="false" title="More detailed info on OPIS properties"}}

878

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL370,'%','relative width of photoline in percent of the FEL photon energy ROI1, rising flank'

879

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL375,'%','relative width of photoline in percent of the FEL photon energy ROI1, tailing flank'

880

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL470,'%','relative width of photoline in percent of the FEL photon energy ROI1, mean'

881

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL371,'%','relative width of photoline in percent of the FEL photon energy ROI2, rising flank'

882

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL376,'%','relative width of photoline in percent of the FEL photon energy ROI2, tailing flank'

883

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL471,'%','relative width of photoline in percent of the FEL photon energy ROI2, mean'

884

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL372,'%','relative width of photoline in percent of the FEL photon energy ROI3, rising flank'

885

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL377,'%','relative width of photoline in percent of the FEL photon energy ROI3, tailing flank'

886

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL472,'%','relative width of photoline in percent of the FEL photon energy ROI3, mean'

887

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL373,'%','relative width of photoline in percent of the FEL photon energy ROI4, rising flank'

888

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL378,'%','relative width of photoline in percent of the FEL photon energy ROI4, tailing flank'

889

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL473,'%','relative width of photoline in percent of the FEL photon energy ROI4, mean'

890

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL374,'%','relative width of photoline in percent of the FEL photon energy ROI5, rising flank'

891

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL379,'%','relative width of photoline in percent of the FEL photon energy ROI5, tailing flank'

892

FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL474,'%','relative width of photoline in percent of the FEL photon energy ROI5, mean'

893

894

895

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"]])

896

897

898

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 ...

==== Electron Beam properties (FLASH2) ====

903

904

===== bunch charge =====

905

906

{{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}

907

DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}

908

DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}

909

desc: electron bunch charge FLASH2 (average value for each bunchtrain).

units: nC

===== electron bunch energy =====

914

915

{{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}}

916

DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}}

917

DAQ channel: (% style="color:#5e6c84" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%)

918

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

919

920

(% style="letter-spacing:0.0px" %)units: (% class="twikiNewLink" %)MeV

921

922

923

(% style="color: rgb(94, 108, 132); font-weight: 600; letter-spacing: 0px;" %)

924

===== undulator settings =====

925

926

{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength 1{{/code}}

927

DOOCS prop : {{code language="none"}}FLASH.FEL/FL2.WAVELENGTHCONTROL/FLASH2.COLOR1/WAVELENGTH{{/code}}

928

DAQ channel: {{code language="none"}}FLASH.FEL/FL2.WAVELENGTHCONTROL/FLASH2.COLOR1/WAVELENGTH{{/code}}

929

desc: Set value for the anticipated wavelength 1 . This parameter is used to set the undulator gap. It may however deviate from the actual wavelength by several % ... For 2 color operation there is also the same parameter for COLOR 2

930

units: nm

931

932

{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE13 gap{{/code}}

933

DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE13/GAP{{/code}}

934

DAQ channel: {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE13/GAP{{/code}}

935

desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper.

936

units: mm

937

938

The gap values are saved for all 12 undulators (Nr 2 to 13). Undulator 13 is the one closest to the experimental hall.

939

940

=====

941

arrival time (BAM) =====

942

943

944

* see: [[Info collection about the BAMs and how to use the BAM data>>doc:FS-FLASH USER tmp.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]

945

* The data format of the BAM has been completely altered in the 2022 shutdown

946

* before 2022 BAMs were always saving the arrival time information for each 1µs bucked regardless if there were electrons in the accelerator or not. IN addition the arrival times for FL1 and FL2 were saved in the same parameter ...

947

* THIS is now different. There are new parameters saving only the arrival times for pulses that go to FL1 and to FL2 (in detail: first time slot of the accelerator and second)

948

* There has been also a renaming (and relocation) of the BAMs.

949

** acc: 4DBC3 → FL0.DBC2

950

** FL1: 1SFELC → FL1.SFELC

951

** FL2: FL2XTDS → (% style="color:#172b4d" %)FL2.SEED5

952

* for more Info: [[LINK to detailed infos from MSK>>doc:SDiag.How-to articles.BAM Data Structure.WebHome||shape="rect"]]

953

* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]

954

* a recent [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]

(% style="color:#000000" %)**Discontinued BAM data recording **

959

960

{{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}

961

//always saved (PBD2)//

962

DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}

963

DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/8FL2XTDS.LOW_CHARGE_ARRIVAL_TIME{{/code}}

964

desc: Electron bunch arrival time measured with the BAM after the FLASH2 undulator (pulse resolved data)

965

units: ps (bigger numbers indicate later arrivaltime of the electrons)

966

967

**FL1**{{code language="none"}}//Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}

968

//always saved (PBD2)//

969

DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}

970

DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/4DBC3.LOW_CHARGE_ARRIVAL_TIME{{/code}}

971

desc: Electron bunch arrival time measured with the BAM in the accelerator (pulse resolved data)

972

units: ps (bigger numbers indicate later arrivaltime of the electrons)

973

974

975

* The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).

976

* The BAM 8FL2XTDS measures only for FLASH2 BUT has the same data structure as the other BAMS ... thus there are also (random) values in in the FLASH1 time slot

977

** Structure: The first values are for FLASH1 bunches. After a gap of about 70 micros ( 70 colums) with as entry for the switching between FLASH 1 and 2 the values for the electrons used in FLASH2 start. The start time of FLASH2 is also recorded in the DAQ. FLASH1 start time is for historic reasons 700. thus if e.g. the start time of FLASH2 ( property name see below) is 1200 it means that FLASH starts at column 500 (1200-700) ... .In case of doubt ask your local contact

978

* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments >>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]

979

* [[LINK to detailed infos from MSK (may only work inside DESY network~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|height="12" width="13"~]~]>>url:http://www.desy.de/~~mbock/pages/BAM_daq_channel_descriptions.html||shape="rect"]]

980

* a recent [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]

====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======

986

987

(% style="color:#ff6600" %)**DBC2**/electron bunch arrival time (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}

988

989

990

/zraw/FLASH.SDIAG/BAM.DAQ/FL0.DBC2.ARRIVAL_TIME.ABSOLUTE.SA2.COMP/dGroup/

991

992

993

//always saved (PBD)//

994

**FL0.DBC2**

995

(% style="color:#000000" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA2.COMP

996

{{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA2.COMPDAQ {{/code}}(% style="letter-spacing:0.0px" %)desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). The property contains only the arrival time of the bunches sent to FL2 (e.g. if there are 30 bunches in FL2 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not0). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time of the XUV pulses in the experiment (see help).

997

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

998

999

1000

(% style="color:#ff6600" %)DBC2/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}

1001

1002

{{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.DBC2.ARRIVAL_TIME.ABSOLUTE.SA2/dGroup/{{/code}}

1003

//always saved (PBD)//

1004

{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE{{/code}}

1005

(% style="color:#000000" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel: {{/code}}(%%)

1006

desc: Electron bunch arrival time measured with the BAM inside the accelerator (after bunch compressor 2). Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 2 in the second part. they may be separated by several "0" values if the reprate is different from 1 MHz ... - It shows a very good correlation to the arrival time of the XUV pulses in the experiment (see help).

1007

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

1008

1009

1010

DBC2/error (% style="color:#f39c12" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/

1011

//always saved (PBD)//

1012

DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.bamError.2

1013

DAQ channel: FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR.2

1014

desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!

1015

1016

DBC2/status (% style="color:#e67e22" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/

1017

//always saved (PBD)//

1018

DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.bamStatus.//2//

1019

DAQ channel: FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.2

1020

desc: status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting; mostly check for bit 0 == 1 is sufficient

====== **BAM FL2.SEED5**{{code language="none"}}{{/code}} ======

1025

1026

/FL2/Electron Diagnostic/BAM/**SEED5**(% style="color:#ff6600" %)/electron bunch arrival time (HDF5 name not yet implemented - see zraw)

1027

1028

(% style="color:#000000" %){{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.SEED5.ARRIVAL_TIME.ABSOLUTE.SA2.COMP/dGroup/{{/code}}

1029

1030

//always saved (PBD)//

1031

(% style="color:#172b4d" %)**FL2.SEED5**(%%)

1032

(% style="color:#000000" %)channel: FLASH.SDIAG/BAM/(% style="color:#172b4d" %)**FL2.SEED5**(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP

1033

{{code language="none"}} DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ {{/code}}(%%)desc: Electron bunch arrival time measured with the BAM before the undulator (pulse resolved data). This one was newly installed in 2020.. The property contains only the arrival time of the bunches sent to FL2 (e.g. if there are 30 bunches in FL2 the first 30 values are the arrival time the remaining numbers still may have arbitrary numbers looking like a signal which they are not). These are the same values as the "raw" data below - just "cleaned". The values show a very good correlation to the arrival time of the XUV pulses in the experiment (see help).

1034

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

(% style="color:#172b4d" %)SEED5(% style="color:#ff6600" %)/electron bunch arrival time (raw) (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}

1039

1040

(% style="color:#000000" %){{code language="none"}}/zraw/FLASH.SDIAG/BAM.DAQ/FL0.SEED5.ARRIVAL_TIME.ABSOLUTE.SA2/dGroup/{{/code}}(%%)

1041

//always saved (PBD)//

1042

(% style="color:#172b4d" %)**FL2.SEED5**{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE{{/code}}(%%)

1043

**~ **(% style="color:#000000" %)FLASH.SDIAG/BAM/(% style="color:#172b4d" %)**FL2.SEED5**(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel:{{/code}}(%%)

1044

desc: Electron bunch arrival time measured with the BAM before the undulator (pulse resolved data). This one was newly installed in 2020. Here the complete bunch train from the FEL is recorded (FLASH1 and FLASH2 pulses). Thus there are values from FLASH 2 in the second part. they may be separated by several "0" values if the reprate is different from 1 MHz ... - It shows a very good correlation to the arrival time of the XUV pulses in the experiment (see help).

1045

units: fs (bigger numbers (typically) indicate later arrival times of the electrons).

1046

1047

1048

FL2.SEED5/error (% style="color:#f39c12" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/

1049

//always saved (PBD)//

1050

DOOCS prop : FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.bamError.2

1051

DAQ channel: FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.BAMERROR.2

1052

desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!

1053

1054

FL2.SEED5/status (% style="color:#e67e22" %)(HDF5 name not yet implemented - see zraw)(%%)/FL2/Electron Diagnostic/BAM/

1055

//always saved (PBD)//

1056

DOOCS prop : FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.bamStatus.//2//

1057

DAQ channel: FLASH.SDIAG/BAM/FL2.SEED5/ARRIVAL_TIME.BAMSTATUS.2

1058

desc: status bit: 0 - data is valid; 1 - beam present; 2 - calibration ongoing; 3 - feedback enabled; 4 - feedback acting; mostly check for bit 0 == 1 is sufficient

1059

1060

1061

[[Contents>>doc:||anchor="Contents"]]

1062

1063

1064

==== Timing information, rep rate etc. (FLASH2) ====

1065

1066

===== start time of FLASH2 =====

1067

1068

{{code language="none"}}/FL2/Timing/start time flash2{{/code}}

1069

//always saved (PBD2)//

1070

DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}

1071

DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/BUNCH_POSITION.2{{/code}}

1072

desc: The max 600 µs acceleration time of FLASH is devided between FLASH1 and FLASH2. This 600 µs window starts with FLASH1 (up to now) at a time"label" of 700 µs (for historic reasons). Thus the first bunch of FLASH 1 comes at "700" and the last possibel bunch comes at 1300 (700+600). After FLASH1 train is over ther is a about 70µs switching time with no bunches. Then comes the first FLASH2 bunch. Thus if e.g. the start time of FLASH2 is 1200 it means that FLASH2 starts at column 500 (1200-700) in the HDF5 files. (However for yet unknown reasons this may change by 2-3 colums ...)

1073

units: µs

1074

1075

===== bunch repetition rate =====

1076

1077

{{code language="none"}}/FL2/Timing/repetition rate{{/code}}

1078

//always saved (PBD2)//

1079

DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}

1080

DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.2{{/code}}

1081

desc: repetition rate of the bunches / pulses within the burst (FLASH2)

units: kHz

===== set number of pulses =====

1086

1087

(% style="color:#ff6600" %)(HDF5 name not yet implemented - see zraw)(% style="color:#ff0000" %){{code language="none"}}/FL2/Timing/set number of bunches {{/code}}(%%)

1088

//always saved (PBD2)//

1089

DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.2 [4th number]{{/code}}

1090

DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.2 [4th number]{{/code}}

1091

desc: Number of bunches set in the control (timing) system. The property contains 4 numbers. the last one is the number of pulses (see also [[doc:FLASH.Timing properties]] (internal link)). If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated and thus the actual number of pulses may be smaller than the set one

1092

units:

1093

1094

===== actual number of pulses =====

1095

1096

{{code language="none"}}/FL1/Timing/actual number of bunches{{/code}}

1097

//always saved (PBD2)//

1098

DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}

1099

DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}

1100

desc: Number of bunches measured BEHIND the undulator. If pulses are used for diagnostic of the protection system of the accelerator limits the number of bunches to be accelerated this is the actual number that created XUV radiation.The number is calculated by the DAQ middle layer server, (FLASH2)

1101

units:

1102

1103

===== actual pulse pattern recorded after the undulator =====

1104

1105

{{code language="none"}}/FL1/Timing/Bunch pattern/pattern after undulator{{/code}}

1106

//always saved (PBD2)//

1107

DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}

1108

DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}

1109

desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)

units:

===== Train ID =====

{{code language="none"}}/Timing/train ID{{/code}}

1115

//always saved (PBD2)//

1116

DOOCS prop : {{code language="none"}}none{{/code}}

1117

DAQ channel: {{code language="none"}}none{{/code}}

1118

desc: Each 10 Hz burst has its unique train ID. For the HDF5 dataset the ID is the same for all parameters with the same index (note camera images may be shifted by 1 ID - talk to the experts !)

1119

units:

1120

1121

===== (% style="color:#e67e22" %)Train time(%%) =====

1122

1123

(% style="color:#e67e22" %)//always saved (PBD2)//(%%)

1124

(% style="color:#e67e22" %){{code language="none"}}/Timing/train time{{/code}}

1125

desc:Local time as array of day, hour, minute, second, and centisecond. This dataset is meant for visualisation purposes only. For correlations use the train ID or the Unix time of the time stamp

units: d h min s cs

/Timing/time stamp

(% style="color:#e67e22" %)//always saved (PBD2)//(%%)

1133

(% style="color:#e67e22" %)desc: first column: Local time in unix time. To get day, hour, minute, second you can use unix: e.g. date ~-~-date='@1553617729' or matlab, python etc

1134

second column: microseconds

1135

third column: Train ID of FLASH

1136

1137

1138

(% id="cke_bm_2455529S" style="display:none" %) (%%)currently it is saved as Unix time in : /zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time

import time

# epoch time is found in /zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time #!!! a leading 1 has to be added !!!

1144

# The time and date of the start of the data taking in the HDF file is encoded in the filename - to roughly check the time

1145

epoch_time = 1709051499.17 # Replace with your epoch time

1146

1147

formatted_time = time.strftime('%Y-%m-%d %H:%M:%S', time.gmtime(epoch_time))

1148

print(formatted_time)

[[Contents>>doc:||anchor="Contents"]]

1155

1156

1157

==== User Data (FLASH2) ====

1158

1159

The data saved specifically for detectors at an experiment will show up in /Experiment/ there is a large number of options for cameras or monitoring pslow properties (motor positons etc) for user experiments. For details please ask your local contact.

1160

1161

NOTE: If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with the DOOCS names

1162

1163

The most common and permanently installed device used by experiment are our ADCs:

===== GHz ADCs =====

ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FS-FLASH USER tmp.Data Acquisition and controls 1.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**

1168

//saved on DEMAND in the user DAQ//

1169

\\Up to now there are 4 channels available at FL24

1170

\\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}

1171

{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH01/TD{{/code}}

1172

\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH02/TD{{/code}}{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH03/TD{{/code}}

1173

1174

1175

DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00/CH00.TD or CH00.DAQ.TD{{/code}}

1176

here the {{code language="none"}}CH00.TD{{/code}} is the full ADC trace as it is sampled ( typically several 100.000 samples per pulse train) while the {{code language="none"}}CH00.DAQ.TD{{/code}} trace only has the number of samples which are sent to the DAQ OR if //grouping// is activated the {{code language="none"}}CH00.DAQ.TD{{/code}} conatins only the grouped spectra. To read the ADC trace with an online analysis program the {{code language="none"}}CH00.DAQ.TD{{/code}} is used preferablly.

1177

DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.FL2EXP1/FL2EXP1.CH00{{/code}}

1178

1179

In addition there are also additional parameters saved like:

1180

1181

* {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.

1182

* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger

1183

* {{code language="none"}}error (ADC):{{/code}}0 indicates that there was no error

1184

* {{code language="none"}}/CH0-CH3/offset{{/code}}: To use the full dynamic range of the ADC one can shift the base line . This offset is saved here.

===== MHz ADCs =====

similar to the GHz ADCs the MHz ADCs are saved with HDF5 names like:

1189

{{code language="none"}}/FL2/Experiment/MTCA-EXP1/SIS8300 100MHz ADC/CH2/TD{{/code}}

1190

DOOCS prop : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02/CH00.TD

1191

DAQ channel: : FLASH.FEL/ADC.SIS.FL2EXP1/FL2EXP1.CH02

1192

1193

In addition there are also additional parameters saved like:

1194

1195

* {{code language="none"}}sample frequency{{/code}}: it shows the sample frequency in MHz (number of samples per µs). NOTE: the clock of the ADC is NOT synchronized to the FLASH timing system. Thus the number of samples between bunches in the bunch train may be not integer numbers which will be show up for long bunch trains.

1196

* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger

1197

1198

[[Contents>>doc:||anchor="Contents"]]

==== Pump Probe Laser (FLASH2) ====

1203

1204

1205

list of saved parameters status May 2024 (up to now the parameters can be found in /zraw/ ... )

1206

1207

[[attach:FSLADAQ-DAQParameterlistULGAN-2.pdf||target="_blank"]]

1208

1209

[[attach:FSLADAQ-DAQParameterlistFL23-2.pdf||target="_blank"]]

1210

1211

[[attach:FSLADAQ-DAQParameterlistFL24-2.pdf||target="_blank"]]

internal link to parameter list: [[FS-LA DAQ - XWiki>>url:https://xwiki.desy.de/xwiki/bin/view/FSLADAQ/]]

These are the parameters that can be saved in the FL2 User DAQ for the FL2 PP laser//** FOR BEAMLINE FL24**//

**User delay**

Delay (set value):

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR

Delay (readback):

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD

1240

1241

1242

(% style="letter-spacing:0.0px" %)Delay (encoder readback):

1243

1244

1245

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.ENCODER_POSITION.RD

OXC. jitter:

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD

**FL24 Pulse resolved energy:**

1257

1258

OPCPA output (photodiode signal raw ADC trace 16000 samples):

1259

1260

1261

/zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH23.TD/dGroup

1262

1263

1264

(% style="letter-spacing:0.0px" %)Upper breadboard Photodiode (THG) burst (photodiode signal raw ADC trace 16000 samples)::

1265

1266

1267

/zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH26.TD/dGroup

1268

1269

1270

Upper breadboard Photodiode (THG) energy (analyzed signal. integration over pulses in the ADC trace. contains for each laser pulse the pulse energy in a.u.)

1271

1272

1273

/zraw/FLASH.LASER/MOD24.PES/FL24_userPD/dGroup

**FL24 LAM (Laser Arrivaltime Monitor) pulse resolved data:**

1278

1279

Signal of Photodiode1 - for experts only... (analyzed signal. integration over pulses in the ADC trace. )

1280

1281

1282

/zraw/FLASH.LASER/MOD24.PES/LAM.PD1/dGroup

1283

1284

1285

Signal of Photodiode2 - for experts only... (analyzed signal. integration over pulses in the ADC trace.)

1286

1287

1288

/zraw/FLASH.LASER/MOD24.PES/LAM.PD2/dGroup

1289

1290

1291

"Actual" LAM Signal - to be calibrated ...... (analyzed signal. integration over pulses in the ADC trace.)

1292

1293

1294

/zraw/FLASH.LASER/MOD24.PES/LAM.PDBAL/dGroup

1295

1296

1297

The delay feedback(% style="letter-spacing:0.0px" %)

1298

1299

1300

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26

1301

1302

1303

The LAM delay feedback(% style="letter-spacing:0.0px" %) (the pulse energy signal, which is saved in the above but maybe it’s good to have this also as slow, in the case these two numbers are not the same the sysdc was active instead of the LAM):

1304

1305

1306

FLASH.LASER/MOD24.PES/LAM.PDBAL/PULSEENERGY.MEAN

LAM Delay line act:

{{code language="none"}}FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.1.POSITION.RD{{/code}}

LAM Delay line set:

FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.1.POSITION_SET.WR

1316

1317

1318

LAM Delay line encoder:

1319

1320

1321

FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.1.ENCODER_POSITION.RD

1322

1323

1324

Temperature feedback:

1325

1326

1327

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE24

1328

1329

1330

**Feedback mode** (if this is not =1 the delay FB is not active, then it’s either temp feedback controlled or failsave, maybe it’s good to have):

1331

1332

1333

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.INTS/INTEGER30

**FL24 Attenuator angle:**

1338

1339

1340

FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS

1341

1342

1343

**FL24 Polarization control:**

1344

1345

1346

FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS

1347

1348

1349

**SysDC delay error:**

1350

1351

1352

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26

**Timing error: (these two need to be observed and both=0 means no error)**

1357

1358

1359

FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm

FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN

1364

1365

1366

**Laser error status:**

1367

1368

1369

**FL24 Virtual camera X and Y history, beam size: (use slow data)**

1370

1371

1372

FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.X

FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.Y

FLASH.LASER/MOD24.CAM/UV.14.VF/ROI_SPECTRUM.X.SIG

//{{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}always saved (PBD2)//

1385

DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}

1386

DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}

1387

desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)

units : deg.

//{{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/polarization position{{/code}}always saved (PBD2)//

1393

DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}

1394

DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR2.FL24/FPOS{{/code}}

1395

desc: attenuation of the PPLaser in the FL24 hutch (rotation of a waveplate)

units : deg.

{{code language="none"}}/FL1/Experiment/Pump probe laser/laser delay readback{{/code}}

1400

//always saved (PBD2)//

1401

DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}

1402

DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/FMC0.MD22.0.POSITION.RD{{/code}}

1403

desc: delay of the Pump probe laser - measured by the read back position of the motor. There is also the set value available ( upto now these values are only updating every 1-2 seconds. There is no fast encoder property as on FLASH1 available)

units : ps )

{{code language="none"}}/FL1/Experiment/Pump probe laser/Synchronization/timing jitter RMS{{/code}}

1408

//always saved (PBD)//

1409

DOOCS prop : {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}

1410

DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}

1411

desc: rms jitter of the fs-Oscillator

units: fs

==== FL 26 Pump Probe Laser (FLASH2) ====

1417

1418

These are the parameters that can be saved in the FL2 User DAQ for the FL2 PP laser//** FOR BEAMLINE FL26**//

**User delay**

Delay (set value):

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR

Delay (readback):

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD

1433

1434

1435

Delay (encoder readback):

1436

1437

1438

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.ENCODER_POSITION.RD

OXC. jitter:

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD

**Parameters for FL26**

1449

1450

(% class="wrapped" %)

1451

|(((

1452

FL2PPL FL26 REMI Attenuation: HWP motor current position

1453

)))|(((

1454

FLASH.FEL/FLAPP2BEAMLINES/MOTOR11.FL26B/FPOS

1455

)))

1456

|(((

1457

FL2PPL FL26 REMI Polarization: linear polarization angle

1458

)))|(((

1459

FLASH.FEL/FLAPP2BEAMLINES/MOTOR12.FL26B/FPOS

1460

)))

1461

|(((

1462

FL2PPL FL26 REMI Diagnostics: NIR spectrum

1463

)))|(((

1464

FLASH.LASER/MOD26.SPECT/REMI/DAQ_CHANNEL

1465

)))

1466

|(((

1467

FL2PPL FL26 REMI Diagnostics: photo diode input MOD2.6 - pulse energy mean

1468

)))|(((

1469

FLASH.LASER/MOD26.PES/RE_OUT/PULSEENERGY.MEAN

1470

)))

1471

|(((

1472

FL2PPL FL26 REMI Diagnostics: photo diode input MOD2.6 - intra burst pulse energy

1473

)))|(((

1474

FLASH.LASER/MOD26.PES/RE_OUT/DAQ_CHANNEL

1475

)))

1476

|(((

1477

FL2PPL FL26 REMI Diagnostics: photo diode input MOD2.6 - raw adc

1478

)))|(((

1479

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH04.TD

1480

)))

1481

|(((

1482

FL2PPL FL26 REMI Diagnostics: photo diode input REMI - pulse energy mean

1483

)))|(((

1484

FLASH.LASER/MOD26.PES/INC_BOX/PULSEENERGY.MEAN

1485

)))

1486

|(((

1487

FL2PPL FL26 REMI Diagnostics: photo diode input REMI - intra burst pulse energy

1488

)))|(((

1489

FLASH.LASER/MOD26.PES/INC_BOX/DAQ_CHANNEL

1490

)))

1491

|(((

1492

FL2PPL FL26 REMI Diagnostics: photo diode input REMI - raw adc

1493

)))|(((

1494

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH05.TD

1495

)))

1496

|(((

1497

FL2PPL FL26 REMI In coupling: filter wheel 1 position

1498

)))|(((

1499

FLASH/MOD26.FW1/FLASH2MOD26/pos

1500

)))

1501

|(((

1502

FL2PPL FL26 REMI In coupling: filter wheel 2 position

1503

)))|(((

1504

FLASH/MOD26.FW2/FLASH2MOD26/pos

1505

)))

1506

|(((

1507

FL2PPL FL26 REMI: Energy meter REMI incoupling breadboard

1508

)))|(((

1509

FLASH.LASER/MOD26.OPHIRE/REINC.54/DAQ_CHANNEL

1510

)))

1511

|(((

1512

FL2PPL FL26 REMI Incoupling: focusing lens position

1513

)))|(((

1514

FLASH.FEL/FLAPP2BEAMLINES/MOTOR3.FL26B/FPOS

1515

)))

1516

|(((

1517

FL2PPL FL26 REMI Incoupling: nearfield

1518

)))|(((

1519

FLASH.LASER/MOD26.CAM/REINC.21.NF/DAQ_CHANNEL

1520

)))

1521

|(((

1522

FL2PPL FL26 REMI Incoupling: focus

1523

)))|(((

1524

FLASH.LASER/MOD26.CAM/REINC.22.FF/DAQ_CHANNEL

1525

)))

1526

|(((

1527

FL2PPL FL26 REMI Drift: relative arrival time intra burst LAM balanced - calb. in the PES

1528

)))|(((

1529

FLASH.LASER/MOD26.PES/LAM_DIFF/DAQ_CHANNEL

1530

)))

1531

|(((

1532

FL2PPL FL26 REMI Drift: forward signal (PD1) raw

1533

)))|(((

1534

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH00.TD

1535

)))

1536

|(((

1537

FL2PPL FL26 REMI Drift: backward signal (PD2) raw

1538

)))|(((

1539

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH01.TD

1540

)))

1541

|(((

1542

FL2PPL FL26 REMI Drift: mean relative burst arrival time - avarage of the calib value

1543

)))|(((

1544

FLASH.LASER/MOD26.PES/LAM_DIFF/PULSEENERGY.MEAN

1545

)))

1546

|(((

1547

FL2PPL FL26 REMI Drift: delay line position (ODL of the LAM REMI)

1548

)))|(((

1549

FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL26B/FPOS

1550

)))

1551

|(((

1552

FL2PPL FL26 Laser Hutch: delay line position (ODL of the osc. Sync / user delay)

1553

)))|(((

1554

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD

1555

)))

1556

|(((

1557

FL2PPL FL26 REMI Drift: delay line encoder position (ODL REMI raw value)

1558

)))|(((

1559

FLASH.SYNC/LAM.EXP.ODL/F2.MOD.AMC12/FMC0.MD22.0.ENCODER_POSITION.RD

1560

)))

1561

|(((

1562

Jiiter between oscillator and MLO (inloop jitter osc. Sync)

1563

)))|(((

1564

FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD

1565

)))

1566

|(((

1567

Temperature controlled fiber (PWM signal to the temperature controlled fiber delay sysdc)

1568

)))|(((

1569

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE23

1570

)))

1571

|(((

1572

Temperature controlled fiber (Temp of the fiber delay sysdc)

1573

)))|(((

1574

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE24

1575

)))

1576

|(((

1577

Sydc feedback data if LAM is not activated (sysdc delay)

1578

)))|(((

1579

FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26

)))

=== "/uncategorized/" ===

1586

1587

If parameters for an experiment are included on short notice the correct naming in the HDF5 may not be in time and the data will show up in /uncategorized/ with their DOOCS names

1588

1589

1590

=== HDF5 structure revisions ===

1591

1592

Starting with Beamblock 4, August 2018, the hierarchy of the HDF group names have been adapted to reflect the new situation at FLASH. FLASH2 is operating for users quite some time now. Therefore, both accelerators appear equally in their respective HDF groups, namely "/FL1" and "/FL2". The root group of proper, by run organised HDF files have an attribute called "version". This version attribute has changed from "0.2.x" to "0.3.x". The changes in detail:

1593

1594

1595

* All FLASH1 related HDF groups moved to group "/FL1", i.e. a new prefix "/FL1" is added to their HDF path.

1596

* The ambigious term "pulse" has been replaced by "train" to refer to "pulse train". Most notably, the dataset "/Timing/pulse ID" has changed to "/Timing/train ID".

1597

* A number of inconsistent names have been streamlined. The relevant changes are listed in the following table.

1598

1599

(% class="wrapped" %)

1600

|=(((

1601

earlier HDF path (vers. 0.2)

)))|=(((

is now (vers. 0.3)

)))

|(((

/Photon Diagnostic/GMD/Beam position/position BDA x

1607

)))|(((

1608

/FL1/Photon Diagnostic/GMD/Beam position/position BDA horizontal

1609

)))

1610

|(((

1611

/Photon Diagnostic/GMD/Beam position/position BDA y

1612

)))|(((

1613

/FL1/Photon Diagnostic/GMD/Beam position/position BDA vertical

1614

)))

1615

|(((

1616

/Photon Diagnostic/GMD/Beam position/position tunnel x

1617

)))|(((

1618

/FL1/Photon Diagnostic/GMD/Beam position/position tunnel horizontal

1619

)))

1620

|(((

1621

/Photon Diagnostic/GMD/Beam position/position tunnel y

1622

)))|(((

1623

/FL1/Photon Diagnostic/GMD/Beam position/position tunnel vertical

1624

)))

1625

|(((

1626

/Experiment/Pump probe laser/BPM/position x

1627

)))|(((

1628

/FL1/Experiment/Pump probe laser/BPM/position horizontal

1629

)))

1630

|(((

1631

/Experiment/Pump probe laser/BPM/position y

1632

)))|(((

1633

/FL1/Experiment/Pump probe laser/BPM/position vertical

1634

)))

1635

|(((

1636

/FL2/Photon Diagnostic/GMD/Beam position/Average/position hall horizontal

1637

)))|(((

1638

/FL2/Photon Diagnostic/GMD/Average beam position/position hall horizontal

1639

)))

1640

|(((

1641

/FL2/Photon Diagnostic/GMD/Beam position/Average/position hall vertical

1642

)))|(((

1643

/FL2/Photon Diagnostic/GMD/Average beam position/position hall vertical

1644

)))

1645

|(((

1646

/FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel horizontal

1647

)))|(((

1648

/FL2/Photon Diagnostic/GMD/Average beam position/position tunnel horizontal

1649

)))

1650

|(((

1651

/FL2/Photon Diagnostic/GMD/Beam position/Average/position tunnel vertical

1652

)))|(((

1653

/FL2/Photon Diagnostic/GMD/Average beam position/position tunnel vertical

1654

)))

1655

|(((

1656

/FL2/Photon Diagnostic/GMD/Average energy/hall

1657

)))|(((

1658

/FL2/Photon Diagnostic/GMD/Average energy/energy hall

1659

)))

1660

|(((

1661

/FL2/Photon Diagnostic/GMD/Average energy/hall (raw)

1662

)))|(((

1663

/FL2/Photon Diagnostic/GMD/Average energy/energy hall (raw)

1664

)))

1665

|(((

1666

/FL2/Photon Diagnostic/GMD/Average energy/tunnel

1667

)))|(((

1668

/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel

1669

)))

1670

|(((

1671

/FL2/Photon Diagnostic/GMD/Average energy/tunnel (raw)

1672

)))|(((

1673

/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel (raw)

1674

)))

1675

|(((

1676

/FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall x

1677

)))|(((

1678

/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall horizontal

1679

)))

1680

|(((

1681

/FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/hall y

1682

)))|(((

1683

/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position hall vertical

1684

)))

1685

|(((

1686

/FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel x

1687

)))|(((

1688

/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel horizontal

1689

)))

1690

|(((

1691

/FL2/Photon Diagnostic/GMD/Beam position/Pulse resolved/tunnel y

1692

)))|(((

1693

/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel vertical

1694

)))

1695

1696

[[Contents>>doc:||anchor="Contents"]]

Wiki source code of The FLASH HDF5 structure