source: sasview/sanscalculator/docs/sphinx/html/api/kiessig_calculator.html @ 2605b879

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 2605b879 was a4f04f2, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc
  • Property mode set to 100644
File size: 13.2 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>kiessig_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="next" title="resolution_calculator" href="resolution_calculator.html" />
31    <link rel="prev" title="instrument" href="instrument.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="resolution_calculator.html" title="resolution_calculator"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="instrument.html" title="instrument"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="kiessig-calculator">
60<h1>kiessig_calculator<a class="headerlink" href="#kiessig-calculator" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-calculator-kiessig-calculator">
62<h2><a class="reference internal" href="#module-sans.calculator.kiessig_calculator" title="sans.calculator.kiessig_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-kiessig-calculator" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.calculator.kiessig_calculator"></span><p>This module is a small tool to allow user to quickly
64determine the size value in real space  from the
65fringe width in q space.</p>
66<dl class="class">
67<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator">
68<em class="property">class </em><tt class="descclassname">sans.calculator.kiessig_calculator.</tt><tt class="descname">KiessigThicknessCalculator</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator" title="Permalink to this definition">¶</a></dt>
69<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
70<p>compute thickness from the fringe width of data</p>
71<dl class="attribute">
72<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__class__">
73<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__class__" title="Permalink to this definition">¶</a></dt>
74<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
75</dd></dl>
76
77<dl class="attribute">
78<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__delattr__">
79<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__delattr__" title="Permalink to this definition">¶</a></dt>
80<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
81</dd></dl>
82
83<dl class="attribute">
84<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__dict__">
85<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01C9DBD0&gt;</em><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__dict__" title="Permalink to this definition">¶</a></dt>
86<dd></dd></dl>
87
88<dl class="attribute">
89<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__getattribute__">
90<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt>
91<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
92</dd></dl>
93
94<dl class="attribute">
95<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__hash__">
96<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__hash__" title="Permalink to this definition">¶</a></dt>
97<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
98</dd></dl>
99
100<dl class="method">
101<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__init__">
102<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__init__" title="Permalink to this definition">¶</a></dt>
103<dd></dd></dl>
104
105<dl class="attribute">
106<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__module__">
107<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.kiessig_calculator'</em><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__module__" title="Permalink to this definition">¶</a></dt>
108<dd></dd></dl>
109
110<dl class="staticmethod">
111<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__new__">
112<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.kiessig_calculator.KiessigThicknessCalculator.__new__" title="Permalink to this definition">¶</a></dt>
113<dd></dd></dl>
114
115<dl class="method">
116<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce__">
117<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce__" title="Permalink to this definition">¶</a></dt>
118<dd><p>helper for pickle</p>
119</dd></dl>
120
121<dl class="method">
122<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce_ex__">
123<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
124<dd><p>helper for pickle</p>
125</dd></dl>
126
127<dl class="attribute">
128<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__repr__">
129<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__repr__" title="Permalink to this definition">¶</a></dt>
130<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
131</dd></dl>
132
133<dl class="attribute">
134<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__setattr__">
135<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__setattr__" title="Permalink to this definition">¶</a></dt>
136<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
137</dd></dl>
138
139<dl class="attribute">
140<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__str__">
141<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__str__" title="Permalink to this definition">¶</a></dt>
142<dd><p>x.__str__() &lt;==&gt; str(x)</p>
143</dd></dl>
144
145<dl class="attribute">
146<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__weakref__">
147<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__weakref__" title="Permalink to this definition">¶</a></dt>
148<dd><p>list of weak references to the object (if defined)</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.compute_thickness">
153<tt class="descname">compute_thickness</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.compute_thickness" title="Permalink to this definition">¶</a></dt>
154<dd><p>Calculate thickness.</p>
155<table class="docutils field-list" frame="void" rules="none">
156<col class="field-name" />
157<col class="field-body" />
158<tbody valign="top">
159<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness.</td>
160</tr>
161</tbody>
162</table>
163</dd></dl>
164
165<dl class="method">
166<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.get_deltaq">
167<tt class="descname">get_deltaq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.get_deltaq" title="Permalink to this definition">¶</a></dt>
168<dd><p>return deltaQ value in 1/A unit</p>
169</dd></dl>
170
171<dl class="method">
172<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.get_thickness_unit">
173<tt class="descname">get_thickness_unit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.get_thickness_unit" title="Permalink to this definition">¶</a></dt>
174<dd><table class="docutils field-list" frame="void" rules="none">
175<col class="field-name" />
176<col class="field-body" />
177<tbody valign="top">
178<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness unit.</td>
179</tr>
180</tbody>
181</table>
182</dd></dl>
183
184<dl class="method">
185<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq">
186<tt class="descname">set_deltaq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq" title="Permalink to this definition">¶</a></dt>
187<dd><p>Receive deltaQ value</p>
188<table class="docutils field-list" frame="void" rules="none">
189<col class="field-name" />
190<col class="field-body" />
191<tbody valign="top">
192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dq</strong> &#8211; q fringe width in 1/A unit</td>
193</tr>
194</tbody>
195</table>
196</dd></dl>
197
198</dd></dl>
199
200</div>
201</div>
202
203
204          </div>
205        </div>
206      </div>
207      <div class="sphinxsidebar">
208        <div class="sphinxsidebarwrapper">
209  <h3><a href="../index.html">Table Of Contents</a></h3>
210  <ul>
211<li><a class="reference internal" href="#">kiessig_calculator</a><ul>
212<li><a class="reference internal" href="#sans-calculator-kiessig-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li>
213</ul>
214</li>
215</ul>
216
217  <h4>Previous topic</h4>
218  <p class="topless"><a href="instrument.html"
219                        title="previous chapter">instrument</a></p>
220  <h4>Next topic</h4>
221  <p class="topless"><a href="resolution_calculator.html"
222                        title="next chapter">resolution_calculator</a></p>
223  <h3>This Page</h3>
224  <ul class="this-page-menu">
225    <li><a href="../_sources/api/kiessig_calculator.txt"
226           rel="nofollow">Show Source</a></li>
227  </ul>
228<div id="searchbox" style="display: none">
229  <h3>Quick search</h3>
230    <form class="search" action="../search.html" method="get">
231      <input type="text" name="q" />
232      <input type="submit" value="Go" />
233      <input type="hidden" name="check_keywords" value="yes" />
234      <input type="hidden" name="area" value="default" />
235    </form>
236    <p class="searchtip" style="font-size: 90%">
237    Enter search terms or a module, class or function name.
238    </p>
239</div>
240<script type="text/javascript">$('#searchbox').show(0);</script>
241        </div>
242      </div>
243      <div class="clearer"></div>
244    </div>
245    <div class="related">
246      <h3>Navigation</h3>
247      <ul>
248        <li class="right" style="margin-right: 10px">
249          <a href="../genindex.html" title="General Index"
250             >index</a></li>
251        <li class="right" >
252          <a href="../py-modindex.html" title="Python Module Index"
253             >modules</a> |</li>
254        <li class="right" >
255          <a href="resolution_calculator.html" title="resolution_calculator"
256             >next</a> |</li>
257        <li class="right" >
258          <a href="instrument.html" title="instrument"
259             >previous</a> |</li>
260        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
261          <li><a href="index.html" >Reference</a> &raquo;</li> 
262      </ul>
263    </div>
264    <div class="footer">
265        &copy; Copyright 2010, Gervaise Alina.
266      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
267    </div>
268  </body>
269</html>
Note: See TracBrowser for help on using the repository browser.