source: 1dwg/trunk/doc/src/cansas1d_element_SASsource.xml @ 128

Last change on this file since 128 was 128, checked in by prjemian, 11 years ago

more cross-references and formatting, first index entries, cleaned up the Makefile, refs #19

  • Property svn:executable set to *
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 14.2 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_SASsource -->
13<section xml:id="cansas1d_documentation-element-SASsource" xmlns="http://docbook.org/ns/docbook"
14    version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
15    <title>SASsource element</title>
16    <bridgehead> $Revision$ $Date$ </bridgehead>
17    <itemizedlist mark="opencircle">
18        <listitem>
19            <indexterm><primary>SASsource</primary></indexterm>
20            <para> parent: <link xlink:href="#cansas1d_documentation-element-SASinstrument"
21                    >SASinstrument</link>
22            </para>
23        </listitem>
24    </itemizedlist>
25    <figure>
26        <title>The SASsource element</title>
27        <mediaobject>
28            <imageobject>
29                <imagedata fileref="../../graphics/5-SASsource.png" width="200pt" scalefit="1"/>
30            </imageobject>
31            <textobject>
32                <phrase>cansas1d-v1-5-SASsource</phrase>
33            </textobject>
34            <caption>
35                <para>The SASsource element</para>
36            </caption>
37        </mediaobject>
38    </figure>
39    <section>
40        <title>SASsource</title>
41        <table orient="port" role="small">
42            <title/>
43            <tgroup cols="5">
44                <colspec colname="c1" colwidth="15*"/>
45                <colspec colname="c2" colwidth="15*"/>
46                <colspec colname="c3" colwidth="10*"/>
47                <colspec colname="c4" colwidth="30*"/>
48                <colspec colname="c5" colwidth="30*"/>
49                <tbody>
50                    <row>
51                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
52                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
53                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
54                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
55                        <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
56                    </row>
57                    <row>
58                        <entry>
59                            <para>
60                                <emphasis role="bold">radiation</emphasis>
61                            </para>
62                        </entry>
63                        <entry> string </entry>
64                        <entry> [1..1] </entry>
65                        <entry>
66                            <para>
67                                Name of the radiation used. For maximum compatibility with NeXus,
68                                use one of the names defined by either <link
69                                    xlink:href="http://www.nexusformat.org/NXsource"
70                                    ><citetitle>NeXus</citetitle>
71                                        <literal>NXsource/type</literal></link> 
72                            </para>
73                            <itemizedlist>
74                                <listitem><para>Spallation Neutron Source</para></listitem>
75                                <listitem><para>Pulsed Reactor Neutron Source</para></listitem>
76                                <listitem><para>Reactor Neutron Source</para></listitem>
77                                <listitem><para>Synchrotron X-ray Source</para></listitem>
78                                <listitem><para>Pulsed Muon Source</para></listitem>
79                                <listitem><para>Rotating Anode X-ray</para></listitem>
80                                <listitem><para>Fixed Tube X-ray</para></listitem>
81                            </itemizedlist>
82                            <para> 
83                                or <link
84                                    xlink:href="http://www.nexusformat.org/NXsource"
85                                    ><citetitle>NeXus</citetitle>
86                                    <literal>NXsource/probe</literal></link> 
87                            </para>
88                            <itemizedlist>
89                                <listitem><para>neutron</para></listitem>
90                                <listitem><para>x-ray</para></listitem>
91                                <listitem><para>muon</para></listitem>
92                                <listitem><para>electron</para></listitem>
93                            </itemizedlist>
94                        </entry>
95                        <entry/>
96                       
97                    </row>
98                    <row>
99                        <entry> '''''beam_size''''' </entry>
100                        <entry> container </entry>
101                        <entry> [0..1] </entry>
102                        <entry> Physical dimension of the beam (incident on the sample). Note: If
103                            beam is round, just use X dimension. Note: While Z dimension is allowed
104                            by the standard, it does not make sense for small-angle scattering. </entry>
105                        <entry>
106                            <para>
107                                <emphasis role="bold"><emphasis>name</emphasis></emphasis>={name}
108                            </para>
109                        </entry>
110                    </row>
111                    <row>
112                        <entry>
113                            <para>
114                                <emphasis role="bold"><emphasis>beam_shape</emphasis></emphasis>
115                            </para>
116                        </entry>
117                        <entry> string </entry>
118                        <entry> [0..1] </entry>
119                        <entry> Text description of the shape of the beam (incident on the sample). </entry>
120                        <entry>
121                        </entry>
122                    </row>
123                    <row>
124                        <entry>
125                            <para>
126                                <emphasis role="bold"><emphasis>wavelength</emphasis></emphasis>
127                            </para>
128                        </entry>
129                        <entry> floating-point number </entry>
130                        <entry> [0..1] </entry>
131                        <entry> 
132                            <para>
133                                wavelength
134                                (<inlineequation>
135                                    <mathphrase><alt>$\lambda$</alt></mathphrase>
136                                </inlineequation>)
137                                of radiation incident on the sample.
138                            </para>
139                        </entry>
140                        <entry>
141                            <para>
142                                <emphasis role="bold">unit</emphasis>={unit} </para>
143                        </entry>
144                    </row>
145                    <row>
146                        <entry>
147                            <para>
148                                <emphasis role="bold"><emphasis>wavelength_min</emphasis></emphasis>
149                            </para>
150                        </entry>
151                        <entry> floating-point number </entry>
152                        <entry> [0..1] </entry>
153                        <entry> Some facilities specify wavelength using a range. The minimum of
154                            such a range is given by wavelength_min. </entry>
155                        <entry>
156                            <para>
157                                <emphasis role="bold">unit</emphasis>={unit} </para>
158                        </entry>
159                    </row>
160                    <row>
161                        <entry>
162                            <para>
163                                <emphasis role="bold"><emphasis>wavelength_max</emphasis></emphasis>
164                            </para>
165                        </entry>
166                        <entry> floating-point number </entry>
167                        <entry> [0..1] </entry>
168                        <entry> Some facilities specify wavelength using a range. The maximum of
169                            such a range is given by wavelength_max. </entry>
170                        <entry>
171                            <para>
172                                <emphasis role="bold">unit</emphasis>={unit} </para>
173                        </entry>
174                    </row>
175                    <row>
176                        <entry>
177                            <para>
178                                <emphasis role="bold"
179                                    ><emphasis>wavelength_spread</emphasis></emphasis>
180                            </para>
181                        </entry>
182                        <entry> floating-point number </entry>
183                        <entry> [0..1] </entry>
184                        <entry> Some facilities specify the width of the wavelength spectrum. The
185                            width of such a range is given by wavelength_spread. </entry>
186                        <entry>
187                            <para>
188                                <emphasis role="bold">unit</emphasis>={unit} </para>
189                        </entry>
190                    </row>
191                </tbody>
192            </tgroup>
193        </table>
194    </section>
195    <section>
196        <title>beam_size</title>
197        <para>
198            <table>
199                <title/>
200                <tgroup cols="2">
201                    <tbody>
202                        <row>
203                            <entry>
204                                <mediaobject>
205                                    <imageobject>
206                                        <imagedata
207                                            fileref="../../graphics/translation-orientation-geometry.jpg"
208                                            width="200pt" scalefit="1"/>
209                                    </imageobject>
210                                    <caption>
211                                        <para>view from source</para>
212                                    </caption>
213                                </mediaobject>
214                            </entry>
215                            <entry>
216                                <mediaobject>
217                                    <imageobject>
218                                        <imagedata
219                                            fileref="../../graphics/translation-orientation-geometry-2.jpg"
220                                            width="200pt" scalefit="1"/>
221                                    </imageobject>
222                                    <caption>
223                                        <para>view from detector</para>
224                                    </caption>
225                                </mediaobject>
226                            </entry>
227                        </row>
228                    </tbody>
229                </tgroup>
230            </table>
231            <table orient="port" role="small">
232                <title/>
233                <tgroup cols="5">
234                    <colspec colname="c1" colwidth="15*"/>
235                    <colspec colname="c2" colwidth="15*"/>
236                    <colspec colname="c3" colwidth="10*"/>
237                    <colspec colname="c4" colwidth="30*"/>
238                    <colspec colname="c5" colwidth="30*"/>
239                    <tbody>
240                        <row>
241                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
242                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
243                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
244                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
245                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
246                        </row>
247                        <row>
248                            <entry>
249                                <emphasis role="bold">x</emphasis>
250                            </entry>
251                            <entry> floating-point number </entry>
252                            <entry> [0..1] </entry>
253                            <entry> Dimension of the beam in X. The <emphasis role="bold"
254                                    >unit</emphasis> attribute is required. See
255                                cansas1d_documentation#Rules for acceptable values. </entry>
256                            <entry>
257                                <emphasis role="bold">unit</emphasis>={units} </entry>
258                        </row>
259                        <row>
260                            <entry>
261                                <emphasis role="bold">y</emphasis>
262                            </entry>
263                            <entry> floating-point number </entry>
264                            <entry> [0..1] </entry>
265                            <entry> Dimension of the beam in Y. The <emphasis role="bold"
266                                    >unit</emphasis> attribute is required. See
267                                cansas1d_documentation#Rules for acceptable values. </entry>
268                            <entry>
269                                <emphasis role="bold">unit</emphasis>={units} </entry>
270                        </row>
271                        <row>
272                            <entry>
273                                <emphasis role="bold">z</emphasis>
274                            </entry>
275                            <entry> floating-point number </entry>
276                            <entry> [0..1] </entry>
277                            <entry> Dimension of the beam in Z. The <emphasis role="bold"
278                                    >unit</emphasis> attribute is required. See
279                                cansas1d_documentation#Rules for acceptable values. Note: While Z
280                                dimension is allowed by the standard (provided by use of a standard
281                                element in the XML Schema), it does not make sense for small-angle
282                                scattering. </entry>
283                            <entry>
284                                <emphasis role="bold">unit</emphasis>={units} </entry>
285                        </row>
286                    </tbody>
287                </tgroup>
288            </table>
289        </para>
290    </section>
291</section>
Note: See TracBrowser for help on using the repository browser.