aboutsummaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorYaroslav Gevorkov <yaroslav.gevorkov@desy.de>2020-02-07 21:26:58 +0100
committerYaroslav Gevorkov <yaroslav.gevorkov@desy.de>2020-02-07 21:26:58 +0100
commit8823d9877ad3f1badacd232d900f269368a582b5 (patch)
tree92bf345cbd34cd2afc3842064d8df64d28e1a8e0 /doc/man
parent190204f3806cd343097afad62a29523bd109cc7f (diff)
refine documentation for --pinkIndexer-override-bandwidth
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/indexamajig.12
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1
index 99463711..64929727 100644
--- a/doc/man/indexamajig.1
+++ b/doc/man/indexamajig.1
@@ -473,7 +473,7 @@ These set low-level parameters for the PinkIndexer indexing algorithm.
.IP
\fB--pinkIndexer-no-check-indexed\fR Leave the check whether a pattern is indexed completely to CrystFEL. Useful for monochromatic (since CrystFEL's prediction model is smarter than the one of pinkIndexer) or in combnation with --no-check-peaks for geometry optimization. This flag is meant to eventually disappear, when the full pink pipeline is implemented.
.IP
-\fB--pinkIndexer-override-bandwidth=\fIn\fR Overrides the bandwidth in (delta energy)/(mean energy) to use for indexing (which usually is defined in the geometry file). Should be used together with \fB--pinkIndexer-override-photon-energy=\fIn\fR
+\fB--pinkIndexer-override-bandwidth=\fIn\fR Overrides the bandwidth in (delta energy)/(mean energy) to use for indexing (which usually is defined in the geometry file). Should be used together with \fB--pinkIndexer-override-photon-energy=\fIn\fR. Note: this option sets the borders for the spectrum, whereas the option in the geometry file sets the standard deviation for a Gaussian that fits the spectrum. Internally, the standard deviation is multiplied by 5 to compute the hard borders of the spectrum. I.e., photon_energy_bandwith = 0.005 in the geometry file equals --pinkIndexer-override-bandwidth=0.025. For monochromatic experiments usually --pinkIndexer-override-bandwidth=0.01 is sufficiently large. If in doubt, use --pinkIndexer-override-visible-energy-range.
.IP
\fB--pinkIndexer-override-photon-energy=\fIn\fR Overrides the mean energy in eV to use for indexing (which usually is defined in the geometry file). Should be used together with \fB--pinkIndexer-override-bandwidth=\fIn\fR
.IP