diff options
| author | Thomas White <taw@physics.org> | 2021-09-17 11:01:27 +0200 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2021-09-17 11:09:02 +0200 |
| commit | e7362ede786ad437ce33e6f8593fd3c99bb0edd6 (patch) | |
| tree | 158c17616ac83409ca129357365672129f293f77 /doc | |
| parent | e2f451edadc9908ea3c3b97329bddaf3bd0b23a5 (diff) | |
Update online.rst to mention HDF5
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/articles/online.rst | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/articles/online.rst b/doc/articles/online.rst index 18bac119..bcb9c834 100644 --- a/doc/articles/online.rst +++ b/doc/articles/online.rst @@ -42,10 +42,17 @@ process_hkl will result in zeroes everywhere. Data format =========== -In this version, CrystFEL makes the following assumptions about the data -received via ZeroMQ: +In this version, CrystFEL can handle real-time data in HDF5 for MessagePack +format. To specify the format of the data, use either ``--data-format=hdf5`` +or ``--data-format=msgpack``. Note that *all* data format assumptions are +'open for negotiation' and will be relaxed in future CrystFEL versions, as new +online data formats arise. + +For HDF5 format, everything works just as it does with HDF5 files, except that +peak lists are not currently supported. This will be added soon. + +For data in MessagePack format, the following assumptions are made: -* The data is serialised using MessagePack * The data consists of either a single MsgPack 'map' object, or an array of maps. If there are multiple map objects in the array, only the first one will be @@ -63,10 +70,6 @@ received via ZeroMQ: * The data array within the NumPy map should be in a binary object called ``data``. -Note that *all* of the above assumptions are 'open for negotiation' and will be -relaxed in future CrystFEL versions, as new online data formats arise. Anyone -interested in streaming CBF files over ZeroMQ? - You can specify which map objects to look at in the geometry file. The following example will get the incident photon energy (in eV) and detector distance (in mm) by looking up the ``beam_energy`` and ``detector_distance`` @@ -94,7 +97,9 @@ explanation of ``peak_list``:: Peak lists ========== -You can use all of the usual peak search methods for streaming data. +You can use all of the usual peak search methods for streaming data, but +note that HDF5/CXI peak lists are not currently supported for streamed data. +This will be fixed soon. In addition, you can use ``--peaks=msgpack`` to get the peak locations from the MsgPack data. In this case, the ``peak_list`` directive in the geometry |