source: 1dwg/trunk/doc/src/cansas1d_element_SASdetector.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: 20.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_SASdetector -->
13<section xml:id="cansas1d_documentation-element-SASdetector" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SASdetector element</title>
16    <bridgehead>
17        $Revision$
18        $Date$
19    </bridgehead>
20    <itemizedlist mark="opencircle">
21        <listitem>
22            <indexterm><primary>SASdetector</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 SASdetector element</title>
31        <mediaobject>
32            <imageobject>
33                <imagedata fileref="../../graphics/7-SASdetector.png" width="200pt"
34                    scalefit="1"/>
35            </imageobject>
36            <textobject>
37                <phrase>cansas1d-v1-7-SASdetector</phrase>
38            </textobject>
39            <caption>
40                <para>The SASdetector element</para>
41            </caption>
42        </mediaobject>
43    </figure>
44    <section>
45        <title>SASdetector</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><para><literal> name </literal></para></entry>
64                        <entry>
65                            string
66                        </entry>
67                        <entry>
68                            [1..1]
69                        </entry>
70                        <entry>
71                            Text string that identifies the name of this detector.
72                        </entry>
73                        <entry/>
74                    </row>
75                    <row>
76                        <entry><para><literal> SDD </literal></para></entry>
77                        <entry>
78                            floating-point number
79                        </entry>
80                        <entry>
81                            [0..1]
82                        </entry>
83                        <entry>
84                            Distance between sample and detector.
85                        </entry>
86                        <entry><para><literal> unit={unit} </literal></para></entry>
87                    </row>
88                    <row>
89                        <entry>
90                            <literal>offset</literal>
91                        </entry>
92                        <entry>
93                            container
94                        </entry>
95                        <entry>
96                            [0..1]
97                        </entry>
98                        <entry>
99                            Offset of this detector position in X, Y, (and Z if necessary).
100                        </entry>
101                        <entry/>
102                    </row>
103                    <row>
104                        <entry>
105                            <literal>orientation</literal>
106                        </entry>
107                        <entry>
108                            container
109                        </entry>
110                        <entry>
111                            [0..1]
112                        </entry>
113                        <entry>
114                            Orientation (rotation) of this detector in roll, pitch, and yaw.
115                        </entry>
116                        <entry/>
117                    </row>
118                    <row>
119                        <entry>
120                            <literal>beam_center</literal>
121                        </entry>
122                        <entry>
123                            container
124                        </entry>
125                        <entry>
126                            [0..1]
127                        </entry>
128                        <entry>
129                            Center of the beam on the detector in X and Y (and Z if necessary).
130                        </entry>
131                        <entry/>
132                    </row>
133                    <row>
134                        <entry>
135                            <literal>pixel_size</literal>
136                        </entry>
137                        <entry>
138                            container
139                        </entry>
140                        <entry>
141                            [0..1]
142                        </entry>
143                        <entry>
144                            Size of detector pixels in X and Y (and Z if necessary).
145                        </entry>
146                        <entry/>
147                    </row>
148                    <row>
149                        <entry><para><literal> slit_length </literal></para></entry>
150                        <entry>
151                            floating-point number
152                        </entry>
153                        <entry>
154                            [0..1]
155                        </entry>
156                        <entry>
157                            Slit length of the instrument for this detector.
158                            This is expressed in the same units as Q (reciprocal space units).
159                        </entry>
160                        <entry><para><literal> unit={unit} </literal></para></entry>
161                    </row>
162                </tbody>
163            </tgroup>
164        </table>
165    </section>
166    <section>
167        <title>geometry</title>
168        <para>
169            <table>
170                <title/>
171                <tgroup cols='2'>
172                    <tbody>
173                        <row>
174                    <entry>
175                        <mediaobject>
176                            <imageobject>
177                                <imagedata
178                                    fileref="../../graphics/translation-orientation-geometry.jpg"
179                                    width="200pt" scalefit="1"/>
180                            </imageobject>
181                            <textobject>
182                                <phrase/>
183                            </textobject>
184                            <caption>
185                                <para>view from source</para>
186                            </caption>
187                        </mediaobject>
188                        <indexterm>
189                            <primary>geometry</primary>
190                            <secondary>translation</secondary>
191                        </indexterm>
192                    </entry>
193                    <entry>
194                        <mediaobject>
195                            <imageobject>
196                                <imagedata
197                                    fileref="../../graphics/translation-orientation-geometry-2.jpg"
198                                    width="200pt" scalefit="1"/>
199                            </imageobject>
200                            <textobject>
201                                <phrase/>
202                            </textobject>
203                            <caption>
204                                <para>view from detector</para>
205                            </caption>
206                        </mediaobject>
207                        <indexterm>
208                            <primary>geometry</primary>
209                            <secondary>rotation</secondary>
210                        </indexterm>
211                    </entry>
212                </row>
213                </tbody></tgroup>
214            </table>
215        </para>
216    </section>
217    <section>
218        <title>offset</title>
219        <table orient="port" role="small">
220            <title/>
221            <tgroup cols="5">
222                <colspec colname="c1" colwidth="15*"/>
223                <colspec colname="c2" colwidth="15*"/>
224                <colspec colname="c3" colwidth="10*"/>
225                <colspec colname="c4" colwidth="30*"/>
226                <colspec colname="c5" colwidth="30*"/>
227                <tbody>
228                    <row>
229                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
230                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
231                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
232                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
233                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
234                    </row>
235                    <row>
236                        <entry><para><literal> x </literal></para></entry>
237                    <entry>
238                        floating-point number
239                    </entry>
240                    <entry>
241                        [0..1]
242                    </entry>
243                    <entry>
244                        Offset of the detector position in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
245                    </entry>
246                    <entry><para><literal> unit={unit} </literal></para></entry>
247                </row>
248                    <row>
249                        <entry><para><literal> y </literal></para></entry>
250                    <entry>
251                        floating-point number
252                    </entry>
253                    <entry>
254                        [0..1]
255                    </entry>
256                    <entry>
257                        Offset of the detector position in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
258                    </entry>
259                    <entry><para><literal> unit={unit} </literal></para></entry>
260                </row>
261                    <row>
262                        <entry><para><literal> z </literal></para></entry>
263                    <entry>
264                        floating-point number
265                    </entry>
266                    <entry>
267                        [0..1]
268                    </entry>
269                    <entry>
270                        Offset of the detector position in Z. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values. Note: While Z 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><para><literal> unit={unit} </literal></para></entry>
273                </row>
274                </tbody>
275            </tgroup>
276        </table>
277    </section>
278    <section>
279        <title>orientation</title>
280        <table orient="port" role="small">
281            <title/>
282            <tgroup cols="5">
283                <colspec colname="c1" colwidth="15*"/>
284                <colspec colname="c2" colwidth="15*"/>
285                <colspec colname="c3" colwidth="10*"/>
286                <colspec colname="c4" colwidth="30*"/>
287                <colspec colname="c5" colwidth="30*"/>
288                <tbody>
289                    <row>
290                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
291                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
292                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
293                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
294                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
295                    </row>
296                    <row>
297                        <entry><para><literal> roll </literal></para></entry>
298                        <entry>
299                            floating-point number
300                        </entry>
301                        <entry>
302                            [0..1]
303                        </entry>
304                        <entry>
305                            Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
306                        </entry>
307                        <entry><para><literal> unit={unit} </literal></para></entry>
308                    </row>
309                    <row>
310                        <entry><para><literal> pitch </literal></para></entry>
311                        <entry>
312                            floating-point number
313                        </entry>
314                        <entry>
315                            [0..1]
316                        </entry>
317                        <entry>
318                            Rotation about the <emphasis>X</emphasis> axis (pitch). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
319                        </entry>
320                        <entry><para><literal> unit={unit} </literal></para></entry>
321                    </row>
322                    <row>
323                        <entry><para><literal> yaw </literal></para></entry>
324                        <entry>
325                            floating-point number
326                        </entry>
327                        <entry>
328                            [0..1]
329                        </entry>
330                        <entry>
331                            Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
332                        </entry>
333                        <entry><para><literal> unit={unit} </literal></para></entry>
334                    </row>
335                </tbody>
336            </tgroup>
337        </table>
338    </section>
339    <section>
340        <title>beam_center</title>
341        <table orient="port" role="small">
342            <title/>
343            <tgroup cols="5">
344                <colspec colname="c1" colwidth="15*"/>
345                <colspec colname="c2" colwidth="15*"/>
346                <colspec colname="c3" colwidth="10*"/>
347                <colspec colname="c4" colwidth="30*"/>
348                <colspec colname="c5" colwidth="30*"/>
349                <tbody>
350                    <row>
351                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
352                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
353                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
354                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
355                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
356                    </row>
357                    <row>
358                        <entry><para><literal> x </literal></para></entry>
359                        <entry>
360                            floating-point number
361                        </entry>
362                        <entry>
363                            [0..1]
364                        </entry>
365                        <entry>
366                            Position of the beam center on the detector in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
367                        </entry>
368                        <entry><para><literal> unit={unit} </literal></para></entry>
369                    </row>
370                    <row>
371                        <entry><para><literal> y </literal></para></entry>
372                        <entry>
373                            floating-point number
374                        </entry>
375                        <entry>
376                            [0..1]
377                        </entry>
378                        <entry>
379                            Position of the beam center on the detector in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
380                        </entry>
381                        <entry><para><literal> unit={unit} </literal></para></entry>
382                    </row>
383                    <row>
384                        <entry><para><literal> z </literal></para></entry>
385                        <entry>
386                            floating-point number
387                        </entry>
388                        <entry>
389                            [0..1]
390                        </entry>
391                        <entry>
392                            Position of the beam center on the detector 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.
393                        </entry>
394                        <entry><para><literal> unit={unit} </literal></para></entry>
395                    </row>
396                </tbody>
397            </tgroup>
398        </table>
399    </section>
400    <section>
401        <title>pixel_size</title>
402        <table orient="port" role="small">
403            <title/>
404            <tgroup cols="5">
405                <colspec colname="c1" colwidth="15*"/>
406                <colspec colname="c2" colwidth="15*"/>
407                <colspec colname="c3" colwidth="10*"/>
408                <colspec colname="c4" colwidth="30*"/>
409                <colspec colname="c5" colwidth="30*"/>
410                <tbody>
411                    <row>
412                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
413                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
414                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
415                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
416                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
417                    </row>
418                    <row>
419                        <entry><para><literal> x </literal></para></entry>
420                    <entry>
421                        floating-point number
422                    </entry>
423                    <entry>
424                        [0..1]
425                    </entry>
426                    <entry>
427                        Size of a detector pixel in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
428                    </entry>
429                    <entry><para><literal> unit={unit} </literal></para></entry>
430                </row>
431                    <row>
432                        <entry><para><literal> y </literal></para></entry>
433                    <entry>
434                        floating-point number
435                    </entry>
436                    <entry>
437                        [0..1]
438                    </entry>
439                    <entry>
440                        Size of a detector pixel in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
441                    </entry>
442                    <entry><para><literal> unit={unit} </literal></para></entry>
443                </row>
444                    <row>
445                        <entry><para><literal> z </literal></para></entry>
446                    <entry>
447                        floating-point number
448                    </entry>
449                    <entry>
450                        [0..1]
451                    </entry>
452                    <entry>
453                        Size of a detector pixel 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.
454                    </entry>
455                    <entry><para><literal> unit={unit} </literal></para></entry>
456                </row>
457            </tbody></tgroup>
458        </table>
459    </section>
460</section>
Note: See TracBrowser for help on using the repository browser.