Changes for page The FLASH HDF5 structure

Last modified by sndueste on 2025/02/06 10:55

From 47.1 to 48.1 From 72.1 to 73.1

From version 48.1

edited by sndueste
on 2021/02/10 10:15

Change comment: There is no comment for this version

To version 72.1

edited by sndueste
on 2023/04/26 12:54

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -19,6 +19,12 @@
  {{code language="none"}}> module load xray{{/code}}
  {{code language="none"}}> hdfview{{/code}}
++or you can use
++
++{{code language="none"}}> silx view{{/code}}
++
++\\
++
  [[Contents>>doc:||anchor="Contents"]]
  == The FLASH HDF5 format ==
@@ -73,12 +73,10 @@
  {{/layout-cell}}
  {{layout-cell}}
--* The //average// FEL pulse energy as example for the **slow** **data** (different e.g. 1 Hz):
++* 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}})
--           ( every 10th train ID is listed in the HDF group "index")
++           ( 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}}
@@ -97,12 +97,12 @@
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--{{info title="Sample scripts in python"}}
--=== Sample scripts / Reference implementation (Python) ===
++{{info}}
++=== Reference implementation (Python) ===
--[[~[~[image:attach:binder_badge.png~|~|thumbnail="true" width="120"~]~]>>url:https://mybinder.org/v2/git/https%3A%2F%2Fgitlab.desy.de%2Fchristopher.passow%2Fflash-daq-hdf/master||shape="rect"]]
++(imperative)  (% 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" %)[[https:~~/~~/gitlab.desy.de/christopher.passow/flash-daq-hdf>>url:https://gitlab.desy.de/christopher.passow/flash-daq-hdf||shape="rect"]]
++(% class="Object" %)(object oriented) [[https:~~/~~/gitlab.desy.de/christopher.passow/fdh-builder>>url:https://gitlab.desy.de/christopher.passow/fdh-builder.git||shape="rect"]]
  {{/info}}
  {{/layout-cell}}
  {{/layout-section}}
@@ -109,6 +109,8 @@
  {{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~[~[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"]].
@@ -200,8 +200,7 @@
  ==== Photon Diagnostics SASE ([[GMD>>url:http://photon-science.desy.de/facilities/flash/photon_diagnostics/gmd_intensity_and_position/index_eng.html||shape="rect"]]) ====
--\\
--
++{{expand title="Discontinued GMD format (used until 2021)"}}
  (% style="color: rgb(0,0,0);" %)**Discontinued GMD data recording / evaluation  (VME + PhotonFlux ML server)**
  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
@@ -249,10 +249,11 @@
  DAQ channel: {{code language="none"}}PBD.PHFLUX/BDA.ENERGYPULSE.FF{{/code}}
  desc :Energy per pulse BDA (from e-) - uncorrected values. There are also values saved if there was no beam ... just background noise
  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]]**
++{{/expand}}
  \\
--(% style="color: rgb(0,0,0);" %)**NEW (2021) GMD data recording / evaluation  (MTCA, analog to FLASH2 and XFEL)**
++(% style="letter-spacing: 0px; color: rgb(0, 0, 0)" %)**NEW (since 2021) GMD data recording / evaluation  (same format as FLASH2 and XFEL)**
  {{code language="none"}}/FL1/Photon Diagnostic/GMD/Average energy/energy tunnel{{/code}}
  //always saved (PBD)//
@@ -410,8 +410,27 @@
  units: nC
  =====
--arrival time =====
++arrival time (BAM) =====
++{{info title="BAM information: updates 2022"}}
++* see: [[Info collection about the BAMs and how to use the BAM data>>url:https://confluence.desy.de/display/FLASHUSER/Info+collection+for+the+BAM||shape="rect"]]
++* The data format of the BAM has been completely altered in the 2022 shutdown
++* 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 ...
++* 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)
++* There has been also a renaming  (and relocation) of the BAMs.
++** acc:  4DBC3 → FL0.DBC2
++** FL1: 1SFELC →  FL1.SFELC
++** FL2: FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
++* for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
++* [[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]]
++* a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
++{{/info}}
++
++\\
++
++{{expand title="Discontinued BAM format (used until end 2021)"}}
++(% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
++
  {{code language="none"}}/FL1/Electron Diagnostic/BAM/4DBC3/electron bunch arrival time (low charge){{/code}}
  //always saved (PBD)//
  DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/4DBC3/LOW_CHARGE_ARRIVAL_TIME{{/code}}
@@ -419,22 +419,94 @@
  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).
  units: ps (bigger numbers indicate later arrivaltime of the electrons)
++\\
++
  {{code language="none"}}/FL1/Electron Diagnostic/BAM/1SFELC/electron bunch arrival time (low charge){{/code}}
  //always saved (PBD)//
  DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/1SFELC/LOW_CHARGE_ARRIVAL_TIME{{/code}}
  DAQ channel: {{code language="none"}}FLASH.SDIAG/BAM.DAQ/1SFELC.LOW_CHARGE_ARRIVAL_TIME{{/code}}
  desc: Electron bunch arrival time measured with the BAM  before the undulator (pulse resolved data). This one was newly installed in 2020.
--units: ps (bigger numbers indicate later arrivaltime of the electrons)
++units: ps (bigger numbers indicate later arrival time of the electrons)
++{{/expand}}
--{{info title="BAM hints"}}
--* besides the arrivaltime from FLASH1 there is also the FLASH2/3 electron arrival time saved.In case of doubt ask your local contact
--* [[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]]
--* [[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"]]
--* a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
--{{/info}}
++====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======
++(% style="color: rgb(255,102,0);" %)**DBC2**/electron bunch arrival time   (HDF5 name not yet implemented - see zraw)(%%)
++//always saved (PBD)//
++**FL0.DBC2**
++(% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA1.COMP (%%)
++{{code language="none"}}/FL1/Electron Diagnostic/BAM/ DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE.SA1.COMPDAQ 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 should be only 0). These are the same values as the "raw" data below - just "cleaned". The values{{/code}}(% style="font-family: SFMono-Medium , ~"SF Mono~" , ~"Segoe UI Mono~" , ~"Roboto Mono~" , ~"Ubuntu Mono~" , Menlo , Courier , monospace;letter-spacing: 0.0px;" %) show a very good correlation to the arrival time  of the XUV pulses in the experiment (see help).
++
++{{code language="none"}}units: fs (bigger numbers (typically) indicate later arrival times of the electrons).{{/code}}
++
  \\
++(% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE
++DAQ channel: (% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE (%%)
++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).
++units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
++
++\\
++
++(% style="color: rgb(255,102,0);" %)DBC2/error  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
++DAQ channel: (% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR(%%)
++desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
++
++\\
++
++(% style="color: rgb(255,102,0);" %)DBC2/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
++DAQ channel(% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.1(%%)
++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
++
++\\
++
++====== **BAM FL1.SFELC**{{code language="none"}}{{/code}} ======
++
++(% 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: rgb(255,102,0);" %)/electron bunch arrival time   (HDF5 name not yet implemented - see zraw)
++
++//always saved (PBD)//
++(% style="color: rgb(23,43,77);" %)**FL1.SFELC**(%%)
++(% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)FL1.SFELC(% style="color: rgb(0,0,0);" %)/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 should be only 0). 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).
++
++\\
++
++\\
++
++(% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIME.ABSOLUTE
++DAQ channel:** **(% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.ABSOLUTE (%%)
++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).
++units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
++
++\\
++
++(% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/error  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E.bamError(%%)
++DAQ channel(% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMERROR(%%)
++desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
++
++\\
++
++(% style="color: rgb(23,43,77);" %)SFELC(% style="color: rgb(255,102,0);" %)/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL1/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++DOOCS prop : FLASH.SDIAG/BAM/(% style="color: rgb(23,43,77);" %)FL1.SFELC(%%)/ARRIVAL_TIM(% style="color: rgb(0,0,0);" %)E..bamStatus.//1//(%%)
++DAQ chann(% style="color: rgb(0,0,0);" %)el: FLASH.SDIAG/BAM/FL1.SFELC/ARRIVAL_TIME.BAMSTATUS.1(%%)
++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 =====
  {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile{{/code}}
@@ -528,7 +528,7 @@
  //always saved (PBD)//
  DOOCS prop : {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP/CHARGE.TD{{/code}}
  DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
--desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH1)
++desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)
  units:
  \\
@@ -561,6 +561,43 @@
  ==== Pump Probe Laser (FLASH1) ====
++**PIGLET (PG laser)**
++
++**{{code language="none"}}/FL1/Experiment/Pump probe laser{{/code}}**
++
++FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/DIAG1out/PULSEENERGY.MEAN
++FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/PG1_incoupl/PULSEENERGY.MEAN
++FLASH.LASER/FLACPUPGLASER1.PULSEENERGY/PG2_incoupl/PULSEENERGY.MEAN
++FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.ENCODER_POSITION.RD
++FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.ENCODER_POSITION_RAW.RD
++FLASH.SYNC/LASER.LOCK.EXP/FLASH1.MOD1.PG.OSC/FMC0.MD22.1.POSITION.RD
++
++**BL - Hidra laser **
++
++Property,Units,Description
++FLASH.LASER/MODBL.CAM/BL1.13.AC/DAQ_CHANNEL,'AU','FL1HIDRAPP1 Autocorrelation (IR) ROI readout'
++FLASH.LASER/MODBL.CAM/BL1.14.VF/DAQ_CHANNEL,'AU','FL1HIDRAPP1 Virtual Focus Camera (IR) ROI readout'
++FLASH.LASER/MODBL.SENSORBOARD/PDTRIG_CAMP/DAQ_CHANNEL,'au','FL1PPL Energy channels'
++FLASH.LASER/MODBL.SPECT/CAMP_IR/DAQ_CHANNEL,'au','FL1PPL BL Table Spectrum'
++FLASH.LASER/HIDRAPP1.SPECTRUM_ANALYSIS/CAMP_IR/DAQ_CHANNEL,'au','FL1PPL Spectrum Analysis'
++FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/FMC0.MD22.1.POSITION.RD,'ps','FL1PPL Optical Delay Line (act)'
++FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/FMC0.MD22.1.POSITION_SET.WR,'ps','FL1PPL Optical Delay Line (set)'
++FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/FMC0.MD22.1.ENCODER_POSITION.RD,'ps','FL1PPL Optical Delay Line (Encoder Readback)'
++FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP_Delayline/FPOS,'ps','FL1PPL NIR delay BL1 table (act)'
++FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP_Delayline/FPOS.SET,'ps','FL1PPL NIR delay BL1 table (set)'
++FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP.ATT/FPOS,'degree','FL1PPL Transmission degree (act)'
++FLASH.FEL/FLAPPBEAMLINES.MOTOR/CAMP.ATT/FPOS.SET,'degree','FL1PPL Transmission degree (set)'
++FLASH.FEL/FLAPPBEAMLINES.MOTOR/Camp_Focus_Lens/FPOS,'mm','FL1PPL Focus Mirror Stage Position (act)'
++FLASH.FEL/FLAPPBEAMLINES.MOTOR/Camp_Focus_Lens/FPOS.SET,'mm','FL1PPL Focus Mirror Stage Position (set)'
++FLASH.LASER/MODBL.FEEDFWD/BL1_Att/INPUT.Y,'%','FL1PPL Transmission rate'
++FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/CURRENT_INPUT_JITTER.RD,'fs','FL1PPL Sync. Jitter'
++FLASH.SYNC/LASER.LOCK.EXP/F1.PPL.OSC/LOCK_STATUS.VALUE.RD,'au','FL1PPL Sync. Status'
++
++\\
++
++\\
++
++{{expand title="Parameters used until 2021"}}
  {{code language="none"}}/FL1/Experiment/Pump probe laser/laser attenuation{{/code}}
  //always saved (PBD)//
@@ -601,7 +601,8 @@
  //always saved (PBD)//
  DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
  DOOCS prop : {{code language="none"}}TTF2.FEL/TDOLFEL/TDOLFEL/STREAK.CAM.TIME{{/code}}
--desc: delaytime between the optical laser and the FEL units: ps
++desc: delay time between the optical laser and the FEL units: ps
++{{/expand}}
  \\
@@ -611,7 +611,7 @@
  ==== User Data (FLASH1) ====
--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.
++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.
  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
@@ -639,13 +639,13 @@
  {{code language="none"}}/FL1/Experiment/BL3/ADQ412 GHz ADC/CH03/TD{{/code}}
  DOOCS prop : {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00/CH00.TD  or CH00.DAQ.TD{{/code}}
--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.
++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.
  DAQ channel: {{code language="none"}}FLASH.FEL/ADC.ADQ.PG/EXP1.CH00{{/code}}
  In addition there are also additional parameters saved like:
  * {{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.
--* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
++* {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
  * {{code language="none"}}error (ADC):{{/code}} 0 indicates that there was no error
  ===== MHz ADCs =====
@@ -658,7 +658,7 @@
  In addition there are also additional parameters saved like:
  * {{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.
--* {{code language="none"}}number of samples{{/code}}: total number of samoles recorded for each 10 Hz trigger
++* {{code language="none"}}number of samples{{/code}}: total number of samples recorded for each 10 Hz trigger
  [[Contents>>doc:||anchor="Contents"]]
@@ -819,7 +819,7 @@
  // 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 : meanwavelength ( ~~ 1 sec averaging time ) measured in the TUNNEL for a specific bunch out of the bunch train (via photoelectron spectroscopy)
++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
  \\
@@ -833,11 +833,11 @@
  \\
--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"]])
++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"]])
  \\
--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 ...
++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 ...
  \\
@@ -856,8 +856,21 @@
  \\
--===== undulator settings =====
++===== 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: rgb(94,108,132);" %)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: rgb(94,108,132);" %)extraction and septum  in the beginning of FLASH2
++
++(% style="letter-spacing: 0.0px;" %)units: (% class="twikiNewLink" %)MeV
++
++\\
++
++(% style="color: rgb(94,108,132);font-weight: 600;letter-spacing: 0.0px;" %)
++undulator settings
++
  {{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}}
@@ -875,8 +875,27 @@
  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 =====
++arrival time (BAM) =====
++{{info title="BAM information: updates 2022"}}
++* see: [[Info collection about the BAMs and how to use the BAM data>>url:https://confluence.desy.de/display/FLASHUSER/Info+collection+for+the+BAM||shape="rect"]]
++* The data format of the BAM has been completely altered in the 2022 shutdown
++* 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. I addition the arrival times for  FL1 and FL2 were saved in the same parameter ...
++* 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)
++* There has been also a renaming  (and relocation) of the BAMs.
++** acc:  4DBC3 → FL0.DBC2
++** FL1: 1SFELC →  FL1.SFELC
++** FL2: 8FL2XTDS → (% style="color: rgb(23,43,77);" %)FL2.SEED5
++* for more Info: [[LINK to detailed infos from MSK>>url:https://confluence.desy.de/display/SDiagPublic/BAM+Data+Structure||shape="rect"]]
++* [[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]]
++* a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
++{{/info}}
++
++\\
++
++{{expand title="Discontinued BAM format (used until end 2021)"}}
++(% style="color: rgb(0,0,0);" %)**Discontinued BAM data recording **
++
  {{code language="none"}}/FL2/Electron Diagnostic/BAM/8FL2XTDS/electron bunch arrival time (low charge){{/code}}
  //always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.SDIAG/BAM/8FL2XTDS/LOW_CHARGE_ARRIVAL_TIME{{/code}}
@@ -901,8 +901,85 @@
  * [[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"]]
  * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
  {{/info}}
++{{/expand}}
++\\
++====== **BAM FL0.DBC2**{{code language="none"}}{{/code}} ======
++
++(% style="color: rgb(255,102,0);" %)**DBC2**/electron bunch arrival time   (HDF5 name not yet implemented - see zraw)(%%)
++//always saved (PBD)//
++**FL0.DBC2**
++(% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/**FL0.DBC2**/ARRIVAL_TIME.ABSOLUTE.SA2.COMP
++{{code language="none"}}/FL2/Electron Diagnostic/BAM/ 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 should be only 0). 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).
++
++\\
++
++(% style="color: rgb(255,102,0);" %)DBC2/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE{{/code}}
++(% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel: {{/code}}(%%)
++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).
++units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
++
++\\
++
++(% style="color: rgb(255,102,0);" %)DBC2/error  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++(% style="color: rgb(0,0,0);" %)E.bamError{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM{{/code}}(%%)
++(% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMERROR{{code language="none"}}DAQ channel: {{/code}}(%%)
++desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
++
++\\
++
++(% style="color: rgb(255,102,0);" %)DBC2/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++(% style="color: rgb(0,0,0);" %)E..bamStatus.//2//{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIM{{/code}}(%%)
++(% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/FL0.DBC2/ARRIVAL_TIME.BAMSTATUS.2{{code language="none"}}DAQ channel{{/code}}(%%)
++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}} ======
++
++/FL2/Electron Diagnostic/BAM/**SEED5**(% style="color: rgb(255,102,0);" %)/electron bunch arrival time   (HDF5 name not yet implemented - see zraw)
++
++//always saved (PBD)//
++(% style="color: rgb(23,43,77);" %)**FL2.SEED5**(%%)
++(% style="color: rgb(0,0,0);" %)channel: FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.ABSOLUTE.SA1.COMP
++{{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 should be only 0). 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).
++
++\\
++
++\\
++
++(% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/electron bunch arrival time (raw)  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++(% style="color: rgb(23,43,77);" %)**FL2.SEED5**{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIME.ABSOLUTE{{/code}}(%%)
++**~ **(% style="color: rgb(0,0,0);" %)FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.ABSOLUTE {{code language="none"}}DAQ channel:{{/code}}(%%)
++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).
++units: fs (bigger numbers (typically) indicate later arrival times of the electrons).
++
++\\
++
++(% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/error  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++(% style="color: rgb(23,43,77);" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)E.bamError{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIM{{/code}}(%%)
++(% style="color: rgb(0,0,0);" %): FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.BAMERROR{{code language="none"}}DAQ channel{{/code}}(%%)
++desc: If the value is 0 , the BAM is working well. If it is non-zero there is a problem !!
++
++\\
++
++(% style="color: rgb(23,43,77);" %)SEED5(% style="color: rgb(255,102,0);" %)/status  (HDF5 name not yet implemented - see zraw){{code language="none"}}/FL2/Electron Diagnostic/BAM/{{/code}}(%%)
++//always saved (PBD)//
++(% style="color: rgb(23,43,77);" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)E.bamStatus.//2//{{code language="none"}}DOOCS prop : FLASH.SDIAG/BAM//ARRIVAL_TIM{{/code}}(%%)
++(% style="color: rgb(0,0,0);" %)el: FLASH.SDIAG/BAM/(% style="color: rgb(0, 0, 0); color: rgb(23, 43, 77)" %)**FL2.SEED5**(% style="color: rgb(0,0,0);" %)/ARRIVAL_TIME.BAMSTATUS.2{{code language="none"}}DAQ chann{{/code}}(%%)
++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
++
++\\
++
  [[Contents>>doc:||anchor="Contents"]]
  \\
@@ -1029,7 +1029,92 @@
  There may be more information available from the "Laser DAQ". laese contact your Laser Local Contact.
++\\
++**User delay**
++
++Delay (set value):
++
++{{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION_SET.WR{{/code}}
++
++Delay (encoder readback):
++
++{{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/FMC0.MD22.0.POSITION.RD{{/code}}
++
++OXC. jitter:
++
++{{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/F2.PPL.OSC/CURRENT_INPUT_JITTER.RD{{/code}}
++
++\\
++
++**Pulse resolved energy:**
++
++OPCPA output (photodiode signal raw ADC trace 16000 samples):
++
++{{code language="none"}}/zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH23.TD/dGroup{{/code}}
++
++(% style="letter-spacing: 0.0px;" %)Upper breadboard Photodiode (THG) burst (photodiode signal raw ADC trace 16000 samples)::
++
++{{code language="none"}}/zraw/FLASH.LASER/FLASH2CPUULGAN1.ADCSCOPE/CH26.TD/dGroup{{/code}}
++
++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.)
++
++{{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/FL24_userPD/dGroup{{/code}}
++
++\\
++
++**LAM (Laser Arrivaltime Monitor)  pulse resolved data:**
++
++Signal of Photodiode1  - for experts only... (analyzed signal. integration over pulses in the ADC trace. )
++
++{{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/LAM.PD1/dGroup{{/code}}
++
++Signal of Photodiode2  - for experts only...  (analyzed signal. integration over pulses in the ADC trace.)
++
++{{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/LAM.PD2/dGroup{{/code}}
++
++"Actual" LAM Signal - to be calibrated ......  (analyzed signal. integration over pulses in the ADC trace.)
++
++{{code language="none"}}/zraw/FLASH.LASER/MOD24.PES/LAM.PDBAL/dGroup{{/code}}
++
++\\
++
++**Attenuator angle:**
++
++{{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
++
++**Polarization control:**
++
++{{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR14.FL24/FPOS{{/code}}
++
++**SysDC delay error:**
++
++{{code language="none"}}FLASH.LASER/ULGAN1.DYNPROP/TCFIBER.DOUBLES/DOUBLE26{{/code}}
++
++\\
++
++**Timing error: (these two need to be observed and both=0 means no error)**
++
++{{code language="none"}}FLASH/CPUULGAN1.TIMING/ULGAN1/dT_alarm{{/code}}
++
++{{code language="none"}}FLASH/CPUULGAN1.TIMING/ULGAN1/dMPN{{/code}}
++
++**Laser error status:**
++
++\\
++
++**Virtual camera X and Y history, beam size: (use slow data)**
++
++{{code language="none"}}FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.X{{/code}}
++
++{{code language="none"}}FLASH.LASER/MOD24.BEAMPOS/UV.VF_BP/CENTER.Y{{/code}}
++
++{{code language="none"}}FLASH.LASER/MOD24.CAM/UV.14.VF/ROI_SPECTRUM.X.SIG{{/code}}
++
++\\
++
++{{expand title="Parameters used until 2021"}}
++
  {{code language="none"}}/FL2/Experiment/Pump probe laser/FL24/attenuator position{{/code}}//always saved (PBD2)//
  DOOCS prop : {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
  DAQ channel: {{code language="none"}}FLASH.FEL/FLAPP2BEAMLINES/MOTOR1.FL24/FPOS{{/code}}
@@ -1062,6 +1062,7 @@
  DAQ channel: {{code language="none"}}FLASH.SYNC/LASER.LOCK.EXP/FLASH2.PPL1.OSC1/CURRENT_INPUT_JITTER.RD{{/code}}
  desc: rms jitter of the fs-Oscillator
  units: fs
++{{/expand}}
  [[Contents>>doc:||anchor="Contents"]]

Changes for page The FLASH HDF5 structure

Summary

Details

Applications

Navigation