source: 1dwg/trunk/doc/src/cansas1d_element_SASdetector.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: 23.0 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>
64                        <para>
65                            <emphasis role="bold">name</emphasis>
66                        </para>
67                    </entry>
68                    <entry>
69                        string
70                    </entry>
71                    <entry>
72                        [1..1]
73                    </entry>
74                    <entry>
75                        Text string that identifies the name of this detector.
76                    </entry>
77                    <entry>
78                    </entry>
79                </row>
80                <row>
81                    <entry>
82                        <para>
83                            <emphasis role="bold"><emphasis>SDD</emphasis></emphasis>
84                        </para>
85                    </entry>
86                    <entry>
87                        floating-point number
88                    </entry>
89                    <entry>
90                        [0..1]
91                    </entry>
92                    <entry>
93                        Distance between sample and detector.
94                    </entry>
95                    <entry>
96                        <para>
97                            <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit}
98                        </para>
99                    </entry>
100                </row>
101                <row>
102                    <entry>
103                        '''''offset'''''
104                    </entry>
105                    <entry>
106                        container
107                    </entry>
108                    <entry>
109                        [0..1]
110                    </entry>
111                    <entry>
112                        Offset of this detector position in X, Y, (and Z if necessary).
113                    </entry>
114                    <entry>
115                    </entry>
116                </row>
117                <row>
118                    <entry>
119                        '''''orientation'''''
120                    </entry>
121                    <entry>
122                        container
123                    </entry>
124                    <entry>
125                        [0..1]
126                    </entry>
127                    <entry>
128                        Orientation (rotation) of this detector in roll, pitch, and yaw.
129                    </entry>
130                    <entry>
131                    </entry>
132                </row>
133                <row>
134                    <entry>
135                        '''''beam_center'''''
136                    </entry>
137                    <entry>
138                        container
139                    </entry>
140                    <entry>
141                        [0..1]
142                    </entry>
143                    <entry>
144                        Center of the beam on the detector in X and Y (and Z if necessary).
145                    </entry>
146                    <entry>
147                    </entry>
148                </row>
149                <row>
150                    <entry>
151                        '''''pixel_size'''''
152                    </entry>
153                    <entry>
154                        container
155                    </entry>
156                    <entry>
157                        [0..1]
158                    </entry>
159                    <entry>
160                        Size of detector pixels in X and Y (and Z if necessary).
161                    </entry>
162                    <entry>
163                    </entry>
164                </row>
165                <row>
166                    <entry>
167                        <para>
168                            <emphasis role="bold"><emphasis>slit_length</emphasis></emphasis>
169                        </para>
170                    </entry>
171                    <entry>
172                        floating-point number
173                    </entry>
174                    <entry>
175                        [0..1]
176                    </entry>
177                    <entry>
178                        Slit length of the instrument for this detector. This is expressed in the same units as Q (reciprocal space units).
179                    </entry>
180                    <entry>
181                        <para>
182                            <emphasis role="bold"><emphasis>unit</emphasis></emphasis>={unit}
183                        </para>
184                    </entry>
185                </row>
186                </tbody>
187            </tgroup>
188        </table>
189    </section>
190    <section>
191        <title>geometry</title>
192        <para>
193            <table>
194                <title/>
195                <tgroup cols='2'>
196                    <tbody>
197                        <row>
198                    <entry>
199                        <mediaobject>
200                            <imageobject>
201                                <imagedata
202                                    fileref="../../graphics/translation-orientation-geometry.jpg"
203                                    width="200pt" scalefit="1"/>
204                            </imageobject>
205                            <textobject>
206                                <phrase/>
207                            </textobject>
208                            <caption>
209                                <para>view from source</para>
210                            </caption>
211                        </mediaobject>
212                        <indexterm>
213                            <primary>geometry</primary>
214                            <secondary>translation</secondary>
215                        </indexterm>
216                    </entry>
217                    <entry>
218                        <mediaobject>
219                            <imageobject>
220                                <imagedata
221                                    fileref="../../graphics/translation-orientation-geometry-2.jpg"
222                                    width="200pt" scalefit="1"/>
223                            </imageobject>
224                            <textobject>
225                                <phrase/>
226                            </textobject>
227                            <caption>
228                                <para>view from detector</para>
229                            </caption>
230                        </mediaobject>
231                        <indexterm>
232                            <primary>geometry</primary>
233                            <secondary>rotation</secondary>
234                        </indexterm>
235                    </entry>
236                </row>
237                </tbody></tgroup>
238            </table>
239        </para>
240    </section>
241    <section>
242        <title>offset</title>
243        <table orient="port" role="small">
244            <title/>
245            <tgroup cols="5">
246                <colspec colname="c1" colwidth="15*"/>
247                <colspec colname="c2" colwidth="15*"/>
248                <colspec colname="c3" colwidth="10*"/>
249                <colspec colname="c4" colwidth="30*"/>
250                <colspec colname="c5" colwidth="30*"/>
251                <tbody>
252                    <row>
253                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
254                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
255                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
256                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
257                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
258                    </row>
259                <row>
260                    <entry>
261                        <para>
262                            <emphasis role="bold">x</emphasis>
263                        </para>
264                    </entry>
265                    <entry>
266                        floating-point number
267                    </entry>
268                    <entry>
269                        [0..1]
270                    </entry>
271                    <entry>
272                        Offset of the detector position in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
273                    </entry>
274                    <entry>
275                        <para>
276                            <emphasis role="bold">unit</emphasis>={units}
277                        </para>
278                    </entry>
279                </row>
280                <row>
281                    <entry>
282                        <para>
283                            <emphasis role="bold">y</emphasis>
284                        </para>
285                    </entry>
286                    <entry>
287                        floating-point number
288                    </entry>
289                    <entry>
290                        [0..1]
291                    </entry>
292                    <entry>
293                        Offset of the detector position in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
294                    </entry>
295                    <entry>
296                        <para>
297                            <emphasis role="bold">unit</emphasis>={units}
298                        </para>
299                    </entry>
300                </row>
301                <row>
302                    <entry>
303                        <para>
304                            <emphasis role="bold">z</emphasis>
305                        </para>
306                    </entry>
307                    <entry>
308                        floating-point number
309                    </entry>
310                    <entry>
311                        [0..1]
312                    </entry>
313                    <entry>
314                        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.
315                    </entry>
316                    <entry>
317                        <para>
318                            <emphasis role="bold">unit</emphasis>={units}
319                        </para>
320                    </entry>
321                </row>
322                </tbody>
323            </tgroup>
324        </table>
325    </section>
326    <section>
327        <title>orientation</title>
328        <table orient="port" role="small">
329            <title/>
330            <tgroup cols="5">
331                <colspec colname="c1" colwidth="15*"/>
332                <colspec colname="c2" colwidth="15*"/>
333                <colspec colname="c3" colwidth="10*"/>
334                <colspec colname="c4" colwidth="30*"/>
335                <colspec colname="c5" colwidth="30*"/>
336                <tbody>
337                    <row>
338                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
339                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
340                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
341                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
342                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
343                    </row>
344                <row>
345                    <entry>
346                        <para>
347                            <emphasis role="bold">roll</emphasis>
348                        </para>
349                    </entry>
350                    <entry>
351                        floating-point number
352                    </entry>
353                    <entry>
354                        [0..1]
355                    </entry>
356                    <entry>
357                        Rotation about the <emphasis>Z</emphasis> axis (roll). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
358                    </entry>
359                    <entry>
360                        <para>
361                            <emphasis role="bold">unit</emphasis>={units}
362                        </para>
363                    </entry>
364                </row>
365                <row>
366                    <entry>
367                        <para>
368                            <emphasis role="bold">pitch</emphasis>
369                        </para>
370                    </entry>
371                    <entry>
372                        floating-point number
373                    </entry>
374                    <entry>
375                        [0..1]
376                    </entry>
377                    <entry>
378                        Rotation about the <emphasis>X</emphasis> axis (pitch). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
379                    </entry>
380                    <entry>
381                        <para>
382                            <emphasis role="bold">unit</emphasis>={units}
383                        </para>
384                    </entry>
385                </row>
386                <row>
387                    <entry>
388                        <para>
389                            <emphasis role="bold">yaw</emphasis>
390                        </para>
391                    </entry>
392                    <entry>
393                        floating-point number
394                    </entry>
395                    <entry>
396                        [0..1]
397                    </entry>
398                    <entry>
399                        Rotation about the <emphasis>Y</emphasis> axis (yaw). The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
400                    </entry>
401                    <entry>
402                        <para>
403                            <emphasis role="bold">unit</emphasis>={units}
404                        </para>
405                    </entry>
406                </row>
407                </tbody>
408            </tgroup>
409        </table>
410    </section>
411    <section>
412        <title>beam_center</title>
413        <table orient="port" role="small">
414            <title/>
415            <tgroup cols="5">
416                <colspec colname="c1" colwidth="15*"/>
417                <colspec colname="c2" colwidth="15*"/>
418                <colspec colname="c3" colwidth="10*"/>
419                <colspec colname="c4" colwidth="30*"/>
420                <colspec colname="c5" colwidth="30*"/>
421                <tbody>
422                    <row>
423                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
424                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
425                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
426                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
427                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
428                    </row>
429                <row>
430                    <entry>
431                        <para>
432                            <emphasis role="bold">x</emphasis>
433                        </para>
434                    </entry>
435                    <entry>
436                        floating-point number
437                    </entry>
438                    <entry>
439                        [0..1]
440                    </entry>
441                    <entry>
442                        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.
443                    </entry>
444                    <entry>
445                        <para>
446                            <emphasis role="bold">unit</emphasis>={units}
447                        </para>
448                    </entry>
449                </row>
450                <row>
451                    <entry>
452                        <para>
453                            <emphasis role="bold">y</emphasis>
454                        </para>
455                    </entry>
456                    <entry>
457                        floating-point number
458                    </entry>
459                    <entry>
460                        [0..1]
461                    </entry>
462                    <entry>
463                        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.
464                    </entry>
465                    <entry>
466                        <para>
467                            <emphasis role="bold">unit</emphasis>={units}
468                        </para>
469                    </entry>
470                </row>
471                <row>
472                    <entry>
473                        <para>
474                            <emphasis role="bold">z</emphasis>
475                        </para>
476                    </entry>
477                    <entry>
478                        floating-point number
479                    </entry>
480                    <entry>
481                        [0..1]
482                    </entry>
483                    <entry>
484                        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.
485                    </entry>
486                    <entry>
487                        <para>
488                            <emphasis role="bold">unit</emphasis>={units}
489                        </para>
490                    </entry>
491                </row>
492            </tbody>
493            </tgroup>
494        </table>
495    </section>
496    <section>
497        <title>pixel_size</title>
498        <table orient="port" role="small">
499            <title/>
500            <tgroup cols="5">
501                <colspec colname="c1" colwidth="15*"/>
502                <colspec colname="c2" colwidth="15*"/>
503                <colspec colname="c3" colwidth="10*"/>
504                <colspec colname="c4" colwidth="30*"/>
505                <colspec colname="c5" colwidth="30*"/>
506                <tbody>
507                    <row>
508                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
509                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
510                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
511                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
512                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
513                    </row>
514                <row>
515                    <entry>
516                        <para>
517                            <emphasis role="bold">x</emphasis>
518                        </para>
519                    </entry>
520                    <entry>
521                        floating-point number
522                    </entry>
523                    <entry>
524                        [0..1]
525                    </entry>
526                    <entry>
527                        Size of a detector pixel in X. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
528                    </entry>
529                    <entry>
530                        <para>
531                            <emphasis role="bold">unit</emphasis>={units}
532                        </para>
533                    </entry>
534                </row>
535                <row>
536                    <entry>
537                        <para>
538                            <emphasis role="bold">y</emphasis>
539                        </para>
540                    </entry>
541                    <entry>
542                        floating-point number
543                    </entry>
544                    <entry>
545                        [0..1]
546                    </entry>
547                    <entry>
548                        Size of a detector pixel in Y. The <emphasis role="bold">unit</emphasis> attribute is required. See cansas1d_documentation#Rules for acceptable values.
549                    </entry>
550                    <entry>
551                        <para>
552                            <emphasis role="bold">unit</emphasis>={units}
553                        </para>
554                    </entry>
555                </row>
556                <row>
557                    <entry>
558                        <para>
559                            <emphasis role="bold">z</emphasis>
560                        </para>
561                    </entry>
562                    <entry>
563                        floating-point number
564                    </entry>
565                    <entry>
566                        [0..1]
567                    </entry>
568                    <entry>
569                        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.
570                    </entry>
571                    <entry>
572                        <para>
573                            <emphasis role="bold">unit</emphasis>={units}
574                        </para>
575                    </entry>
576                </row>
577            </tbody></tgroup>
578        </table>
579    </section>
580</section>
Note: See TracBrowser for help on using the repository browser.