aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2021-05-18 12:27:47 +0200
committerThomas White <taw@physics.org>2021-05-18 12:27:47 +0200
commit91b54fd8b8f1ddf345f0a133d936f13bf3fec3b3 (patch)
treefafee52779d9f3ade5c37b1e31757d08ca342145 /doc
parent7c3059ee1204d169e025b0d57d32a0d4e389c541 (diff)
Update online.rst
Diffstat (limited to 'doc')
-rw-r--r--doc/articles/online.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/articles/online.rst b/doc/articles/online.rst
index 6183d7eb..4b1622e7 100644
--- a/doc/articles/online.rst
+++ b/doc/articles/online.rst
@@ -52,7 +52,16 @@ received via ZeroMQ:
used. The others will be ignored.
* The image data is given as a two-dimensional array (i.e. no 3D arrays with
'panel number' as one of the dimensions).
-* The image data itself is given as a MsgPack 'map' object with "type"=>"<i4".
+* The image data itself is given as a MsgPack 'map' object representing a
+ serialised NumPy array. That is, it should contain ``type``, ``data`` and
+ ``shape`` keys.
+* The data ``type`` field should contain either ``<i4`` (if the data is in
+ little-endian 32-bit signed integer format) or ``<f4`` for 32-bit (IEEE754
+ single precision) floating-point.
+* The data ``shape`` field should be a 1D array of two values. The first
+ element is the slow-scan size, the second is that fast-scan size.
+* 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