From 1228c4b4f54a9617227eca395c9bbb9e7e9418b1 Mon Sep 17 00:00:00 2001 From: Yaroslav Gevorkov Date: Fri, 15 Nov 2019 17:47:17 +0100 Subject: PinkIndexer documentation --- doc/man/indexamajig.1 | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'doc') diff --git a/doc/man/indexamajig.1 b/doc/man/indexamajig.1 index 2e9e4e76..3a87488e 100644 --- a/doc/man/indexamajig.1 +++ b/doc/man/indexamajig.1 @@ -448,6 +448,9 @@ These set low-level parameters for the XGANDALF indexing algorithm. .IP \fB--pinkIndexer-multi=\fIn\fR .IP \fB--pinkIndexer-thread-count=\fIn\fR .IP \fB--pinkIndexer-no-check-indexed=\fIn\fR +.IP \fB--pinkIndexer-override-photon-energy=\fIn\fR +.IP \fB--pinkIndexer-override-bandwidth=\fIn\fR +.IP \fB--pinkIndexer-override-visible-energy-range=\fImin-max\fR .PD These set low-level parameters for the XGANDALF indexing algorithm. @@ -469,6 +472,12 @@ These set low-level parameters for the XGANDALF indexing algorithm. \fB--pinkIndexer-thread-count\fR sets the thread count for internal parallelization. Default is 1. Very useful for small datasets (e.g. for screening). Internal parallelization does not significantly increase the amount of RAM needed, whereas CrystFELs parallelization does. For HPCs typically a mixture of both parallelizations leads to best results. .IP \fB--pinkIndexer-no-check-indexed\fR Leave the check whether a pattern is indexed completely to CrystFEL. Useful for monochromatic (since CrystFELs 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-photon-energy=\fIn\fR Overrides the bandwidth in (delta energy)/(mean energy) to use for indexing (which usually is difined in the geometry file). Should be used together with \fB--pinkIndexer-override-bandwidth=\fIn\fR +.IP +\fB--pinkIndexer-override-bandwidth=\fIn\fR Overrides the mean energy in eV to use for indexing (which usually is difined in the geometry file). Should be used together with \fB--pinkIndexer-override-bandwidth=\fIn\fR +.IP +\fB--pinkIndexer-override-visible-energy-range=\fImin-max\fR Overrides photon energy and bandwidth according to a range of energies that have high enough intensity to produce visible Bragg spots on the detector. min and max range borders are separated by a minus sign (no whitespace). .SH INTEGRATION OPTIONS .PD 0 -- cgit v1.2.3