source: 1dwg/trunk/doc/src/cansas1d_element_SASdata.xml @ 128

Last change on this file since 128 was 128, checked in by prjemian, 12 years ago

more cross-references and formatting, first index entries, cleaned up the Makefile, refs #19

  • Property svn:executable set to *
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 17.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?>
3<!--
4    ########### SVN repository information ###################
5    # $Date$
6    # $Author$
7    # $Revision$
8    # $HeadURL$
9    # $Id$
10    ########### SVN repository information ###################
11-->
12<!-- from: http://www.smallangles.net/wgwiki/index.php/cansas1d_SASdata -->
13<section xml:id="cansas1d_documentation-element-SASdata" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SASdata element</title>
16    <bridgehead> $Revision$ $Date$ </bridgehead>
17    <itemizedlist mark="opencircle">
18        <listitem>
19            <indexterm><primary>SASdata</primary></indexterm>
20            <para> parent: <link xlink:href="#cansas1d_documentation-element-SASentry"
21                ><literal>SASentry</literal></link>
22            </para>
23        </listitem>
24    </itemizedlist>
25    <figure>
26        <title>The SASdata element</title>
27        <mediaobject>
28            <imageobject>
29                <imagedata fileref="../../graphics/2-SASdata.png" width="200pt" scalefit="1"/>
30            </imageobject>
31            <textobject>
32                <phrase>cansas1d-v1-2-SASdata.png</phrase>
33            </textobject>
34            <caption>
35                <para>The SASdata element</para>
36            </caption>
37        </mediaobject>
38    </figure>
39    <figure>
40        <title>Q geometry</title>
41        <mediaobject>
42            <imageobject>
43                <imagedata fileref="../../graphics/Q-geometry.jpg" width="200pt" scalefit="1"/>
44            </imageobject>
45            <textobject>
46                <phrase>Q-geometry.jpg</phrase>
47            </textobject>
48            <caption>
49                <para>Q geometry</para>
50            </caption>
51        </mediaobject>
52    </figure>
53    <section>
54        <title>SASdata</title>
55        <table orient="port" role="small">
56            <title/>
57            <tgroup cols="5">
58                <colspec colname="c1" colwidth="15*"/>
59                <colspec colname="c2" colwidth="15*"/>
60                <colspec colname="c3" colwidth="10*"/>
61                <colspec colname="c4" colwidth="30*"/>
62                <colspec colname="c5" colwidth="30*"/>
63                <tbody>
64                    <row>
65                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
66                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
67                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
68                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
69                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
70                    </row>
71                    <row>
72                        <entry>
73                            <emphasis role="bold">
74                                Idata
75                                <indexterm><primary>Idata</primary></indexterm>
76                            </emphasis>
77                        </entry>
78                        <entry> container </entry>
79                        <entry> [1..inf] </entry>
80                        <entry> Idata describes a single SAS data point. </entry>
81                        <entry/>
82                    </row>
83                </tbody>
84            </tgroup>
85        </table>
86    </section>
87    <section>
88        <title>Idata</title>
89        <table orient="port" role="small">
90            <title/>
91            <tgroup cols="5">
92                <colspec colname="c1" colwidth="15*"/>
93                <colspec colname="c2" colwidth="15*"/>
94                <colspec colname="c3" colwidth="10*"/>
95                <colspec colname="c4" colwidth="30*"/>
96                <colspec colname="c5" colwidth="30*"/>
97                <tbody>
98                    <row>
99                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
100                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
101                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
102                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
103                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
104                    </row>
105                    <row>
106                        <entry>
107                            <para>
108                                <emphasis role="bold">Q</emphasis>
109                            </para>
110                        </entry>
111                        <entry> floating-point number </entry>
112                        <entry> [1..1] </entry>
113                        <entry>
114                            <para>
115                                <emphasis>Q=(4 pi; / lambda;) sin(theta;)</emphasis> where
116                                    <emphasis>lambda;</emphasis> is the wavelength of the radiation
117                                and <emphasis>2theta;</emphasis> is the angle through which the
118                                detected radiation has been scattered. The <emphasis role="bold"
119                                    >unit</emphasis> attribute is required. See <link
120                                    xlink:href="#cansas1d_documentation-rules">rules for
121                                    units</link>
122                                <!--cansas1d_documentation#Rules --> for acceptable values. Either
123                                    <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are
124                                typical. </para>
125                        </entry>
126                        <entry>
127                            <para>
128                                <emphasis role="bold">unit</emphasis>={units} </para>
129                        </entry>
130                    </row>
131                    <row>
132                        <entry>
133                            <para>
134                                <emphasis role="bold">I</emphasis>
135                            </para>
136                        </entry>
137                        <entry> floating-point number </entry>
138                        <entry> [1..1] </entry>
139                        <entry>
140                            <para> Intensity of the detected radiation. The <emphasis role="bold"
141                                    >unit</emphasis> attribute is required. See
142                                cansas1d_documentation#Rules for acceptable values. One possibility
143                                might be<emphasis>1/cm</emphasis> for absolute units when the
144                                intensity describes a <emphasis>differential cross-section per unit
145                                    volume per unit solid angle</emphasis>. </para>
146                            <para> Be aware that there are different types of intensity used in
147                                small-angle scattering that may be reported (see the section titled
148                                    <link xlink:href="#the_intensity_problem-rules"><emphasis
149                                        role="italic">The Intensity Problem</emphasis></link>). One
150                                should be very careful to inspect the <emphasis role="bold"
151                                    >unit</emphasis> attribute to determine how to handle subsequent
152                                data processing, especially in the area of units conversion. </para>
153                        </entry>
154                        <entry>
155                            <para>
156                                <emphasis role="bold">unit</emphasis>={units} </para>
157                        </entry>
158                    </row>
159                    <row>
160                        <entry>
161                            <para>
162                                <emphasis role="bold"><emphasis>Idev</emphasis></emphasis>
163                            </para>
164                        </entry>
165                        <entry> floating-point number </entry>
166                        <entry> [0..1] </entry>
167                        <entry> Estimated standard deviation of <emphasis role="bold">I</emphasis>.
168                            The <emphasis role="bold">unit</emphasis> attribute is required. See
169                                <link xlink:href="#cansas1d_documentation-rules">rules for
170                                units</link>
171                            <!--cansas1d_documentation#Rules --> for acceptable values. One
172                            possibility might be <emphasis>1/cm</emphasis>. </entry>
173                        <entry>
174                            <para>
175                                <emphasis role="bold">unit</emphasis>={units} </para>
176                        </entry>
177                    </row>
178                    <row>
179                        <entry>
180                            <para>
181                                <emphasis role="bold"><emphasis>Qdev</emphasis></emphasis>
182                            </para>
183                        </entry>
184                        <entry> floating-point number </entry>
185                        <entry> [0..1] </entry>
186                        <entry> Estimated standard deviation of <emphasis role="bold">Q</emphasis>.
187                            (optional: see note below on usage)The <emphasis role="bold"
188                                >unit</emphasis> attribute is required. See <link
189                                xlink:href="#cansas1d_documentation-rules">rules for units</link>
190                            <!--cansas1d_documentation#Rules --> for acceptable values. Either
191                                <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are typical. </entry>
192                        <entry>
193                            <para>
194                                <emphasis role="bold">unit</emphasis>={units} </para>
195                        </entry>
196                    </row>
197                    <row>
198                        <entry>
199                            <para>
200                                <emphasis role="bold"><emphasis>dQw</emphasis></emphasis>
201                            </para>
202                        </entry>
203                        <entry> floating-point number </entry>
204                        <entry> [0..1] </entry>
205                        <entry>
206                            <para>
207                                <emphasis role="bold">Q</emphasis> resolution along the axis of
208                                scanning (the high-resolution <emphasis>slit width</emphasis>
209                                direction). Useful for defining resolution data from slit-smearing
210                                instruments such as Bonse-Hart geometry. (optional: see note below
211                                on usage).</para>
212                            <para> The <emphasis role="bold">unit</emphasis> attribute is required.
213                                See <link xlink:href="#cansas1d_documentation-rules">rules for
214                                    units</link>
215                                <!--cansas1d_documentation#Rules --> for acceptable values. Either
216                                    <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are
217                                typical. </para>
218                        </entry>
219                        <entry>
220                            <para>
221                                <emphasis role="bold">unit</emphasis>={units} </para>
222                        </entry>
223                    </row>
224                    <row>
225                        <entry>
226                            <para>
227                                <emphasis role="bold"><emphasis>dQl</emphasis></emphasis>
228                            </para>
229                        </entry>
230                        <entry> floating-point number </entry>
231                        <entry> [0..1] </entry>
232                        <entry>
233                            <para>
234                                <emphasis role="bold">Q</emphasis> resolution perpendicular to the
235                                axis of scanning (the low-resolution <emphasis>slit
236                                    length</emphasis> direction). Useful for defining resolution
237                                data from slit-smearing instruments such as Bonse-Hart geometry.
238                                (optional: see note below on usage)The <emphasis role="bold"
239                                    >unit</emphasis> attribute is required. See <link
240                                    xlink:href="#cansas1d_documentation-rules">rules for
241                                    units</link>
242                                <!--cansas1d_documentation#Rules --> for acceptable values. Either
243                                    <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are
244                                typical. </para>
245                        </entry>
246                        <entry>
247                            <para>
248                                <emphasis role="bold">unit</emphasis>={units} </para>
249                        </entry>
250                    </row>
251                    <row>
252                        <entry>
253                            <para>
254                                <emphasis role="bold"><emphasis>Qmean</emphasis></emphasis>
255                            </para>
256                        </entry>
257                        <entry> floating-point number </entry>
258                        <entry> [0..1] </entry>
259                        <entry> Mean value of <emphasis role="bold">Q</emphasis> for this datum.
260                            Useful when describing data that has been binned from higher-resolution
261                            or from area detectors.The <emphasis role="bold">unit</emphasis>
262                            attribute is required. See <link
263                                xlink:href="#cansas1d_documentation-rules">rules for units</link>
264                            <!--cansas1d_documentation#Rules --> for acceptable values. Either
265                                <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are typical. </entry>
266                        <entry>
267                            <para>
268                                <emphasis role="bold">unit</emphasis>={units} </para>
269                        </entry>
270                    </row>
271                    <row>
272                        <entry>
273                            <para>
274                                <emphasis role="bold"><emphasis>Shadowfactor</emphasis></emphasis>
275                            </para>
276                        </entry>
277                        <entry> floating-point number </entry>
278                        <entry> [0..1] </entry>
279                        <entry>
280                            <para> Describes the adjustment due to the beam stop penumbra. </para>
281                            <caution>
282                                <para>This definition needs revision. NIST?</para>
283                            </caution>
284                            <note>
285                                <para>There is no unit attribute.</para>
286                            </note>
287                        </entry>
288                        <entry/>
289                    </row>
290                    <row>
291                        <entry><emphasis role="bold"><emphasis role="italic"> {any}
292                                </emphasis></emphasis></entry>
293                        <entry> container </entry>
294                        <entry> [0..inf] </entry>
295                        <entry> Any element(s) not defined in the cansas1d/1.0 standard can be
296                            placed at this point. See <link
297                                xlink:href="#cansas1d_documentation-element-any"><emphasis
298                                    role="bold">{any}</emphasis></link>
299                            <!--''{any}'' --> for more details. </entry>
300                        <entry>
301                            <para>
302                                <emphasis role="bold"
303                                    ><emphasis
304                                        >xmlns:{foreign-prefix}</emphasis></emphasis>
305                                =<link
306                                    xlink:href="#cansas1d_documentation-element-any"
307                                    ><literal>{foreign-namespace}</literal></link>
308                            </para>
309                        </entry>
310                    </row>
311                </tbody>
312            </tgroup>
313        </table>
314    </section>
315    <section>
316        <title>Notes</title>
317        <orderedlist numeration="arabic">
318            <listitem>
319                <para> When an optional element (<emphasis role="bold"
320                        ><emphasis>Idev</emphasis></emphasis>, <emphasis role="bold"
321                            ><emphasis>Qdev</emphasis></emphasis>, ...) is used, it must be given in
322                    every <emphasis role="bold">Idata</emphasis> within the enclosing <emphasis
323                        role="bold">SASdata</emphasis>. </para>
324            </listitem>
325            <listitem>
326                <para> If either <emphasis role="bold"><emphasis>dQw</emphasis></emphasis> or
327                        <emphasis role="bold"><emphasis>dQl</emphasis></emphasis> are used, then
328                        <emphasis role="bold"><emphasis>Qdev</emphasis></emphasis> is not permitted
329                    to be used. </para>
330            </listitem>
331        </orderedlist>
332        <note>
333            <para>
334                <emphasis role="bold">(The Shadowfactor attribute definition needs revision.
335                    NIST?)</emphasis>
336            </para>
337        </note>
338    </section>
339</section>
Note: See TracBrowser for help on using the repository browser.