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 doubbelclicking 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) nad create the link via:

> silx view

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

23

24

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

25

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

26

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

or you can use

> silx view

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

36

37

== The FLASH HDF5 format ==

38

39

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.

40

41

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.

42

43

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

44

45

46

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

47

48

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

49

50

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.

51

52

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.

53

54

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.

55

56

57

**HDF5 example files (old format)**

58

59

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

60

61

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

62

63

64

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

71

72

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

73

74

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

75

76

* The //average// FEL pulse energy as example for the **slow** **data**. Here the data is not saved with 10 Hz - thus not for every FEL pulse train. The data is typically saved with 1 Hz if the values are changing (like the FEL energy) and every about 20 sec if there is no change for longer time ( e.g. motor set values). Thus to use the data together with the "fast" one, one has to interpolate the data as explained in the examples in the repos below show (e.g. {{code language="none"}}df['GMD_T_average'] = df['GMD_T_average'].interpolate(method='linear'){{/code}})

77

78

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

79

80

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

81

82

* (((

83

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

84

)))

85

86

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

87

88

89

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

90

91

92

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

93

94

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

95

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

96

97

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

103

104

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

105

106

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

115

116

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

117

118

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

119

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

120

121

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

122

//always saved (PBD)//

123

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

124

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

125

desc: set pressure in the gas attenuator

126

units: mbar

127

128

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

129

//always saved (PBD)//

130

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

131

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

132

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

133

units: none

134

135

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

136

//always saved (PBD)//

137

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

138

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

139

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

140

units: none

141

142

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

143

//always saved (PBD)//

144

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

145

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

146

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

147

units: degree

148

149

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

150

//always saved (PBD)//

151

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

152

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

153

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

154

units: degree

155

156

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

157

//always saved (PBD)//

158

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

159

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

160

desc: Position of the PG filter wheel 1

161

units: degree

162

163

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

164

//always saved (PBD)//

165

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

166

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

167

desc: Position of the PG filter wheel 2

168

units: degree

169

170

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

171

//always saved (PBD)//

172

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

173

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

174

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

180

181

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

182

183

184

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

185

186

187

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

188

189

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

190

//always saved (PBD)//

191

192

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

193

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

194

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

195

units : microJ

196

197

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

198

//always saved (PBD)//

199

200

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

201

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

202

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

203

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

204

205

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

206

//always saved (PBD)//

207

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

208

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

209

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

210

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

211

212

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

213

//always saved (PBD)//

214

215

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

216

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

217

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

218

units : microJ

219

220

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

221

//always saved (PBD)//

222

223

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

224

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

225

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

226

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

227

228

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

229

//always saved (PBD)//

230

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

231

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

232

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

233

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

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

238

239

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

240

//always saved (PBD)//

241

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

242

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

243

244

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

249

//always saved (PBD)//

250

251

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

252

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

253

254

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)

255

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

256

257

258

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

259

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

1. Combined warning and error flags

268

269

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

270

file

271

272

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

278

279

280

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

281

282

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

283

//always saved (PBD)//

284

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

285

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

286

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

287

units : mm

288

289

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

290

//always saved (PBD)//

291

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

292

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

293

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

294

units : mm

295

296

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

297

//always saved (PBD)//

298

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

299

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

300

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

301

units : mm

302

303

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

304

//always saved (PBD)//

305

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

306

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

307

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

units : mm

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

312

313

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

314

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

315

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

316

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

317

desc : XUV Spectrum measured with the "tunnel spectrometer"

318

units :

319

320

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

321

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

322

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

323

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

324

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

325

units : nm

326

327

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

328

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

329

DOOCS prop : ==

330

DAQ channel: ==

331

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

332

units : nm

333

334

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

335

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

336

DOOCS prop : ==

337

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

338

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

339

units :

340

341

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

342

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

343

DOOCS prop : ==

344

DAQ channel: ==

345

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

346

units : eV

347

348

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

349

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

350

DOOCS prop : ==

