aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/geometry.c
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2015-07-20 15:52:38 +0200
committerThomas White <taw@physics.org>2015-07-21 10:18:33 +0200
commit466402c6a1b2804c168aa0da40a54842243ca60a (patch)
tree65918872bd1b3a9e4db0560dae04bdaa7522bab5 /libcrystfel/src/geometry.c
parentd75b852f52b244796c0386c4f21cf36ca5bfcf70 (diff)
Update API docs
Diffstat (limited to 'libcrystfel/src/geometry.c')
-rw-r--r--libcrystfel/src/geometry.c9
1 files changed, 8 insertions, 1 deletions
diff --git a/libcrystfel/src/geometry.c b/libcrystfel/src/geometry.c
index 3325923c..d8b40a16 100644
--- a/libcrystfel/src/geometry.c
+++ b/libcrystfel/src/geometry.c
@@ -495,7 +495,14 @@ static void set_unity_partialities(Crystal *cryst)
}
-/* Calculate partialities and apply them to the image's reflections */
+/**
+ * update_partialities:
+ * @cryst: A %Crystal
+ * @pmodel: A %PartialityModel
+ *
+ * Updates the partialities of @cryst's reflections according to @pmodel and
+ * the current state of the crystal (e.g. its unit cell parameters).
+ */
void update_partialities(Crystal *cryst, PartialityModel pmodel)
{
Reflection *refl;