source: sasview/pr_inversion/docs/sphinx/html/api/distance_explorer.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 8884996, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc
  • Property mode set to 100644
File size: 12.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>distance_explorer &mdash; pr_inversion 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="pr_inversion 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="invertor" href="invertor.html" />
31    <link rel="prev" title="Reference" href="index.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="invertor.html" title="invertor"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="index.html" title="Reference"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">pr_inversion 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="distance-explorer">
60<h1>distance_explorer<a class="headerlink" href="#distance-explorer" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-pr-distance-explorer">
62<h2><a class="reference internal" href="#module-sans.pr.distance_explorer" title="sans.pr.distance_explorer"><tt class="xref py py-mod docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a><a class="headerlink" href="#sans-pr-distance-explorer" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.pr.distance_explorer"></span><p>Module to explore the P(r) inversion results for a range
64of D_max value. User picks a number of points and a range of
65distances, then get a series of outputs as a function of D_max
66over that range.</p>
67<dl class="class">
68<dt id="sans.pr.distance_explorer.DistExplorer">
69<em class="property">class </em><tt class="descclassname">sans.pr.distance_explorer.</tt><tt class="descname">DistExplorer</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer" title="Permalink to this definition">¶</a></dt>
70<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
71<p>The explorer class</p>
72<dl class="method">
73<dt id="sans.pr.distance_explorer.DistExplorer.__call__">
74<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__call__" title="Permalink to this definition">¶</a></dt>
75<dd><p>Compute the outputs as a function of D_max.</p>
76<table class="docutils field-list" frame="void" rules="none">
77<col class="field-name" />
78<col class="field-body" />
79<tbody valign="top">
80<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
81<li><strong>dmin</strong> &#8211; minimum value for D_max</li>
82<li><strong>dmax</strong> &#8211; maximum value for D_max</li>
83<li><strong>npts</strong> &#8211; number of points for D_max</li>
84</ul>
85</td>
86</tr>
87</tbody>
88</table>
89</dd></dl>
90
91<dl class="attribute">
92<dt id="sans.pr.distance_explorer.DistExplorer.__class__">
93<tt class="descname">__class__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__class__" title="Permalink to this definition">¶</a></dt>
94<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
95</dd></dl>
96
97<dl class="attribute">
98<dt id="sans.pr.distance_explorer.DistExplorer.__delattr__">
99<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__delattr__" title="Permalink to this definition">¶</a></dt>
100<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
101</dd></dl>
102
103<dl class="attribute">
104<dt id="sans.pr.distance_explorer.DistExplorer.__dict__">
105<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x018F9B90&gt;</em><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__dict__" title="Permalink to this definition">¶</a></dt>
106<dd></dd></dl>
107
108<dl class="attribute">
109<dt id="sans.pr.distance_explorer.DistExplorer.__getattribute__">
110<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__getattribute__" title="Permalink to this definition">¶</a></dt>
111<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
112</dd></dl>
113
114<dl class="attribute">
115<dt id="sans.pr.distance_explorer.DistExplorer.__hash__">
116<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__hash__" title="Permalink to this definition">¶</a></dt>
117<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
118</dd></dl>
119
120<dl class="method">
121<dt id="sans.pr.distance_explorer.DistExplorer.__init__">
122<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__init__" title="Permalink to this definition">¶</a></dt>
123<dd><p>Initialization.</p>
124<table class="docutils field-list" frame="void" rules="none">
125<col class="field-name" />
126<col class="field-body" />
127<tbody valign="top">
128<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pr_state</strong> &#8211; sans.pr.invertor.Invertor object</td>
129</tr>
130</tbody>
131</table>
132</dd></dl>
133
134<dl class="attribute">
135<dt id="sans.pr.distance_explorer.DistExplorer.__module__">
136<tt class="descname">__module__</tt><em class="property"> = 'sans.pr.distance_explorer'</em><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__module__" title="Permalink to this definition">¶</a></dt>
137<dd></dd></dl>
138
139<dl class="staticmethod">
140<dt id="sans.pr.distance_explorer.DistExplorer.__new__">
141<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.pr.distance_explorer.DistExplorer.__new__" title="Permalink to this definition">¶</a></dt>
142<dd></dd></dl>
143
144<dl class="method">
145<dt id="sans.pr.distance_explorer.DistExplorer.__reduce__">
146<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__reduce__" title="Permalink to this definition">¶</a></dt>
147<dd><p>helper for pickle</p>
148</dd></dl>
149
150<dl class="method">
151<dt id="sans.pr.distance_explorer.DistExplorer.__reduce_ex__">
152<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
153<dd><p>helper for pickle</p>
154</dd></dl>
155
156<dl class="attribute">
157<dt id="sans.pr.distance_explorer.DistExplorer.__repr__">
158<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__repr__" title="Permalink to this definition">¶</a></dt>
159<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
160</dd></dl>
161
162<dl class="attribute">
163<dt id="sans.pr.distance_explorer.DistExplorer.__setattr__">
164<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__setattr__" title="Permalink to this definition">¶</a></dt>
165<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
166</dd></dl>
167
168<dl class="attribute">
169<dt id="sans.pr.distance_explorer.DistExplorer.__str__">
170<tt class="descname">__str__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__str__" title="Permalink to this definition">¶</a></dt>
171<dd><p>x.__str__() &lt;==&gt; str(x)</p>
172</dd></dl>
173
174<dl class="attribute">
175<dt id="sans.pr.distance_explorer.DistExplorer.__weakref__">
176<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__weakref__" title="Permalink to this definition">¶</a></dt>
177<dd><p>list of weak references to the object (if defined)</p>
178</dd></dl>
179
180</dd></dl>
181
182<dl class="class">
183<dt id="sans.pr.distance_explorer.Results">
184<em class="property">class </em><tt class="descclassname">sans.pr.distance_explorer.</tt><tt class="descname">Results</tt><a class="headerlink" href="#sans.pr.distance_explorer.Results" title="Permalink to this definition">¶</a></dt>
185<dd><p>Class to hold the inversion output parameters
186as a function of D_max</p>
187<dl class="method">
188<dt id="sans.pr.distance_explorer.Results.__init__">
189<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.Results.__init__" title="Permalink to this definition">¶</a></dt>
190<dd><p>Initialization. Create empty arrays
191and dictionary of labels.</p>
192</dd></dl>
193
194<dl class="attribute">
195<dt id="sans.pr.distance_explorer.Results.__module__">
196<tt class="descname">__module__</tt><em class="property"> = 'sans.pr.distance_explorer'</em><a class="headerlink" href="#sans.pr.distance_explorer.Results.__module__" title="Permalink to this definition">¶</a></dt>
197<dd></dd></dl>
198
199</dd></dl>
200
201</div>
202</div>
203
204
205          </div>
206        </div>
207      </div>
208      <div class="sphinxsidebar">
209        <div class="sphinxsidebarwrapper">
210  <h3><a href="../index.html">Table Of Contents</a></h3>
211  <ul>
212<li><a class="reference internal" href="#">distance_explorer</a><ul>
213<li><a class="reference internal" href="#sans-pr-distance-explorer"><tt class="docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a></li>
214</ul>
215</li>
216</ul>
217
218  <h4>Previous topic</h4>
219  <p class="topless"><a href="index.html"
220                        title="previous chapter">Reference</a></p>
221  <h4>Next topic</h4>
222  <p class="topless"><a href="invertor.html"
223                        title="next chapter">invertor</a></p>
224  <h3>This Page</h3>
225  <ul class="this-page-menu">
226    <li><a href="../_sources/api/distance_explorer.txt"
227           rel="nofollow">Show Source</a></li>
228  </ul>
229<div id="searchbox" style="display: none">
230  <h3>Quick search</h3>
231    <form class="search" action="../search.html" method="get">
232      <input type="text" name="q" />
233      <input type="submit" value="Go" />
234      <input type="hidden" name="check_keywords" value="yes" />
235      <input type="hidden" name="area" value="default" />
236    </form>
237    <p class="searchtip" style="font-size: 90%">
238    Enter search terms or a module, class or function name.
239    </p>
240</div>
241<script type="text/javascript">$('#searchbox').show(0);</script>
242        </div>
243      </div>
244      <div class="clearer"></div>
245    </div>
246    <div class="related">
247      <h3>Navigation</h3>
248      <ul>
249        <li class="right" style="margin-right: 10px">
250          <a href="../genindex.html" title="General Index"
251             >index</a></li>
252        <li class="right" >
253          <a href="../py-modindex.html" title="Python Module Index"
254             >modules</a> |</li>
255        <li class="right" >
256          <a href="invertor.html" title="invertor"
257             >next</a> |</li>
258        <li class="right" >
259          <a href="index.html" title="Reference"
260             >previous</a> |</li>
261        <li><a href="../index.html">pr_inversion 0.1.0 documentation</a> &raquo;</li>
262          <li><a href="index.html" >Reference</a> &raquo;</li> 
263      </ul>
264    </div>
265    <div class="footer">
266        &copy; Copyright 2010, sans group.
267      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
268    </div>
269  </body>
270</html>
Note: See TracBrowser for help on using the repository browser.