351

DAQ channel: ==

352

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

353

units : eV

354

355

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

356

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

357

DOOCS prop : ==

358

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

359

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

360

units :

361

362

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

363

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

364

DOOCS prop : ==

365

DAQ channel: ==

366

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

367

units : nm

368

369

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

370

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

371

DOOCS prop : ==

372

DAQ channel: ==

373

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

374

units : nm

375

376

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

377

378

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

379

380

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

381

382

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

383

//always saved (PBD)//

384

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

385

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

386

desc: electron bunch charge (FLASH1)

units: nC

=====

arrival time (BAM) =====

391

392

393

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

394

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

395

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

396

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

397

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

398

** acc: 4DBC3 → FL0.DBC2

399

** FL1: 1SFELC → FL1.SFELC

400

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

401

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

402

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

403

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

408

409

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

410

//always saved (PBD)//

411

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

412

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

413

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

414

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

415

416

417

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

418

//always saved (PBD)//

419

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

420

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

421

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

422

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

423

424

425

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

426

427

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

428

//always saved (PBD)//

429

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

430

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

431

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

432

433

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

434

435

436

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

437

//always saved (PBD)//

438

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

439

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

440

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

441

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

442

443

444

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

445

//always saved (PBD)//

446

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

447

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

448

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

449

450

451

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

452

//always saved (PBD)//

453

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

454

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

455

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

456

457

458

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

459

460

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

461

462

//always saved (PBD)//

463

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

464

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

465

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

466

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

471

//always saved (PBD)//

472

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

473

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

474

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

475

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

476

477

478

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

479

//always saved (PBD)//

480

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

481

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

482

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

483

484

485

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

486

//always saved (PBD)//

487

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

488

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

489

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

494

495

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

496

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

497

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

498

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

499

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

500

units: pixel

501

502

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

503

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

504

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

505

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

506

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

507

units: fs per pixel

508

509

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

510

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

511

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

512

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

513

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

514

units: fs

515

516

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

517

518

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

519

//always saved (PBD)//

520

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

521

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

522

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

523

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

524

525

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

526

//always saved (PBD)//

527

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

528

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

529

desc: electron bunch energy bunch resolved

530

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

531

532

533

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

534

//always saved (PBD)//

535

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

536

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

537

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

538

units: nm

539

540

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

==== ====

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

547

548

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

549

550

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

551

//always saved (PBD)//

552

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

553

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

554

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

555

units: kHz

556

557

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

558

559

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

560

//always saved (PBD)//

561

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

562

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

563

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

564

units:

565

566

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

567

568

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

569

//always saved (PBD)//

570

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

571

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

572

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)

573

units:

574

575

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

576

577

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

578

//always saved (PBD)//

579

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

580

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

581

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

587

//always saved (PBD)//

588

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

589

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

590

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

591

units:

592

593

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

594

595

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

596

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

597

units: d h min s cs

598

599

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

600

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

601

second column: microseconds

602

third column: Train ID of FLASH

603

604

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

610

# 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

611

epoch_time = 1709051499.17 # Replace with your epoch time

612

613

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

614

print(formatted_time)

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

621

622

**PIGLET (PG laser)**

623

624

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

625

626

627

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

640

641

642

//always saved (PBD)//

643

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

644

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

645

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

646

units : 0 no transmission , 1: full transmission

647

648

649

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

650

//always saved (PBD)//

651

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

652

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

653

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

654

units : ps ( pos delay means IR comes later)

655

656

657

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

658

//always saved (PBD)//

659

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

660

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

661

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

662

units : ps ( pos delay means IR comes later)

663

664

665

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

666

//always saved (PBD)//

667

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

668

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

669

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

670

671

672

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

673

//always saved (PBD)//

674

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

675

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

676

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

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

681

682

683

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

684

685

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.

686

687

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

688

689

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

694

//saved on DEMAND in the user DAQ//

695

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

696

\\PG Beamline:

697

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

698

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

