diff options
| author | Thomas White <taw@physics.org> | 2021-04-21 13:58:51 +0200 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2021-04-21 13:58:51 +0200 |
| commit | 1363f2de072e84c688e35cb87aabbc286877cad8 (patch) | |
| tree | 9e47783452e9aa55c2eede9560f9c35a20dba3f3 /doc | |
| parent | b1d2949582c546934d8de33f49444d178d5f4853 (diff) | |
indexamajig: Replace --zmq-msgpack with --zmq-input
This removes some unnecessary work (getting the address from the file)
and seems cleaner.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/indexamajig.1 | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1 index 44f46c18..d3077516 100644 --- a/doc/man/indexamajig.1 +++ b/doc/man/indexamajig.1 @@ -177,6 +177,11 @@ Write the output data stream to \fIfilename\fR. Read the detector geometry description from \fIfilename\fR. See \fBman crystfel_geometry\fR for more information. .PD 0 +.IP \fB--zmq-input=\fIaddress\fR +.PD +Receive data over ZeroMQ from \fIaddress\fR. In this version, the ZeroMQ data will be assumed to be serialised with MsgPack, but other formats might be added in future. The options \fB--input\fR and \fB--zmq-input\fR are mutually exclusive - you must specify exactly one of them. Example: \fB--zmq-input=tcp://127.0.0.1:5002\fR. + +.PD 0 .IP \fB--basename\fR .PD Remove the directory parts of the filenames taken from the input file. If \fB--prefix\fR or \fB-x\fR is also given, the directory parts of the filename will be removed \fIbefore\fR adding the prefix. @@ -217,11 +222,6 @@ Put the temporary folder under \fIpath\fR. .PD Wait at most \fIn\fR seconds for each image file in the input list to be created before trying to process it. This is useful for some automated processing pipelines. It obviously only really works for single-frame files. If a file exists but is not readable when this option is set non-zero, a second attempt will be made after ten seconds. This is to allow for incompletely written files. A value of -1 means to wait forever. The default value is \fB--wait-for-file=0\fR. -.PD 0 -.IP \fB--zmq-msgpack\fR -.PD -Receive data as MessagePack objects over ZeroMQ. The input "file list", given with \fB--input\fR or \fB-i\fR, should contain a socket URL suitable for passing to zmq_connect(), such as "tcp://127.0.0.1:12322". At the moment, only one URL can be given, but this may change in future. - .IP \fB--no-image-data\fR .PD Do not load the actual image data (or bad pixel masks), only the metadata. This allows you to check if patterns can be indexed, without high data bandwidth requirements. Obviously, any feature requiring the image data, especially peak search procedures and integration, cannot be used in this case. At the moment, this option only works when \fB--zmq-msgpack\fR is also used. You will probably want to use \fB--peaks=msgpack\fR. |