source: 1dwg/trunk/doc/src/cansas1d_element_SAScollimation.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: 11.5 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><para><literal> unit={unit} </literal></para></entry>
78                    </row>
79                    <row>
80                        <entry>
81                            <literal>aperture</literal>
82                        </entry>
83                        <entry>
84                            container
85                        </entry>
86                        <entry>
87                            [0..inf]
88                        </entry>
89                        <entry>
90                            Description of a slit or aperture.
91                            <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, ...).
92                        </entry>
93                        <entry><para><literal> name={type} </literal></para></entry>
94                    </row>
95                </tbody>
96            </tgroup>
97        </table>
98    </section>
99    <section>
100        <title>aperture</title>
101        <table orient="port" role="small">
102            <title/>
103            <tgroup cols="5">
104                <colspec colname="c1" colwidth="15*"/>
105                <colspec colname="c2" colwidth="15*"/>
106                <colspec colname="c3" colwidth="10*"/>
107                <colspec colname="c4" colwidth="30*"/>
108                <colspec colname="c5" colwidth="30*"/>
109                <tbody>
110                    <row>
111                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
112                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
113                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
114                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
115                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
116                    </row>
117                    <row>
118                        <entry>
119                            <literal>size</literal>
120                        </entry>
121                        <entry>
122                            container
123                        </entry>
124                        <entry>
125                            [0..1]
126                        </entry>
127                        <entry>
128                            Opening dimensions of this aperture.
129                        </entry>
130                        <entry><para><literal> name={name} </literal></para></entry>
131                    </row>
132                    <row>
133                        <entry><para><literal> distance </literal></para></entry>
134                        <entry>
135                            floating-point number
136                        </entry>
137                        <entry>
138                            [0..1]
139                        </entry>
140                        <entry>
141                            Distance from this collimation element to the sample.
142                        </entry>
143                        <entry><para><literal> unit={unit} </literal></para></entry>
144                    </row>
145                </tbody>
146            </tgroup>
147        </table>
148    </section>
149    <section>
150        <title>size</title>
151        <para>
152            <table>
153                <title/>
154                <tgroup cols='2'>
155                    <tbody>
156                        <row>
157                            <entry>
158                                <mediaobject>
159                                    <imageobject>
160                                        <imagedata fileref="../../graphics/translation-orientation-geometry.jpg" width='200pt' scalefit='1'/>
161                                    </imageobject>
162                                    <caption>
163                                        <para>view from source</para>
164                                    </caption>
165                                </mediaobject>
166                                <indexterm>
167                                    <primary>geometry</primary>
168                                    <secondary>translation</secondary>
169                                </indexterm>
170                            </entry>
171                            <entry>
172                                <mediaobject>
173                                    <imageobject>
174                                        <imagedata fileref="../../graphics/translation-orientation-geometry-2.jpg" width='200pt' scalefit='1'/>
175                                    </imageobject>
176                                    <caption>
177                                        <para>view from detector</para>
178                                    </caption>
179                                </mediaobject>
180                                <indexterm>
181                                    <primary>geometry</primary>
182                                    <secondary>rotation</secondary>
183                                </indexterm>
184                            </entry>
185                        </row>
186                    </tbody>
187                </tgroup>
188            </table>
189            <table orient="port" role="small">
190                <title/>
191                <tgroup cols="5">
192                    <colspec colname="c1" colwidth="15*"/>
193                    <colspec colname="c2" colwidth="15*"/>
194                    <colspec colname="c3" colwidth="10*"/>
195                    <colspec colname="c4" colwidth="30*"/>
196                    <colspec colname="c5" colwidth="30*"/>
197                    <tbody>
198                        <row>
199                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
200                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
201                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
202                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
203                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
204                        </row>
205                        <row>
206                            <entry><para><literal> x </literal></para></entry>
207                            <entry>
208                                floating-point number
209                            </entry>
210                            <entry>
211                                [0..1]
212                            </entry>
213                            <entry>
214                                Dimension of the collimation in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
215                            </entry>
216                            <entry><para><literal> unit={unit} </literal></para></entry>
217                        </row>
218                        <row>
219                            <entry><para><literal> y </literal></para></entry>
220                            <entry>
221                                floating-point number
222                            </entry>
223                            <entry>
224                                [0..1]
225                            </entry>
226                            <entry>
227                                Dimension of the collimation in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
228                            </entry>
229                            <entry><para><literal> unit={unit} </literal></para></entry>
230                        </row>
231                        <row>
232                            <entry><para><literal> z </literal></para></entry>
233                            <entry>
234                                floating-point number
235                            </entry>
236                            <entry>
237                                [0..1]
238                            </entry>
239                            <entry>
240                                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.
241                            </entry>
242                            <entry><para><literal> unit={unit} </literal></para></entry>
243                        </row>
244                    </tbody>
245                </tgroup>
246            </table>
247        </para>
248    </section>
249</section>
Note: See TracBrowser for help on using the repository browser.