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

Last change on this file since 129 was 129, checked in by prjemian, 11 years ago

more cross-references, formatting, & indices, refs #19

  • Property svn:executable set to *
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 17.7 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 significance="preferred"><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                            <literal>
74                                Idata
75                                <indexterm><primary>Idata</primary></indexterm>
76                            </literal>
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                                <literal>Q</literal>
109                            </para>
110                        </entry>
111                        <entry> floating-point number </entry>
112                        <entry> [1..1] </entry>
113                        <entry>
114                            <para>
115                                <inlineequation>
116                                    <mathphrase><alt>$Q=(4 \pi / \lambda) \sin(\theta)$</alt></mathphrase>
117                                </inlineequation>
118                                where
119                                <inlineequation>
120                                    <mathphrase><alt>$\lambda$</alt></mathphrase>
121                                </inlineequation>
122                                is the wavelength of the radiation and
123                                <inlineequation>
124                                    <mathphrase><alt>$2\theta$</alt></mathphrase>
125                                </inlineequation>
126                                is the angle through which the
127                                detected radiation has been scattered. The <emphasis role="bold"
128                                    >unit</emphasis> attribute is required. See <link
129                                    xlink:href="#cansas1d_documentation-rules">rules for
130                                    units</link>
131                                for acceptable values. Either
132                                    <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are
133                                typical. </para>
134                        </entry>
135                        <entry>
136                            <para>
137                                <emphasis role="bold">unit</emphasis>={units} </para>
138                        </entry>
139                    </row>
140                    <row>
141                        <entry>
142                            <para>
143                                <literal>I</literal>
144                            </para>
145                        </entry>
146                        <entry> floating-point number </entry>
147                        <entry> [1..1] </entry>
148                        <entry>
149                            <para> Intensity of the detected radiation. The <emphasis role="bold"
150                                    >unit</emphasis> attribute is required. See
151                                cansas1d_documentation#Rules for acceptable values. One possibility
152                                might be<emphasis>1/cm</emphasis> for absolute units when the
153                                intensity describes a <emphasis>differential cross-section per unit
154                                    volume per unit solid angle</emphasis>. </para>
155                            <para> Be aware that there are different types of intensity used in
156                                small-angle scattering that may be reported (see the section titled
157                                    <link xlink:href="#the_intensity_problem-rules"><emphasis
158                                        role="italic">The Intensity Problem</emphasis></link>). One
159                                should be very careful to inspect the <emphasis role="bold"
160                                    >unit</emphasis> attribute to determine how to handle subsequent
161                                data processing, especially in the area of units conversion. </para>
162                        </entry>
163                        <entry>
164                            <para>
165                                <emphasis role="bold">unit</emphasis>={units} </para>
166                        </entry>
167                    </row>
168                    <row>
169                        <entry>
170                            <para>
171                                <literal>Idev</literal>
172                            </para>
173                        </entry>
174                        <entry> floating-point number </entry>
175                        <entry> [0..1] </entry>
176                        <entry> Estimated standard deviation of <emphasis role="bold">I</emphasis>.
177                            The <emphasis role="bold">unit</emphasis> attribute is required. See
178                                <link xlink:href="#cansas1d_documentation-rules">rules for
179                                units</link>
180                            <!--cansas1d_documentation#Rules --> for acceptable values. One
181                            possibility might be <emphasis>1/cm</emphasis>. </entry>
182                        <entry>
183                            <para>
184                                <emphasis role="bold">unit</emphasis>={units} </para>
185                        </entry>
186                    </row>
187                    <row>
188                        <entry>
189                            <para>
190                                <literal>Qdev</literal>
191                            </para>
192                        </entry>
193                        <entry> floating-point number </entry>
194                        <entry> [0..1] </entry>
195                        <entry> Estimated standard deviation of <emphasis role="bold">Q</emphasis>.
196                            (optional: see note below on usage)The <emphasis role="bold"
197                                >unit</emphasis> attribute is required. See <link
198                                xlink:href="#cansas1d_documentation-rules">rules for units</link>
199                            <!--cansas1d_documentation#Rules --> for acceptable values. Either
200                                <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are typical. </entry>
201                        <entry>
202                            <para>
203                                <emphasis role="bold">unit</emphasis>={units} </para>
204                        </entry>
205                    </row>
206                    <row>
207                        <entry>
208                            <para>
209                                <literal>dQw</literal>
210                            </para>
211                        </entry>
212                        <entry> floating-point number </entry>
213                        <entry> [0..1] </entry>
214                        <entry>
215                            <para>
216                                <emphasis role="bold">Q</emphasis> resolution along the axis of
217                                scanning (the high-resolution <emphasis>slit width</emphasis>
218                                direction). Useful for defining resolution data from slit-smearing
219                                instruments such as Bonse-Hart geometry. (optional: see note below
220                                on usage).</para>
221                            <para> The <emphasis role="bold">unit</emphasis> attribute is required.
222                                See <link xlink:href="#cansas1d_documentation-rules">rules for
223                                    units</link>
224                                <!--cansas1d_documentation#Rules --> for acceptable values. Either
225                                    <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are
226                                typical. </para>
227                        </entry>
228                        <entry>
229                            <para>
230                                <emphasis role="bold">unit</emphasis>={units} </para>
231                        </entry>
232                    </row>
233                    <row>
234                        <entry>
235                            <para>
236                                <literal>dQl</literal>
237                            </para>
238                        </entry>
239                        <entry> floating-point number </entry>
240                        <entry> [0..1] </entry>
241                        <entry>
242                            <para>
243                                <emphasis role="bold">Q</emphasis> resolution perpendicular to the
244                                axis of scanning (the low-resolution <emphasis>slit
245                                    length</emphasis> direction). Useful for defining resolution
246                                data from slit-smearing instruments such as Bonse-Hart geometry.
247                                (optional: see note below on usage)The <emphasis role="bold"
248                                    >unit</emphasis> attribute is required. See <link
249                                    xlink:href="#cansas1d_documentation-rules">rules for
250                                    units</link>
251                                <!--cansas1d_documentation#Rules --> for acceptable values. Either
252                                    <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are
253                                typical. </para>
254                        </entry>
255                        <entry>
256                            <para>
257                                <emphasis role="bold">unit</emphasis>={units} </para>
258                        </entry>
259                    </row>
260                    <row>
261                        <entry>
262                            <para>
263                                <literal>Qmean</literal>
264                            </para>
265                        </entry>
266                        <entry> floating-point number </entry>
267                        <entry> [0..1] </entry>
268                        <entry> Mean value of <emphasis role="bold">Q</emphasis> for this datum.
269                            Useful when describing data that has been binned from higher-resolution
270                            or from area detectors.The <emphasis role="bold">unit</emphasis>
271                            attribute is required. See <link
272                                xlink:href="#cansas1d_documentation-rules">rules for units</link>
273                            <!--cansas1d_documentation#Rules --> for acceptable values. Either
274                                <emphasis>1/A</emphasis> or <emphasis>1/nm</emphasis> are typical. </entry>
275                        <entry>
276                            <para>
277                                <emphasis role="bold">unit</emphasis>={units} </para>
278                        </entry>
279                    </row>
280                    <row>
281                        <entry>
282                            <para>
283                                <literal>Shadowfactor</literal>
284                            </para>
285                        </entry>
286                        <entry> floating-point number </entry>
287                        <entry> [0..1] </entry>
288                        <entry>
289                            <para> Describes the adjustment due to the beam stop penumbra. </para>
290                            <caution>
291                                <para>This definition needs revision. NIST?</para>
292                            </caution>
293                            <note>
294                                <para>There is no unit attribute.</para>
295                            </note>
296                        </entry>
297                        <entry/>
298                    </row>
299                    <row>
300                        <entry><literal>{any}</literal></entry>
301                        <entry> container </entry>
302                        <entry> [0..inf] </entry>
303                        <entry> Any element(s) not defined in the cansas1d/1.0 standard can be
304                            placed at this point. See <link
305                                xlink:href="#cansas1d_documentation-element-any"><emphasis
306                                    role="bold">{any}</emphasis></link>
307                            for more details. </entry>
308                        <entry>
309                            <para>
310                                <emphasis role="bold"
311                                    ><emphasis
312                                        >xmlns:{foreign-prefix}</emphasis></emphasis>
313                                =<link
314                                    xlink:href="#cansas1d_documentation-element-any"
315                                    ><literal>{foreign-namespace}</literal></link>
316                            </para>
317                        </entry>
318                    </row>
319                </tbody>
320            </tgroup>
321        </table>
322    </section>
323    <section>
324        <title>Notes</title>
325        <orderedlist numeration="arabic">
326            <listitem>
327                <para> When an optional element (<emphasis role="bold"
328                        ><emphasis>Idev</emphasis></emphasis>, <emphasis role="bold"
329                            ><emphasis>Qdev</emphasis></emphasis>, ...) is used, it must be given in
330                    every <emphasis role="bold">Idata</emphasis> within the enclosing <emphasis
331                        role="bold">SASdata</emphasis>. </para>
332            </listitem>
333            <listitem>
334                <para> If either <emphasis role="bold"><emphasis>dQw</emphasis></emphasis> or
335                        <emphasis role="bold"><emphasis>dQl</emphasis></emphasis> are used, then
336                        <emphasis role="bold"><emphasis>Qdev</emphasis></emphasis> is not permitted
337                    to be used. </para>
338            </listitem>
339        </orderedlist>
340        <note>
341            <para>
342                <emphasis role="bold">(The Shadowfactor attribute definition needs revision.
343                    NIST?)</emphasis>
344            </para>
345        </note>
346    </section>
347</section>
Note: See TracBrowser for help on using the repository browser.