1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
3 | |
---|
4 | |
---|
5 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
6 | <head> |
---|
7 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
8 | |
---|
9 | <title>sas.perspectives.pr package — SasView 3.0.0 documentation</title> |
---|
10 | |
---|
11 | <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> |
---|
12 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
---|
13 | |
---|
14 | <script type="text/javascript"> |
---|
15 | var DOCUMENTATION_OPTIONS = { |
---|
16 | URL_ROOT: '../../', |
---|
17 | VERSION: '3.0.0', |
---|
18 | COLLAPSE_INDEX: false, |
---|
19 | FILE_SUFFIX: '.html', |
---|
20 | HAS_SOURCE: true |
---|
21 | }; |
---|
22 | </script> |
---|
23 | <script type="text/javascript" src="../../_static/jquery.js"></script> |
---|
24 | <script type="text/javascript" src="../../_static/underscore.js"></script> |
---|
25 | <script type="text/javascript" src="../../_static/doctools.js"></script> |
---|
26 | <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
27 | <link rel="top" title="SasView 3.0.0 documentation" href="../../index.html" /> |
---|
28 | <link rel="up" title="sas.perspectives package" href="sas.perspectives.html" /> |
---|
29 | <link rel="next" title="sas.plottools package" href="sas.plottools.html" /> |
---|
30 | <link rel="prev" title="sas.perspectives.invariant package" href="sas.perspectives.invariant.html" /> |
---|
31 | </head> |
---|
32 | <body> |
---|
33 | <div class="related"> |
---|
34 | <h3>Navigation</h3> |
---|
35 | <ul> |
---|
36 | <li class="right" style="margin-right: 10px"> |
---|
37 | <a href="../../genindex.html" title="General Index" |
---|
38 | accesskey="I">index</a></li> |
---|
39 | <li class="right" > |
---|
40 | <a href="../../py-modindex.html" title="Python Module Index" |
---|
41 | >modules</a> |</li> |
---|
42 | <li class="right" > |
---|
43 | <a href="sas.plottools.html" title="sas.plottools package" |
---|
44 | accesskey="N">next</a> |</li> |
---|
45 | <li class="right" > |
---|
46 | <a href="sas.perspectives.invariant.html" title="sas.perspectives.invariant package" |
---|
47 | accesskey="P">previous</a> |</li> |
---|
48 | <li><a href="../../index.html">SasView 3.0.0 documentation</a> »</li> |
---|
49 | <li><a href="../dev.html" >Developer Documentation</a> »</li> |
---|
50 | <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> »</li> |
---|
51 | <li><a href="sas.html" >sas package</a> »</li> |
---|
52 | <li><a href="sas.perspectives.html" accesskey="U">sas.perspectives package</a> »</li> |
---|
53 | </ul> |
---|
54 | </div> |
---|
55 | |
---|
56 | <div class="document"> |
---|
57 | <div class="documentwrapper"> |
---|
58 | <div class="bodywrapper"> |
---|
59 | <div class="body"> |
---|
60 | |
---|
61 | <div class="section" id="sas-perspectives-pr-package"> |
---|
62 | <h1>sas.perspectives.pr package</h1> |
---|
63 | <div class="section" id="submodules"> |
---|
64 | <h2>Submodules</h2> |
---|
65 | </div> |
---|
66 | <div class="section" id="module-sas.perspectives.pr.explore_dialog"> |
---|
67 | <span id="sas-perspectives-pr-explore-dialog-module"></span><h2>sas.perspectives.pr.explore_dialog module</h2> |
---|
68 | <p>Dialog panel to explore the P(r) inversion results for a range |
---|
69 | of D_max value. User picks a number of points and a range of |
---|
70 | distances, then can toggle between inversion outputs and see |
---|
71 | their distribution as a function of D_max.</p> |
---|
72 | <dl class="class"> |
---|
73 | <dt id="sas.perspectives.pr.explore_dialog.ExploreDialog"> |
---|
74 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.explore_dialog.</tt><tt class="descname">ExploreDialog</tt><big>(</big><em>pr_state</em>, <em>nfunc</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/explore_dialog.html#ExploreDialog"><span class="viewcode-link">[source]</span></a></dt> |
---|
75 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p> |
---|
76 | <p>The explorer dialog box. This dialog is meant to be |
---|
77 | invoked by the InversionControl class.</p> |
---|
78 | <dl class="class"> |
---|
79 | <dt id="sas.perspectives.pr.explore_dialog.ExploreDialog.Event"> |
---|
80 | <em class="property">class </em><tt class="descname">Event</tt><a class="reference internal" href="../../_modules/sas/perspectives/pr/explore_dialog.html#ExploreDialog.Event"><span class="viewcode-link">[source]</span></a></dt> |
---|
81 | <dd><p>Class that holds the content of the form</p> |
---|
82 | <dl class="attribute"> |
---|
83 | <dt id="sas.perspectives.pr.explore_dialog.ExploreDialog.Event.dmax"> |
---|
84 | <tt class="descname">dmax</tt><em class="property"> = 0</em></dt> |
---|
85 | <dd></dd></dl> |
---|
86 | |
---|
87 | <dl class="attribute"> |
---|
88 | <dt id="sas.perspectives.pr.explore_dialog.ExploreDialog.Event.dmin"> |
---|
89 | <tt class="descname">dmin</tt><em class="property"> = 0</em></dt> |
---|
90 | <dd></dd></dl> |
---|
91 | |
---|
92 | <dl class="attribute"> |
---|
93 | <dt id="sas.perspectives.pr.explore_dialog.ExploreDialog.Event.npts"> |
---|
94 | <tt class="descname">npts</tt><em class="property"> = 0</em></dt> |
---|
95 | <dd></dd></dl> |
---|
96 | |
---|
97 | </dd></dl> |
---|
98 | |
---|
99 | <dl class="method"> |
---|
100 | <dt id="sas.perspectives.pr.explore_dialog.ExploreDialog.set_plot_unfocus"> |
---|
101 | <tt class="descclassname">ExploreDialog.</tt><tt class="descname">set_plot_unfocus</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/explore_dialog.html#ExploreDialog.set_plot_unfocus"><span class="viewcode-link">[source]</span></a></dt> |
---|
102 | <dd><p>Not implemented</p> |
---|
103 | </dd></dl> |
---|
104 | |
---|
105 | </dd></dl> |
---|
106 | |
---|
107 | <dl class="class"> |
---|
108 | <dt id="sas.perspectives.pr.explore_dialog.OutputPlot"> |
---|
109 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.explore_dialog.</tt><tt class="descname">OutputPlot</tt><big>(</big><em>d_min</em>, <em>d_max</em>, <em>parent</em>, <em>id=-1</em>, <em>color=None</em>, <em>dpi=None</em>, <em>style=0</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/explore_dialog.html#OutputPlot"><span class="viewcode-link">[source]</span></a></dt> |
---|
110 | <dd><p>Bases: <a class="reference internal" href="sas.plottools.html#sas.plottools.PlotPanel.PlotPanel" title="sas.plottools.PlotPanel.PlotPanel"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.PlotPanel.PlotPanel</span></tt></a></p> |
---|
111 | <p>Plot panel used to show the selected results as a function |
---|
112 | of D_max</p> |
---|
113 | <dl class="method"> |
---|
114 | <dt id="sas.perspectives.pr.explore_dialog.OutputPlot.onContextMenu"> |
---|
115 | <tt class="descname">onContextMenu</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/explore_dialog.html#OutputPlot.onContextMenu"><span class="viewcode-link">[source]</span></a></dt> |
---|
116 | <dd><p>Default context menu for the plot panel</p> |
---|
117 | <table class="docutils field-list" frame="void" rules="none"> |
---|
118 | <col class="field-name" /> |
---|
119 | <col class="field-body" /> |
---|
120 | <tbody valign="top"> |
---|
121 | <tr class="field-odd field"><th class="field-name">TODO:</th><td class="field-body">Would be nice to add printing and log/linear scales. |
---|
122 | The current verison of plottools no longer plays well with |
---|
123 | plots outside of guiframe. Guiframe team needs to fix this.</td> |
---|
124 | </tr> |
---|
125 | </tbody> |
---|
126 | </table> |
---|
127 | </dd></dl> |
---|
128 | |
---|
129 | </dd></dl> |
---|
130 | |
---|
131 | <dl class="class"> |
---|
132 | <dt id="sas.perspectives.pr.explore_dialog.Results"> |
---|
133 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.explore_dialog.</tt><tt class="descname">Results</tt><a class="reference internal" href="../../_modules/sas/perspectives/pr/explore_dialog.html#Results"><span class="viewcode-link">[source]</span></a></dt> |
---|
134 | <dd><p>Class to hold the inversion output parameters |
---|
135 | as a function of D_max</p> |
---|
136 | </dd></dl> |
---|
137 | |
---|
138 | </div> |
---|
139 | <div class="section" id="module-sas.perspectives.pr.inversion_panel"> |
---|
140 | <span id="sas-perspectives-pr-inversion-panel-module"></span><h2>sas.perspectives.pr.inversion_panel module</h2> |
---|
141 | <dl class="class"> |
---|
142 | <dt id="sas.perspectives.pr.inversion_panel.HelpDialog"> |
---|
143 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.inversion_panel.</tt><tt class="descname">HelpDialog</tt><big>(</big><em>parent</em>, <em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#HelpDialog"><span class="viewcode-link">[source]</span></a></dt> |
---|
144 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p> |
---|
145 | </dd></dl> |
---|
146 | |
---|
147 | <dl class="class"> |
---|
148 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl"> |
---|
149 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.inversion_panel.</tt><tt class="descname">InversionControl</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>plots=None</em>, <em>standalone=False</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl"><span class="viewcode-link">[source]</span></a></dt> |
---|
150 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.scrolledpanel.ScrolledPanel</span></tt>, <a class="reference internal" href="sas.guiframe.html#sas.guiframe.panel_base.PanelBase" title="sas.guiframe.panel_base.PanelBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.panel_base.PanelBase</span></tt></a></p> |
---|
151 | <dl class="attribute"> |
---|
152 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.CENTER_PANE"> |
---|
153 | <tt class="descname">CENTER_PANE</tt><em class="property"> = True</em></dt> |
---|
154 | <dd></dd></dl> |
---|
155 | |
---|
156 | <dl class="method"> |
---|
157 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.clear_panel"> |
---|
158 | <tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.clear_panel"><span class="viewcode-link">[source]</span></a></dt> |
---|
159 | <dd></dd></dl> |
---|
160 | |
---|
161 | <dl class="method"> |
---|
162 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.get_data"> |
---|
163 | <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.get_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
164 | <dd></dd></dl> |
---|
165 | |
---|
166 | <dl class="method"> |
---|
167 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.get_state"> |
---|
168 | <tt class="descname">get_state</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.get_state"><span class="viewcode-link">[source]</span></a></dt> |
---|
169 | <dd><p>Get the current state</p> |
---|
170 | <p>: return: state object</p> |
---|
171 | </dd></dl> |
---|
172 | |
---|
173 | <dl class="method"> |
---|
174 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.on_reset"> |
---|
175 | <tt class="descname">on_reset</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.on_reset"><span class="viewcode-link">[source]</span></a></dt> |
---|
176 | <dd><p>Resets inversion parameters</p> |
---|
177 | </dd></dl> |
---|
178 | |
---|
179 | <dl class="method"> |
---|
180 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.on_save"> |
---|
181 | <tt class="descname">on_save</tt><big>(</big><em>evt=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.on_save"><span class="viewcode-link">[source]</span></a></dt> |
---|
182 | <dd><p>Method used to create a memento of the current state</p> |
---|
183 | <table class="docutils field-list" frame="void" rules="none"> |
---|
184 | <col class="field-name" /> |
---|
185 | <col class="field-body" /> |
---|
186 | <tbody valign="top"> |
---|
187 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">state object</td> |
---|
188 | </tr> |
---|
189 | </tbody> |
---|
190 | </table> |
---|
191 | </dd></dl> |
---|
192 | |
---|
193 | <dl class="attribute"> |
---|
194 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.oscillation_max"> |
---|
195 | <tt class="descname">oscillation_max</tt><em class="property"> = 1.5</em></dt> |
---|
196 | <dd></dd></dl> |
---|
197 | |
---|
198 | <dl class="method"> |
---|
199 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.save_project"> |
---|
200 | <tt class="descname">save_project</tt><big>(</big><em>doc=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.save_project"><span class="viewcode-link">[source]</span></a></dt> |
---|
201 | <dd><dl class="docutils"> |
---|
202 | <dt>return an xml node containing state of the panel</dt> |
---|
203 | <dd>that guiframe can write to file</dd> |
---|
204 | </dl> |
---|
205 | </dd></dl> |
---|
206 | |
---|
207 | <dl class="method"> |
---|
208 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.set_manager"> |
---|
209 | <tt class="descname">set_manager</tt><big>(</big><em>manager</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.set_manager"><span class="viewcode-link">[source]</span></a></dt> |
---|
210 | <dd></dd></dl> |
---|
211 | |
---|
212 | <dl class="method"> |
---|
213 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.set_state"> |
---|
214 | <tt class="descname">set_state</tt><big>(</big><em>state</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#InversionControl.set_state"><span class="viewcode-link">[source]</span></a></dt> |
---|
215 | <dd><p>Set the state of the panel and inversion problem to |
---|
216 | the state passed as a parameter. |
---|
217 | Execute the inversion immediately after filling the |
---|
218 | controls.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>state</strong> – InversionState object</td> |
---|
224 | </tr> |
---|
225 | </tbody> |
---|
226 | </table> |
---|
227 | </dd></dl> |
---|
228 | |
---|
229 | <dl class="attribute"> |
---|
230 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.window_caption"> |
---|
231 | <tt class="descname">window_caption</tt><em class="property"> = 'P(r) control panel'</em></dt> |
---|
232 | <dd></dd></dl> |
---|
233 | |
---|
234 | <dl class="attribute"> |
---|
235 | <dt id="sas.perspectives.pr.inversion_panel.InversionControl.window_name"> |
---|
236 | <tt class="descname">window_name</tt><em class="property"> = 'pr_control'</em></dt> |
---|
237 | <dd></dd></dl> |
---|
238 | |
---|
239 | </dd></dl> |
---|
240 | |
---|
241 | <dl class="class"> |
---|
242 | <dt id="sas.perspectives.pr.inversion_panel.PrDistDialog"> |
---|
243 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.inversion_panel.</tt><tt class="descname">PrDistDialog</tt><big>(</big><em>parent</em>, <em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#PrDistDialog"><span class="viewcode-link">[source]</span></a></dt> |
---|
244 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p> |
---|
245 | <p>Property dialog to let the user change the number |
---|
246 | of points on the P(r) plot.</p> |
---|
247 | <dl class="method"> |
---|
248 | <dt id="sas.perspectives.pr.inversion_panel.PrDistDialog.get_content"> |
---|
249 | <tt class="descname">get_content</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#PrDistDialog.get_content"><span class="viewcode-link">[source]</span></a></dt> |
---|
250 | <dd><p>Return the content of the dialog. |
---|
251 | At this point the values have already been |
---|
252 | checked.</p> |
---|
253 | </dd></dl> |
---|
254 | |
---|
255 | <dl class="method"> |
---|
256 | <dt id="sas.perspectives.pr.inversion_panel.PrDistDialog.set_content"> |
---|
257 | <tt class="descname">set_content</tt><big>(</big><em>npts</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_panel.html#PrDistDialog.set_content"><span class="viewcode-link">[source]</span></a></dt> |
---|
258 | <dd><p>Initialize the content of the dialog.</p> |
---|
259 | </dd></dl> |
---|
260 | |
---|
261 | </dd></dl> |
---|
262 | |
---|
263 | </div> |
---|
264 | <div class="section" id="module-sas.perspectives.pr.inversion_state"> |
---|
265 | <span id="sas-perspectives-pr-inversion-state-module"></span><h2>sas.perspectives.pr.inversion_state module</h2> |
---|
266 | <p>Handling of P(r) inversion states</p> |
---|
267 | <dl class="class"> |
---|
268 | <dt id="sas.perspectives.pr.inversion_state.InversionState"> |
---|
269 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.inversion_state.</tt><tt class="descname">InversionState</tt><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#InversionState"><span class="viewcode-link">[source]</span></a></dt> |
---|
270 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> |
---|
271 | <p>Class to hold the state information of the InversionControl panel.</p> |
---|
272 | <dl class="method"> |
---|
273 | <dt id="sas.perspectives.pr.inversion_state.InversionState.fromXML"> |
---|
274 | <tt class="descname">fromXML</tt><big>(</big><em>file=None</em>, <em>node=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#InversionState.fromXML"><span class="viewcode-link">[source]</span></a></dt> |
---|
275 | <dd><p>Load a P(r) inversion state from a file</p> |
---|
276 | <table class="docutils field-list" frame="void" rules="none"> |
---|
277 | <col class="field-name" /> |
---|
278 | <col class="field-body" /> |
---|
279 | <tbody valign="top"> |
---|
280 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
281 | <li><strong>file</strong> – .prv file</li> |
---|
282 | <li><strong>node</strong> – node of a XML document to read from</li> |
---|
283 | </ul> |
---|
284 | </td> |
---|
285 | </tr> |
---|
286 | </tbody> |
---|
287 | </table> |
---|
288 | </dd></dl> |
---|
289 | |
---|
290 | <dl class="method"> |
---|
291 | <dt id="sas.perspectives.pr.inversion_state.InversionState.toXML"> |
---|
292 | <tt class="descname">toXML</tt><big>(</big><em>file='pr_state.prv'</em>, <em>doc=None</em>, <em>entry_node=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#InversionState.toXML"><span class="viewcode-link">[source]</span></a></dt> |
---|
293 | <dd><p>Writes the state of the InversionControl panel to file, as XML.</p> |
---|
294 | <p>Compatible with standalone writing, or appending to an |
---|
295 | already existing XML document. In that case, the XML document |
---|
296 | is required. An optional entry node in the XML document |
---|
297 | may also be given.</p> |
---|
298 | <table class="docutils field-list" frame="void" rules="none"> |
---|
299 | <col class="field-name" /> |
---|
300 | <col class="field-body" /> |
---|
301 | <tbody valign="top"> |
---|
302 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
303 | <li><strong>file</strong> – file to write to</li> |
---|
304 | <li><strong>doc</strong> – XML document object [optional]</li> |
---|
305 | <li><strong>entry_node</strong> – XML node within the XML document at which |
---|
306 | we will append the data [optional]</li> |
---|
307 | </ul> |
---|
308 | </td> |
---|
309 | </tr> |
---|
310 | </tbody> |
---|
311 | </table> |
---|
312 | </dd></dl> |
---|
313 | |
---|
314 | </dd></dl> |
---|
315 | |
---|
316 | <dl class="class"> |
---|
317 | <dt id="sas.perspectives.pr.inversion_state.Reader"> |
---|
318 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.inversion_state.</tt><tt class="descname">Reader</tt><big>(</big><em>call_back</em>, <em>cansas=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#Reader"><span class="viewcode-link">[source]</span></a></dt> |
---|
319 | <dd><p>Bases: <a class="reference internal" href="sas.dataloader.readers.html#sas.dataloader.readers.cansas_reader.Reader" title="sas.dataloader.readers.cansas_reader.Reader"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.readers.cansas_reader.Reader</span></tt></a></p> |
---|
320 | <p>Class to load a .prv P(r) inversion file</p> |
---|
321 | <dl class="attribute"> |
---|
322 | <dt id="sas.perspectives.pr.inversion_state.Reader.ext"> |
---|
323 | <tt class="descname">ext</tt><em class="property"> = ['.prv', '.PRV', '.svs', '.SVS']</em></dt> |
---|
324 | <dd></dd></dl> |
---|
325 | |
---|
326 | <dl class="method"> |
---|
327 | <dt id="sas.perspectives.pr.inversion_state.Reader.read"> |
---|
328 | <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#Reader.read"><span class="viewcode-link">[source]</span></a></dt> |
---|
329 | <dd><p>Load a new P(r) inversion state from file</p> |
---|
330 | <table class="docutils field-list" frame="void" rules="none"> |
---|
331 | <col class="field-name" /> |
---|
332 | <col class="field-body" /> |
---|
333 | <tbody valign="top"> |
---|
334 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – file path</td> |
---|
335 | </tr> |
---|
336 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td> |
---|
337 | </tr> |
---|
338 | </tbody> |
---|
339 | </table> |
---|
340 | </dd></dl> |
---|
341 | |
---|
342 | <dl class="attribute"> |
---|
343 | <dt id="sas.perspectives.pr.inversion_state.Reader.type"> |
---|
344 | <tt class="descname">type</tt><em class="property"> = ['P(r) files (*.prv)|*.prv', 'SASView files (*.svs)|*.svs']</em></dt> |
---|
345 | <dd></dd></dl> |
---|
346 | |
---|
347 | <dl class="attribute"> |
---|
348 | <dt id="sas.perspectives.pr.inversion_state.Reader.type_name"> |
---|
349 | <tt class="descname">type_name</tt><em class="property"> = 'P(r)'</em></dt> |
---|
350 | <dd></dd></dl> |
---|
351 | |
---|
352 | <dl class="method"> |
---|
353 | <dt id="sas.perspectives.pr.inversion_state.Reader.write"> |
---|
354 | <tt class="descname">write</tt><big>(</big><em>filename</em>, <em>datainfo=None</em>, <em>prstate=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#Reader.write"><span class="viewcode-link">[source]</span></a></dt> |
---|
355 | <dd><p>Write the content of a Data1D as a CanSAS XML file</p> |
---|
356 | <table class="docutils field-list" frame="void" rules="none"> |
---|
357 | <col class="field-name" /> |
---|
358 | <col class="field-body" /> |
---|
359 | <tbody valign="top"> |
---|
360 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
361 | <li><strong>filename</strong> – name of the file to write</li> |
---|
362 | <li><strong>datainfo</strong> – Data1D object</li> |
---|
363 | <li><strong>prstate</strong> – InversionState object</li> |
---|
364 | </ul> |
---|
365 | </td> |
---|
366 | </tr> |
---|
367 | </tbody> |
---|
368 | </table> |
---|
369 | </dd></dl> |
---|
370 | |
---|
371 | <dl class="method"> |
---|
372 | <dt id="sas.perspectives.pr.inversion_state.Reader.write_toXML"> |
---|
373 | <tt class="descname">write_toXML</tt><big>(</big><em>datainfo=None</em>, <em>state=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/inversion_state.html#Reader.write_toXML"><span class="viewcode-link">[source]</span></a></dt> |
---|
374 | <dd><p>Write toXML, a helper for write()</p> |
---|
375 | <p>: return: xml doc</p> |
---|
376 | </dd></dl> |
---|
377 | |
---|
378 | </dd></dl> |
---|
379 | |
---|
380 | </div> |
---|
381 | <div class="section" id="module-sas.perspectives.pr.pr"> |
---|
382 | <span id="sas-perspectives-pr-pr-module"></span><h2>sas.perspectives.pr.pr module</h2> |
---|
383 | <dl class="class"> |
---|
384 | <dt id="sas.perspectives.pr.pr.Plugin"> |
---|
385 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr.</tt><tt class="descname">Plugin</tt><big>(</big><em>standalone=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin"><span class="viewcode-link">[source]</span></a></dt> |
---|
386 | <dd><p>Bases: <a class="reference internal" href="sas.guiframe.html#sas.guiframe.plugin_base.PluginBase" title="sas.guiframe.plugin_base.PluginBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.plugin_base.PluginBase</span></tt></a></p> |
---|
387 | <p>P(r) inversion perspective</p> |
---|
388 | <dl class="attribute"> |
---|
389 | <dt id="sas.perspectives.pr.pr.Plugin.DEFAULT_ALPHA"> |
---|
390 | <tt class="descname">DEFAULT_ALPHA</tt><em class="property"> = 0.0001</em></dt> |
---|
391 | <dd></dd></dl> |
---|
392 | |
---|
393 | <dl class="attribute"> |
---|
394 | <dt id="sas.perspectives.pr.pr.Plugin.DEFAULT_DMAX"> |
---|
395 | <tt class="descname">DEFAULT_DMAX</tt><em class="property"> = 140.0</em></dt> |
---|
396 | <dd></dd></dl> |
---|
397 | |
---|
398 | <dl class="attribute"> |
---|
399 | <dt id="sas.perspectives.pr.pr.Plugin.DEFAULT_NFUNC"> |
---|
400 | <tt class="descname">DEFAULT_NFUNC</tt><em class="property"> = 10</em></dt> |
---|
401 | <dd></dd></dl> |
---|
402 | |
---|
403 | <dl class="method"> |
---|
404 | <dt id="sas.perspectives.pr.pr.Plugin.delete_data"> |
---|
405 | <tt class="descname">delete_data</tt><big>(</big><em>data_id</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.delete_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
406 | <dd><p>delete the data association with prview</p> |
---|
407 | </dd></dl> |
---|
408 | |
---|
409 | <dl class="method"> |
---|
410 | <dt id="sas.perspectives.pr.pr.Plugin.estimate_file_inversion"> |
---|
411 | <tt class="descname">estimate_file_inversion</tt><big>(</big><em>alpha</em>, <em>nfunc</em>, <em>d_max</em>, <em>data</em>, <em>path=None</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="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.estimate_file_inversion"><span class="viewcode-link">[source]</span></a></dt> |
---|
412 | <dd></dd></dl> |
---|
413 | |
---|
414 | <dl class="method"> |
---|
415 | <dt id="sas.perspectives.pr.pr.Plugin.estimate_plot_inversion"> |
---|
416 | <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="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.estimate_plot_inversion"><span class="viewcode-link">[source]</span></a></dt> |
---|
417 | <dd></dd></dl> |
---|
418 | |
---|
419 | <dl class="method"> |
---|
420 | <dt id="sas.perspectives.pr.pr.Plugin.get_context_menu"> |
---|
421 | <tt class="descname">get_context_menu</tt><big>(</big><em>plotpanel=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.get_context_menu"><span class="viewcode-link">[source]</span></a></dt> |
---|
422 | <dd><p>Get the context menu items available for P(r)</p> |
---|
423 | <table class="docutils field-list" frame="void" rules="none"> |
---|
424 | <col class="field-name" /> |
---|
425 | <col class="field-body" /> |
---|
426 | <tbody valign="top"> |
---|
427 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> – the Graph object to which we attach the context menu</td> |
---|
428 | </tr> |
---|
429 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td> |
---|
430 | </tr> |
---|
431 | </tbody> |
---|
432 | </table> |
---|
433 | </dd></dl> |
---|
434 | |
---|
435 | <dl class="method"> |
---|
436 | <dt id="sas.perspectives.pr.pr.Plugin.get_data"> |
---|
437 | <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.get_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
438 | <dd><p>Returns the current data</p> |
---|
439 | </dd></dl> |
---|
440 | |
---|
441 | <dl class="method"> |
---|
442 | <dt id="sas.perspectives.pr.pr.Plugin.get_npts"> |
---|
443 | <tt class="descname">get_npts</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.get_npts"><span class="viewcode-link">[source]</span></a></dt> |
---|
444 | <dd><p>Returns the number of points in the I(q) data</p> |
---|
445 | </dd></dl> |
---|
446 | |
---|
447 | <dl class="method"> |
---|
448 | <dt id="sas.perspectives.pr.pr.Plugin.get_panels"> |
---|
449 | <tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.get_panels"><span class="viewcode-link">[source]</span></a></dt> |
---|
450 | <dd><p>Create and return a list of panel objects</p> |
---|
451 | </dd></dl> |
---|
452 | |
---|
453 | <dl class="method"> |
---|
454 | <dt id="sas.perspectives.pr.pr.Plugin.help"> |
---|
455 | <tt class="descname">help</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.help"><span class="viewcode-link">[source]</span></a></dt> |
---|
456 | <dd><p>Show a general help dialog.</p> |
---|
457 | <table class="docutils field-list" frame="void" rules="none"> |
---|
458 | <col class="field-name" /> |
---|
459 | <col class="field-body" /> |
---|
460 | <tbody valign="top"> |
---|
461 | <tr class="field-odd field"><th class="field-name">TODO:</th><td class="field-body">replace the text with a nice image</td> |
---|
462 | </tr> |
---|
463 | </tbody> |
---|
464 | </table> |
---|
465 | </dd></dl> |
---|
466 | |
---|
467 | <dl class="method"> |
---|
468 | <dt id="sas.perspectives.pr.pr.Plugin.load"> |
---|
469 | <tt class="descname">load</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.load"><span class="viewcode-link">[source]</span></a></dt> |
---|
470 | <dd><p>Load data. This will eventually be replaced |
---|
471 | by our standard DataLoader class.</p> |
---|
472 | </dd></dl> |
---|
473 | |
---|
474 | <dl class="method"> |
---|
475 | <dt id="sas.perspectives.pr.pr.Plugin.load_abs"> |
---|
476 | <tt class="descname">load_abs</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.load_abs"><span class="viewcode-link">[source]</span></a></dt> |
---|
477 | <dd><p>Load an IGOR .ABS reduced file</p> |
---|
478 | <table class="docutils field-list" frame="void" rules="none"> |
---|
479 | <col class="field-name" /> |
---|
480 | <col class="field-body" /> |
---|
481 | <tbody valign="top"> |
---|
482 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – file path</td> |
---|
483 | </tr> |
---|
484 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">x, y, err vectors</td> |
---|
485 | </tr> |
---|
486 | </tbody> |
---|
487 | </table> |
---|
488 | </dd></dl> |
---|
489 | |
---|
490 | <dl class="method"> |
---|
491 | <dt id="sas.perspectives.pr.pr.Plugin.load_columns"> |
---|
492 | <tt class="descname">load_columns</tt><big>(</big><em>path='sphere_60_q0_2.txt'</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.load_columns"><span class="viewcode-link">[source]</span></a></dt> |
---|
493 | <dd><p>Load 2- or 3- column ascii</p> |
---|
494 | </dd></dl> |
---|
495 | |
---|
496 | <dl class="method"> |
---|
497 | <dt id="sas.perspectives.pr.pr.Plugin.perform_estimate"> |
---|
498 | <tt class="descname">perform_estimate</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.perform_estimate"><span class="viewcode-link">[source]</span></a></dt> |
---|
499 | <dd></dd></dl> |
---|
500 | |
---|
501 | <dl class="method"> |
---|
502 | <dt id="sas.perspectives.pr.pr.Plugin.perform_estimateNT"> |
---|
503 | <tt class="descname">perform_estimateNT</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.perform_estimateNT"><span class="viewcode-link">[source]</span></a></dt> |
---|
504 | <dd></dd></dl> |
---|
505 | |
---|
506 | <dl class="method"> |
---|
507 | <dt id="sas.perspectives.pr.pr.Plugin.perform_inversion"> |
---|
508 | <tt class="descname">perform_inversion</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.perform_inversion"><span class="viewcode-link">[source]</span></a></dt> |
---|
509 | <dd></dd></dl> |
---|
510 | |
---|
511 | <dl class="method"> |
---|
512 | <dt id="sas.perspectives.pr.pr.Plugin.post_init"> |
---|
513 | <tt class="descname">post_init</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.post_init"><span class="viewcode-link">[source]</span></a></dt> |
---|
514 | <dd><p>Post initialization call back to close the loose ends |
---|
515 | [Somehow openGL needs this call]</p> |
---|
516 | </dd></dl> |
---|
517 | |
---|
518 | <dl class="method"> |
---|
519 | <dt id="sas.perspectives.pr.pr.Plugin.pr_theory"> |
---|
520 | <tt class="descname">pr_theory</tt><big>(</big><em>r</em>, <em>R</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.pr_theory"><span class="viewcode-link">[source]</span></a></dt> |
---|
521 | <dd><p>Return P(r) of a sphere for a given R |
---|
522 | For test purposes</p> |
---|
523 | </dd></dl> |
---|
524 | |
---|
525 | <dl class="method"> |
---|
526 | <dt id="sas.perspectives.pr.pr.Plugin.save_data"> |
---|
527 | <tt class="descname">save_data</tt><big>(</big><em>filepath</em>, <em>prstate=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.save_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
528 | <dd><p>Save data in provided state object.</p> |
---|
529 | <table class="docutils field-list" frame="void" rules="none"> |
---|
530 | <col class="field-name" /> |
---|
531 | <col class="field-body" /> |
---|
532 | <tbody valign="top"> |
---|
533 | <tr class="field-odd 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. |
---|
534 | Then remove the “prstate” input and make this method private.</p> |
---|
535 | </td> |
---|
536 | </tr> |
---|
537 | <tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
538 | <li><strong>filepath</strong> – path of file to write to</li> |
---|
539 | <li><strong>prstate</strong> – P(r) inversion state</li> |
---|
540 | </ul> |
---|
541 | </td> |
---|
542 | </tr> |
---|
543 | </tbody> |
---|
544 | </table> |
---|
545 | </dd></dl> |
---|
546 | |
---|
547 | <dl class="method"> |
---|
548 | <dt id="sas.perspectives.pr.pr.Plugin.set_data"> |
---|
549 | <tt class="descname">set_data</tt><big>(</big><em>data_list=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.set_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
550 | <dd><p>receive a list of data to compute pr</p> |
---|
551 | </dd></dl> |
---|
552 | |
---|
553 | <dl class="method"> |
---|
554 | <dt id="sas.perspectives.pr.pr.Plugin.set_state"> |
---|
555 | <tt class="descname">set_state</tt><big>(</big><em>state=None</em>, <em>datainfo=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.set_state"><span class="viewcode-link">[source]</span></a></dt> |
---|
556 | <dd><p>Call-back method for the inversion state reader. |
---|
557 | This method is called when a .prv file is loaded.</p> |
---|
558 | <table class="docutils field-list" frame="void" rules="none"> |
---|
559 | <col class="field-name" /> |
---|
560 | <col class="field-body" /> |
---|
561 | <tbody valign="top"> |
---|
562 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
563 | <li><strong>state</strong> – InversionState object</li> |
---|
564 | <li><strong>datainfo</strong> – Data1D object [optional]</li> |
---|
565 | </ul> |
---|
566 | </td> |
---|
567 | </tr> |
---|
568 | </tbody> |
---|
569 | </table> |
---|
570 | </dd></dl> |
---|
571 | |
---|
572 | <dl class="method"> |
---|
573 | <dt id="sas.perspectives.pr.pr.Plugin.setup_file_inversion"> |
---|
574 | <tt class="descname">setup_file_inversion</tt><big>(</big><em>alpha</em>, <em>nfunc</em>, <em>d_max</em>, <em>data</em>, <em>path=None</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="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.setup_file_inversion"><span class="viewcode-link">[source]</span></a></dt> |
---|
575 | <dd></dd></dl> |
---|
576 | |
---|
577 | <dl class="method"> |
---|
578 | <dt id="sas.perspectives.pr.pr.Plugin.setup_plot_inversion"> |
---|
579 | <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="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.setup_plot_inversion"><span class="viewcode-link">[source]</span></a></dt> |
---|
580 | <dd></dd></dl> |
---|
581 | |
---|
582 | <dl class="method"> |
---|
583 | <dt id="sas.perspectives.pr.pr.Plugin.show_data"> |
---|
584 | <tt class="descname">show_data</tt><big>(</big><em>path=None</em>, <em>data=None</em>, <em>reset=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.show_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
585 | <dd><p>Show data read from a file</p> |
---|
586 | <table class="docutils field-list" frame="void" rules="none"> |
---|
587 | <col class="field-name" /> |
---|
588 | <col class="field-body" /> |
---|
589 | <tbody valign="top"> |
---|
590 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
591 | <li><strong>path</strong> – file path</li> |
---|
592 | <li><strong>reset</strong> – if True all other plottables will be cleared</li> |
---|
593 | </ul> |
---|
594 | </td> |
---|
595 | </tr> |
---|
596 | </tbody> |
---|
597 | </table> |
---|
598 | </dd></dl> |
---|
599 | |
---|
600 | <dl class="method"> |
---|
601 | <dt id="sas.perspectives.pr.pr.Plugin.show_iq"> |
---|
602 | <tt class="descname">show_iq</tt><big>(</big><em>out</em>, <em>pr</em>, <em>q=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.show_iq"><span class="viewcode-link">[source]</span></a></dt> |
---|
603 | <dd></dd></dl> |
---|
604 | |
---|
605 | <dl class="method"> |
---|
606 | <dt id="sas.perspectives.pr.pr.Plugin.show_pr"> |
---|
607 | <tt class="descname">show_pr</tt><big>(</big><em>out</em>, <em>pr</em>, <em>cov=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.show_pr"><span class="viewcode-link">[source]</span></a></dt> |
---|
608 | <dd></dd></dl> |
---|
609 | |
---|
610 | <dl class="method"> |
---|
611 | <dt id="sas.perspectives.pr.pr.Plugin.show_shpere"> |
---|
612 | <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="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.show_shpere"><span class="viewcode-link">[source]</span></a></dt> |
---|
613 | <dd></dd></dl> |
---|
614 | |
---|
615 | <dl class="method"> |
---|
616 | <dt id="sas.perspectives.pr.pr.Plugin.start_thread"> |
---|
617 | <tt class="descname">start_thread</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr.html#Plugin.start_thread"><span class="viewcode-link">[source]</span></a></dt> |
---|
618 | <dd></dd></dl> |
---|
619 | |
---|
620 | </dd></dl> |
---|
621 | |
---|
622 | </div> |
---|
623 | <div class="section" id="module-sas.perspectives.pr.pr_thread"> |
---|
624 | <span id="sas-perspectives-pr-pr-thread-module"></span><h2>sas.perspectives.pr.pr_thread module</h2> |
---|
625 | <dl class="class"> |
---|
626 | <dt id="sas.perspectives.pr.pr_thread.CalcPr"> |
---|
627 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_thread.</tt><tt class="descname">CalcPr</tt><big>(</big><em>pr</em>, <em>nfunc=5</em>, <em>error_func=None</em>, <em>completefn=None</em>, <em>updatefn=None</em>, <em>yieldtime=0.01</em>, <em>worktime=0.01</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#CalcPr"><span class="viewcode-link">[source]</span></a></dt> |
---|
628 | <dd><p>Bases: <a class="reference internal" href="sas.data_util.html#sas.data_util.calcthread.CalcThread" title="sas.data_util.calcthread.CalcThread"><tt class="xref py py-class docutils literal"><span class="pre">sas.data_util.calcthread.CalcThread</span></tt></a></p> |
---|
629 | <p>Compute P(r)</p> |
---|
630 | <dl class="method"> |
---|
631 | <dt id="sas.perspectives.pr.pr_thread.CalcPr.compute"> |
---|
632 | <tt class="descname">compute</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#CalcPr.compute"><span class="viewcode-link">[source]</span></a></dt> |
---|
633 | <dd><p>Perform P(r) inversion</p> |
---|
634 | </dd></dl> |
---|
635 | |
---|
636 | </dd></dl> |
---|
637 | |
---|
638 | <dl class="class"> |
---|
639 | <dt id="sas.perspectives.pr.pr_thread.EstimateNT"> |
---|
640 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_thread.</tt><tt class="descname">EstimateNT</tt><big>(</big><em>pr</em>, <em>nfunc=5</em>, <em>error_func=None</em>, <em>completefn=None</em>, <em>updatefn=None</em>, <em>yieldtime=0.01</em>, <em>worktime=0.01</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#EstimateNT"><span class="viewcode-link">[source]</span></a></dt> |
---|
641 | <dd><p>Bases: <a class="reference internal" href="sas.data_util.html#sas.data_util.calcthread.CalcThread" title="sas.data_util.calcthread.CalcThread"><tt class="xref py py-class docutils literal"><span class="pre">sas.data_util.calcthread.CalcThread</span></tt></a></p> |
---|
642 | <dl class="method"> |
---|
643 | <dt id="sas.perspectives.pr.pr_thread.EstimateNT.compute"> |
---|
644 | <tt class="descname">compute</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#EstimateNT.compute"><span class="viewcode-link">[source]</span></a></dt> |
---|
645 | <dd><p>Calculates the estimate</p> |
---|
646 | </dd></dl> |
---|
647 | |
---|
648 | <dl class="method"> |
---|
649 | <dt id="sas.perspectives.pr.pr_thread.EstimateNT.isquit"> |
---|
650 | <tt class="descname">isquit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#EstimateNT.isquit"><span class="viewcode-link">[source]</span></a></dt> |
---|
651 | <dd></dd></dl> |
---|
652 | |
---|
653 | </dd></dl> |
---|
654 | |
---|
655 | <dl class="class"> |
---|
656 | <dt id="sas.perspectives.pr.pr_thread.EstimatePr"> |
---|
657 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_thread.</tt><tt class="descname">EstimatePr</tt><big>(</big><em>pr</em>, <em>nfunc=5</em>, <em>error_func=None</em>, <em>completefn=None</em>, <em>updatefn=None</em>, <em>yieldtime=0.01</em>, <em>worktime=0.01</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#EstimatePr"><span class="viewcode-link">[source]</span></a></dt> |
---|
658 | <dd><p>Bases: <a class="reference internal" href="sas.data_util.html#sas.data_util.calcthread.CalcThread" title="sas.data_util.calcthread.CalcThread"><tt class="xref py py-class docutils literal"><span class="pre">sas.data_util.calcthread.CalcThread</span></tt></a></p> |
---|
659 | <p>Estimate P(r)</p> |
---|
660 | <dl class="method"> |
---|
661 | <dt id="sas.perspectives.pr.pr_thread.EstimatePr.compute"> |
---|
662 | <tt class="descname">compute</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_thread.html#EstimatePr.compute"><span class="viewcode-link">[source]</span></a></dt> |
---|
663 | <dd><p>Calculates the estimate</p> |
---|
664 | </dd></dl> |
---|
665 | |
---|
666 | </dd></dl> |
---|
667 | |
---|
668 | </div> |
---|
669 | <div class="section" id="module-sas.perspectives.pr.pr_widgets"> |
---|
670 | <span id="sas-perspectives-pr-pr-widgets-module"></span><h2>sas.perspectives.pr.pr_widgets module</h2> |
---|
671 | <p>Text controls for input/output of the main PrView panel</p> |
---|
672 | <dl class="class"> |
---|
673 | <dt id="sas.perspectives.pr.pr_widgets.DataDialog"> |
---|
674 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_widgets.</tt><tt class="descname">DataDialog</tt><big>(</big><em>data_list</em>, <em>parent=None</em>, <em>text=''</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#DataDialog"><span class="viewcode-link">[source]</span></a></dt> |
---|
675 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p> |
---|
676 | <p>Allow file selection at loading time</p> |
---|
677 | <dl class="method"> |
---|
678 | <dt id="sas.perspectives.pr.pr_widgets.DataDialog.get_data"> |
---|
679 | <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#DataDialog.get_data"><span class="viewcode-link">[source]</span></a></dt> |
---|
680 | <dd><p>return the selected data</p> |
---|
681 | </dd></dl> |
---|
682 | |
---|
683 | </dd></dl> |
---|
684 | |
---|
685 | <dl class="class"> |
---|
686 | <dt id="sas.perspectives.pr.pr_widgets.DataFileTextCtrl"> |
---|
687 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_widgets.</tt><tt class="descname">DataFileTextCtrl</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#DataFileTextCtrl"><span class="viewcode-link">[source]</span></a></dt> |
---|
688 | <dd><p>Bases: <a class="reference internal" href="#sas.perspectives.pr.pr_widgets.OutputTextCtrl" title="sas.perspectives.pr.pr_widgets.OutputTextCtrl"><tt class="xref py py-class docutils literal"><span class="pre">sas.perspectives.pr.pr_widgets.OutputTextCtrl</span></tt></a></p> |
---|
689 | <p>Text control used to display only the file name |
---|
690 | given a full path.</p> |
---|
691 | <table class="docutils field-list" frame="void" rules="none"> |
---|
692 | <col class="field-name" /> |
---|
693 | <col class="field-body" /> |
---|
694 | <tbody valign="top"> |
---|
695 | <tr class="field-odd field"><th class="field-name">TODO:</th><td class="field-body">now that we no longer choose the data file from the panel, |
---|
696 | it’s no longer necessary to pass around the file path. That code |
---|
697 | should be refactored away and simplified.</td> |
---|
698 | </tr> |
---|
699 | </tbody> |
---|
700 | </table> |
---|
701 | <dl class="method"> |
---|
702 | <dt id="sas.perspectives.pr.pr_widgets.DataFileTextCtrl.GetValue"> |
---|
703 | <tt class="descname">GetValue</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#DataFileTextCtrl.GetValue"><span class="viewcode-link">[source]</span></a></dt> |
---|
704 | <dd><p>Return the full path</p> |
---|
705 | </dd></dl> |
---|
706 | |
---|
707 | <dl class="method"> |
---|
708 | <dt id="sas.perspectives.pr.pr_widgets.DataFileTextCtrl.SetValue"> |
---|
709 | <tt class="descname">SetValue</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#DataFileTextCtrl.SetValue"><span class="viewcode-link">[source]</span></a></dt> |
---|
710 | <dd><p>Sets the file name given a path</p> |
---|
711 | </dd></dl> |
---|
712 | |
---|
713 | </dd></dl> |
---|
714 | |
---|
715 | <dl class="class"> |
---|
716 | <dt id="sas.perspectives.pr.pr_widgets.DialogPanel"> |
---|
717 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_widgets.</tt><tt class="descname">DialogPanel</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#DialogPanel"><span class="viewcode-link">[source]</span></a></dt> |
---|
718 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx.lib.scrolledpanel.ScrolledPanel</span></tt></p> |
---|
719 | </dd></dl> |
---|
720 | |
---|
721 | <dl class="class"> |
---|
722 | <dt id="sas.perspectives.pr.pr_widgets.OutputTextCtrl"> |
---|
723 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_widgets.</tt><tt class="descname">OutputTextCtrl</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#OutputTextCtrl"><span class="viewcode-link">[source]</span></a></dt> |
---|
724 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._controls.TextCtrl</span></tt></p> |
---|
725 | <p>Text control used to display outputs. |
---|
726 | No editing allowed. The background is |
---|
727 | grayed out. User can’t select text.</p> |
---|
728 | </dd></dl> |
---|
729 | |
---|
730 | <dl class="class"> |
---|
731 | <dt id="sas.perspectives.pr.pr_widgets.PrTextCtrl"> |
---|
732 | <em class="property">class </em><tt class="descclassname">sas.perspectives.pr.pr_widgets.</tt><tt class="descname">PrTextCtrl</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#PrTextCtrl"><span class="viewcode-link">[source]</span></a></dt> |
---|
733 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._controls.TextCtrl</span></tt></p> |
---|
734 | <p>Text control for model and fit parameters. |
---|
735 | Binds the appropriate events for user interactions.</p> |
---|
736 | </dd></dl> |
---|
737 | |
---|
738 | <dl class="function"> |
---|
739 | <dt id="sas.perspectives.pr.pr_widgets.load_error"> |
---|
740 | <tt class="descclassname">sas.perspectives.pr.pr_widgets.</tt><tt class="descname">load_error</tt><big>(</big><em>error=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/pr/pr_widgets.html#load_error"><span class="viewcode-link">[source]</span></a></dt> |
---|
741 | <dd><p>Pop up an error message.</p> |
---|
742 | <table class="docutils field-list" frame="void" rules="none"> |
---|
743 | <col class="field-name" /> |
---|
744 | <col class="field-body" /> |
---|
745 | <tbody valign="top"> |
---|
746 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error</strong> – details error message to be displayed</td> |
---|
747 | </tr> |
---|
748 | </tbody> |
---|
749 | </table> |
---|
750 | </dd></dl> |
---|
751 | |
---|
752 | </div> |
---|
753 | <div class="section" id="module-sas.perspectives.pr"> |
---|
754 | <span id="module-contents"></span><h2>Module contents</h2> |
---|
755 | </div> |
---|
756 | </div> |
---|
757 | |
---|
758 | |
---|
759 | </div> |
---|
760 | </div> |
---|
761 | </div> |
---|
762 | <div class="sphinxsidebar"> |
---|
763 | <div class="sphinxsidebarwrapper"> |
---|
764 | <h3><a href="../../index.html">Table Of Contents</a></h3> |
---|
765 | <ul> |
---|
766 | <li><a class="reference internal" href="#">sas.perspectives.pr package</a><ul> |
---|
767 | <li><a class="reference internal" href="#submodules">Submodules</a></li> |
---|
768 | <li><a class="reference internal" href="#module-sas.perspectives.pr.explore_dialog">sas.perspectives.pr.explore_dialog module</a></li> |
---|
769 | <li><a class="reference internal" href="#module-sas.perspectives.pr.inversion_panel">sas.perspectives.pr.inversion_panel module</a></li> |
---|
770 | <li><a class="reference internal" href="#module-sas.perspectives.pr.inversion_state">sas.perspectives.pr.inversion_state module</a></li> |
---|
771 | <li><a class="reference internal" href="#module-sas.perspectives.pr.pr">sas.perspectives.pr.pr module</a></li> |
---|
772 | <li><a class="reference internal" href="#module-sas.perspectives.pr.pr_thread">sas.perspectives.pr.pr_thread module</a></li> |
---|
773 | <li><a class="reference internal" href="#module-sas.perspectives.pr.pr_widgets">sas.perspectives.pr.pr_widgets module</a></li> |
---|
774 | <li><a class="reference internal" href="#module-sas.perspectives.pr">Module contents</a></li> |
---|
775 | </ul> |
---|
776 | </li> |
---|
777 | </ul> |
---|
778 | |
---|
779 | <h4>Previous topic</h4> |
---|
780 | <p class="topless"><a href="sas.perspectives.invariant.html" |
---|
781 | title="previous chapter">sas.perspectives.invariant package</a></p> |
---|
782 | <h4>Next topic</h4> |
---|
783 | <p class="topless"><a href="sas.plottools.html" |
---|
784 | title="next chapter">sas.plottools package</a></p> |
---|
785 | <h3>This Page</h3> |
---|
786 | <ul class="this-page-menu"> |
---|
787 | <li><a href="../../_sources/dev/api/sas.perspectives.pr.txt" |
---|
788 | rel="nofollow">Show Source</a></li> |
---|
789 | </ul> |
---|
790 | <div id="searchbox" style="display: none"> |
---|
791 | <h3>Quick search</h3> |
---|
792 | <form class="search" action="../../search.html" method="get"> |
---|
793 | <input type="text" name="q" /> |
---|
794 | <input type="submit" value="Go" /> |
---|
795 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
796 | <input type="hidden" name="area" value="default" /> |
---|
797 | </form> |
---|
798 | <p class="searchtip" style="font-size: 90%"> |
---|
799 | Enter search terms or a module, class or function name. |
---|
800 | </p> |
---|
801 | </div> |
---|
802 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
803 | </div> |
---|
804 | </div> |
---|
805 | <div class="clearer"></div> |
---|
806 | </div> |
---|
807 | <div class="related"> |
---|
808 | <h3>Navigation</h3> |
---|
809 | <ul> |
---|
810 | <li class="right" style="margin-right: 10px"> |
---|
811 | <a href="../../genindex.html" title="General Index" |
---|
812 | >index</a></li> |
---|
813 | <li class="right" > |
---|
814 | <a href="../../py-modindex.html" title="Python Module Index" |
---|
815 | >modules</a> |</li> |
---|
816 | <li class="right" > |
---|
817 | <a href="sas.plottools.html" title="sas.plottools package" |
---|
818 | >next</a> |</li> |
---|
819 | <li class="right" > |
---|
820 | <a href="sas.perspectives.invariant.html" title="sas.perspectives.invariant package" |
---|
821 | >previous</a> |</li> |
---|
822 | <li><a href="../../index.html">SasView 3.0.0 documentation</a> »</li> |
---|
823 | <li><a href="../dev.html" >Developer Documentation</a> »</li> |
---|
824 | <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> »</li> |
---|
825 | <li><a href="sas.html" >sas package</a> »</li> |
---|
826 | <li><a href="sas.perspectives.html" >sas.perspectives package</a> »</li> |
---|
827 | </ul> |
---|
828 | </div> |
---|
829 | <div class="footer"> |
---|
830 | © Copyright 2013, The SasView Project. |
---|
831 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. |
---|
832 | </div> |
---|
833 | </body> |
---|
834 | </html> |
---|