source: sasview/prview/docs/sphinx/_build/html/api/perspectives/pr/pr.html @ 7116b6e0

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 7116b6e0 was 7116b6e0, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 16.7 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>pr &mdash; prview 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="prview v0.1.0 documentation" href="../../../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="prev" title="pr_widgets" href="pr_widgets.html" /> 
28  </head>
29  <body>
30    <div class="related">
31      <h3>Navigation</h3>
32      <ul>
33        <li class="right" style="margin-right: 10px">
34          <a href="../../../genindex.html" title="General Index"
35             accesskey="I">index</a></li>
36        <li class="right" >
37          <a href="../../../py-modindex.html" title="Python Module Index"
38             >modules</a> |</li>
39        <li class="right" >
40          <a href="pr_widgets.html" title="pr_widgets"
41             accesskey="P">previous</a> |</li>
42        <li><a href="../../../index.html">prview v0.1.0 documentation</a> &raquo;</li>
43          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
44      </ul>
45    </div> 
46
47    <div class="document">
48      <div class="documentwrapper">
49        <div class="bodywrapper">
50          <div class="body">
51           
52  <div class="section" id="pr">
53<h1>pr<a class="headerlink" href="#pr" title="Permalink to this headline">¶</a></h1>
54<div class="section" id="module-sans.perspectives.pr.pr">
55<span id="sans-perspectives-pr-pr"></span><h2><a class="reference internal" href="#module-sans.perspectives.pr.pr"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.pr.pr</span></tt></a><a class="headerlink" href="#module-sans.perspectives.pr.pr" title="Permalink to this headline">¶</a></h2>
56<dl class="class">
57<dt id="sans.perspectives.pr.pr.Plugin">
58<em class="property">class </em><tt class="descclassname">sans.perspectives.pr.pr.</tt><tt class="descname">Plugin</tt><big>(</big><em>standalone=True</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin" title="Permalink to this definition">¶</a></dt>
59<dd><dl class="method">
60<dt id="sans.perspectives.pr.pr.Plugin.choose_file">
61<tt class="descname">choose_file</tt><big>(</big><em>path=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.choose_file" title="Permalink to this definition">¶</a></dt>
62<dd></dd></dl>
63
64<dl class="method">
65<dt id="sans.perspectives.pr.pr.Plugin.estimate_file_inversion">
66<tt class="descname">estimate_file_inversion</tt><big>(</big><em>alpha</em>, <em>nfunc</em>, <em>d_max</em>, <em>path</em>, <em>q_min=None</em>, <em>q_max=None</em>, <em>bck=False</em>, <em>height=0</em>, <em>width=0</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.estimate_file_inversion" title="Permalink to this definition">¶</a></dt>
67<dd></dd></dl>
68
69<dl class="method">
70<dt id="sans.perspectives.pr.pr.Plugin.estimate_plot_inversion">
71<tt class="descname">estimate_plot_inversion</tt><big>(</big><em>alpha</em>, <em>nfunc</em>, <em>d_max</em>, <em>q_min=None</em>, <em>q_max=None</em>, <em>bck=False</em>, <em>height=0</em>, <em>width=0</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.estimate_plot_inversion" title="Permalink to this definition">¶</a></dt>
72<dd></dd></dl>
73
74<dl class="method">
75<dt id="sans.perspectives.pr.pr.Plugin.get_context_menu">
76<tt class="descname">get_context_menu</tt><big>(</big><em>graph=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_context_menu" title="Permalink to this definition">¶</a></dt>
77<dd><p>Get the context menu items available for P(r)</p>
78<table class="docutils field-list" frame="void" rules="none">
79<col class="field-name" />
80<col class="field-body" />
81<tbody valign="top">
82<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
83<li><strong>graph</strong> &#8211; the Graph object to which we attach the context menu</li>
84</ul>
85</td>
86</tr>
87<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list of menu items with call-back function</p>
88</td>
89</tr>
90</tbody>
91</table>
92</dd></dl>
93
94<dl class="method">
95<dt id="sans.perspectives.pr.pr.Plugin.get_npts">
96<tt class="descname">get_npts</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_npts" title="Permalink to this definition">¶</a></dt>
97<dd>Returns the number of points in the I(q) data</dd></dl>
98
99<dl class="method">
100<dt id="sans.perspectives.pr.pr.Plugin.get_panels">
101<tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_panels" title="Permalink to this definition">¶</a></dt>
102<dd>Create and return a list of panel objects</dd></dl>
103
104<dl class="method">
105<dt id="sans.perspectives.pr.pr.Plugin.get_perspective">
106<tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_perspective" title="Permalink to this definition">¶</a></dt>
107<dd>Get the list of panel names for this perspective</dd></dl>
108
109<dl class="method">
110<dt id="sans.perspectives.pr.pr.Plugin.help">
111<tt class="descname">help</tt><big>(</big><em>evt</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.help" title="Permalink to this definition">¶</a></dt>
112<dd><p>Show a general help dialog.</p>
113<table class="docutils field-list" frame="void" rules="none">
114<col class="field-name" />
115<col class="field-body" />
116<tbody valign="top">
117<tr class="field"><th class="field-name">Todo :</th><td class="field-body">replace the text with a nice image</td>
118</tr>
119</tbody>
120</table>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.perspectives.pr.pr.Plugin.load">
125<tt class="descname">load</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load" title="Permalink to this definition">¶</a></dt>
126<dd>Load data. This will eventually be replaced
127by our standard DataLoader class.</dd></dl>
128
129<dl class="method">
130<dt id="sans.perspectives.pr.pr.Plugin.load_abs">
131<tt class="descname">load_abs</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load_abs" title="Permalink to this definition">¶</a></dt>
132<dd><p>Load an IGOR .ABS reduced file</p>
133<table class="docutils field-list" frame="void" rules="none">
134<col class="field-name" />
135<col class="field-body" />
136<tbody valign="top">
137<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
138<li><strong>path</strong> &#8211; file path</li>
139</ul>
140</td>
141</tr>
142<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">x, y, err vectors</p>
143</td>
144</tr>
145</tbody>
146</table>
147</dd></dl>
148
149<dl class="method">
150<dt id="sans.perspectives.pr.pr.Plugin.load_columns">
151<tt class="descname">load_columns</tt><big>(</big><em>path='sphere_60_q0_2.txt'</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load_columns" title="Permalink to this definition">¶</a></dt>
152<dd>Load 2- or 3- column ascii</dd></dl>
153
154<dl class="method">
155<dt id="sans.perspectives.pr.pr.Plugin.on_perspective">
156<tt class="descname">on_perspective</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.on_perspective" title="Permalink to this definition">¶</a></dt>
157<dd>Call back function for the perspective menu item.
158We notify the parent window that the perspective
159has changed.</dd></dl>
160
161<dl class="method">
162<dt id="sans.perspectives.pr.pr.Plugin.perform_estimate">
163<tt class="descname">perform_estimate</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.perform_estimate" title="Permalink to this definition">¶</a></dt>
164<dd></dd></dl>
165
166<dl class="method">
167<dt id="sans.perspectives.pr.pr.Plugin.perform_estimateNT">
168<tt class="descname">perform_estimateNT</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.perform_estimateNT" title="Permalink to this definition">¶</a></dt>
169<dd></dd></dl>
170
171<dl class="method">
172<dt id="sans.perspectives.pr.pr.Plugin.perform_inversion">
173<tt class="descname">perform_inversion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.perform_inversion" title="Permalink to this definition">¶</a></dt>
174<dd></dd></dl>
175
176<dl class="method">
177<dt id="sans.perspectives.pr.pr.Plugin.populate_menu">
178<tt class="descname">populate_menu</tt><big>(</big><em>id</em>, <em>owner</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.populate_menu" title="Permalink to this definition">¶</a></dt>
179<dd>Create a menu for the plug-in</dd></dl>
180
181<dl class="method">
182<dt id="sans.perspectives.pr.pr.Plugin.post_init">
183<tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.post_init" title="Permalink to this definition">¶</a></dt>
184<dd>Post initialization call back to close the loose ends
185[Somehow openGL needs this call]</dd></dl>
186
187<dl class="method">
188<dt id="sans.perspectives.pr.pr.Plugin.pr_theory">
189<tt class="descname">pr_theory</tt><big>(</big><em>r</em>, <em>R</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.pr_theory" title="Permalink to this definition">¶</a></dt>
190<dd></dd></dl>
191
192<dl class="method">
193<dt id="sans.perspectives.pr.pr.Plugin.save_data">
194<tt class="descname">save_data</tt><big>(</big><em>filepath</em>, <em>prstate=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.save_data" title="Permalink to this definition">¶</a></dt>
195<dd><p>Save data in provided state object.</p>
196<table class="docutils field-list" frame="void" rules="none">
197<col class="field-name" />
198<col class="field-body" />
199<tbody valign="top">
200<tr class="field"><th class="field-name">Todo :</th><td class="field-body"><p class="first">move the state code away from inversion_panel and move it here.
201Then remove the &#8220;prstate&#8221; input and make this method private.</p>
202</td>
203</tr>
204<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
205<li><strong>filepath</strong> &#8211; path of file to write to</li>
206<li><strong>prstate</strong> &#8211; P(r) inversion state</li>
207</ul>
208</td>
209</tr>
210</tbody>
211</table>
212</dd></dl>
213
214<dl class="method">
215<dt id="sans.perspectives.pr.pr.Plugin.set_state">
216<tt class="descname">set_state</tt><big>(</big><em>state</em>, <em>datainfo=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_state" title="Permalink to this definition">¶</a></dt>
217<dd><p>Call-back method for the inversion state reader.
218This method is called when a .prv file is loaded.</p>
219<table class="docutils field-list" frame="void" rules="none">
220<col class="field-name" />
221<col class="field-body" />
222<tbody valign="top">
223<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
224<li><strong>state</strong> &#8211; InversionState object</li>
225<li><strong>datainfo</strong> &#8211; Data1D object [optional]</li>
226</ul>
227</td>
228</tr>
229</tbody>
230</table>
231</dd></dl>
232
233<dl class="method">
234<dt id="sans.perspectives.pr.pr.Plugin.setup_file_inversion">
235<tt class="descname">setup_file_inversion</tt><big>(</big><em>alpha</em>, <em>nfunc</em>, <em>d_max</em>, <em>path</em>, <em>q_min=None</em>, <em>q_max=None</em>, <em>bck=False</em>, <em>height=0</em>, <em>width=0</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.setup_file_inversion" title="Permalink to this definition">¶</a></dt>
236<dd></dd></dl>
237
238<dl class="method">
239<dt id="sans.perspectives.pr.pr.Plugin.setup_plot_inversion">
240<tt class="descname">setup_plot_inversion</tt><big>(</big><em>alpha</em>, <em>nfunc</em>, <em>d_max</em>, <em>q_min=None</em>, <em>q_max=None</em>, <em>bck=False</em>, <em>height=0</em>, <em>width=0</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.setup_plot_inversion" title="Permalink to this definition">¶</a></dt>
241<dd></dd></dl>
242
243<dl class="method">
244<dt id="sans.perspectives.pr.pr.Plugin.show_data">
245<tt class="descname">show_data</tt><big>(</big><em>path=None</em>, <em>reset=False</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_data" title="Permalink to this definition">¶</a></dt>
246<dd><p>Show data read from a file</p>
247<table class="docutils field-list" frame="void" rules="none">
248<col class="field-name" />
249<col class="field-body" />
250<tbody valign="top">
251<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
252<li><strong>path</strong> &#8211; file path</li>
253<li><strong>reset</strong> &#8211; if True all other plottables will be cleared</li>
254</ul>
255</td>
256</tr>
257</tbody>
258</table>
259</dd></dl>
260
261<dl class="method">
262<dt id="sans.perspectives.pr.pr.Plugin.show_iq">
263<tt class="descname">show_iq</tt><big>(</big><em>out</em>, <em>pr</em>, <em>q=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_iq" title="Permalink to this definition">¶</a></dt>
264<dd></dd></dl>
265
266<dl class="method">
267<dt id="sans.perspectives.pr.pr.Plugin.show_pr">
268<tt class="descname">show_pr</tt><big>(</big><em>out</em>, <em>pr</em>, <em>cov=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_pr" title="Permalink to this definition">¶</a></dt>
269<dd></dd></dl>
270
271<dl class="method">
272<dt id="sans.perspectives.pr.pr.Plugin.show_shpere">
273<tt class="descname">show_shpere</tt><big>(</big><em>x</em>, <em>radius=70.0</em>, <em>x_range=70.0</em><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_shpere" title="Permalink to this definition">¶</a></dt>
274<dd></dd></dl>
275
276<dl class="method">
277<dt id="sans.perspectives.pr.pr.Plugin.start_thread">
278<tt class="descname">start_thread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.start_thread" title="Permalink to this definition">¶</a></dt>
279<dd></dd></dl>
280
281</dd></dl>
282
283</div>
284</div>
285
286
287          </div>
288        </div>
289      </div>
290      <div class="sphinxsidebar">
291        <div class="sphinxsidebarwrapper">
292  <h3><a href="../../../index.html">Table Of Contents</a></h3>
293  <ul>
294<li><a class="reference internal" href="#">pr</a><ul>
295<li><a class="reference internal" href="#module-sans.perspectives.pr.pr"><tt class="docutils literal"><span class="pre">sans.perspectives.pr.pr</span></tt></a></li>
296</ul>
297</li>
298</ul>
299
300  <h4>Previous topic</h4>
301  <p class="topless"><a href="pr_widgets.html"
302                        title="previous chapter">pr_widgets</a></p>
303  <h3>This Page</h3>
304  <ul class="this-page-menu">
305    <li><a href="../../../_sources/api/perspectives/pr/pr.txt"
306           rel="nofollow">Show Source</a></li>
307  </ul>
308<div id="searchbox" style="display: none">
309  <h3>Quick search</h3>
310    <form class="search" action="../../../search.html" method="get">
311      <input type="text" name="q" size="18" />
312      <input type="submit" value="Go" />
313      <input type="hidden" name="check_keywords" value="yes" />
314      <input type="hidden" name="area" value="default" />
315    </form>
316    <p class="searchtip" style="font-size: 90%">
317    Enter search terms or a module, class or function name.
318    </p>
319</div>
320<script type="text/javascript">$('#searchbox').show(0);</script>
321        </div>
322      </div>
323      <div class="clearer"></div>
324    </div>
325    <div class="related">
326      <h3>Navigation</h3>
327      <ul>
328        <li class="right" style="margin-right: 10px">
329          <a href="../../../genindex.html" title="General Index"
330             >index</a></li>
331        <li class="right" >
332          <a href="../../../py-modindex.html" title="Python Module Index"
333             >modules</a> |</li>
334        <li class="right" >
335          <a href="pr_widgets.html" title="pr_widgets"
336             >previous</a> |</li>
337        <li><a href="../../../index.html">prview v0.1.0 documentation</a> &raquo;</li>
338          <li><a href="index.html" >Reference</a> &raquo;</li> 
339      </ul>
340    </div>
341    <div class="footer">
342        &copy; Copyright 2010, sans group.
343      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
344    </div>
345  </body>
346</html>
Note: See TracBrowser for help on using the repository browser.