aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/image.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/image.h
parentf5a13135c61f6e86ebc5be8afabdf4dd5a8c629e (diff)
Update docs
Diffstat (limited to 'libcrystfel/src/image.h')
-rw-r--r--libcrystfel/src/image.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/libcrystfel/src/image.h b/libcrystfel/src/image.h
index f19a7427..69edb768 100644
--- a/libcrystfel/src/image.h
+++ b/libcrystfel/src/image.h
@@ -48,6 +48,15 @@ struct image;
#include "crystal.h"
#include "index.h"
+/**
+ * SpectrumType:
+ * @SPECTRUM_TOPHAT: A top hat distribution of wavelengths
+ * @SPECTRUM_SASE: A simulated SASE spectrum
+ * @SPECTRUM_TWOCOLOUR: A spectrum containing two peaks
+ *
+ * A %SpectrumType represents a type of X-ray energy spectrum to use for
+ * generating simulated data.
+ **/
typedef enum {
SPECTRUM_TOPHAT,
SPECTRUM_SASE,