Changes for page The FLASH HDF5 structure

Last modified by sndueste on 2025/09/10 11:43

From version 89.13
edited by sndueste
on 2025/04/24 13:24
Change comment: There is no comment for this version
To version 89.4
edited by sndueste
on 2025/04/23 14:28
Change comment: Renamed back-links.

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -FLASHUSER.Offline data analysis (DAQ).WebHome
1 +FS-FLASH USER tmp.Offline data analysis (DAQ).WebHome
Content
... ... @@ -99,7 +99,7 @@
99 99  * The currently developed option for large data sets: [[the FAB package>>url:https://hasfcpkg.desy.de/fab/fab.html||shape="rect"]] ... see below
100 100  * 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"]]
101 101  
102 -(% 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]]
102 +(% class="Object" %)See also the collection of Demo data and sample scripts : [[doc:FLASHUSER.Data Acquisition and controls.DAQ and controls overview.Offline data analysis (DAQ).Collection of HDF5 sample data from different beamlines.WebHome]] and [[doc:FLASHUSER.Data Acquisition and controls.DAQ and controls overview.Offline data analysis (DAQ).DEMO - Working with FLASH data.WebHome]]
103 103  {{/info}}
104 104  {{/layout-cell}}
105 105  {{/layout-section}}
... ... @@ -111,6 +111,7 @@
111 111  == Complete list of recordable parameters ==
112 112  
113 113  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"]].
114 +
114 114  
115 115  == Most popular FLASH parameters and their names in HDF5, DOOCS and (raw) DAQ ==
116 116  
... ... @@ -129,6 +129,7 @@
129 129  DAQ channel: {{code language="none"}}FLASH.FEL/GAS_DOSING/FL1.ATTENUATOR/PRESSURE{{/code}}
130 130  desc: set pressure in the gas attenuator
131 131  units: mbar
133 +
132 132  
133 133  {{code language="none"}}/FL1/Beamlines/BL/Fast shutter/open{{/code}}
134 134  //always saved (PBD)//
... ... @@ -148,15 +148,17 @@
148 148  //always saved (PBD)//
149 149  DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
150 150  DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS1/FILTER1/FW.MOTOR.POS{{/code}}
151 -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]]
153 +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]]
152 152  units: degree
155 +
153 153  
154 154  {{code language="none"}}/FL1/Beamlines/BL/Filters/BL filter wheel/position filter 2{{/code}}
155 155  //always saved (PBD)//
156 156  DOOCS prop : {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
157 157  DAQ channel: {{code language="none"}}TTF2.FEL/BLFILTERS2/FILTER2/FW.MOTOR.POS{{/code}}
158 -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]]
161 +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]]
159 159  units: degree
163 +
160 160  
161 161  {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 1{{/code}}
162 162  //always saved (PBD)//
... ... @@ -164,6 +164,7 @@
164 164  DAQ channel: {{code language="none"}}TTF2.FEL/BDAF1/BDA.F1/FW.MOTOR.POS{{/code}}
165 165  desc: Position of the PG filter wheel 1
166 166  units: degree
171 +
167 167  
168 168  {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 2{{/code}}
169 169  //always saved (PBD)//
... ... @@ -171,6 +171,7 @@
171 171  DAQ channel: {{code language="none"}}TTF2.FEL/BDAF2/BDA.F2/FW.MOTOR.POS{{/code}}
172 172  desc: Position of the PG filter wheel 2
173 173  units: degree
179 +
174 174  
175 175  {{code language="none"}}/FL1/Beamlines/PG/Filters/position filter 3{{/code}}
176 176  //always saved (PBD)//
... ... @@ -261,6 +261,7 @@
261 261  
262 262  {{info title="GMD pulse resolved data structure"}}
263 263  For every pulse in the pulse train the information is saved:
270 +
264 264  
265 265  1. **Intensity per pulse** (a.u. (more or less µJ ))
266 266  1. Intensity per pulse (auxillary GMD) - not used
... ... @@ -396,7 +396,7 @@
396 396  arrival time (BAM) =====
397 397  
398 398  {{info title="BAM information: updates 2022 (status 2025)"}}
399 -* see: [[Info collection about the BAMs and how to use the BAM data>>doc:FS-FLASH USER tmp.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]
406 +* see: [[Info collection about the BAMs and how to use the BAM data>>doc:FLASHUSER.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]
400 400  * The data format of the BAM has been completely altered in the 2022 shutdown
401 401  * 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 ...
402 402  * 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)
... ... @@ -405,7 +405,7 @@
405 405  ** FL1: 1SFELC →  FL1.SFELC
406 406  ** FL2: FL2XTDS → (% style="color:#172b4d" %)FL2.SEED5
407 407  * for more Info: [[LINK to detailed infos from MSK>>doc:SDiag.How-to articles.BAM Data Structure.WebHome||shape="rect"]]
408 -* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]
415 +* [[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]]
409 409  * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
410 410  {{/info}}
411 411  
... ... @@ -504,6 +504,7 @@
504 504  DAQ channel: {{code language="none"}}PBD.BEAM.PROF.ML/DAQ.OUT.PROF.CCCED{{/code}}
505 505  desc: temporal profile of electron bunch, y axis in Ampers (FLASH1)
506 506  units: pixel
514 +
507 507  
508 508  {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/Expert stuff/TDS calibration constant{{/code}}
509 509  //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
... ... @@ -511,6 +511,7 @@
511 511  DAQ channel: = PBD.BEAM.PROF.ML/CCT=
512 512  desc: TDS calibration constant for the x-axis of the profiles: fs per pixel
513 513  units: fs per pixel
522 +
514 514  
515 515  {{code language="none"}}/FL1/Electron Diagnostic/Electron bunch profile/TDS profile width rms{{/code}}
516 516  //always saved (PBD) - IF LOLA is ON and ACTIVATED in the PBD DAQ (talk to expert)//
... ... @@ -526,7 +526,8 @@
526 526  DOOCS prop : {{code language="none"}}TTF2.DAQ/ENERGY.DOGLEG/E_INTRA_MEAN/VAL{{/code}}
527 527  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/E_MEAN{{/code}}
528 528  desc: electron bunch energy (average over the bunch train)
529 -units: (% class="twikiNewLink" %)MeV
538 +units: (% class="twikiNewLink" %)MeV(%%)
539 +
530 530  
531 531  {{code language="none"}}/FL1/Electron Diagnostic/Electron energy/pulse resolved energy{{/code}}
532 532  //always saved (PBD)//
... ... @@ -542,6 +542,7 @@
542 542  DAQ channel: {{code language="none"}}PBD.ENERGY.DOGLEG/LAMBDA_MEAN{{/code}}
543 543  desc: Wavelength calculated by the electron bunch energy (average over the bunch train) (FLASH1)
544 544  units: nm
555 +
545 545  
546 546  [[Contents>>doc:||anchor="Contents"]]
547 547  
... ... @@ -556,6 +556,7 @@
556 556  DAQ channel: {{code language="none"}}TTF2.UTIL/LASER.CONTROL/GUN/PULSE_FREQ{{/code}}
557 557  desc: repetition rate of the bunches / pulses within the burst (FLASH1)
558 558  units: kHz
570 +
559 559  
560 560  ===== set number of pulses =====
561 561  
... ... @@ -574,6 +574,7 @@
574 574  DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
575 575  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)
576 576  units:
589 +
577 577  
578 578  ===== actual pulse pattern recorded after the undulator =====
579 579  
... ... @@ -583,6 +583,7 @@
583 583  DAQ channel: {{code language="none"}}TTF2.DIAG/PBD.TOROID.ML/12EXP{{/code}}
584 584  desc: The bunch pattern as function of time in a burst recorded by toroid diagnostic BEHIND the undulator. (FLASH1)
585 585  units:
599 +
586 586  
587 587  ===== Train ID =====
588 588  
... ... @@ -592,25 +592,20 @@
592 592  DAQ channel: {{code language="none"}}none{{/code}}
593 593  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 !)
594 594  units:
609 +
595 595  
596 -===== (% style="color:#e67e22" %)Train time(%%) =====
611 +===== Train time =====
597 597  
598 -(% style="color:#e67e22" %){{code language="none"}}/Timing/train time{{/code}}
613 +{{code language="none"}}/Timing/train time{{/code}}
599 599  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
600 600  units: d h min s cs
616 +
601 601  
602 -(% style="color:#e67e22" %){{code language="none"}}/Timing/time stamp{{/code}}
618 +{{code language="none"}}/Timing/time stamp{{/code}}
603 603  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
604 604  second column: microseconds
605 605  third column: Train ID of FLASH
606 -
607 -currently it is saved as Unix time in
608 -
609 -|(((
610 -/zraw/FLASH.DIAG/TIMINGINFO/TIME1.BUNCH_FIRST_INDEX.1/dGroup/time
611 -
612 612  
613 -)))
614 614  
615 615  [[Contents>>doc:||anchor="Contents"]]
616 616  
... ... @@ -688,7 +688,7 @@
688 688  
689 689  ===== GHz ADCs =====
690 690  
691 -ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FS-FLASH USER tmp.Data Acquisition and controls 1.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**
700 +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]]**
692 692  //saved on DEMAND in the user DAQ//
693 693  \\The HDF5 names for the ADC traces are depending on the beamline :
694 694  \\PG Beamline:
... ... @@ -745,7 +745,8 @@
745 745  (% style="color:#000000" %)DOOCS prop : {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
746 746  (% style="color:#000000" %)DAQ channel:  {{code language="none"}}FLASH.FEL/ATT.GAS_DOSING/FL2.HALL/PRESSURE{{/code}} (%%)
747 747  (% style="color:#000000" %)desc: set pressure in the gas attenuator (%%)
748 -(% style="color:#000000" %)units: mbar
757 +(% style="color:#000000" %)units: mbar(%%)
758 +
749 749  
750 750  {{code language="none"}}/FL2/Beamlines/FL20/Shutter/open{{/code}}
751 751  //always saved (PBD2)//
... ... @@ -759,14 +759,15 @@
759 759  //always saved (PBD2)//
760 760  DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS{{/code}}
761 761  DAQ channel: FLASH.FEL/FL20H.PH.MOTOR/MOTOR1.MOT3/FPOS
762 -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]]**
772 +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]]**
763 763  units: degree
774 +
764 764  
765 765  /FL2/Beamlines/Filter wheel/position wheel 2
766 766  always saved (PBD2)
767 767  DOOCS prop : {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
768 768  DAQ channel: {{code language="none"}}FLASH.FEL/FL20H.PH.MOTOR/MOTOR2.MOT3/FPOS{{/code}}
769 -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]]
780 +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]]
770 770  units: degree
771 771  
772 772  
... ... @@ -795,6 +795,7 @@
795 795  
796 796  {{info title="GMD pulse resolved data structure"}}
797 797  For every pulse in the pulse train the information is saved:
809 +
798 798  
799 799  1. **Intensity per pulse** (a.u. (more or less µJ ))
800 800  1. Intensity per pulse (auxillary GMD) - not used
... ... @@ -934,7 +934,7 @@
934 934  arrival time (BAM) =====
935 935  
936 936  {{info title="BAM information: updates 2022 (status 2025)"}}
937 -* see: [[Info collection about the BAMs and how to use the BAM data>>doc:FS-FLASH USER tmp.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]
949 +* see: [[Info collection about the BAMs and how to use the BAM data>>doc:FLASHUSER.jddd-linked help pages.Info collection for the BAM.WebHome||shape="rect"]]
938 938  * The data format of the BAM has been completely altered in the 2022 shutdown
939 939  * 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 ...
940 940  * THIS is now different. There are new parameters saving only the arrival times for pulses that go to FL1 and to FL2 (in detail: first time slot of the accelerator and second)
... ... @@ -943,7 +943,7 @@
943 943  ** FL1: 1SFELC →  FL1.SFELC
944 944  ** FL2: FL2XTDS → (% style="color:#172b4d" %)FL2.SEED5
945 945  * for more Info: [[LINK to detailed infos from MSK>>doc:SDiag.How-to articles.BAM Data Structure.WebHome||shape="rect"]]
946 -* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments>>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]
958 +* [[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]]
947 947  * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
948 948  {{/info}}
949 949  
... ... @@ -968,7 +968,7 @@
968 968  * The BAM 4DBC3 measures the arrivaltime of** FLASH 1 and FLASH2** in the same data set (thus also sorted in at /FL1/ !).
969 969  * 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 
970 970  ** 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
971 -* [[Link a collection of papers related to the BAM and the analysis of pump-probe experiments >>doc:FS-FLASH USER tmp.Additional helpful things1.FLASH beamlines and instruments references.WebHome]]
983 +* [[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]]
972 972  * [[LINK to detailed infos from MSK (may only work inside DESY network~[~[image:url:http://hasfweb.desy.de/pub/TWiki/TWikiDocGraphics/external-link.gif~|~|height="12" width="13"~]~]>>url:http://www.desy.de/~~mbock/pages/BAM_daq_channel_descriptions.html||shape="rect"]]
973 973  * a recent  [[talk about the working principle of the BAM>>attach:BAM-basics and outlook-2018_DESY-template_16-9Format.pdf]]
974 974  {{/info}}
... ... @@ -1092,6 +1092,7 @@
1092 1092  DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/3GUN/NUMBEROFBUNCHES.FLASH2{{/code}}
1093 1093  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)
1094 1094  units:
1107 +
1095 1095  
1096 1096  ===== actual pulse pattern recorded after the undulator =====
1097 1097  
... ... @@ -1101,6 +1101,7 @@
1101 1101  DAQ channel: {{code language="none"}}FLASH.DIAG/PBD2.TOROID.ML/9FL2BURN.PULSEPATTERN{{/code}}
1102 1102  desc: The bunch pattern as function of time in a burst recorded by toroide diagnostic BEHIND the undulator. (FLASH2)
1103 1103  units:
1117 +
1104 1104  
1105 1105  ===== Train ID =====
1106 1106  
... ... @@ -1110,6 +1110,7 @@
1110 1110  DAQ channel: {{code language="none"}}none{{/code}}
1111 1111  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 !)
1112 1112  units:
1127 +
1113 1113  
1114 1114  ===== Train time =====
1115 1115  
... ... @@ -1117,6 +1117,7 @@
1117 1117  {{code language="none"}}/Timing/train time{{/code}}
1118 1118  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
1119 1119  units: d h min s cs
1135 +
1120 1120  
1121 1121  {{code language="none"}}
1122 1122  /Timing/time stamp
... ... @@ -1126,6 +1126,7 @@
1126 1126  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
1127 1127  second column: microseconds
1128 1128  third column: Train ID of FLASH
1145 +
1129 1129  
1130 1130  [[Contents>>doc:||anchor="Contents"]]
1131 1131  
... ... @@ -1140,7 +1140,7 @@
1140 1140  
1141 1141  ===== GHz ADCs =====
1142 1142  
1143 -ADC traces of the (SPDevices 412) GHZ ADCs available for the users . More information about the ADCs can be found** [[here>>doc:FS-FLASH USER tmp.Data Acquisition and controls 1.Controls (DOOCS, jDDD,\.\.\.).MTCA ADCs.WebHome]]**
1160 +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]]**
1144 1144  //saved on DEMAND in the user DAQ//
1145 1145  \\Up to now there are 4 channels available at FL24
1146 1146  \\\\{{code language="none"}}/FL2/Experiment/MTCA-EXP1/ADQ412 GHz ADC/CH00/TD{{/code}}