source: sasview/pr_inversion/docs/sphinx/_build/html/api/distance_explorer.html @ 6bdb9b3

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 6bdb9b3 was 6bdb9b3, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

Added sphinx documentation for pr_inversion
  • Property mode set to 100644
File size: 6.1 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>distance_explorer &mdash; pr_inversion 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="pr_inversion v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="invertor" href="invertor.html" />
28    <link rel="prev" title="Reference" href="index.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="invertor.html" title="invertor"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="index.html" title="Reference"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">pr_inversion 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="distance-explorer">
57<h1>distance_explorer<a class="headerlink" href="#distance-explorer" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.pr.distance_explorer">
59<span id="sans-pr-distance-explorer"></span><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="#module-sans.pr.distance_explorer" title="Permalink to this headline">¶</a></h2>
60<p>Module to explore the P(r) inversion results for a range
61of D_max value. User picks a number of points and a range of
62distances, then get a series of outputs as a function of D_max
63over that range.</p>
64<dl class="class">
65<dt id="sans.pr.distance_explorer.DistExplorer">
66<em class="property">class </em><tt class="descclassname">sans.pr.distance_explorer.</tt><tt class="descname">DistExplorer</tt><big>(</big><em>pr_state</em><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer" title="Permalink to this definition">¶</a></dt>
67<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
68<p>The explorer class</p>
69</dd></dl>
70
71<dl class="class">
72<dt id="sans.pr.distance_explorer.Results">
73<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>
74<dd><p>Class to hold the inversion output parameters
75as a function of D_max</p>
76</dd></dl>
77
78</div>
79</div>
80
81
82          </div>
83        </div>
84      </div>
85      <div class="sphinxsidebar">
86        <div class="sphinxsidebarwrapper">
87  <h3><a href="../index.html">Table Of Contents</a></h3>
88  <ul>
89<li><a class="reference internal" href="#">distance_explorer</a><ul>
90<li><a class="reference internal" href="#module-sans.pr.distance_explorer"><tt class="docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a></li>
91</ul>
92</li>
93</ul>
94
95  <h4>Previous topic</h4>
96  <p class="topless"><a href="index.html"
97                        title="previous chapter">Reference</a></p>
98  <h4>Next topic</h4>
99  <p class="topless"><a href="invertor.html"
100                        title="next chapter">invertor</a></p>
101  <h3>This Page</h3>
102  <ul class="this-page-menu">
103    <li><a href="../_sources/api/distance_explorer.txt"
104           rel="nofollow">Show Source</a></li>
105  </ul>
106<div id="searchbox" style="display: none">
107  <h3>Quick search</h3>
108    <form class="search" action="../search.html" method="get">
109      <input type="text" name="q" size="18" />
110      <input type="submit" value="Go" />
111      <input type="hidden" name="check_keywords" value="yes" />
112      <input type="hidden" name="area" value="default" />
113    </form>
114    <p class="searchtip" style="font-size: 90%">
115    Enter search terms or a module, class or function name.
116    </p>
117</div>
118<script type="text/javascript">$('#searchbox').show(0);</script>
119        </div>
120      </div>
121      <div class="clearer"></div>
122    </div>
123    <div class="related">
124      <h3>Navigation</h3>
125      <ul>
126        <li class="right" style="margin-right: 10px">
127          <a href="../genindex.html" title="General Index"
128             >index</a></li>
129        <li class="right" >
130          <a href="../py-modindex.html" title="Python Module Index"
131             >modules</a> |</li>
132        <li class="right" >
133          <a href="invertor.html" title="invertor"
134             >next</a> |</li>
135        <li class="right" >
136          <a href="index.html" title="Reference"
137             >previous</a> |</li>
138        <li><a href="../index.html">pr_inversion v0.1.0 documentation</a> &raquo;</li>
139          <li><a href="index.html" >Reference</a> &raquo;</li> 
140      </ul>
141    </div>
142    <div class="footer">
143        &copy; Copyright 2010, sans group.
144      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
145    </div>
146  </body>
147</html>
Note: See TracBrowser for help on using the repository browser.