Changes for page The FLASH HDF5 structure

Last modified by sndueste on 2025-11-19 14:51

From 93.5 to 93.4

From version 104.1

edited by sndueste
on 2025-11-19 14:51

Change comment: There is no comment for this version

To version 93.5

edited by sndueste
on 2025-05-19 16:48

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,3 +1,6 @@
++{{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  == Contents ==
@@ -58,17 +58,25 @@
  {{/expand}}
  === HDF examples: ===
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="three_equal"}}
++{{layout-cell}}
  *  ADC data as example for **fast** **data** (10 Hz):
  [[image:attach:image2020-11-16_15-26-28.png||height="250"]]
++{{/layout-cell}}
++{{layout-cell}}
  * 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}})
             ( as example only every 10th train ID is listed in the HDF group "index")
  [[image:attach:image2020-11-16_15-31-45.png||height="250"]]
++{{/layout-cell}}
++{{layout-cell}}
  * (((
  //zraw// group contains the **original DAQ (DOOCS) names**
  )))
@@ -77,7 +77,11 @@
  [[image:attach:image2020-11-16_16-26-3.png||height="400"]]
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  {{info}}
  === There are different options that help you to work with the FLASH HDF5 data in Python ===
@@ -84,16 +84,20 @@
  * The currently developed option for large data sets: [[the FAB package>>url:https://hasfcpkg.desy.de/fab/fab.html||shape="rect"]] ... see below
  * 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"]]
--(% 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]]
++(% class="Object" %)See also the collection of Demo data and sample scripts : [[doc:FS-FLASH USER tmp.Data Acquisition and controls 1.DAQ and controls overview.Offline data analysis (DAQ).Collection of HDF5 sample data from different beamlines.WebHome]] and [[doc:FS-FLASH USER tmp.Data Acquisition and controls 1.DAQ and controls overview.Offline data analysis (DAQ).DEMO - Working with FLASH data.WebHome]]
  {{/info}}
++{{/layout-cell}}
++{{/layout-section}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++
--
  == Complete list of recordable parameters ==
  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"]].
--== Most popular FLASH parameters and their names in HDF5, DOOCS and (.raw) DAQ ==
++== Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
  {{id name="DOOCSparameters"/}}
@@ -103,10 +103,8 @@
  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.
--The previously used naming scheme (2024 and before) can be found here:
--{{expand expanded="false" title="FLASH1 naming scheme used until 2024"}}
--==== (% id="cke_bm_8853497S" style="display:none" %) (%%)Beamline info (FLASH1) ====
++==== Beamline info (FLASH1) ====
  {{code language="none"}}/FL1/Beamlines/Attenuator/pressure{{/code}}
  //always saved (PBD)//
@@ -228,8 +228,8 @@
  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
  //always saved (PBD)//
--(% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
--(% style="color:#000000" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
++(% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}} (%%)
++(% style="color:#000000" %)DAQ channel: {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL1.TUNNEL/PHOTONFLUX.UJ{{/code}}
  desc : calibrated average SASE Energy/pulse measured in the TUNNEL upstream the gas attenuator
  units : microJ
@@ -238,8 +238,8 @@
  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
  //always saved (PBD)//
--(% style="color:#000000" %)DOOCS prop : (%%)
--(% 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}}
++(% style="color:#000000" %)DOOCS prop :
++{{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}}
  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)
  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]]**
@@ -259,7 +259,8 @@
  The pulse energy and the error are plotted for the first bunch of the pulse trains saved in this
  file
-- [[image:image2021-2-9_10-51-6.png]]
++
++[[image:attach:image2021-2-9_10-51-6.png||height="250"]]
  {{/info}}
@@ -451,8 +451,8 @@
  //always saved (PBD)//
  (% style="color:#172b4d" %)**FL1.SFELC**(%%)
