source: 1dwg/trunk/doc/src/cansas1d_element_SAScollimation.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: 12.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_SAScollimation -->
13<section xml:id="cansas1d_documentation-element-SAScollimation" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SAScollimation element</title>
16    <bridgehead>
17        $Revision$
18        $Date$
19    </bridgehead>
20    <itemizedlist mark="opencircle">
21        <listitem>
22            <indexterm><primary>SAScollimation</primary></indexterm>
23            <para>
24                parent:
25                <link xlink:href="#cansas1d_documentation-element-SASinstrument">SASinstrument</link>
26            </para>
27        </listitem>
28    </itemizedlist>
29    <figure>
30        <title>The SAScollimation element</title>
31        <mediaobject>
32            <imageobject>
33                <imagedata fileref="../../graphics/6-SAScollimation.png" width="200pt"
34                    scalefit="1"/>
35            </imageobject>
36            <textobject>
37                <phrase>cansas1d-v1-6-SAScollimation</phrase>
38            </textobject>
39            <caption>
40                <para>The SAScollimation element</para>
41            </caption>
42        </mediaobject>
43    </figure>
44    <section>
45        <title>SAScollimation</title>
46        <table orient="port" role="small">
47            <title/>
48            <tgroup cols="5">
49                <colspec colname="c1" colwidth="15*"/>
50                <colspec colname="c2" colwidth="15*"/>
51                <colspec colname="c3" colwidth="10*"/>
52                <colspec colname="c4" colwidth="30*"/>
53                <colspec colname="c5" colwidth="30*"/>
54                <tbody>
55                    <row>
56                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
57                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
58                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
59                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
60                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
61                    </row>
62                    <row>
63                        <entry>
64                            <para>
65                                <emphasis role="bold"><emphasis>length</emphasis></emphasis>
66                            </para>
67                        </entry>
68                        <entry>
69                            floating-point number
70                        </entry>
71                        <entry>
72                            [0..1]
73                        </entry>
74                        <entry>
75                            Amount/length of collimation inserted (on a SANS instrument)
76                        </entry>
77                        <entry>
78                            <para>
79                                <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit}
80                            </para>
81                        </entry>
82                    </row>
83                    <row>
84                        <entry>
85                            '''''aperture'''''
86                        </entry>
87                        <entry>
88                            container
89                        </entry>
90                        <entry>
91                            [0..inf]
92                        </entry>
93                        <entry>
94                            Description of a slit or aperture.
95                            <emphasis role="bold"><emphasis>name</emphasis></emphasis>: Optional name attribute for this aperture.  <emphasis role="bold"><emphasis>type</emphasis></emphasis>: Optional text attribute to describe the type aperture (pinhole, 4-blade slit, Soller slit, ...).
96                        </entry>
97                        <entry>
98                            <para>
99                                <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name}  <emphasis role="bold"><emphasis>type</emphasis></emphasis>={type}
100                            </para>
101                        </entry>
102                    </row>
103                </tbody>
104            </tgroup>
105        </table>
106    </section>
107    <section>
108        <title>aperture</title>
109        <table orient="port" role="small">
110            <title/>
111            <tgroup cols="5">
112                <colspec colname="c1" colwidth="15*"/>
113                <colspec colname="c2" colwidth="15*"/>
114                <colspec colname="c3" colwidth="10*"/>
115                <colspec colname="c4" colwidth="30*"/>
116                <colspec colname="c5" colwidth="30*"/>
117                <tbody>
118                    <row>
119                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
120                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
121                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
122                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
123                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
124                    </row>
125                    <row>
126                        <entry>
127                            '''''size'''''
128                        </entry>
129                        <entry>
130                            container
131                        </entry>
132                        <entry>
133                            [0..1]
134                        </entry>
135                        <entry>
136                            Opening dimensions of this aperture.
137                        </entry>
138                        <entry>
139                            <para>
140                                <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name}
141                            </para>
142                        </entry>
143                    </row>
144                    <row>
145                        <entry>
146                            <para>
147                                <emphasis role="bold"><emphasis>distance</emphasis></emphasis>
148                            </para>
149                        </entry>
150                        <entry>
151                            floating-point number
152                        </entry>
153                        <entry>
154                            [0..1]
155                        </entry>
156                        <entry>
157                            Distance from this collimation element to the sample.
158                        </entry>
159                        <entry>
160                            <para>
161                                <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit}
162                            </para>
163                        </entry>
164                    </row>
165                </tbody>
166            </tgroup>
167        </table>
168    </section>
169    <section>
170        <title>size</title>
171        <para>
172            <table>
173                <title/>
174                <tgroup cols='2'>
175                    <tbody>
176                        <row>
177                            <entry>
178                                <mediaobject>
179                                    <imageobject>
180                                        <imagedata fileref="../../graphics/translation-orientation-geometry.jpg" width='200pt' scalefit='1'/>
181                                    </imageobject>
182                                    <caption>
183                                        <para>view from source</para>
184                                    </caption>
185                                </mediaobject>
186                                <indexterm>
187                                    <primary>geometry</primary>
188                                    <secondary>translation</secondary>
189                                </indexterm>
190                            </entry>
191                            <entry>
192                                <mediaobject>
193                                    <imageobject>
194                                        <imagedata fileref="../../graphics/translation-orientation-geometry-2.jpg" width='200pt' scalefit='1'/>
195                                    </imageobject>
196                                    <caption>
197                                        <para>view from detector</para>
198                                    </caption>
199                                </mediaobject>
200                                <indexterm>
201                                    <primary>geometry</primary>
202                                    <secondary>rotation</secondary>
203                                </indexterm>
204                            </entry>
205                        </row>
206                    </tbody>
207                </tgroup>
208            </table>
209            <table orient="port" role="small">
210                <title/>
211                <tgroup cols="5">
212                    <colspec colname="c1" colwidth="15*"/>
213                    <colspec colname="c2" colwidth="15*"/>
214                    <colspec colname="c3" colwidth="10*"/>
215                    <colspec colname="c4" colwidth="30*"/>
216                    <colspec colname="c5" colwidth="30*"/>
217                    <tbody>
218                        <row>
219                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
220                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
221                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
222                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
223                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
224                        </row>
225                        <row>
226                            <entry>
227                                <emphasis role="bold">x</emphasis>
228                            </entry>
229                            <entry>
230                                floating-point number
231                            </entry>
232                            <entry>
233                                [0..1]
234                            </entry>
235                            <entry>
236                                Dimension of the collimation in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
237                            </entry>
238                            <entry>
239                                <emphasis role="bold">unit</emphasis>={units}
240                            </entry>
241                        </row>
242                        <row>
243                            <entry>
244                                <emphasis role="bold">y</emphasis>
245                            </entry>
246                            <entry>
247                                floating-point number
248                            </entry>
249                            <entry>
250                                [0..1]
251                            </entry>
252                            <entry>
253                                Dimension of the collimation in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
254                            </entry>
255                            <entry>
256                                <emphasis role="bold">unit</emphasis>={units}
257                            </entry>
258                        </row>
259                        <row>
260                            <entry>
261                                <emphasis role="bold">z</emphasis>
262                            </entry>
263                            <entry>
264                                floating-point number
265                            </entry>
266                            <entry>
267                                [0..1]
268                            </entry>
269                            <entry>
270                                Dimension of the collimation in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z dimension is allowed by the standard (provided by use of a standard element in the XML Schema), it does not make sense for small-angle scattering.
271                            </entry>
272                            <entry>
273                                <emphasis role="bold">unit</emphasis>={units}
274                            </entry>
275                        </row>
276                    </tbody>
277                </tgroup>
278            </table>
279        </para>
280    </section>
281</section>
Note: See TracBrowser for help on using the repository browser.