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.

22

23

24

Alternativaly you can also use a conventional HDF viewer:

25

26

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

27

28

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

29

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

30

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

or you can use

> silx view

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

40

41

== The FLASH HDF5 format ==

42

43

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.

44

45

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.

46

47

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

48

49

50

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

51

52

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

53

54

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.

55

56

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.

57

58

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.

59

60

61

**HDF5 example files (old format)**

62

63

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

64

65

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

66

67

68

[[~[~[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: ===

75

76

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

77

78

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

79

80

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

81

82

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

83

84

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

85

86

* (((

87

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

88

)))

89

90

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

91

92

93

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

94

95

96

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

97

98

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

99

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

100

101

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

107

108

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

109

110

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

119

120

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

121

122

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

123

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

124

125

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

126

//always saved (PBD)//

127

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

128

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

129

desc: set pressure in the gas attenuator

130

units: mbar

131

132

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

133

//always saved (PBD)//

134

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

135

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

136

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

137

units: none

138

139

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

140

//always saved (PBD)//

141

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

142

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

143

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

144

units: none

145

146

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

147

//always saved (PBD)//

148

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

149

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

150

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

151

units: degree

152

153

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

154

//always saved (PBD)//

155

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

156

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

157

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

158

units: degree

159

160

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

161

//always saved (PBD)//

162

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

163

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

164

desc: Position of the PG filter wheel 1

165

units: degree

166

167

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

168

//always saved (PBD)//

169

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

170

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

171

desc: Position of the PG filter wheel 2

172

units: degree

173

174

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

175

//always saved (PBD)//

176

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

177

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

178

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

184

185

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

186

187

188

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

189

190

191

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

192

193

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

194

//always saved (PBD)//

195

196

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

197

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

198

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

199

units : microJ

200

201

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

202

//always saved (PBD)//

203

204

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

205

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

206

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

207

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

208

209

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

210

//always saved (PBD)//

211

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

212

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

213

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

214

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

215

216

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

217

//always saved (PBD)//

218

219

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

220

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

221

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

222

units : microJ

223

224

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

225

//always saved (PBD)//

226

227

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

228

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

229

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

230

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

231

232

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

233

//always saved (PBD)//

234

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

235

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

236

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

237

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

242

243

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

244

//always saved (PBD)//

245

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

246

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

247

248

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

253

//always saved (PBD)//

254

255

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

256

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

257

258

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)

259

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

260

261

262

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

263

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

1. Combined warning and error flags

272

273

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

274

file

275

276

[[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 !

282

283

284

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

285

286

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

287

//always saved (PBD)//

288

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

289

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

290

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

291

units : mm

292

293

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

294

//always saved (PBD)//

295

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

296

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

297

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

298

units : mm

299

300

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

301

//always saved (PBD)//

302

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

303

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

304

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

305

units : mm

306

307

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

308

//always saved (PBD)//

309

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

310

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

311

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

units : mm

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

316

317

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

318

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

319

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

320

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

321

desc : XUV Spectrum measured with the "tunnel spectrometer"

322

units :

323

324

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

325

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

326

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

327

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

328

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

329

units : nm

330

331

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

332

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

333

DOOCS prop : ==

334

DAQ channel: ==

335

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

336

units : nm

337

338

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

339

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

340

DOOCS prop : ==

341

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

342

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

343

units :

344

345

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

346

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

347

DOOCS prop : ==

348

DAQ channel: ==

349

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

350

units : eV

351

352

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

353

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

354

DOOCS prop : ==

355

DAQ channel: ==

356

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

357

units : eV

358

359

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

360

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

361

DOOCS prop : ==

362

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

363

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

364

units :

365

366

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

367

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

368

DOOCS prop : ==

369

DAQ channel: ==

370

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

371

units : nm

372

373

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

374

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

375

DOOCS prop : ==

376

DAQ channel: ==

377

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

378

units : nm

379

380

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

381

382

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

383

384

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

385

386

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

387

//always saved (PBD)//

388

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

389

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

390

desc: electron bunch charge (FLASH1)

units: nC

=====

arrival time (BAM) =====

395

396

397

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

398

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

399

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

400

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

401

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

402

** acc: 4DBC3 → FL0.DBC2

403

** FL1: 1SFELC → FL1.SFELC

404

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

405

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

406

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

407

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

412

413

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

414

//always saved (PBD)//

415

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

416

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

417

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

418

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

419

420

421

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

422

//always saved (PBD)//

423

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

424

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

425

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

426

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

427

428

429

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

430

431

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

432

//always saved (PBD)//

433

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

434

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

435

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

436

437

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

438

439

440

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

441

//always saved (PBD)//

442

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

443

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

444

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

445

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

446

447

448

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

449

//always saved (PBD)//

450

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

451

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

452

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

453

454

455

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

456

//always saved (PBD)//

457

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

458

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

459

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

460

461

462

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

463

464

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

465

466

//always saved (PBD)//

467

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

468

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

469

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

470

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

475

//always saved (PBD)//

476

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

477

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

478

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

479

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

480

481

482

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

483

//always saved (PBD)//

484

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

485

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

486

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

487

488

489

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

490

//always saved (PBD)//

491

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

492

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

493

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

498

499

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

500

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

501

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

502

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

503

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

504

units: pixel

505

506

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

507

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

508

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

509

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

510

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

511

units: fs per pixel

512

513

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

514

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

515

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

516

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

517

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

518

units: fs

519

520

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

521

522

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

523

//always saved (PBD)//

524

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

525

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

526

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

527

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

528

529

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

530

//always saved (PBD)//

531

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

532

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

533

desc: electron bunch energy bunch resolved

534

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

535

536

537

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

538

//always saved (PBD)//

539

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

540

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

541

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

542

units: nm

543

544

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

==== ====

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

551

552

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

553

554

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

555

//always saved (PBD)//

556

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

557

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

558

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

559

units: kHz

560

561

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

562

563

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

564

//always saved (PBD)//

565

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

566

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

567

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

568

units:

569

570

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

571

572

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

573

//always saved (PBD)//

574

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

575

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

576

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)

577

units:

578

579

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

580

581

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

582

//always saved (PBD)//

583

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

584

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

585

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

591

//always saved (PBD)//

592

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

593

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

594

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

595

units:

596

597

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

598

599

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

600

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

601

units: d h min s cs

602

603

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

604

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

605

second column: microseconds

606

third column: Train ID of FLASH

607

608

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

614

# 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

615

epoch_time = 1709051499.17 # Replace with your epoch time

616

617

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

618

print(formatted_time)

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

625

626

**PIGLET (PG laser)**

627

628

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

629

630

631

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

644

645

646

//always saved (PBD)//

647

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

648

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

649

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

650

units : 0 no transmission , 1: full transmission

651

652

653

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

654

//always saved (PBD)//

655

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

656

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

657

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

658

units : ps ( pos delay means IR comes later)

659

660

661

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

662

//always saved (PBD)//

663

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

664

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

665

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

666

units : ps ( pos delay means IR comes later)

667

668

669

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

670

//always saved (PBD)//

671

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

672

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

673

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

674

675

676

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

677

//always saved (PBD)//

678

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

679

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

680

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

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

685

686

687

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

688

689

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.

690

691

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

692

693

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

698

//saved on DEMAND in the user DAQ//

699

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

700

\\PG Beamline:

701

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

702

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

703

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

704

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

705

706

BL Beamlines:

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

716

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

717

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.

718

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

719

720

In addition there are also additional parameters saved like:

721

722

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

723

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

724

* {{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:

729

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

730

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

731

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

732

733

In addition there are also additional parameters saved like:

734

735

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

736

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

737

738

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

=== FLASH2 ===

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

745

746

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

747

748

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

749

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

750

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

751

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

752

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

753

754

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

755

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

756

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

757

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

762

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

763

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

764

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

765

units: degree

766

767

/FL2/Beamlines/Filter wheel/position wheel 2

768

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

769

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

770

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

775

776

[[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) ====

781

782

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

783

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

784

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

785

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

790

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

791

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

792

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)

793

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

794

795

796

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

797

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

1. Combined warning and error flags

806

807

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 !

818

819

820

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

821

822

823

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

824

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

825

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

826

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

831

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

832

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

833

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

838

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

839

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

840

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

841

units : mm

842

843

(x=horizontal, y = vertial)

844

845

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

850

851

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

852

853

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

854

855

856

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

857

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

858

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

859

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

864

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

865

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

866

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

871

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

872

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

873

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

874

units :

875

876

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

877

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

878

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

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

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

892

893

894

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

895

896

897

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

902

903

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

904

905

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

906

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

907

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

908

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

units: nC

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

913

914

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

915

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

916

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

917

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

918

919

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

920

921

922

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

923

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

924

925

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

926

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

927

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

928

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

929

units: nm

930

931

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

932

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

933

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

934

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

935

units: mm

936

937

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

938

939

=====

940

arrival time (BAM) =====

941

942

943

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

944

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

945

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

946

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

947

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

948

** acc: 4DBC3 → FL0.DBC2

949

** FL1: 1SFELC → FL1.SFELC

950

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

951

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

952

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

953

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

958

959

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

960

//always saved (PBD2)//

961

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

962

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

963

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

964

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

965

966

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

967

//always saved (PBD2)//

968

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

969

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

970

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

971

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

972

973

974

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

975

* 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

976

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

977

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

978

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

979

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

985

986

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

987

988

989

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

990

991

992

//always saved (PBD)//

993

**FL0.DBC2**

994

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

995

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

996

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

997

998

999

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

1000

1001

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

1002

//always saved (PBD)//

1003

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

1004

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

1005

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

1006

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

1007

1008

1009

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

1010

//always saved (PBD)//

1011

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

1012

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

1013

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

1014

1015

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

1016

//always saved (PBD)//

1017

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

1018

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

1019

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

1024

1025

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

1026

1027

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

1028

1029

//always saved (PBD)//

1030

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

1031

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

1032

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

1033

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

1038

1039

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

1040

//always saved (PBD)//

1041

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

1042

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

1043

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

1044

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

1045

1046

1047

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

1048

//always saved (PBD)//

1049

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

1050

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

1051

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

1052

1053

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

1054

//always saved (PBD)//

1055

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

1056

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

1057

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

1058

1059

1060

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

1061

1062

1063

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

1064

1065

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

1066

1067

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

1068

//always saved (PBD2)//

1069

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

1070

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

1071

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

1072

units: µs

1073

1074

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

1075

1076

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

1077

//always saved (PBD2)//

1078

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

1079

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

1080

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

units: kHz

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

1085

1086

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

1087

//always saved (PBD2)//

1088

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

1089

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

1090

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

1091

units:

1092

1093

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

1094

1095

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

1096

//always saved (PBD2)//

1097

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

1098

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

1099

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)

1100

units:

1101

1102

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

1103

1104

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

1105

//always saved (PBD2)//

1106

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

1107

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

1108

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

1114

//always saved (PBD2)//

1115

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

1116

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

1117

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

1118

units:

1119

1120

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

1121

1122

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

1123

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

1124

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

1132

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

1133

second column: microseconds

1134

third column: Train ID of FLASH

1135

1136

1137

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

1143

# 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

1144

epoch_time = 1709051499.17 # Replace with your epoch time

1145

1146

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

1147

print(formatted_time)

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

1154

1155

1156

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

1157

1158

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.

1159

1160

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

1161

1162

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

1167

//saved on DEMAND in the user DAQ//

1168

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

1169

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

1170

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

1171

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

1172

1173

1174

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

1175

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.

1176

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

1177

1178

In addition there are also additional parameters saved like:

1179

1180

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

1181

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

1182

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

1183

* {{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:

1188

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

1189

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

1190

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

1191

1192

In addition there are also additional parameters saved like:

1193

1194

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

1195

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

1196

1197

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

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

1202

1203

1204

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

1205

1206

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

1207

1208

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

1209

1210

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

1239

1240

1241

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

1242

1243

1244

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

1256

1257

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

1258

1259

1260

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

1261

1262

1263

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

1264

1265

1266

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

1267

1268

1269

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

1270

1271

1272

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

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

1277

1278

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

1279

1280

1281

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

1282

1283

1284

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

1285

1286

1287

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

1288

1289

1290

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

1291

1292

1293

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

1294

1295

1296

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

1297

1298

1299

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

1300

1301

1302

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

1303

1304

1305

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

1315

1316

1317

LAM Delay line encoder:

1318

1319

1320

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

1321

1322

1323

Temperature feedback:

1324

1325

1326

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

1327

1328

1329

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

1330

1331

1332

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

**FL24 Attenuator angle:**

1337

1338

1339

FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS

1340

1341

1342

**FL24 Polarization control:**

1343

1344

1345

FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS

1346

1347

1348

**SysDC delay error:**

1349

1350

1351

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

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

1356

1357

1358

FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm

FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN

1363

1364

1365

**Laser error status:**

1366

1367

1368

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

1369

1370

1371

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

1384

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

1385

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

1386

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

1392

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

1393

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

1394

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

1399

//always saved (PBD2)//

1400

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

1401

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

1402

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

1407

//always saved (PBD)//

1408

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

1409

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

1410

desc: rms jitter of the fs-Oscillator

units: fs

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

1416

1417

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

1432

1433

1434

Delay (encoder readback):

1435

1436

1437

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

1448

1449

(% class="wrapped" %)

1450

|(((

1451

FL2PPL FL26 REMI Attenuation: HWP motor current position

1452

)))|(((

1453

FLASH.FEL/FLAPP2BEAMLINES/MOTOR11.FL26B/FPOS

1454

)))

1455

|(((

1456

FL2PPL FL26 REMI Polarization: linear polarization angle

1457

)))|(((

1458

FLASH.FEL/FLAPP2BEAMLINES/MOTOR12.FL26B/FPOS

1459

)))

1460

|(((

1461

FL2PPL FL26 REMI Diagnostics: NIR spectrum

1462

)))|(((

1463

FLASH.LASER/MOD26.SPECT/REMI/DAQ_CHANNEL

1464

)))

1465

|(((

1466

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

1467

)))|(((

1468

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

1469

)))

1470

|(((

1471

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

1472

)))|(((

1473

FLASH.LASER/MOD26.PES/RE_OUT/DAQ_CHANNEL

1474

)))

1475

|(((

1476

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

1477

)))|(((

1478

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH04.TD

1479

)))

1480

|(((

1481

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

1482

)))|(((

1483

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

1484

)))

1485

|(((

1486

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

1487

)))|(((

1488

FLASH.LASER/MOD26.PES/INC_BOX/DAQ_CHANNEL

1489

)))

1490

|(((

1491

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

1492

)))|(((

1493

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH05.TD

1494

)))

1495

|(((

1496

FL2PPL FL26 REMI In coupling: filter wheel 1 position

1497

)))|(((

1498

FLASH/MOD26.FW1/FLASH2MOD26/pos

1499

)))

1500

|(((

1501

FL2PPL FL26 REMI In coupling: filter wheel 2 position

1502

)))|(((

1503

FLASH/MOD26.FW2/FLASH2MOD26/pos

1504

)))

1505

|(((

1506

FL2PPL FL26 REMI: Energy meter REMI incoupling breadboard

1507

)))|(((

1508

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

1509

)))

1510

|(((

1511

FL2PPL FL26 REMI Incoupling: focusing lens position

1512

)))|(((

1513

FLASH.FEL/FLAPP2BEAMLINES/MOTOR3.FL26B/FPOS

1514

)))

1515

|(((

1516

FL2PPL FL26 REMI Incoupling: nearfield

1517

)))|(((

1518

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

1519

)))

1520

|(((

1521

FL2PPL FL26 REMI Incoupling: focus

1522

)))|(((

1523

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

1524

)))

1525

|(((

1526

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

1527

)))|(((

1528

FLASH.LASER/MOD26.PES/LAM_DIFF/DAQ_CHANNEL

1529

)))

1530

|(((

1531

FL2PPL FL26 REMI Drift: forward signal (PD1) raw

1532

)))|(((

1533

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH00.TD

1534

)))

1535

|(((

1536

FL2PPL FL26 REMI Drift: backward signal (PD2) raw

1537

)))|(((

1538

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH01.TD

1539

)))

1540

|(((

1541

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

1542

)))|(((

1543

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

1544

)))

1545

|(((

1546

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

1547

)))|(((

1548

FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL26B/FPOS

1549

)))

1550

|(((

1551

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

1552

)))|(((

1553

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

1554

)))

1555

|(((

1556

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

1557

)))|(((

1558

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

1559

)))

1560

|(((

1561

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

1562

)))|(((

1563

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

1564

)))

1565

|(((

1566

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

1567

)))|(((

1568

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

1569

)))

1570

|(((

1571

Temperature controlled fiber (Temp of the fiber delay sysdc)

1572

)))|(((

1573

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

1574

)))

1575

|(((

1576

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

1577

)))|(((

1578

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

)))

=== "/uncategorized/" ===

1585

1586

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

1587

1588

1589

=== HDF5 structure revisions ===

1590

1591

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:

1592

1593

1594

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

1595

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

1596

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

1597

1598

(% class="wrapped" %)

1599

|=(((

1600

earlier HDF path (vers. 0.2)

)))|=(((

is now (vers. 0.3)

)))

|(((

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

1606

)))|(((

1607

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

1608

)))

1609

|(((

1610

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

1611

)))|(((

1612

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

1613

)))

1614

|(((

1615

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

1616

)))|(((

1617

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

1618

)))

1619

|(((

1620

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

1621

)))|(((

1622

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

1623

)))

1624

|(((

1625

/Experiment/Pump probe laser/BPM/position x

1626

)))|(((

1627

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

1628

)))

1629

|(((

1630

/Experiment/Pump probe laser/BPM/position y

1631

)))|(((

1632

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

1633

)))

1634

|(((

1635

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

1636

)))|(((

1637

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

1638

)))

1639

|(((

1640

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

1641

)))|(((

1642

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

1643

)))

1644

|(((

1645

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

1646

)))|(((

1647

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

1648

)))

1649

|(((

1650

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

1651

)))|(((

1652

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

1653

)))

1654

|(((

1655

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

1656

)))|(((

1657

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

1658

)))

1659

|(((

1660

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

1661

)))|(((

1662

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

1663

)))

1664

|(((

1665

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

1666

)))|(((

1667

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

1668

)))

1669

|(((

1670

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

1671

)))|(((

1672

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

1673

)))

1674

|(((

1675

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

1676

)))|(((

1677

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

1678

)))

1679

|(((

1680

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

1681

)))|(((

1682

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

1683

)))

1684

|(((

1685

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

1686

)))|(((

1687

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

1688

)))

1689

|(((

1690

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

1691

)))|(((

1692

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

1693

)))

1694

1695

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

Wiki source code of The FLASH HDF5 structure

Navigation