699

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

700

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

701

702

BL Beamlines:

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

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

711

712

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

713

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.

714

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

715

716

In addition there are also additional parameters saved like:

717

718

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

719

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

720

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

725

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

726

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

727

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

728

729

In addition there are also additional parameters saved like:

730

731

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

732

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

733

734

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

=== FLASH2 ===

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

741

742

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

743

744

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

745

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

746

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

747

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

748

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

749

750

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

751

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

752

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

753

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

758

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

759

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

760

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

761

units: degree

762

763

/FL2/Beamlines/Filter wheel/position wheel 2

764

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

765

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

766

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

771

772

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

777

778

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

779

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

780

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

781

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

786

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

787

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

788

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)

789

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

790

791

792

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

793

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

1. Combined warning and error flags

802

803

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 !

814

815

816

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

817

818

819

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

820

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

821

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

822

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

827

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

828

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

829

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

834

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

835

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

836

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

837

units : mm

838

839

(x=horizontal, y = vertial)

840

841

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

846

847

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

848

849

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

850

851

852

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

853

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

854

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

855

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

860

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

861

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

862

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

867

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

868

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

869

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

870

units :

871

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

889

890

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

891

892

893

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

898

899

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

900

901

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

902

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

903

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

904

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

units: nC

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

909

910

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

911

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

912

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

913

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

914

915

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

916

917

918

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

919

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

920

921

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

922

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

923

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

924

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

925

units: nm

926

927

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

928

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

929

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

930

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

931

units: mm

932

933

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

934

935

=====

936

arrival time (BAM) =====

937

938

939

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

940

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

941

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

942

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

943

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

944

** acc: 4DBC3 → FL0.DBC2

945

** FL1: 1SFELC → FL1.SFELC

946

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

947

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

948

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

949

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

954

955

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

956

//always saved (PBD2)//

957

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

958

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

959

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

960

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

961

962

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

963

//always saved (PBD2)//

964

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

965

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

966

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

967

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

968

969

970

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

971

* 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

972

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

973

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

974

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

975

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

981

982

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

983

984

985

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

986

987

988

//always saved (PBD)//

989

**FL0.DBC2**

990

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

991

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

992

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

993

994

995

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

996

997

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

998

//always saved (PBD)//

999

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

1000

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

1001

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

1002

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

1003

1004

1005

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

1006

//always saved (PBD)//

1007

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

1008

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

1009

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

1010

1011

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

1012

//always saved (PBD)//

1013

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

1014

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

1015

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

1020

1021

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

1022

1023

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

1024

1025

//always saved (PBD)//

1026

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

1027

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

1028

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

1029

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

1034

1035

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

1036

//always saved (PBD)//

1037

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

1038

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

1039

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

1040

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

1041

1042

1043

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

1044

//always saved (PBD)//

1045

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

1046

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

1047

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

1048

1049

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

1050

//always saved (PBD)//

1051

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

1052

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

1053

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

1054

1055

1056

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

1057

1058

1059

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

1060

1061

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

1062

1063

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

1064

//always saved (PBD2)//

1065

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

1066

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

1067

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

1068

units: µs

1069

1070

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

1071

1072

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

1073

//always saved (PBD2)//

1074

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

1075

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

1076

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

units: kHz

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

1081

1082

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

1083

//always saved (PBD2)//

1084

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

1085

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

1086

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

1087

units:

1088

1089

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

1090

1091

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

1092

//always saved (PBD2)//

1093

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

1094

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

1095

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)

1096

units:

1097

1098

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

1099

1100

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

1101

//always saved (PBD2)//

1102

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

1103

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

1104

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

1110

//always saved (PBD2)//

1111

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

1112

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

1113

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

1114

units:

1115

1116

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

1117

1118

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

1119

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

1120

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

1128

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

1129

second column: microseconds

1130

third column: Train ID of FLASH

1131

1132

1133

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

1139

# 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

1140

epoch_time = 1709051499.17 # Replace with your epoch time

