aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2019-05-15 17:02:21 +0200
committerThomas White <taw@physics.org>2019-05-15 17:02:21 +0200
commit6aa34aa38aa2116ff69861c1857dac96fa8c9361 (patch)
tree887657817cfc83fa5c6f021f9be8426f4613d5f6 /libcrystfel
parenta68c03522a0eafadd1cdcb635896c4be76e665c8 (diff)
Spectrum API clarifications
Diffstat (limited to 'libcrystfel')
-rw-r--r--libcrystfel/src/spectrum.c7
-rw-r--r--libcrystfel/src/spectrum.h6
2 files changed, 8 insertions, 5 deletions
diff --git a/libcrystfel/src/spectrum.c b/libcrystfel/src/spectrum.c
index 3113c75c..21b21f80 100644
--- a/libcrystfel/src/spectrum.c
+++ b/libcrystfel/src/spectrum.c
@@ -240,6 +240,8 @@ static double gauss_high(struct gaussian *gauss, int n_gauss)
* Sets \p kmin and \p kmax to the range of k values in the spectrum. If the
* spectrum is represented as Gaussians, the range returned will be enough to
* contain at least 5 sigmas of all the Gaussians.
+ *
+ * The values will be returned in units of 1/m.
*/
void spectrum_get_range(Spectrum *s, double *kmin, double *kmax)
{
@@ -333,7 +335,7 @@ static void normalise_histogram(double *k, double *pdf, int n)
/**
* \param s A \ref Spectrum
- * \param kvals Pointer to array of k values
+ * \param kvals Pointer to array of k values (in 1/m);
* \param heights Pointer to array of spectral density samples
* \param n Number of samples
*
@@ -406,7 +408,8 @@ static int read_esrf_spectrum(FILE *fh, Spectrum *s)
/**
* \param filename Filename for the input file
*
- * Loads the spectrum from \s filename.
+ * Loads the spectrum from \s filename. Currently, only the ESRF spectrum file
+ * format is supported.
*
* \returns A newly allocated \ref Spectrum, or NULL on error.
*/
diff --git a/libcrystfel/src/spectrum.h b/libcrystfel/src/spectrum.h
index 2bcd0322..b3786c53 100644
--- a/libcrystfel/src/spectrum.h
+++ b/libcrystfel/src/spectrum.h
@@ -51,9 +51,9 @@ typedef struct _spectrum Spectrum;
*/
struct gaussian
{
- double kcen;
- double sigma;
- double height;
+ double kcen; /**< k value at centre of Gaussian (in 1/m) */
+ double sigma; /**< Standard deviation of Gaussian (in 1/m) */
+ double height; /**< Height of Gaussian (arbitrary units) */
};