source: 1dwg/trunk/doc/src/cansas1d_element_SASsource.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: 12.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_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><para><literal> radiation </literal></para></entry>
59                        <entry> string </entry>
60                        <entry> [1..1] </entry>
61                        <entry>
62                            <para>
63                                Name of the radiation used. For maximum compatibility with NeXus,
64                                use one of the names defined by either <link
65                                    xlink:href="http://www.nexusformat.org/NXsource"
66                                    ><citetitle>NeXus</citetitle>
67                                        <literal>NXsource/type</literal></link> 
68                            </para>
69                            <itemizedlist>
70                                <listitem><para>Spallation Neutron Source</para></listitem>
71                                <listitem><para>Pulsed Reactor Neutron Source</para></listitem>
72                                <listitem><para>Reactor Neutron Source</para></listitem>
73                                <listitem><para>Synchrotron X-ray Source</para></listitem>
74                                <listitem><para>Pulsed Muon Source</para></listitem>
75                                <listitem><para>Rotating Anode X-ray</para></listitem>
76                                <listitem><para>Fixed Tube X-ray</para></listitem>
77                            </itemizedlist>
78                            <para> 
79                                or <link
80                                    xlink:href="http://www.nexusformat.org/NXsource"
81                                    ><citetitle>NeXus</citetitle>
82                                    <literal>NXsource/probe</literal></link> 
83                            </para>
84                            <itemizedlist>
85                                <listitem><para>neutron</para></listitem>
86                                <listitem><para>x-ray</para></listitem>
87                                <listitem><para>muon</para></listitem>
88                                <listitem><para>electron</para></listitem>
89                            </itemizedlist>
90                        </entry>
91                        <entry/>
92                    </row>
93                    <row>
94                        <entry><literal> beam_size </literal></entry>
95                        <entry> container </entry>
96                        <entry> [0..1] </entry>
97                        <entry> Physical dimension of the beam (incident on the sample). Note: If
98                            beam is round, just use X dimension. Note: While Z dimension is allowed
99                            by the standard, it does not make sense for small-angle scattering. </entry>
100                        <entry><para><literal>name={name}</literal></para></entry>
101                    </row>
102                    <row>
103                        <entry><para><literal> beam_shape </literal></para></entry>
104                        <entry> string </entry>
105                        <entry> [0..1] </entry>
106                        <entry> Text description of the shape of the beam (incident on the sample). </entry>
107                        <entry/>
108                    </row>
109                    <row>
110                        <entry><para><literal> wavelength </literal></para></entry>
111                        <entry> floating-point number </entry>
112                        <entry> [0..1] </entry>
113                        <entry> 
114                            <para>
115                                wavelength
116                                (<inlineequation>
117                                    <mathphrase><alt>$\lambda$</alt></mathphrase>
118                                </inlineequation>)
119                                of radiation incident on the sample.
120                            </para>
121                        </entry>
122                        <entry><para><literal> unit={unit} </literal></para></entry>
123                    </row>
124                    <row>
125                        <entry><para><literal> wavelength_min </literal></para></entry>
126                        <entry> floating-point number </entry>
127                        <entry> [0..1] </entry>
128                        <entry> Some facilities specify wavelength using a range. The minimum of
129                            such a range is given by wavelength_min. </entry>
130                        <entry><para><literal> unit={unit} </literal></para></entry>
131                    </row>
132                    <row>
133                        <entry><para><literal> wavelength_max </literal></para></entry>
134                        <entry> floating-point number </entry>
135                        <entry> [0..1] </entry>
136                        <entry> Some facilities specify wavelength using a range. The maximum of
137                            such a range is given by wavelength_max. </entry>
138                        <entry><para><literal> unit={unit} </literal></para></entry>
139                    </row>
140                    <row>
141                        <entry><para><literal> wavelength_spread </literal></para></entry>
142                        <entry> floating-point number </entry>
143                        <entry> [0..1] </entry>
144                        <entry> Some facilities specify the width of the wavelength spectrum. The
145                            width of such a range is given by wavelength_spread. </entry>
146                        <entry><para><literal> unit={unit} </literal></para></entry>
147                    </row>
148                </tbody>
149            </tgroup>
150        </table>
151    </section>
152    <section>
153        <title>beam_size</title>
154        <para>
155            <table>
156                <title/>
157                <tgroup cols="2">
158                    <tbody>
159                        <row>
160                            <entry>
161                                <mediaobject>
162                                    <imageobject>
163                                        <imagedata
164                                            fileref="../../graphics/translation-orientation-geometry.jpg"
165                                            width="200pt" scalefit="1"/>
166                                    </imageobject>
167                                    <caption>
168                                        <para>view from source</para>
169                                    </caption>
170                                </mediaobject>
171                            </entry>
172                            <entry>
173                                <mediaobject>
174                                    <imageobject>
175                                        <imagedata
176                                            fileref="../../graphics/translation-orientation-geometry-2.jpg"
177                                            width="200pt" scalefit="1"/>
178                                    </imageobject>
179                                    <caption>
180                                        <para>view from detector</para>
181                                    </caption>
182                                </mediaobject>
183                            </entry>
184                        </row>
185                    </tbody>
186                </tgroup>
187            </table>
188            <table orient="port" role="small">
189                <title/>
190                <tgroup cols="5">
191                    <colspec colname="c1" colwidth="15*"/>
192                    <colspec colname="c2" colwidth="15*"/>
193                    <colspec colname="c3" colwidth="10*"/>
194                    <colspec colname="c4" colwidth="30*"/>
195                    <colspec colname="c5" colwidth="30*"/>
196                    <tbody>
197                        <row>
198                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Name</entry>
199                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Type</entry>
200                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Occurrence</entry>
201                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Description</entry>
202                            <entry><?dblatex bgcolor="[gray]{0.8}"?>Attributes</entry>
203                        </row>
204                        <row>
205                            <entry><para><literal> x </literal></para></entry>
206                            <entry> floating-point number </entry>
207                            <entry> [0..1] </entry>
208                            <entry> Dimension of the beam in X. The <emphasis role="bold"
209                                    >unit</emphasis> attribute is required. See
210                                cansas1d_documentation#Rules for acceptable values. </entry>
211                            <entry><para><literal> unit={unit} </literal></para></entry>
212                        </row>
213                        <row>
214                            <entry><para><literal> y </literal></para></entry>
215                            <entry> floating-point number </entry>
216                            <entry> [0..1] </entry>
217                            <entry> Dimension of the beam in Y. The <emphasis role="bold"
218                                    >unit</emphasis> attribute is required. See
219                                cansas1d_documentation#Rules for acceptable values. </entry>
220                            <entry><para><literal> unit={unit} </literal></para></entry>
221                        </row>
222                        <row>
223                            <entry><para><literal> z </literal></para></entry>
224                            <entry> floating-point number </entry>
225                            <entry> [0..1] </entry>
226                            <entry> Dimension of the beam in Z. The <emphasis role="bold"
227                                    >unit</emphasis> attribute is required. See
228                                cansas1d_documentation#Rules for acceptable values. Note: While Z
229                                dimension is allowed by the standard (provided by use of a standard
230                                element in the XML Schema), it does not make sense for small-angle
231                                scattering.
232                            </entry>
233                            <entry><para><literal> unit={unit} </literal></para></entry>
234                        </row>
235                    </tbody>
236                </tgroup>
237            </table>
238        </para>
239    </section>
240</section>
Note: See TracBrowser for help on using the repository browser.