1141

1142

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

1143

print(formatted_time)

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

1150

1151

1152

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

1153

1154

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.

1155

1156

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

1157

1158

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

1163

//saved on DEMAND in the user DAQ//

1164

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

1165

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

1166

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

1167

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

1168

1169

1170

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

1171

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.

1172

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

1173

1174

In addition there are also additional parameters saved like:

1175

1176

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

1177

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

1178

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

1179

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

1184

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

1185

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

1186

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

1187

1188

In addition there are also additional parameters saved like:

1189

1190

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

1191

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

1192

1193

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

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

1198

1199

1200

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

1201

1202

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

1203

1204

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

1205

1206

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

1235

1236

1237

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

1238

1239

1240

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

1252

1253

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

1254

1255

1256

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

1257

1258

1259

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

1260

1261

1262

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

1263

1264

1265

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

1266

1267

1268

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

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

1273

1274

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

1275

1276

1277

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

1278

1279

1280

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

1281

1282

1283

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

1284

1285

1286

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

1287

1288

1289

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

1290

1291

1292

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

1293

1294

1295

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

1296

1297

1298

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

1299

1300

1301

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

1311

1312

1313

LAM Delay line encoder:

1314

1315

1316

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

1317

1318

1319

Temperature feedback:

1320

1321

1322

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

1323

1324

1325

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

1326

1327

1328

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

**FL24 Attenuator angle:**

1333

1334

1335

FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS

1336

1337

1338

**FL24 Polarization control:**

1339

1340

1341

FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS

1342

1343

1344

**SysDC delay error:**

1345

1346

1347

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

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

1352

1353

1354

FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm

FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN

1359

1360

1361

**Laser error status:**

1362

1363

1364

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

1365

1366

1367

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

1380

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

1381

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

1382

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

1388

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

1389

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

1390

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

1395

//always saved (PBD2)//

1396

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

1397

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

1398

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

1403

//always saved (PBD)//

1404

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

1405

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

1406

desc: rms jitter of the fs-Oscillator

units: fs

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

1412

1413

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

1428

1429

1430

Delay (encoder readback):

1431

1432

1433

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

1444

1445

(% class="wrapped" %)

1446

|(((

1447

FL2PPL FL26 REMI Attenuation: HWP motor current position

1448

)))|(((

1449

FLASH.FEL/FLAPP2BEAMLINES/MOTOR11.FL26B/FPOS

1450

)))

1451

|(((

1452

FL2PPL FL26 REMI Polarization: linear polarization angle

1453

)))|(((

1454

FLASH.FEL/FLAPP2BEAMLINES/MOTOR12.FL26B/FPOS

1455

)))

1456

|(((

1457

FL2PPL FL26 REMI Diagnostics: NIR spectrum

1458

)))|(((

1459

FLASH.LASER/MOD26.SPECT/REMI/DAQ_CHANNEL

1460

)))

1461

|(((

1462

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

1463

)))|(((

1464

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

1465

)))

1466

|(((

1467

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

1468

)))|(((

1469

FLASH.LASER/MOD26.PES/RE_OUT/DAQ_CHANNEL

1470

)))

1471

|(((

1472

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

1473

)))|(((

1474

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH04.TD

1475

)))

1476

|(((

1477

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

1478

)))|(((

1479

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

1480

)))

1481

|(((

1482

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

1483

)))|(((

1484

FLASH.LASER/MOD26.PES/INC_BOX/DAQ_CHANNEL

1485

)))

1486

|(((

1487

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

1488

)))|(((

1489

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH05.TD

1490

)))

1491

|(((

1492

FL2PPL FL26 REMI In coupling: filter wheel 1 position

1493

)))|(((

1494

FLASH/MOD26.FW1/FLASH2MOD26/pos

1495

)))

1496

|(((

1497

FL2PPL FL26 REMI In coupling: filter wheel 2 position

1498

)))|(((

1499

FLASH/MOD26.FW2/FLASH2MOD26/pos

1500

)))

