aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/index.h
diff options
context:
space:
mode:
Diffstat (limited to 'libcrystfel/src/index.h')
-rw-r--r--libcrystfel/src/index.h16
1 files changed, 15 insertions, 1 deletions
diff --git a/libcrystfel/src/index.h b/libcrystfel/src/index.h
index 9d23f3fb..4a724645 100644
--- a/libcrystfel/src/index.h
+++ b/libcrystfel/src/index.h
@@ -43,7 +43,15 @@
#include "detector.h"
-/* Indexing methods */
+/**
+ * IndexingMethod:
+ * @INDEXING_NONE: No indexing to be performed
+ * @INDEXING_DIRAX: Invoke DirAx
+ * @INDEXING_MOSFLM: Invoke MOSFLM
+ * @INDEXING_REAX: DPS algorithm using known cell parameters
+ *
+ * An enumeration of all the available indexing methods.
+ **/
typedef enum {
INDEXING_NONE,
INDEXING_DIRAX,
@@ -61,6 +69,12 @@ enum {
};
+/**
+ * IndexingPrivate:
+ *
+ * This is an opaque data structure containing information needed by the
+ * indexing method.
+ **/
typedef struct _indexingprivate IndexingPrivate;
extern IndexingPrivate *indexing_private(IndexingMethod indm);