aboutsummaryrefslogtreecommitdiff
path: root/doc/reference/libcrystfel/CrystFEL-docs.sgml
blob: b95d4c34eb774e750dc8f4a397842b93633f9b9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index">
  <bookinfo>
    <title>CrystFEL Reference Manual</title>
    <releaseinfo>
      For libcrystfel from CrystFEL 0.5.2.
    </releaseinfo>
    <abstract>
    This is the internal documentation for CrystFEL.  Unless you are looking at
    the code, writing new programs or fixing bugs, you should not need to read
    this.  You might use the information here when reading the code or to better
    understand how the software works, or refer to it when creating a new
    program within the suite.
    </abstract>
  </bookinfo>

  <chapter>
    <title>Images</title>
        <xi:include href="xml/image.xml"/>
  </chapter>

  <chapter>
    <title>Handling reflection data</title>
        <abstract>There are three main reflection list thingies.</abstract>
        <xi:include href="xml/reflist.xml"/>
        <xi:include href="xml/reflist-utils.xml"/>
  </chapter>

  <chapter>
    <title>Unit cells</title>
        <xi:include href="xml/unitcell.xml"/>
        <xi:include href="xml/cell-utils.xml"/>
  </chapter>

  <chapter>
    <title>Crystals</title>
        <xi:include href="xml/crystal.xml"/>
  </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>

  <chapter>
    <title>Symmetry</title>
        <xi:include href="xml/symmetry.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Integer Matrices</title>
        <xi:include href="xml/integer_matrix.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Indexing</title>
        <xi:include href="xml/indexing.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Integration</title>
        <xi:include href="xml/integration.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Detector</title>
        <xi:include href="xml/detector.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>HDF5</title>
        <xi:include href="xml/hdf5-file.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Stream</title>
        <xi:include href="xml/stream.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Render</title>
        <xi:include href="xml/render.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Parallel programming</title>
        <xi:include href="xml/thread-pool.xml"><xi:fallback /></xi:include>
  </chapter>

  <chapter>
    <title>Miscellaneous</title>
        <xi:include href="xml/quaternion.xml"/>
        <xi:include href="xml/histogram.xml"/>
        <xi:include href="xml/utils.xml"/>
  </chapter>

  <chapter>
    <title>Information for developers</title>
        <xi:include href="xml/coding-standards.xml"><xi:fallback /></xi:include>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

</book>