source: 1dwg/trunk/doc/src/cansas1d_element_SASsample.xml @ 131

Last change on this file since 131 was 131, 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: 15.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_SASsample -->
13<section xml:id="cansas1d_documentation-element-SASsample" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SASsample element</title>
16    <bridgehead>
17        $Revision$
18        $Date$
19    </bridgehead>
20    <itemizedlist mark="opencircle">
21        <listitem>
22            <indexterm><primary>SASsample</primary></indexterm>
23            <para>
24                parent:
25                <link xlink:href="#cansas1d_documentation-element-SASentry">SASentry</link>
26            </para>
27        </listitem>
28    </itemizedlist>
29    <figure>
30        <title>The SASsample element</title>
31        <mediaobject>
32            <imageobject>
33                <imagedata fileref="../../graphics/3-SASsample.png" width="200pt" scalefit="1"/>
34            </imageobject>
35            <textobject>
36                <phrase>cansas1d-v1-3-SASsample</phrase>
37            </textobject>
38            <caption>
39                <para>The SASsample element</para>
40            </caption>
41        </mediaobject>
42    </figure>
43    <table orient="port" role="small">
44        <title/>
45        <tgroup cols="5">
46            <colspec colname="c1" colwidth="15*"/>
47            <colspec colname="c2" colwidth="15*"/>
48            <colspec colname="c3" colwidth="10*"/>
49            <colspec colname="c4" colwidth="30*"/>
50            <colspec colname="c5" colwidth="30*"/>
51            <tbody>
52                <row>
53                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
54                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
55                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
56                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
57                    <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
58                </row>
59                <row>
60                    <entry>
61                        <para>
62                            <emphasis role="bold">ID</emphasis>
63                        </para>
64                    </entry>
65                    <entry> string </entry>
66                    <entry> [1..1] </entry>
67                    <entry> Text string that identifies this sample. </entry>
68                    <entry>
69                    </entry>
70                </row>
71                <row>
72                    <entry>
73                        <para>
74                            <emphasis role="bold"><emphasis>thickness</emphasis></emphasis>
75                        </para>
76                    </entry>
77                    <entry> floating-point number </entry>
78                    <entry> [0..1] </entry>
79                    <entry> Thickness of this sample. Must specify the unit as an attribute. </entry>
80                    <entry>
81                        <para>
82                            <emphasis role="bold">unit</emphasis>={unit} </para>
83                    </entry>
84                </row>
85                <row>
86                    <entry>
87                        <para>
88                            <emphasis role="bold"><emphasis>transmission</emphasis></emphasis>
89                        </para>
90                    </entry>
91                    <entry> floating-point number </entry>
92                    <entry> [0..1] </entry>
93                    <entry> Transmission (1-attenuation) of this sample. Express this as a fraction,
94                        not as a percentage. NOTE: there is no unit attribute. </entry>
95                    <entry>
96                    </entry>
97                </row>
98                <row>
99                    <entry>
100                        <para>
101                            <emphasis role="bold"><emphasis>temperature</emphasis></emphasis>
102                        </para>
103                    </entry>
104                    <entry> floating-point number </entry>
105                    <entry> [0..1] </entry>
106                    <entry> Temperature of this sample. Must specify the unit as an attribute. </entry>
107                    <entry>
108                        <para>
109                            <emphasis role="bold">unit</emphasis>={unit} </para>
110                    </entry>
111                </row>
112                <row>
113                    <entry> '''''position''''' </entry>
114                    <entry> container </entry>
115                    <entry> [0..1] </entry>
116                    <entry> Location in X, Y, and Z of the sample. </entry>
117                    <entry>
118                    </entry>
119                </row>
120                <row>
121                    <entry> '''''orientation''''' </entry>
122                    <entry> container </entry>
123                    <entry> [0..1] </entry>
124                    <entry> Orientation (rotation) of the sample. </entry>
125                    <entry>
126                    </entry>
127                </row>
128                <row>
129                    <entry>
130                        <para>
131                            <emphasis role="bold"><emphasis>details</emphasis></emphasis>
132                        </para>
133                    </entry>
134                    <entry> string </entry>
135                    <entry> [0..inf] </entry>
136                    <entry> Any additional sample details. </entry>
137                    <entry>
138                    </entry>
139                </row>
140                <row>
141                    <entry>
142                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>
143                    </entry>
144                    <entry> container </entry>
145                    <entry> [0..inf] </entry>
146                    <entry> Any element(s) not defined in the cansas1d/1.0 standard can be placed at
147                        this point. See
148                        <link xlink:href="#cansas1d_documentation-element-any"><literal>{any}</literal></link>
149                        for more details. </entry>
150                    <entry>
151                        <para>
152                            <emphasis role="bold"
153                                ><emphasis>xmlns:{foreign-prefix}</emphasis></emphasis>={foreign-namespace}
154                        </para>
155                    </entry>
156                </row>
157            </tbody>
158        </tgroup>
159    </table>
160    <section>
161        <title>geometry</title>
162        <para>
163            <table>
164                <title/>
165                <tgroup cols="2">
166                    <tbody>
167                        <row>
168                            <entry>
169                                <mediaobject>
170                                    <imageobject>
171                                        <imagedata
172                                            fileref="../../graphics/translation-orientation-geometry.jpg"
173                                            width="200pt" scalefit="1"/>
174                                    </imageobject>
175                                    <textobject>
176                                        <phrase/>
177                                    </textobject>
178                                    <caption>
179                                        <para>view from source</para>
180                                    </caption>
181                                </mediaobject>
182                            </entry>
183                            <entry>
184                                <mediaobject>
185                                    <imageobject>
186                                        <imagedata
187                                            fileref="../../graphics/translation-orientation-geometry-2.jpg"
188                                            width="200pt" scalefit="1"/>
189                                    </imageobject>
190                                    <textobject>
191                                        <phrase/>
192                                    </textobject>
193                                    <caption>
194                                        <para>view from detector</para>
195                                    </caption>
196                                </mediaobject>
197                            </entry>
198                        </row>
199                    </tbody>
200                </tgroup>
201            </table>
202        </para>
203    </section>
204    <section>
205        <title>position</title>
206        <table orient="port" role="small">
207            <title/>
208            <tgroup cols="5">
209                <colspec colname="c1" colwidth="15*"/>
210                <colspec colname="c2" colwidth="15*"/>
211                <colspec colname="c3" colwidth="10*"/>
212                <colspec colname="c4" colwidth="30*"/>
213                <colspec colname="c5" colwidth="30*"/>
214                <tbody>
215                    <row>
216                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
217                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
218                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
219                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
220                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
221                    </row>
222                    <row>
223                        <entry>
224                            <para>
225                                <emphasis role="bold">x</emphasis>
226                            </para>
227                        </entry>
228                        <entry> floating-point number </entry>
229                        <entry> [0..1] </entry>
230                        <entry> Position of the sample in X. The <emphasis role="bold"
231                                >unit</emphasis> attribute is required. See
232                            cansas1d_documentation#Rules for acceptable values. </entry>
233                        <entry>
234                            <para>
235                                <emphasis role="bold">unit</emphasis>={units} </para>
236                        </entry>
237                    </row>
238                    <row>
239                        <entry>
240                            <para>
241                                <emphasis role="bold">y</emphasis>
242                            </para>
243                        </entry>
244                        <entry> floating-point number </entry>
245                        <entry> [0..1] </entry>
246                        <entry> Position of the sample in Y. The <emphasis role="bold"
247                                >unit</emphasis> attribute is required. See
248                            cansas1d_documentation#Rules for acceptable values. </entry>
249                        <entry>
250                            <para>
251                                <emphasis role="bold">unit</emphasis>={units} </para>
252                        </entry>
253                    </row>
254                    <row>
255                        <entry>
256                            <para>
257                                <emphasis role="bold">z</emphasis>
258                            </para>
259                        </entry>
260                        <entry> floating-point number </entry>
261                        <entry> [0..1] </entry>
262                        <entry> Position of the sample in Z. The <emphasis role="bold"
263                                >unit</emphasis> attribute is required. See
264                            cansas1d_documentation#Rules for acceptable values. Note: While Z
265                            dimension is allowed by the standard (provided by use of a standard
266                            element in the XML Schema), it does not make sense for small-angle
267                            scattering. </entry>
268                        <entry>
269                            <para>
270                                <emphasis role="bold">unit</emphasis>={units} </para>
271                        </entry>
272                    </row>
273                </tbody>
274            </tgroup>
275        </table>
276    </section>
277    <section>
278        <title>orientation</title>
279        <table orient="port" role="small">
280            <title/>
281            <tgroup cols="5">
282                <colspec colname="c1" colwidth="15*"/>
283                <colspec colname="c2" colwidth="15*"/>
284                <colspec colname="c3" colwidth="10*"/>
285                <colspec colname="c4" colwidth="30*"/>
286                <colspec colname="c5" colwidth="30*"/>
287                <tbody>
288                    <row>
289                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
290                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
291                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
292                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
293                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
294                    </row>
295                    <row>
296                        <entry>
297                            <para>
298                                <emphasis role="bold">roll</emphasis>
299                            </para>
300                        </entry>
301                        <entry> floating-point number </entry>
302                        <entry> [0..1] </entry>
303                        <entry> Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis
304                                role="bold">unit</emphasis> attribute is required. See
305                            cansas1d_documentation#Rules for acceptable values. </entry>
306                        <entry>
307                            <para>
308                                <emphasis role="bold">unit</emphasis>={units} </para>
309                        </entry>
310                    </row>
311                    <row>
312                        <entry>
313                            <para>
314                                <emphasis role="bold">pitch</emphasis>
315                            </para>
316                        </entry>
317                        <entry> floating-point number </entry>
318                        <entry> [0..1] </entry>
319                        <entry> Rotation about the <emphasis>X</emphasis> axis (pitch). The
320                                <emphasis role="bold">unit</emphasis> attribute is required. See
321                            cansas1d_documentation#Rules for acceptable values. </entry>
322                        <entry>
323                            <para>
324                                <emphasis role="bold">unit</emphasis>={units} </para>
325                        </entry>
326                    </row>
327                    <row>
328                        <entry>
329                            <para>
330                                <emphasis role="bold">yaw</emphasis>
331                            </para>
332                        </entry>
333                        <entry> floating-point number </entry>
334                        <entry> [0..1] </entry>
335                        <entry> Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis
336                                role="bold">unit</emphasis> attribute is required. See
337                            cansas1d_documentation#Rules for acceptable values. </entry>
338                        <entry>
339                            <para>
340                                <emphasis role="bold">unit</emphasis>={units} </para>
341                        </entry>
342                    </row>
343                </tbody>
344            </tgroup>
345        </table>
346        <note>
347            <para> The <emphasis role="bold">orientation</emphasis> element is intended to describe
348                simple rotations about a single axis rather than a full set of rotations as in a
349                crystallographic context. </para>
350        </note>
351    </section>
352</section>
Note: See TracBrowser for help on using the repository browser.