aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2021-03-25 15:24:36 +0100
committerThomas White <taw@physics.org>2021-03-25 16:16:01 +0100
commit31ab21aba60d592d7fc78a302e2f5620727445ee (patch)
treeffbe06942043943ec5df9cfcf2ed4a5c9f4e0a5c /doc
parent1440b2b897845b713450ef1bc8460d2d6d7bb337 (diff)
indexamajig: Add --camera-length-estimate
Unfortunately, PinkIndexer needs the real camera length for its centre refinement. Giving a fake value and scaling the resulting shift does not work - the indexing rate drops with even a small error. Ideally, this would work in the same way as --wavelength-estimate, by using a static value from the geometry file if it's given. However, this is rather complicated to implement because of the way all the units stuff is implemented. Therefore, this is left as an improvement for the future.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/indexamajig.13
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1
index 6dffdffd..f94bec01 100644
--- a/doc/man/indexamajig.1
+++ b/doc/man/indexamajig.1
@@ -386,8 +386,9 @@ Check that most of the peaks can be accounted for by the indexing solution. Thi
.PD 0
.IP \fB--wavelength-estimate=\fIm\fR
+.IP \fB--camera-length-estimate=\fIm\fR
.PD
-Some indexing algorithms need to know the wavelength of the incident radiation in advance, e.g. to prepare an internal look-up table. However, if the wavelength is taken from image headers, then the wavelength is not available at start-up. In this case, you will be prompted to add this option to give an approximate wavelength, in metres. A warning will be generated if the actual wavelength differs from this value by more than 10%.
+Some indexing algorithms need to know the camera length or the wavelength of the incident radiation in advance, e.g. to prepare an internal look-up table. However, if these values are taken from image headers, then they are not available at start-up. In this case, you will be prompted to add one of these options to give approximate values (in metres). A warning will be generated if the actual value differs from this value by more than 10%.
.PD 0
.IP \fB--max-indexer-threads=\fIn\fR