aboutsummaryrefslogtreecommitdiff
path: root/doc/reference/libcrystfel
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-03-01 14:50:30 +0100
committerThomas White <taw@physics.org>2013-03-01 14:50:30 +0100
commit5fa1c22d6bbeff12c2509e1222090a43a994f7a9 (patch)
tree53d8d3562ee47ac8f5f2955214d72caf103cde03 /doc/reference/libcrystfel
parented6bf4edb2abd89188cdd38911473dadc194a7f9 (diff)
Update docs (and shake out buglets revealed along the way)
Diffstat (limited to 'doc/reference/libcrystfel')
-rw-r--r--doc/reference/libcrystfel/CrystFEL-docs.sgml20
-rw-r--r--doc/reference/libcrystfel/CrystFEL-sections.txt129
2 files changed, 134 insertions, 15 deletions
diff --git a/doc/reference/libcrystfel/CrystFEL-docs.sgml b/doc/reference/libcrystfel/CrystFEL-docs.sgml
index 4e6cc877..1c91e72f 100644
--- a/doc/reference/libcrystfel/CrystFEL-docs.sgml
+++ b/doc/reference/libcrystfel/CrystFEL-docs.sgml
@@ -43,6 +43,26 @@
</chapter>
<chapter>
+ <title>Geometry of diffraction</title>
+ <xi:include href="xml/geometry.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Beam parameters</title>
+ <xi:include href="xml/beam-params.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Peaks</title>
+ <xi:include href="xml/peaks.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Image filters</title>
+ <xi:include href="xml/filter.xml"/>
+ </chapter>
+
+ <chapter>
<title>Statistics and R-factors</title>
<xi:include href="xml/statistics.xml"><xi:fallback /></xi:include>
</chapter>
diff --git a/doc/reference/libcrystfel/CrystFEL-sections.txt b/doc/reference/libcrystfel/CrystFEL-sections.txt
index 5df1f2d5..eb7ac054 100644
--- a/doc/reference/libcrystfel/CrystFEL-sections.txt
+++ b/doc/reference/libcrystfel/CrystFEL-sections.txt
@@ -63,6 +63,8 @@ res_cutoff
check_list_symmetry
copy_reflist
find_equiv_in_list
+resolution_limits
+max_intensity
</SECTION>
<SECTION>
@@ -156,6 +158,10 @@ notrail
smallest
ph_en_to_lambda
ph_lambda_to_en
+ph_eV_to_lambda
+ph_lambda_to_eV
+random_flat
+flat_noise
</SECTION>
<SECTION>
@@ -179,7 +185,9 @@ image_feature_count
image_feature_list_free
image_feature_list_new
image_get_feature
+image_add_crystal
image_remove_feature
+free_all_crystals
</SECTION>
<SECTION>
@@ -189,6 +197,8 @@ TPWorkFunc
TPFinalFunc
<SUBSECTION>
run_threads
+stderr_lock
+get_status_label
</SECTION>
<SECTION>
@@ -210,14 +220,32 @@ stat_scale_intensity
<FILE>indexing</FILE>
IndexingMethod
IndexingPrivate
-MAX_CELL_CANDIDATES
+INDEXING_DEFAULTS_DIRAX
+INDEXING_DEFAULTS_GRAINSPOTTER
+INDEXING_DEFAULTS_MOSFLM
+INDEXING_DEFAULTS_REAX
+INDEXING_DEFAULTS_XDS
+INDEXING_METHOD_MASK
build_indexer_list
cleanup_indexing
prepare_indexing
index_pattern
+indexer_str
+dirax_prepare
run_dirax
+dirax_cleanup
+mosflm_prepare
run_mosflm
-map_all_peaks
+mosflm_cleanup
+xds_prepare
+run_xds
+xds_cleanup
+reax_prepare
+reax_index
+reax_cleanup
+grainspotter_prepare
+grainspotter_index
+grainspotter_cleanup
</SECTION>
<SECTION>
@@ -228,6 +256,7 @@ SymOpMask
free_symoplist
num_equivs
get_pointgroup
+add_symop
get_equiv
special_position
get_asymm
@@ -284,6 +313,15 @@ get_tt
smallest_q
reverse_2d_mapping
largest_q
+in_bad_region
+</SECTION>
+
+<SECTION>
+<FILE>beam-params</FILE>
+beam_params
+get_beam_parameters
+fill_in_beam_parameters
+free_beam_parameters
</SECTION>
<SECTION>
@@ -297,6 +335,7 @@ crystal_free
<FILE>hdf5-file</FILE>
hdf5_read
hdf5_write
+hdf5_write_image
hdfile
hdfile_close
hdfile_get_image_binned
@@ -305,25 +344,85 @@ hdfile_open
hdfile_read_group
hdfile_set_first_image
hdfile_set_image
+get_value
+copy_hdf5_field
+copy_hdf5_fields
+add_copy_hdf5_field
+new_copy_hdf5_field_list
+free_copy_hdf5_field_list
+get_peaks
</SECTION>
<SECTION>
-<FILE>stream</FILE>
-parse_stream_flags
-read_chunk
-write_chunk
-write_stream_header
-skip_some_files
-is_stream
-get_value
-count_patterns
+<FILE>crystal</FILE>
+Crystal
+crystal_new
+crystal_free
+crystal_get_cell
+crystal_get_image
+crystal_get_mosaicity
+crystal_get_num_saturated_reflections
+crystal_get_osf
+crystal_get_profile_radius
+crystal_get_reflections
+crystal_get_resolution_limit
+crystal_get_user_flag
+crystal_set_cell
+crystal_set_image
+crystal_set_mosaicity
+crystal_set_num_saturated_reflections
+crystal_set_osf
+crystal_set_profile_radius
+crystal_set_reflections
+crystal_set_resolution_limit
+crystal_set_user_flag
+</SECTION>
+
+<SECTION>
+<FILE>geometry</FILE>
+find_intersections
+select_intersections
+update_partialities
+</SECTION>
+
+<SECTION>
+<FILE>peaks</FILE>
+peak_sanity_check
+search_peaks
+integrate_reflections
+validate_peaks
</SECTION>
<SECTION>
<FILE>render</FILE>
-render_get_colour_scale
-render_panels
render_scale
-render_tiff_fp
-render_tiff_int16
+</SECTION>
+
+<SECTION>
+<FILE>filter</FILE>
+filter_cm
+filter_noise
+</SECTION>
+
+<SECTION>
+<FILE>stream</FILE>
+Stream
+CHUNK_END_MARKER
+CHUNK_START_MARKER
+CRYSTAL_END_MARKER
+CRYSTAL_START_MARKER
+PEAK_LIST_END_MARKER
+PEAK_LIST_START_MARKER
+REFLECTION_END_MARKER
+REFLECTION_START_MARKER
+open_stream_fd_for_write
+open_stream_for_read
+open_stream_for_write
+close_stream
+read_chunk
+write_chunk
+rewind_stream
+is_stream
+write_command
+write_line
</SECTION>