The FLASH HDF5 structure

1

== Contents ==

2

\\

== General information about HDF5 ==

10

11

HDF5 is a data format maintained by the HDF group. For detailed general information see [[here~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://portal.hdfgroup.org/display/support||shape="rect"]]

12

13

To download the HDF5 Viewer click [[here~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://portal.hdfgroup.org/display/support/Download+HDFView||shape="rect"]]

14

15

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

16

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

17

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

18

19

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

20

21

== The current FLASH HDF5 structure ==

22

23

The photon diagnostic, electron diagnostic and beamline information as well as the information about the pump-probe laser and the infrastructure offered for users (GHz/MHz ADCs) can be included in one HDF5 file which is organized according to train IDs. The general structure is:

24

25

* Electron Diagnostic

* Photon Diagnostics

* Beamlines

* Experiment

* Timing

[[image:attach:HDF5_structure.jpg||height="400"]]

31

32

A detailed description of (most) channels can be found in the lower part of the hdf5 viewer:

33

[[image:attach:HDF5_structure_desc.jpg||thumbnail="true" height="250"]]

34

35

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

\\

=== HDF5 example files ===

40

41

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

42

43

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

\\

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

\\

\\

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

\\

== The new (starting 2021) HDF5 format ==

58

59

Here is [[some documentation on the changes of the HDF5 format>>doc:FLASHUSER.HDF5 format]] that well be available in 2021 (work in progress)

\\

\\

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

The complete list for the relation between DOOCS names and HDF5 names for the recordable parameters can be found in [[DESY's Repository~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|width="13" height="12"~]~]>>url:https://stash.desy.de/projects/CS/repos/pah/browse/src/camp/data/channel2HdfName.dat||shape="rect"]].

70

The most common and often used ones are summarized below:

71

72

Note, the HDF group and data set names apply to our HDF tree version since vers. 0.3.0.

\\

=== FLASH1 ===

\\

==== Beamline info (FLASH1) ====

81

82

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

83

//always saved (PBD)//

84

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

85

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

86

desc: set pressure in the gas attenuator

units: mbar

\\

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

91

//always saved (PBD)//

92

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

93

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

94

desc: BL Beamline Fast shutter state

units: none

\\

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

99

//always saved (PBD)//

100

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

101

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

102

desc: PG Beamline Fast shutter state

units: none

\\

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

107

//always saved (PBD)//

108

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

109

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

110

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

units: degree

\\

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

115

//always saved (PBD)//

116

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

117

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

118

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

units: degree

\\

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

123

//always saved (PBD)//

124

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

125

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

126

desc: Position of the PG filter wheel 1

units: degree

\\

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

131

//always saved (PBD)//

132

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

133

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

134

desc: Position of the PG filter wheel 2

units: degree

\\

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

139

//always saved (PBD)//

140

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

141

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

142

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

149

150

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

\\

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

155

156

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

157

//always saved (PBD)//

158

(% style="color: rgb(165,173,186);" %)New MTCA Version: DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)

159

(% style="color: rgb(165,173,186);" %)New MTCA Version: DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}

160

161

(% style="color: rgb(0,0,0);" %)DOOCS prop : {{code language="none"}}TTF2.DAQ/PHFLUX/OUT04/VAL{{/code}} (%%)

162

(% style="color: rgb(0,0,0);" %)DAQ channel: {{code language="none"}}PBD.PHFLUX/TUNNEL.ENPULSEIC{{/code}}(%%)

163

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

164

units : microJ

165

166

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

167

//always saved (PBD)//

168

169

(% style="color: rgb(193,199,208);" %)New MTCA Version: DOOCS prop :

170

{{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}New MTCA Version: DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.TUNNEL/INTENSITY.TD{{/code}}

171

172

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

173

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

174

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

175

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

176

177

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

178

//always saved (PBD)//

179

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

180

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

181

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

182

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

183

184

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

185

//always saved (PBD)//

186

187

(% style="color: rgb(165,173,186);" %)New MTCA Version: DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.BDA/PHOTONFLUX.UJ{{/code}} (%%)

188

(% style="color: rgb(165,173,186);" %)New MTCA Version: DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.BDA/PHOTONFLUX.UJ{{/code}}

189

190

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

191

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

192

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

193

units : microJ

194

195

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

196

//always saved (PBD)//

197

198

(% style="color: rgb(193,199,208);" %)New MTCA Version: DOOCS prop :

199

{{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.BDA/INTENSITY.TD{{/code}}New MTCA Version: DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL1.BDA/INTENSITY.TD{{/code}}(%%)

200

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

201

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

202

desc :Energy per pulse BDA (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:FLASHUSER.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 BDA (raw){{/code}}

206

//always saved (PBD)//

207

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

208

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

209

desc :Energy per pulse BDA (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:FLASHUSER.jddd-linked help pages.Calibrating the pulse resolved (electron) data from GMD.WebHome]]**

\\

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

215

//always saved (PBD)//

216

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

217

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

218

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

219

units : mm

220

221

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

222

//always saved (PBD)//

223

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

224

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

225

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

226

units : mm

227

228

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

229

//always saved (PBD)//

230

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

231

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

232

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

233

units : mm

234

235

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

236

//always saved (PBD)//

237

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

238

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

239

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

240

units : mm

241

242

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

243

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

244

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

245

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

246

desc : XUV Spectrum measured with the "tunnel spectrometer"

247

units :

248

249

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

250

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

251

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

252

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

253

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

254

units : nm

255

256

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

257

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

258

DOOCS prop : ==

259

DAQ channel: ==

260

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

261

units : nm

262

263

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

264

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

265

DOOCS prop : ==

266

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

267

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

268

units :

269

270

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

271

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

272

DOOCS prop : ==

273

DAQ channel: ==

274

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

275

units : eV

276

277

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

278

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

279

DOOCS prop : ==

280

DAQ channel: ==

281

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

282

units : eV

283

284

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

285

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

286

DOOCS prop : ==

287

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

288

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

289

units :

290

291

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

292

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

293

DOOCS prop : ==

294

DAQ channel: ==

295

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

296

units : nm

297

298

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

299

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

300

DOOCS prop : ==

301

DAQ channel: ==

302

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

303

units : nm

304

305

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

306

307

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

308

309

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

310

311

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

312

//always saved (PBD)//

313

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

314

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

315

desc: electron bunch charge (FLASH1)

units: nC

=====

arrival time =====

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

322

//always saved (PBD)//

323

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

324

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

325

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

326

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

327

328

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

329

//always saved (PBD)//

330

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

331

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

332

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

333

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

334

335

336

* besides the arrivaltime from FLASH1 there is also the FLASH2/3 electron arrival time saved.In case of doubt ask your local contact

337

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

338

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

339

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

\\

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

345

346

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

347

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

348

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

349

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

350

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

units: pixel

\\

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

355

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

356

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

357

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

358

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

units: fs per pixel

\\

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

363

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

364

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

365

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

366

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

367

units: fs

368

369

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

370

371

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

372

_always saved (PBD)

373

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

374

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

375

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

376

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

377

\\

378

379

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

380

_always saved (PBD)

381

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

382

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

383

desc: electron bunch energy bunch resolved

384

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

\\

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

389

_always saved (PBD)

390

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

391

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

392

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

units: nm

\\

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

\\

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

401

402

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

403

404

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

405

//always saved (PBD)//

406

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

407

DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}

408

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

units: kHz

\\

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

413

414

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

415

//always saved (PBD)//

416

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

417

DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_NUM{{/code}}

418

desc: Number of pulses set at the gun (FLASH1)

419

units:

420

421

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

422

423

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

424

//always saved (PBD)//

425

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

426

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

427

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)

units:

\\

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

432

433

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

434

//always saved (PBD)//

435

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

436

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

437

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

units:

\\

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

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

444

//always saved (PBD)//

445

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

446

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

447

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

units:

\\

===== Train time =====

452

453

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

454

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

units: d h min s cs

\\

{{code language="none"}}/Timing/time stamp{{/code}}

459

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

460

second column: microseconds

461

third column: Train ID of FLASH

462

\\

463

464

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

\\

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

469

470

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

471

472

//always saved (PBD)//

473

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

474

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

475

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

476

units : 0 no transmission , 1: full transmission

\\

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

481

//always saved (PBD)//

482

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

483

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

484

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

485

units : ps ( pos delay means IR comes later)

\\

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

490

//always saved (PBD)//

491

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

492

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

493

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

494

units : ps ( pos delay means IR comes later)

\\

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

499

//always saved (PBD)//

500

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

501

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

502

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

\\

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

507

//always saved (PBD)//

508

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

509

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

510

desc: delaytime between the optical laser and the FEL units: ps

\\

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

\\

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

519

520

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.

521

522

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

523

524

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:FLASHUSER.Data Acquisition and controls.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**

529

//saved on DEMAND in the user DAQ//

530

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

531

\\PG Beamline:

532

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

533

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

534

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

535

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

536

537

BL Beamlines:

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

547

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

548

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.

549

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

550

551

In addition there are also additional parameters saved like:

552

553

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

554

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

555

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

560

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

561

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

562

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

563

564

In addition there are also additional parameters saved like:

565

566

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

567

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

568

569

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

\\

\\

\\

=== FLASH2 ===

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

580

581

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

582

583

(% style="color: rgb(255,153,0);" %)(not yet available){{code language="none"}}/FL2/Beamlines/Attenuator/pressure {{/code}}(%%)

584

(% style="color: rgb(193,199,208);" %)//always saved (PBD2)// (%%)

585

(% style="color: rgb(193,199,208);" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)

586

(% style="color: rgb(193,199,208);" %)DAQ channel: {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)

587

(% style="color: rgb(193,199,208);" %)desc: set pressure in the gas attenuator (%%)

588

(% style="color: rgb(193,199,208);" %)units: mbar(%%)

589

\\

590

591

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

592

//always saved (PBD2)//

593

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

594

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

595

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

600

//always saved (PBD2)//

601

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

602

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

603

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

units: degree

\\

//always saved (PBD2)//

609

\\\\**[[here>>doc:FLASHUSER.jddd-linked help pages.Filter-Units.Filter wheels in FLASH1 and FLASH2.WebHome]]**

610

{{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 2 DOOCS prop : FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS desc: Position of the BL filter wheel 2 - to correlate with the filter material please look units: degree{{/code}}

\\

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

615

616

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

623

624

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

625

//always saved (PBD2)//

626

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

627

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

628

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

634

//always saved (PBD2)//

635

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

636

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

637

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)

638

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

639

640

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

641

642

643

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

644

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

645

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

646

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

647

1. **Intensity per pulse sigma** (a.u. (more or less µJ ), (% style="color: rgb(0,0,0);" %)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)(%%))

648

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

649

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

650

1. Combined warning and error flags

651

652

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 !

\\

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

\\

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

670

//always saved (PBD2)//

671

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

672

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

673

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

679

//always saved (PBD2)//

680

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

681

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

682

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

units : mm

\\

//always saved (PBD2)//

689

\\\\{{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TDDAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2 desc: {{/code}}Besides the well calibrated averaged beam position information there is also the option

690

{{code language="none"}}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 ...)units : mm {{/code}}

691

692

{{code language="none"}}(x=horizontal, y = vertial){{/code}}

693

694

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

701

702

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

703

704

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

\\

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

709

// saved opon request (PBD2)//

710

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

711

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

712

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

718

// saved opon request (PBD2)//

719

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

720

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

721

desc : meanwavelength ( ~~ 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}}

727

// saved opon request (PBD2)//

728

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

729

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

730

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

units :

\\

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 savng the compleate 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"]] ( respobsible for [[OPIS>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/opis_spectrometer/index_eng.html||shape="rect"]])

\\

In case OPIS was not operating there is still informaton 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) ====

746

747

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

748

749

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

750

//always saved (PBD2)//

751

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

752

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

753

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

units: nC

\\

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

759

760

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

761

//always saved (PBD2)//

762

DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}

763

DAQ channel: {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}

764

desc: Set value for the anticipated wavelength . This parameter is used to set the undulator gap. It may however deviate from the actual wavelength by several % ...

765

units: nm

766

767

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

768

//always saved (PBD2)//

769

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

770

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

771

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

772

units: mm

773

774

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

=====

arrival time =====

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

780

//always saved (PBD2)//

781

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

782

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

783

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

784

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

785

786

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

787

//always saved (PBD2)//

788

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

789

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

790

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

791

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

\\

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

797

* 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

798

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

799

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

800

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

801

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

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

\\

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

810

811

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

812

813

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

814

//always saved (PBD2)//

815

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

816

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

817

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

818

units: µs

819

820

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

821

822

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

823

//always saved (PBD2)//

824

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

825

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

826

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

827

units: kHz

828

829

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

830

831

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

832

//always saved (PBD2)//

833

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

834

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

835

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)

units:

\\

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

840

841

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

842

//always saved (PBD2)//

843

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

844

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

845

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

852

//always saved (PBD2)//

853

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

854

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

855

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

units:

\\

===== Train time =====

860

861

//always saved (PBD2)

862

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

863

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

\\

{{code language="none"}}/Timing/time stamp{{/code}}

868

869

//always saved (PBD2)//

870

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

871

second column: microseconds

872

third column: Train ID of FLASH

873

\\

874

875

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

\\

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

880

881

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.

882

883

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

884

885

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:FLASHUSER.Data Acquisition and controls.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**

890

//saved on DEMAND in the user DAQ//

891

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

892

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

893

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

894

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

\\

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

899

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.

900

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

901

902

In addition there are also additional parameters saved like:

903

904

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

905

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

906

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

907

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

912

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

913

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

914

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

915

916

In addition there are also additional parameters saved like:

917

918

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

919

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

920

921

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

\\

\\

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

928

929

There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.

930

931

932

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

933

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

934

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

935

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

942

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

943

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

944

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

950

//always saved (PBD2)//

951

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

952

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

953

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

959

//always saved (PBD)//

960

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

961

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

962

desc: rms jitter of the fs-Oscillator

963

units: fs

964

965

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

\\

=== "/uncategorized/" ===

970

971

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

\\

=== HDF5 structure revisions ===

976

977

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:

\\

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

982

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

983

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

\\

(% class="wrapped" %)

988

|=(((

989

earlier HDF path (vers. 0.2)

)))|=(((

is now (vers. 0.3)

)))

|(((

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

995

)))|(((

996

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

997

)))

998

|(((

999

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

1000

)))|(((

1001

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

1002

)))

1003

|(((

1004

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

1005

)))|(((

1006

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

1007

)))

1008

|(((

1009

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

1010

)))|(((

1011

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

1012

)))

1013

|(((

1014

/Experiment/Pump probe laser/BPM/position x

1015

)))|(((

1016

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

1017

)))

1018

|(((

1019

/Experiment/Pump probe laser/BPM/position y

1020

)))|(((

1021

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

1022

)))

1023

|(((

1024

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

1025

)))|(((

1026

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

1027

)))

1028

|(((

1029

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

1030

)))|(((

1031

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

1032

)))

1033

|(((

1034

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

1035

)))|(((

1036

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

1037

)))

1038

|(((

1039

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

1040

)))|(((

1041

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

1042

)))

1043

|(((

1044

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

1045

)))|(((

1046

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

1047

)))

1048

|(((

1049

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

1050

)))|(((

1051

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

1052

)))

1053

|(((

1054

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

1055

)))|(((

1056

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

1057

)))

1058

|(((

1059

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

1060

)))|(((

1061

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

1062

)))

1063

|(((

1064

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

1065

)))|(((

1066

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

1067

)))

1068

|(((

1069

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

1070

)))|(((

1071

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

1072

)))

1073

|(((

1074

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

1075

)))|(((

1076

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

1077

)))

1078

|(((

1079

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

1080

)))|(((

1081

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

)))

\\

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

\\

== Example code showing how to access HDF5 files ==

\\

=== Samples how to read HDF5 with Matlab ===

1095

1096

The examples apply to HDF files with HDF tree version before vers. 0.3.0.

1097

1098

(% style="color: rgb(0,128,0);" %)%% read in the needed data p=path; path(p,'D:\mess-daten\DAQ-data\hdf5\Gotthard') % add the actual folder to the path hdf5file='FLASH1_EXP-2016-03-16T1420.h5'; % data with Gotthard and VLS

1099

1100

(% style="color: rgb(0,128,0);" %)% h5disp(hdf5file,'/','min') % to get an idea what is in the file % h5info(hdf5file,'/Experiment/Gotthard1/BL.0') % get info about the individual channel

1101

1102

(% style="color: rgb(0,128,0);" %)% read a Number per 10 Hz pulse train:

(% class="code" %)

(((

FEL_Wavelength_energy_server=h5read(hdf5file,'/Photon Diagnostic/Wavelength/Calculated by energy/wavelength' );

1107

)))

1108

1109

(% style="color: rgb(0,128,0);" %)% read in a 1D array (spectrum) %GMD data GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA');

1110

1111

(% style="color: rgb(0,128,0);" %)% This reads in all the data . One can also limit the amount of data read to a subset of the data stored in the file. e.g. for image Data (Gotthard)

\\

(% class="code" %)

(((

Start_event= 500 ; % define the first 10 Hz event

1118

Number_of_events = 20; % how many 10 Hz events to load

1119

)))

1120

1121

(% style="color: rgb(0,128,0);" %)% read only part of the data:

(% class="code" %)

(((

Gotthard_data=h5read(hdf5file,'/Experiment/Gotthard1/BL.0',[2 650 Start_event],[50 85 Number_of_events]);

1126

)))

1127

1128

(% style="color: rgb(0,128,0);" %)% start stop increment "manual" for 2 D data : [start bunch number in Gotthard data start pixelin spectrum start sample in 10 Hz trains], % [number of bunches in the Gotthard data number of points in the spectrum number of spectra ]

(% class="code" %)

(((

VLS_Spectrum=h5read(hdf5file,'/Photon Diagnostic/Wavelength/VLS online spectrometer/PCO.ROI.X',[400 Start_event],[200 Number_of_events] );

)))

(% style="color: rgb(0,128,0);" %)% start stop increment "manual" for 1D data : [start sample in the spectrum start sample in 10 Hz trains],[number of points in the spectrum number of spectra ]

1137

1138

(% style="color: rgb(0,128,0);" %)%GMD data

(% class="code" %)

(((

GMD_Spectrum=h5read(hdf5file,'/Photon Diagnostic/GMD/Pulse resolved energy/energy BDA',[1 Start_event],[40 Number_of_events] );

1143

)))

1144

1145

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

\\

== HDF5 and DOOCS ==

Here is an outdated [[list with the available properties that are always saved (PBD) for FLASH1 as>>attach:FLASH1__DaqChannel2HdfNamePbd.xlsx]] HDF5 names and the corresponding DOOCS names

1152

1153

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

Wiki source code of The FLASH HDF5 structure

Applications

Navigation