diff options
| author | Thomas White <taw@physics.org> | 2019-03-14 17:37:27 +0100 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2019-03-15 11:59:12 +0100 |
| commit | 7edc4d2826d5b07487fad1dc5ede6cf3bbf250dc (patch) | |
| tree | 00b94b6690721fdda1c6c4c01549241ce3abdd22 /doc | |
| parent | c8d2d898f09179e647a24cbebbd5d2d06fd6487f (diff) | |
Add documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/indexamajig.1 | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1 index 4b428475..95db227a 100644 --- a/doc/man/indexamajig.1 +++ b/doc/man/indexamajig.1 @@ -220,6 +220,16 @@ 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. + + .SH PEAK SEARCH OPTIONS .PD 0 .IP \fB--peaks=\fR\fImethod\fR |