--(% style="color:#000000" %)channel: FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP(%%)
--(% 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).
++(% style="color:#000000" %)channel: FLASH.SDIAG/BAM/(% style="color:#172b4d" %)FL1.SFELC(% style="color:#000000" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
++{{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).
  units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
@@ -530,23 +530,20 @@
  [[Contents>>doc:||anchor="Contents"]]
--====   ====
--
--
  ==== Timing information, rep rate etc.  (FLASH1) ====
  ===== bunch repetition rate =====
--{{code language="none"}}/Timing/repetition rate{{/code}}
++{{code language="none"}}/FL1/Timing/repetition rate{{/code}}
  //always saved (PBD)//
  DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
--DAQ channel: {{code language="none"}}FLASH.DIAG/TIMER/FLASHCPUTIME1.0/REP_RATE_KHZ.1{{/code}}
++DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
  desc: repetition rate of the bunches / pulses within the burst (FLASH1)
  units: kHz
  ===== set number of pulses =====
--(% style="color:#ff6600" %)(HDF5 name not yet implemented - see zraw)(% style="color:#ff0000" %){{code language="none"}}/Timing/set number of bunches {{/code}}(%%)
++(% style="color:#ff6600" %)(HDF5 name not yet implemented - see zraw)(% style="color:#ff0000" %){{code language="none"}}/FL1/Timing/set number of bunches {{/code}}(%%)
  //always saved (PBD)//
  DOOCS prop : {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}
  DAQ channel: {{code language="none"}}FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1 [4th number]{{/code}}
@@ -605,8 +605,8 @@
  {{/expand}}
++[[Contents>>doc:||anchor="Contents"]]
--
  ==== Pump Probe Laser (FLASH1) ====
  **PIGLET (PG laser)**
@@ -722,9 +722,10 @@
  * {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
  [[Contents>>doc:||anchor="Contents"]]
--{{/expand}}
++
++
  === FLASH2 ===
  There is analog to FLASH1 a permanently running "PhotonDagnostic DAQ FLASH2" (PBD2) and 2 User DAQs
@@ -732,6 +732,7 @@
  ==== Beamline info (FLASH2) ====
  {{code language="none"}}/FL2/Beamlines/Attenuator/pressure  {{/code}}
++(% style="color:#000000" %)//always saved (PBD2)// (%%)
  (% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
  (% style="color:#000000" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
  (% style="color:#000000" %)desc: set pressure in the gas attenuator (%%)
@@ -738,6 +738,7 @@
  (% style="color:#000000" %)units: mbar
  {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER/CH00.TD{{/code}}
  DAQ channel: {{code language="none"}}FLASH.FEL/ADC.SIS.FL2FS/FL20.SHUTTER{{/code}}
  desc: BL Beamline Fast shutter state: 1 is open, 0 is closed ( for technical reasons there are 100 vales of this state saved ...)
@@ -745,6 +745,7 @@
  {{code language="none"}}/FL2/Beamlines/Filter wheel/position wheel 1{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
  DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
  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]]**
@@ -751,6 +751,7 @@
  units: degree
  /FL2/Beamlines/Filter wheel/position wheel 2
++always saved (PBD2)
  DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
  DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
  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]]
@@ -766,6 +766,7 @@
  ==== Photon Diagnostics SASE ([[XGMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]] - FLASH2) ====
  {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
  DAQ channel:{{code language="none"}} FLASH.FEL/XGM.PHOTONFLUX/FL2.TUNNEL/PHOTONFLUX.UJ{{/code}}
  desc : calibrated average ( ~~ 20 sec averaging time ) SASE Energy/pulse measured in the TUNNEL before the attenuator (ion current)
@@ -773,6 +773,7 @@
  {{code language="none"}}/FL2/Photon Diagnostic/GMD/Pulse resolved energy/energy tunnel{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.INTENSITY/FL2.TUNNEL/INTENSITY.TD{{/code}}
  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)
@@ -807,6 +807,7 @@
  {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel horizontal{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IX.POS{{/code}}
  desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
@@ -814,6 +814,7 @@
  {{code language="none"}}/FL2/Photon Diagnostic/GMD/Average Beam position/position tunnel vertical{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
  DAQ channel: {{code language="none"}}FLASH.FEL/XGM.POSMON/FL2.TUNNEL/IY.POS{{/code}}
  desc : the Average ( ~~ 20 sec averaging time ) Beam position of the photon Beam determined by the GMD (tunnel, x=horizontal)
@@ -821,6 +821,7 @@
  /FL2/Photon Diagnostic/GMD/Pulse resolved beam position/position tunnel x
++always saved (PBD2)
  DOOCS prop : FLASH.FEL/XGM.BPM/FL2.HALL/X.TD
  DAQ channel: FLASH.FEL/XGM.BPM/FL2.HALL:2
  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 ...)
@@ -840,6 +840,7 @@
  {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean photon energy{{/code}}
++// saved opon request (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
  DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL042{{/code}}
  desc : mean photon energy ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
@@ -847,6 +847,7 @@
  {{code language="none"}}/FL2/Photon Diagnostic/Wavelength/OPIS tunnel/Processed/mean wavelength{{/code}}
++// saved opon request (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
  DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL040{{/code}}
  desc : mean wavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
@@ -854,6 +854,7 @@
  {{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}}
++// saved opon request (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
  DAQ channel:{{code language="none"}} FLASH.UTIL/STORE/FL2.TUNNEL.OPIS/VAL060{{/code}}
  desc : The bunch number of the bunch used for the wavelength calculation
@@ -872,6 +872,7 @@
  ===== bunch charge =====
  {{code language="none"}}/FL2/Electron Diagnostic/Bunch charge/after undulator{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
  DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN/CHARGE.FLASH2{{/code}}
  desc: electron bunch charge FLASH2 (average value for each bunchtrain).
@@ -881,6 +881,7 @@
  ===== electron bunch energy =====
  {{code language="none"}}/FL2/Electron Diagnostic/Electron energy/energy of first bunch/behind undulators{{/code}}
++//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.DIAG/BEAM_ENERGY_MEASUREMENT/FL2XTDS/ENERGY.FLASH2{{/code}}
  DAQ channel: (% style="color:#5e6c84" %)TTF2.DAQ/PBD2.BEAM.ENERGY.MEAS.ML.COPY/FL2XTDS.ENERGY.FLASH2{{code language="none"}}{{/code}}(%%)
  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
@@ -891,19 +891,21 @@
  (% style="color: rgb(94, 108, 132); font-weight: 600; letter-spacing: 0px;" %)
  ===== undulator settings =====
--{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength 1{{/code}}
--DOOCS prop : {{code language="none"}}FLASH.FEL/FL2.WAVELENGTHCONTROL/FLASH2.COLOR1/WAVELENGTH{{/code}}
--DAQ channel:  {{code language="none"}}FLASH.FEL/FL2.WAVELENGTHCONTROL/FLASH2.COLOR1/WAVELENGTH{{/code}}
--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
++{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/set wavelength{{/code}}
++//always saved (PBD2)//
++DOOCS prop : {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
++DAQ channel:  {{code language="none"}}TTF2.FEEDBACK/FL2.WAVELENGTHCONTROL/FLASH2/WAVELENGTH{{/code}}
++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 % ...
  units: nm
--{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE13 gap{{/code}}
--DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE13/GAP{{/code}}
--DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE13/GAP{{/code}}
--desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper.
++{{code language="none"}}/FL2/Electron Diagnostic/Undulator setting/SASE14 gap{{/code}}
++//always saved (PBD2)//
++DOOCS prop : {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
++DAQ channel:  {{code language="none"}}FLASH.UTIL/FL2.UND.MOTOR/FL2SASE14/GAP{{/code}}
++desc: gap value of the undulators. This can be used to follow up how many undulators were closed and if there was a taper
  units: mm
--The gap values are saved for all 12 undulators (Nr 2 to 13). Undulator 13 is the one closest to the experimental hall.
++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 (BAM) =====
@@ -1187,7 +1187,7 @@
  {{view-file att--filename="FSLADAQ-DAQParameterlistFL24-2.pdf"}}{{/view-file}}
--internal link to parameter list: [[FS-LA DAQ - XWiki>>url:https://xwiki.desy.de/xwiki/bin/view/FSLADAQ/]]
++
  {{/info}}
  {{expand title="Laser parameters used until 2023"}}
@@ -1662,3 +1662,8 @@
  )))
  [[Contents>>doc:||anchor="Contents"]]
++
++
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}

Changes for page The FLASH HDF5 structure

Summary

Details

Applications

Navigation