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

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 9a56619 was 771fe98, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago
  • Property mode set to 100644
File size: 8.0 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<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>Slit Length Calculator &mdash; calculator v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="Kiessig Calculator" href="kiessig_calculator.html" />
28    <link rel="prev" title="Instrument" href="instrument.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="kiessig_calculator.html" title="Kiessig Calculator"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="instrument.html" title="Instrument"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="slit-length-calculator">
57<h1>Slit Length Calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.calculator.slit_length_calculator">
59<span id="sans-calculator-slit-length-calculator"></span><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="#module-sans.calculator.slit_length_calculator" title="Permalink to this headline">¶</a></h2>
60<p>This module is a small tool to allow user to quickly
61determine the slit length value of data.</p>
62<dl class="class">
63<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator">
64<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>
65<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
66<p>compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I ,
67and 3rd col. dI.: don&#8217;t need the 3rd)</p>
68<dl class="method">
69<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">
70<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>
71<dd><p>Calculate slit length.</p>
72<table class="docutils field-list" frame="void" rules="none">
73<col class="field-name" />
74<col class="field-body" />
75<tbody valign="top">
76<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td>
77</tr>
78</tbody>
79</table>
80</dd></dl>
81
82<dl class="method">
83<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">
84<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>
85<dd><table class="docutils field-list" frame="void" rules="none">
86<col class="field-name" />
87<col class="field-body" />
88<tbody valign="top">
89<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td>
90</tr>
91</tbody>
92</table>
93</dd></dl>
94
95<dl class="method">
96<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data">
97<tt class="descname">set_data</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt>
98<dd><blockquote>
99<div>Receive two vector x, y and prepare the slit calculator for
100computation.</div></blockquote>
101<table class="docutils field-list" frame="void" rules="none">
102<col class="field-name" />
103<col class="field-body" />
104<tbody valign="top">
105<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
106<li><strong>x</strong> &#8211; array</li>
107<li><strong>y</strong> &#8211; array</li>
108</ul>
109</td>
110</tr>
111</tbody>
112</table>
113</dd></dl>
114
115</dd></dl>
116
117</div>
118</div>
119
120
121          </div>
122        </div>
123      </div>
124      <div class="sphinxsidebar">
125        <div class="sphinxsidebarwrapper">
126  <h3><a href="../index.html">Table Of Contents</a></h3>
127  <ul>
128<li><a class="reference internal" href="#">Slit Length Calculator</a><ul>
129<li><a class="reference internal" href="#module-sans.calculator.slit_length_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li>
130</ul>
131</li>
132</ul>
133
134  <h4>Previous topic</h4>
135  <p class="topless"><a href="instrument.html"
136                        title="previous chapter">Instrument</a></p>
137  <h4>Next topic</h4>
138  <p class="topless"><a href="kiessig_calculator.html"
139                        title="next chapter">Kiessig Calculator</a></p>
140  <h3>This Page</h3>
141  <ul class="this-page-menu">
142    <li><a href="../_sources/api/slit_length_calculator.txt"
143           rel="nofollow">Show Source</a></li>
144  </ul>
145<div id="searchbox" style="display: none">
146  <h3>Quick search</h3>
147    <form class="search" action="../search.html" method="get">
148      <input type="text" name="q" size="18" />
149      <input type="submit" value="Go" />
150      <input type="hidden" name="check_keywords" value="yes" />
151      <input type="hidden" name="area" value="default" />
152    </form>
153    <p class="searchtip" style="font-size: 90%">
154    Enter search terms or a module, class or function name.
155    </p>
156</div>
157<script type="text/javascript">$('#searchbox').show(0);</script>
158        </div>
159      </div>
160      <div class="clearer"></div>
161    </div>
162    <div class="related">
163      <h3>Navigation</h3>
164      <ul>
165        <li class="right" style="margin-right: 10px">
166          <a href="../genindex.html" title="General Index"
167             >index</a></li>
168        <li class="right" >
169          <a href="../py-modindex.html" title="Python Module Index"
170             >modules</a> |</li>
171        <li class="right" >
172          <a href="kiessig_calculator.html" title="Kiessig Calculator"
173             >next</a> |</li>
174        <li class="right" >
175          <a href="instrument.html" title="Instrument"
176             >previous</a> |</li>
177        <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li>
178          <li><a href="index.html" >Reference</a> &raquo;</li> 
179      </ul>
180    </div>
181    <div class="footer">
182        &copy; Copyright 2010, Gervaise Alina.
183      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
184    </div>
185  </body>
186</html>
Note: See TracBrowser for help on using the repository browser.