source: sasview/sanscalculator/docs/sphinx/html/api/slit_length_calculator.html @ a4f04f2

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since a4f04f2 was a4f04f2, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc
  • Property mode set to 100644
File size: 12.6 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>slit_length_calculator &mdash; calculator 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="prev" title="resolution_calculator" href="resolution_calculator.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="resolution_calculator.html" title="resolution_calculator"
44             accesskey="P">previous</a> |</li>
45        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
46          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
47      </ul>
48    </div> 
49
50    <div class="document">
51      <div class="documentwrapper">
52        <div class="bodywrapper">
53          <div class="body">
54           
55  <div class="section" id="slit-length-calculator">
56<h1>slit_length_calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1>
57<div class="section" id="sans-calculator-slit-length-calculator">
58<h2><a class="reference internal" href="#module-sans.calculator.slit_length_calculator" title="sans.calculator.slit_length_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-slit-length-calculator" title="Permalink to this headline">¶</a></h2>
59<span class="target" id="module-sans.calculator.slit_length_calculator"></span><p>This module is a small tool to allow user to quickly
60determine the slit length value of data.</p>
61<dl class="class">
62<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator">
63<em class="property">class </em><tt class="descclassname">sans.calculator.slit_length_calculator.</tt><tt class="descname">SlitlengthCalculator</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator" title="Permalink to this definition">¶</a></dt>
64<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
65<p>compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I ,
66and 3rd col. dI.: don&#8217;t need the 3rd)</p>
67<dl class="attribute">
68<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__class__">
69<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__class__" title="Permalink to this definition">¶</a></dt>
70<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
71</dd></dl>
72
73<dl class="attribute">
74<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__delattr__">
75<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__delattr__" title="Permalink to this definition">¶</a></dt>
76<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
77</dd></dl>
78
79<dl class="attribute">
80<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__dict__">
81<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0226C6F0&gt;</em><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__dict__" title="Permalink to this definition">¶</a></dt>
82<dd></dd></dl>
83
84<dl class="attribute">
85<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__getattribute__">
86<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt>
87<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
88</dd></dl>
89
90<dl class="attribute">
91<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__hash__">
92<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__hash__" title="Permalink to this definition">¶</a></dt>
93<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
94</dd></dl>
95
96<dl class="method">
97<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__init__">
98<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__init__" title="Permalink to this definition">¶</a></dt>
99<dd></dd></dl>
100
101<dl class="attribute">
102<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__module__">
103<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.slit_length_calculator'</em><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__module__" title="Permalink to this definition">¶</a></dt>
104<dd></dd></dl>
105
106<dl class="staticmethod">
107<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__new__">
108<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__new__" title="Permalink to this definition">¶</a></dt>
109<dd></dd></dl>
110
111<dl class="method">
112<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce__">
113<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce__" title="Permalink to this definition">¶</a></dt>
114<dd><p>helper for pickle</p>
115</dd></dl>
116
117<dl class="method">
118<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce_ex__">
119<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
120<dd><p>helper for pickle</p>
121</dd></dl>
122
123<dl class="attribute">
124<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__repr__">
125<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__repr__" title="Permalink to this definition">¶</a></dt>
126<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
127</dd></dl>
128
129<dl class="attribute">
130<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__setattr__">
131<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__setattr__" title="Permalink to this definition">¶</a></dt>
132<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
133</dd></dl>
134
135<dl class="attribute">
136<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__str__">
137<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__str__" title="Permalink to this definition">¶</a></dt>
138<dd><p>x.__str__() &lt;==&gt; str(x)</p>
139</dd></dl>
140
141<dl class="attribute">
142<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__weakref__">
143<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__weakref__" title="Permalink to this definition">¶</a></dt>
144<dd><p>list of weak references to the object (if defined)</p>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">
149<tt class="descname">calculate_slit_length</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length" title="Permalink to this definition">¶</a></dt>
150<dd><p>Calculate slit length.</p>
151<table class="docutils field-list" frame="void" rules="none">
152<col class="field-name" />
153<col class="field-body" />
154<tbody valign="top">
155<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td>
156</tr>
157</tbody>
158</table>
159</dd></dl>
160
161<dl class="method">
162<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">
163<tt class="descname">get_slit_length_unit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit" title="Permalink to this definition">¶</a></dt>
164<dd><table class="docutils field-list" frame="void" rules="none">
165<col class="field-name" />
166<col class="field-body" />
167<tbody valign="top">
168<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td>
169</tr>
170</tbody>
171</table>
172</dd></dl>
173
174<dl class="method">
175<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data">
176<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt>
177<dd><dl class="docutils">
178<dt>Receive two vector x, y and prepare the slit calculator for </dt>
179<dd>computation.</dd>
180</dl>
181<table class="docutils field-list" frame="void" rules="none">
182<col class="field-name" />
183<col class="field-body" />
184<tbody valign="top">
185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
186<li><strong>x</strong> &#8211; array</li>
187<li><strong>y</strong> &#8211; array</li>
188</ul>
189</td>
190</tr>
191</tbody>
192</table>
193</dd></dl>
194
195</dd></dl>
196
197</div>
198</div>
199
200
201          </div>
202        </div>
203      </div>
204      <div class="sphinxsidebar">
205        <div class="sphinxsidebarwrapper">
206  <h3><a href="../index.html">Table Of Contents</a></h3>
207  <ul>
208<li><a class="reference internal" href="#">slit_length_calculator</a><ul>
209<li><a class="reference internal" href="#sans-calculator-slit-length-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li>
210</ul>
211</li>
212</ul>
213
214  <h4>Previous topic</h4>
215  <p class="topless"><a href="resolution_calculator.html"
216                        title="previous chapter">resolution_calculator</a></p>
217  <h3>This Page</h3>
218  <ul class="this-page-menu">
219    <li><a href="../_sources/api/slit_length_calculator.txt"
220           rel="nofollow">Show Source</a></li>
221  </ul>
222<div id="searchbox" style="display: none">
223  <h3>Quick search</h3>
224    <form class="search" action="../search.html" method="get">
225      <input type="text" name="q" />
226      <input type="submit" value="Go" />
227      <input type="hidden" name="check_keywords" value="yes" />
228      <input type="hidden" name="area" value="default" />
229    </form>
230    <p class="searchtip" style="font-size: 90%">
231    Enter search terms or a module, class or function name.
232    </p>
233</div>
234<script type="text/javascript">$('#searchbox').show(0);</script>
235        </div>
236      </div>
237      <div class="clearer"></div>
238    </div>
239    <div class="related">
240      <h3>Navigation</h3>
241      <ul>
242        <li class="right" style="margin-right: 10px">
243          <a href="../genindex.html" title="General Index"
244             >index</a></li>
245        <li class="right" >
246          <a href="../py-modindex.html" title="Python Module Index"
247             >modules</a> |</li>
248        <li class="right" >
249          <a href="resolution_calculator.html" title="resolution_calculator"
250             >previous</a> |</li>
251        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
252          <li><a href="index.html" >Reference</a> &raquo;</li> 
253      </ul>
254    </div>
255    <div class="footer">
256        &copy; Copyright 2010, Gervaise Alina.
257      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
258    </div>
259  </body>
260</html>
Note: See TracBrowser for help on using the repository browser.