aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/integration.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2014-09-05 13:36:08 +0200
committerThomas White <taw@physics.org>2014-09-05 13:36:39 +0200
commitacbc6aec2f192189659975503717a8ac3d1226f0 (patch)
tree9287eb6a2c54797cd9684e094830253d07572211 /libcrystfel/src/integration.h
parentf5a13135c61f6e86ebc5be8afabdf4dd5a8c629e (diff)
Update docs
Diffstat (limited to 'libcrystfel/src/integration.h')
-rw-r--r--libcrystfel/src/integration.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/libcrystfel/src/integration.h b/libcrystfel/src/integration.h
index 9e1c8ee1..ca04157a 100644
--- a/libcrystfel/src/integration.h
+++ b/libcrystfel/src/integration.h
@@ -36,6 +36,23 @@
#include "geometry.h"
+/**
+ * IntDiag:
+ * @INTDIAG_NONE: Never show diagnostics
+ * @INTDIAG_RANDOM: Show diagnostics for a randomly selected 1% of reflections
+ * @INTDIAG_ALL: Show diagnostics for all reflections
+ * @INTDIAG_INDICES: Show diagnostics when the Miller indices of the reflection
+ * are the ones specified
+ * @INTDIAG_NEGATIVE: Show diagnostics when the measured intensity is less than
+ * minus three times its estimated error.
+ * @INTDIAG_IMPLAUSIBLE: Show diagnostics when the measured intensity is les
+ * than minus five times its estimated error.
+ * @INTDIAG_STRONG: Show diagnostics when the measured intensity is more than
+ * three times its estimated error.
+ *
+ * An %IntDiag describes the condition under which the integration subsystem
+ * should display diagnostic information to the user.
+ **/
typedef enum {
INTDIAG_NONE,