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

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