aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-06-05 14:17:07 +0200
committerThomas White <taw@physics.org>2014-06-05 14:19:29 +0200
commitcfb9a9979cab8eacc4636a8360502c3d33c66f2a (patch)
tree6ff0d8db299ca77753bdc6f26ffd0a5641f5fbb4 /doc
parent945a899b01ffc54d95e961cd4df5e6616ae7ee18 (diff)
ambigator: Add --corr-matrix
Diffstat (limited to 'doc')
-rw-r--r--doc/man/ambigator.13
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/man/ambigator.1 b/doc/man/ambigator.1
index 4aa5da98..14b87491 100644
--- a/doc/man/ambigator.1
+++ b/doc/man/ambigator.1
@@ -100,6 +100,9 @@ Use \fIn\fR correlations per crystal. The default is to correlate against every
.IP \fB--really-random\fR
Be non-deterministic by seeding the random number generator (used to make the initial indexing assignments and select patterns to correlate against) from /dev/urandom. Otherwise, with single-threaded operation (\fB-j 1\fR) on the same data, the results from this program should be the same if it is re-run. Using more than one thread already introduces some non-deterministic behaviour.
+.PD 0
+.IP \fB--corr-matrix=\fR\fIfilename\fR
+Write the the correlation matrices in HDF5 format to \fIfilename\fR. The file will contain two datasets: \fBcorrelation_matrix\fR and \fBcorrelation_matrix_reindexed\fR. They contain, respectively, the correlation matrix with all crystals in their original orientations and all crystals in the reindexed orientations. If the ambiguity operator is unknown (i.e. neither \fB--operator\fR nor \fB-w\fR were used), then the latter will be zero everywhere.
.SH AUTHOR
This page was written by Thomas White.