Files
slsDetectorPackage/docs/src/hdf5fileformat.rst
Dhanya Thattil 72056ff813
Some checks failed
Build on RHEL9 / build (push) Failing after 4m6s
Build on RHEL8 / build (push) Failing after 5m13s
Dev/doc architecture commands (#1272)
* wip for sw architecture

* wip:intro

* wip client wip

* documentation on architecutre is done. commands left

* wip. clientto module done

* almost done

* about 2nd port

* done

* review changes

* review fixes

* minor
2025-08-21 11:41:54 +02:00

3.0 KiB

HDF5 File Format

Compilation

  1. Compile the package with HDF5 option enabled

    1. Using cmk script: ./cmk.sh -hj9 -d [path of hdf5 dir] (-d is optional and for custom installation folder)
    2. Enable using cmake option -DSLS_USE_HDF5=ON and -DCMAKE_INSTALL_PREFIX=/path/to/custom/hdf/installation (optional).

Setup

  1. Start Receiver process

  2. Load config file

  3. Set file format using command fformat.

    sls_detector_put fformat hdf5

Master File

  • File Name: [fpath]/[fname]_master_[findex].h5 Details here<file name format>
  • It contains attributes<master file attributes> relevant to the acquisition. This can vary with detector type.
/                                               # Root level
|---> entry                                     # entry group
|    |---> data                                 # data group
|         |---> column                          # dataset of each sls_receiver_header member
|         |---> data
|         |---> detector header version
|         |---> detector specific 1
|         |---> detector specific 2
|         |---> detector specific 3
|         |---> detector specific 4
|         |---> detector type
|         |---> exp length or sub exposure time
|         |---> frame number
|         |---> mod id
|         |---> packets caught
|         |---> packets caught bit mask
|         |---> row
|         |---> timestamp
|    |---> instrument                           # instrument group
|         |---> beam                            # beam group
|         |---> detector                        # detector group
|              |---> Master File Attribute 1    # dataset of each master file attribute
|              |---> Master File Attribute 2
|              |---> Master File Attribute 3
|              |---> Master File Attribute ..
|    |---> sample                               # sample group
If more than 1 data file per frame:
  • The dataset of each **SLS Receiver Header** <sls receiver header format> member is a virtual dataset.
  • data dataset is a virtual dataset.

More details regarding master file attributes can be found here<master file attributes>.

Data File

  • File Name: [fpath]/[fname]_dx_fy_[findex].h5 Details here<file name format>
  • More details on slsReceiverHeader<sls receiver header format> and the actual image data is described in the Detector Image Size and Format <data format> section.

Virtual Data File

  • File Name: [fpath]/[fname]_virtual_[findex].h5 Details here<file name format>
  • For multiple modules, a virtual file linking data from all the modules is created. The individual files are expected to be present.
  • It is linked in the master file.