aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-12-03 17:24:34 +0100
committerThomas White <taw@physics.org>2013-12-03 17:24:34 +0100
commitca5db9466bf7da04f61f9bc86463bfdcdc025ecf (patch)
tree88a9c5867fe4addd9e827af82db98c16adf114f3
parente93f8d734b509cc75028d6ad41d2ca842cbdf57f (diff)
Update docs
-rw-r--r--doc/reference/libcrystfel/CrystFEL-docs.sgml1
-rw-r--r--doc/reference/libcrystfel/CrystFEL-sections.txt13
-rw-r--r--libcrystfel/src/index.h7
3 files changed, 19 insertions, 2 deletions
diff --git a/doc/reference/libcrystfel/CrystFEL-docs.sgml b/doc/reference/libcrystfel/CrystFEL-docs.sgml
index 2381bbc5..b840f04b 100644
--- a/doc/reference/libcrystfel/CrystFEL-docs.sgml
+++ b/doc/reference/libcrystfel/CrystFEL-docs.sgml
@@ -115,6 +115,7 @@
<chapter>
<title>Miscellaneous</title>
<xi:include href="xml/quaternion.xml"/>
+ <xi:include href="xml/histogram.xml"/>
<xi:include href="xml/utils.xml"/>
</chapter>
diff --git a/doc/reference/libcrystfel/CrystFEL-sections.txt b/doc/reference/libcrystfel/CrystFEL-sections.txt
index 51e2930c..7422f5ca 100644
--- a/doc/reference/libcrystfel/CrystFEL-sections.txt
+++ b/doc/reference/libcrystfel/CrystFEL-sections.txt
@@ -167,6 +167,7 @@ ph_eV_to_lambda
ph_lambda_to_eV
random_flat
flat_noise
+show_matrix
</SECTION>
<SECTION>
@@ -181,6 +182,15 @@ quat_rot
</SECTION>
<SECTION>
+<FILE>histogram</FILE>
+Histogram
+histogram_init
+histogram_free
+histogram_add_value
+histogram_show
+</SECTION>
+
+<SECTION>
<FILE>image</FILE>
image
ImageFeatureList
@@ -356,6 +366,7 @@ add_copy_hdf5_field
new_copy_hdf5_field_list
free_copy_hdf5_field_list
get_peaks
+hdfile_is_scalar
</SECTION>
<SECTION>
@@ -391,6 +402,7 @@ PartialityModel
find_intersections
select_intersections
update_partialities
+update_partialities_2
polarisation_correction
</SECTION>
@@ -421,6 +433,7 @@ INTEGRATION_DEFAULTS_PROF2D
INTEGRATION_DEFAULTS_RINGS
INTEGRATION_METHOD_MASK
IntegrationMethod
+IntDiag
integrate_all
integration_method
</SECTION>
diff --git a/libcrystfel/src/index.h b/libcrystfel/src/index.h
index e71a4c6f..e36e531c 100644
--- a/libcrystfel/src/index.h
+++ b/libcrystfel/src/index.h
@@ -67,7 +67,8 @@
* @INDEXING_MOSFLM: Invoke MOSFLM
* @INDEXING_REAX: DPS algorithm using known cell parameters
* @INDEXING_GRAINSPOTTER: Invoke GrainSpotter
- * @INDEXING_XDS: Invokve XDS
+ * @INDEXING_XDS: Invoke XDS
+ * @INDEXING_SIMULATION: Dummy value
* @INDEXING_CHECK_CELL_COMBINATIONS: Check linear combinations of unit cell
* axes for agreement with given cell.
* @INDEXING_CHECK_CELL_AXES: Check unit cell axes for agreement with given
@@ -79,7 +80,9 @@
* @INDEXING_USE_CELL_PARAMETERS: Use the unit cell parameters to guide the
* indexingprocess.
*
- * An enumeration of all the available indexing methods.
+ * An enumeration of all the available indexing methods. The dummy value
+ * @INDEXING_SIMULATION is used by partial_sim to indicate that no indexing was
+ * performed, and that the indexing results are just from simulation.
**/
typedef enum {