1501

|(((

1502

FL2PPL FL26 REMI: Energy meter REMI incoupling breadboard

1503

)))|(((

1504

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

1505

)))

1506

|(((

1507

FL2PPL FL26 REMI Incoupling: focusing lens position

1508

)))|(((

1509

FLASH.FEL/FLAPP2BEAMLINES/MOTOR3.FL26B/FPOS

1510

)))

1511

|(((

1512

FL2PPL FL26 REMI Incoupling: nearfield

1513

)))|(((

1514

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

1515

)))

1516

|(((

1517

FL2PPL FL26 REMI Incoupling: focus

1518

)))|(((

1519

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

1520

)))

1521

|(((

1522

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

1523

)))|(((

1524

FLASH.LASER/MOD26.PES/LAM_DIFF/DAQ_CHANNEL

1525

)))

1526

|(((

1527

FL2PPL FL26 REMI Drift: forward signal (PD1) raw

1528

)))|(((

1529

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH00.TD

1530

)))

1531

|(((

1532

FL2PPL FL26 REMI Drift: backward signal (PD2) raw

1533

)))|(((

1534

FLASH.LASER/TAMC532DMA/ULGAN1_S5/CH01.TD

1535

)))

1536

|(((

1537

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

1538

)))|(((

1539

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

1540

)))

1541

|(((

1542

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

1543

)))|(((

1544

FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL26B/FPOS

1545

)))

1546

|(((

1547

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

1548

)))|(((

1549

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

1550

)))

1551

|(((

1552

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

1553

)))|(((

1554

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

1555

)))

1556

|(((

1557

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

1558

)))|(((

1559

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

1560

)))

1561

|(((

1562

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

1563

)))|(((

1564

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

1565

)))

1566

|(((

1567

Temperature controlled fiber (Temp of the fiber delay sysdc)

1568

)))|(((

1569

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

1570

)))

1571

|(((

1572

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

1573

)))|(((

1574

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

)))

=== "/uncategorized/" ===

1581

1582

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

1583

1584

1585

=== HDF5 structure revisions ===

1586

1587

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:

1588

1589

1590

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

1591

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

1592

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

1593

1594

(% class="wrapped" %)

1595

|=(((

1596

earlier HDF path (vers. 0.2)

)))|=(((

is now (vers. 0.3)

)))

|(((

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

1602

)))|(((

1603

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

1604

)))

1605

|(((

1606

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

1607

)))|(((

1608

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

1609

)))

1610

|(((

1611

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

1612

)))|(((

1613

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

1614

)))

1615

|(((

1616

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

1617

)))|(((

1618

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

1619

)))

1620

|(((

1621

/Experiment/Pump probe laser/BPM/position x

1622

)))|(((

1623

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

1624

)))

1625

|(((

1626

/Experiment/Pump probe laser/BPM/position y

1627

)))|(((

1628

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

1629

)))

1630

|(((

1631

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

1632

)))|(((

1633

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

1634

)))

1635

|(((

1636

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

1637

)))|(((

1638

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

1639

)))

1640

|(((

1641

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

1642

)))|(((

1643

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

1644

)))

1645

|(((

1646

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

1647

)))|(((

1648

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

1649

)))

1650

|(((

1651

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

1652

)))|(((

1653

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

1654

)))

1655

|(((

1656

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

1657

)))|(((

1658

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

1659

)))

1660

|(((

1661

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

1662

)))|(((

1663

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

1664

)))

1665

|(((

1666

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

1667

)))|(((

1668

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

1669

)))

1670

|(((

1671

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

1672

)))|(((

1673

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

1674

)))

1675

|(((

1676

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

1677

)))|(((

1678

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

1679

)))

1680

|(((

1681

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

1682

)))|(((

1683

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

1684

)))

1685

|(((

1686

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

1687

)))|(((

1688

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

1689

)))

1690

1691

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

Wiki source code of The FLASH HDF5 structure