mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-02-14 00:18:43 +01:00

Files

Dhanya Thattil 7b21ce34d6 Dev/document json ctb file format (#1029 )

* docs receiver formats rewrite

* added documentation for all the receiver files, updated release notes, udpated help in commands help for timing, fixed by throwing exception for aa dividy by 0 error caused by not freeing memory (detsize) when switching between 1d and 2d detectors, removed unnecessary 'recevier up' printout, fixed dbit list 64 bit mask error in master json file (was not 64 bit before), fixed bug in reading gotthard1 data (needs to be tested)

* generating commands help and formatting, also fix help for trimen command line

* added ctb frame format documentation, added some links to some commands, added documentation about adding expat-devel in installation for rhel8 gui, fixed some indentation issues that screwed up command line help documentation

* added ctb frame format documentation

* updated documentation about zeromq-devel for <8.0.0 versions

2024-11-18 09:52:24 +01:00

2.8 KiB

Raw Blame History

HDF5 File Format

Compilation

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

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.

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>

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.

2.8 KiB Raw Blame History