aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/index.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-03-01 14:50:30 +0100
committerThomas White <taw@physics.org>2013-03-01 14:50:30 +0100
commit5fa1c22d6bbeff12c2509e1222090a43a994f7a9 (patch)
tree53d8d3562ee47ac8f5f2955214d72caf103cde03 /libcrystfel/src/index.h
parented6bf4edb2abd89188cdd38911473dadc194a7f9 (diff)
Update docs (and shake out buglets revealed along the way)
Diffstat (limited to 'libcrystfel/src/index.h')
-rw-r--r--libcrystfel/src/index.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/libcrystfel/src/index.h b/libcrystfel/src/index.h
index f8f6e55b..31ee4339 100644
--- a/libcrystfel/src/index.h
+++ b/libcrystfel/src/index.h
@@ -64,6 +64,18 @@
* @INDEXING_DIRAX: Invoke DirAx
* @INDEXING_MOSFLM: Invoke MOSFLM
* @INDEXING_REAX: DPS algorithm using known cell parameters
+ * @INDEXING_GRAINSPOTTER: Invoke GrainSpotter
+ * @INDEXING_XDS: Invokve XDS
+ * @INDEXING_CHECK_CELL_COMBINATIONS: Check linear combinations of unit cell
+ * axes for agreement with given cell.
+ * @INDEXING_CHECK_CELL_AXES: Check unit cell axes for agreement with given
+ * cell, and permute them if necessary.
+ * @INDEXING_CHECK_PEAKS: Check that the peaks can be explained by the indexing
+ * result.
+ * @INDEXING_USE_LATTICE_TYPE: Use lattice type and centering information to
+ * guide the indexing process.
+ * @INDEXING_USE_CELL_PARAMETERS: Use the unit cell parameters to guide the
+ * indexingprocess.
*
* An enumeration of all the available indexing methods.
**/