mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-02-07 18:18:40 +01:00
* 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
3.0 KiB
3.0 KiB
HDF5 File Format
Compilation
Compile the package with HDF5 option enabled
- Using cmk script: ./cmk.sh -hj9 -d [path of hdf5 dir] (-d is optional and for custom installation folder)
- Enable using cmake option -DSLS_USE_HDF5=ON and -DCMAKE_INSTALL_PREFIX=/path/to/custom/hdf/installation (optional).
Setup
Start Receiver process
Load config file
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.
- The dataset of each
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 theDetector 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.