[242eba5] | 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 | |
---|
[40299ce] | 6 | |
---|
[242eba5] | 7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 8 | <head> |
---|
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 10 | |
---|
[40299ce] | 11 | <title>pr — prview 0.1.0 documentation</title> |
---|
| 12 | |
---|
[242eba5] | 13 | <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> |
---|
| 14 | <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
---|
[40299ce] | 15 | |
---|
[242eba5] | 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> |
---|
[40299ce] | 28 | <link rel="top" title="prview 0.1.0 documentation" href="../../../index.html" /> |
---|
[242eba5] | 29 | <link rel="up" title="Reference" href="index.html" /> |
---|
[40299ce] | 30 | <link rel="next" title="pr_thread" href="pr_thread.html" /> |
---|
| 31 | <link rel="prev" title="inversion_state" href="inversion_state.html" /> |
---|
[242eba5] | 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" > |
---|
[40299ce] | 41 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 42 | >modules</a> |</li> |
---|
| 43 | <li class="right" > |
---|
| 44 | <a href="pr_thread.html" title="pr_thread" |
---|
| 45 | accesskey="N">next</a> |</li> |
---|
| 46 | <li class="right" > |
---|
| 47 | <a href="inversion_state.html" title="inversion_state" |
---|
[242eba5] | 48 | accesskey="P">previous</a> |</li> |
---|
[40299ce] | 49 | <li><a href="../../../index.html">prview 0.1.0 documentation</a> »</li> |
---|
[242eba5] | 50 | <li><a href="index.html" accesskey="U">Reference</a> »</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="pr"> |
---|
| 60 | <h1>pr<a class="headerlink" href="#pr" title="Permalink to this headline">¶</a></h1> |
---|
| 61 | <div class="section" id="sans-perspectives-pr-pr"> |
---|
[40299ce] | 62 | <h2><a class="reference internal" href="#module-sans.perspectives.pr.pr" title="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="#sans-perspectives-pr-pr" title="Permalink to this headline">¶</a></h2> |
---|
| 63 | <span class="target" id="module-sans.perspectives.pr.pr"></span><dl class="class"> |
---|
| 64 | <dt id="sans.perspectives.pr.pr.Plugin"> |
---|
| 65 | <em class="property">class </em><tt class="descclassname">sans.perspectives.pr.pr.</tt><tt class="descname">Plugin</tt><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin" title="Permalink to this definition">¶</a></dt> |
---|
| 66 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.plugin_base.PluginBase</span></tt></p> |
---|
| 67 | <dl class="attribute"> |
---|
| 68 | <dt id="sans.perspectives.pr.pr.Plugin.DEFAULT_ALPHA"> |
---|
| 69 | <tt class="descname">DEFAULT_ALPHA</tt><em class="property"> = 0.0001</em><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.DEFAULT_ALPHA" title="Permalink to this definition">¶</a></dt> |
---|
| 70 | <dd></dd></dl> |
---|
| 71 | |
---|
| 72 | <dl class="attribute"> |
---|
| 73 | <dt id="sans.perspectives.pr.pr.Plugin.DEFAULT_DMAX"> |
---|
| 74 | <tt class="descname">DEFAULT_DMAX</tt><em class="property"> = 140.0</em><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.DEFAULT_DMAX" title="Permalink to this definition">¶</a></dt> |
---|
| 75 | <dd></dd></dl> |
---|
| 76 | |
---|
| 77 | <dl class="attribute"> |
---|
| 78 | <dt id="sans.perspectives.pr.pr.Plugin.DEFAULT_NFUNC"> |
---|
| 79 | <tt class="descname">DEFAULT_NFUNC</tt><em class="property"> = 10</em><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.DEFAULT_NFUNC" title="Permalink to this definition">¶</a></dt> |
---|
| 80 | <dd></dd></dl> |
---|
| 81 | |
---|
| 82 | <dl class="method"> |
---|
| 83 | <dt id="sans.perspectives.pr.pr.Plugin.add_color"> |
---|
| 84 | <tt class="descname">add_color</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.add_color" title="Permalink to this definition">¶</a></dt> |
---|
| 85 | <dd><p>Adds color to a plugin</p> |
---|
| 86 | </dd></dl> |
---|
| 87 | |
---|
| 88 | <dl class="method"> |
---|
| 89 | <dt id="sans.perspectives.pr.pr.Plugin.can_load_data"> |
---|
| 90 | <tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.can_load_data" title="Permalink to this definition">¶</a></dt> |
---|
| 91 | <dd><p>if return True, then call handler to laod data</p> |
---|
| 92 | </dd></dl> |
---|
| 93 | |
---|
| 94 | <dl class="method"> |
---|
| 95 | <dt id="sans.perspectives.pr.pr.Plugin.clear_panel"> |
---|
| 96 | <tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.clear_panel" title="Permalink to this definition">¶</a></dt> |
---|
| 97 | <dd><p>clear all related panels</p> |
---|
| 98 | </dd></dl> |
---|
| 99 | |
---|
| 100 | <dl class="method"> |
---|
| 101 | <dt id="sans.perspectives.pr.pr.Plugin.delete_data"> |
---|
| 102 | <tt class="descname">delete_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.delete_data" title="Permalink to this definition">¶</a></dt> |
---|
| 103 | <dd><p>delete the data association with prview</p> |
---|
| 104 | </dd></dl> |
---|
| 105 | |
---|
| 106 | <dl class="method"> |
---|
| 107 | <dt id="sans.perspectives.pr.pr.Plugin.estimate_file_inversion"> |
---|
| 108 | <tt class="descname">estimate_file_inversion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.estimate_file_inversion" title="Permalink to this definition">¶</a></dt> |
---|
| 109 | <dd></dd></dl> |
---|
| 110 | |
---|
| 111 | <dl class="method"> |
---|
| 112 | <dt id="sans.perspectives.pr.pr.Plugin.estimate_plot_inversion"> |
---|
| 113 | <tt class="descname">estimate_plot_inversion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.estimate_plot_inversion" title="Permalink to this definition">¶</a></dt> |
---|
| 114 | <dd></dd></dl> |
---|
| 115 | |
---|
| 116 | <dl class="method"> |
---|
| 117 | <dt id="sans.perspectives.pr.pr.Plugin.get_batch_capable"> |
---|
| 118 | <tt class="descname">get_batch_capable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_batch_capable" title="Permalink to this definition">¶</a></dt> |
---|
| 119 | <dd><p>Check if the plugin has a batch capability</p> |
---|
| 120 | </dd></dl> |
---|
| 121 | |
---|
| 122 | <dl class="method"> |
---|
| 123 | <dt id="sans.perspectives.pr.pr.Plugin.get_context_menu"> |
---|
| 124 | <tt class="descname">get_context_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_context_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 125 | <dd><p>Get the context menu items available for P(r)</p> |
---|
| 126 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 127 | <col class="field-name" /> |
---|
| 128 | <col class="field-body" /> |
---|
| 129 | <tbody valign="top"> |
---|
| 130 | <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> |
---|
| 131 | </tr> |
---|
| 132 | <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> |
---|
| 133 | </tr> |
---|
| 134 | </tbody> |
---|
| 135 | </table> |
---|
| 136 | </dd></dl> |
---|
| 137 | |
---|
| 138 | <dl class="method"> |
---|
| 139 | <dt id="sans.perspectives.pr.pr.Plugin.get_data"> |
---|
| 140 | <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_data" title="Permalink to this definition">¶</a></dt> |
---|
| 141 | <dd></dd></dl> |
---|
| 142 | |
---|
| 143 | <dl class="method"> |
---|
| 144 | <dt id="sans.perspectives.pr.pr.Plugin.get_extensions"> |
---|
| 145 | <tt class="descname">get_extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_extensions" title="Permalink to this definition">¶</a></dt> |
---|
| 146 | <dd><p>return state reader and its extensions</p> |
---|
| 147 | </dd></dl> |
---|
| 148 | |
---|
| 149 | <dl class="method"> |
---|
| 150 | <dt id="sans.perspectives.pr.pr.Plugin.get_npts"> |
---|
| 151 | <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> |
---|
| 152 | <dd><p>Returns the number of points in the I(q) data</p> |
---|
| 153 | </dd></dl> |
---|
| 154 | |
---|
| 155 | <dl class="method"> |
---|
| 156 | <dt id="sans.perspectives.pr.pr.Plugin.get_panels"> |
---|
| 157 | <tt class="descname">get_panels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_panels" title="Permalink to this definition">¶</a></dt> |
---|
| 158 | <dd><p>Create and return a list of panel objects</p> |
---|
| 159 | </dd></dl> |
---|
| 160 | |
---|
| 161 | <dl class="method"> |
---|
| 162 | <dt id="sans.perspectives.pr.pr.Plugin.get_perspective"> |
---|
| 163 | <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> |
---|
| 164 | <dd><p>Get the list of panel names for this perspective</p> |
---|
| 165 | </dd></dl> |
---|
| 166 | |
---|
| 167 | <dl class="method"> |
---|
| 168 | <dt id="sans.perspectives.pr.pr.Plugin.get_tools"> |
---|
| 169 | <tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.get_tools" title="Permalink to this definition">¶</a></dt> |
---|
| 170 | <dd><p>Returns a set of menu entries for tools</p> |
---|
| 171 | </dd></dl> |
---|
| 172 | |
---|
| 173 | <dl class="method"> |
---|
| 174 | <dt id="sans.perspectives.pr.pr.Plugin.help"> |
---|
| 175 | <tt class="descname">help</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.help" title="Permalink to this definition">¶</a></dt> |
---|
| 176 | <dd><p>Show a general help dialog.</p> |
---|
| 177 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 178 | <col class="field-name" /> |
---|
| 179 | <col class="field-body" /> |
---|
| 180 | <tbody valign="top"> |
---|
| 181 | <tr class="field-odd field"><th class="field-name">Todo :</th><td class="field-body">replace the text with a nice image</td> |
---|
| 182 | </tr> |
---|
| 183 | </tbody> |
---|
| 184 | </table> |
---|
| 185 | </dd></dl> |
---|
| 186 | |
---|
| 187 | <dl class="method"> |
---|
| 188 | <dt id="sans.perspectives.pr.pr.Plugin.is_always_active"> |
---|
| 189 | <tt class="descname">is_always_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.is_always_active" title="Permalink to this definition">¶</a></dt> |
---|
| 190 | <dd><p>return True is this plugin is always active and it is local to guiframe |
---|
| 191 | even if the user is switching between perspectives</p> |
---|
| 192 | </dd></dl> |
---|
| 193 | |
---|
| 194 | <dl class="method"> |
---|
| 195 | <dt id="sans.perspectives.pr.pr.Plugin.is_in_use"> |
---|
| 196 | <tt class="descname">is_in_use</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.is_in_use" title="Permalink to this definition">¶</a></dt> |
---|
| 197 | <dd><dl class="docutils"> |
---|
| 198 | <dt>get a data id a list of data name if data data is</dt> |
---|
| 199 | <dd>currently used by the plugin and the name of the plugin</dd> |
---|
| 200 | </dl> |
---|
| 201 | <p>data_name = ‘None’ |
---|
| 202 | in_use = False |
---|
| 203 | example [(data_name, self.sub_menu)]</p> |
---|
| 204 | </dd></dl> |
---|
| 205 | |
---|
| 206 | <dl class="method"> |
---|
| 207 | <dt id="sans.perspectives.pr.pr.Plugin.load"> |
---|
| 208 | <tt class="descname">load</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load" title="Permalink to this definition">¶</a></dt> |
---|
| 209 | <dd><p>Load data. This will eventually be replaced |
---|
| 210 | by our standard DataLoader class.</p> |
---|
| 211 | </dd></dl> |
---|
| 212 | |
---|
| 213 | <dl class="method"> |
---|
| 214 | <dt id="sans.perspectives.pr.pr.Plugin.load_abs"> |
---|
| 215 | <tt class="descname">load_abs</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load_abs" title="Permalink to this definition">¶</a></dt> |
---|
| 216 | <dd><p>Load an IGOR .ABS reduced file</p> |
---|
| 217 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 218 | <col class="field-name" /> |
---|
| 219 | <col class="field-body" /> |
---|
| 220 | <tbody valign="top"> |
---|
| 221 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – file path</td> |
---|
| 222 | </tr> |
---|
| 223 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">x, y, err vectors</td> |
---|
| 224 | </tr> |
---|
| 225 | </tbody> |
---|
| 226 | </table> |
---|
| 227 | </dd></dl> |
---|
| 228 | |
---|
| 229 | <dl class="method"> |
---|
| 230 | <dt id="sans.perspectives.pr.pr.Plugin.load_columns"> |
---|
| 231 | <tt class="descname">load_columns</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load_columns" title="Permalink to this definition">¶</a></dt> |
---|
| 232 | <dd><p>Load 2- or 3- column ascii</p> |
---|
| 233 | </dd></dl> |
---|
| 234 | |
---|
| 235 | <dl class="method"> |
---|
| 236 | <dt id="sans.perspectives.pr.pr.Plugin.load_data"> |
---|
| 237 | <tt class="descname">load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load_data" title="Permalink to this definition">¶</a></dt> |
---|
| 238 | <dd><p>Load data</p> |
---|
| 239 | </dd></dl> |
---|
| 240 | |
---|
| 241 | <dl class="method"> |
---|
| 242 | <dt id="sans.perspectives.pr.pr.Plugin.load_folder"> |
---|
| 243 | <tt class="descname">load_folder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.load_folder" title="Permalink to this definition">¶</a></dt> |
---|
| 244 | <dd><p>Load entire folder</p> |
---|
| 245 | </dd></dl> |
---|
| 246 | |
---|
| 247 | <dl class="method"> |
---|
| 248 | <dt id="sans.perspectives.pr.pr.Plugin.on_batch_selection"> |
---|
| 249 | <tt class="descname">on_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.on_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
| 250 | <dd><p>need to be overwritten by the derivated class</p> |
---|
| 251 | </dd></dl> |
---|
| 252 | |
---|
| 253 | <dl class="method"> |
---|
| 254 | <dt id="sans.perspectives.pr.pr.Plugin.on_perspective"> |
---|
| 255 | <tt class="descname">on_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.on_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 256 | <dd><p>Call back function for the perspective menu item. |
---|
| 257 | We notify the parent window that the perspective |
---|
| 258 | has changed.</p> |
---|
| 259 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 260 | <col class="field-name" /> |
---|
| 261 | <col class="field-body" /> |
---|
| 262 | <tbody valign="top"> |
---|
| 263 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – menu event</td> |
---|
| 264 | </tr> |
---|
| 265 | </tbody> |
---|
| 266 | </table> |
---|
| 267 | </dd></dl> |
---|
| 268 | |
---|
| 269 | <dl class="method"> |
---|
| 270 | <dt id="sans.perspectives.pr.pr.Plugin.on_set_state_helper"> |
---|
| 271 | <tt class="descname">on_set_state_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.on_set_state_helper" title="Permalink to this definition">¶</a></dt> |
---|
| 272 | <dd><p>update state</p> |
---|
| 273 | </dd></dl> |
---|
| 274 | |
---|
| 275 | <dl class="method"> |
---|
| 276 | <dt id="sans.perspectives.pr.pr.Plugin.perform_estimate"> |
---|
| 277 | <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> |
---|
| 278 | <dd></dd></dl> |
---|
| 279 | |
---|
| 280 | <dl class="method"> |
---|
| 281 | <dt id="sans.perspectives.pr.pr.Plugin.perform_estimateNT"> |
---|
| 282 | <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> |
---|
| 283 | <dd></dd></dl> |
---|
| 284 | |
---|
| 285 | <dl class="method"> |
---|
| 286 | <dt id="sans.perspectives.pr.pr.Plugin.perform_inversion"> |
---|
| 287 | <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> |
---|
| 288 | <dd></dd></dl> |
---|
| 289 | |
---|
| 290 | <dl class="method"> |
---|
| 291 | <dt id="sans.perspectives.pr.pr.Plugin.populate_file_menu"> |
---|
| 292 | <tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.populate_file_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 293 | <dd><p>Append menu item under file menu item of the frame</p> |
---|
| 294 | </dd></dl> |
---|
| 295 | |
---|
| 296 | <dl class="method"> |
---|
| 297 | <dt id="sans.perspectives.pr.pr.Plugin.populate_menu"> |
---|
| 298 | <tt class="descname">populate_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.populate_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 299 | <dd><p>Create and return the list of application menu |
---|
| 300 | items for the plug-in.</p> |
---|
| 301 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 302 | <col class="field-name" /> |
---|
| 303 | <col class="field-body" /> |
---|
| 304 | <tbody valign="top"> |
---|
| 305 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – parent window</td> |
---|
| 306 | </tr> |
---|
| 307 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">plug-in menu</td> |
---|
| 308 | </tr> |
---|
| 309 | </tbody> |
---|
| 310 | </table> |
---|
| 311 | </dd></dl> |
---|
| 312 | |
---|
| 313 | <dl class="method"> |
---|
| 314 | <dt id="sans.perspectives.pr.pr.Plugin.post_init"> |
---|
| 315 | <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> |
---|
| 316 | <dd><p>Post initialization call back to close the loose ends |
---|
| 317 | [Somehow openGL needs this call]</p> |
---|
| 318 | </dd></dl> |
---|
| 319 | |
---|
| 320 | <dl class="method"> |
---|
| 321 | <dt id="sans.perspectives.pr.pr.Plugin.pr_theory"> |
---|
| 322 | <tt class="descname">pr_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.pr_theory" title="Permalink to this definition">¶</a></dt> |
---|
| 323 | <dd></dd></dl> |
---|
| 324 | |
---|
| 325 | <dl class="method"> |
---|
| 326 | <dt id="sans.perspectives.pr.pr.Plugin.save_data"> |
---|
| 327 | <tt class="descname">save_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.save_data" title="Permalink to this definition">¶</a></dt> |
---|
| 328 | <dd><p>Save data in provided state object.</p> |
---|
| 329 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 330 | <col class="field-name" /> |
---|
| 331 | <col class="field-body" /> |
---|
| 332 | <tbody valign="top"> |
---|
| 333 | <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. |
---|
| 334 | Then remove the “prstate” input and make this method private.</p> |
---|
| 335 | </td> |
---|
| 336 | </tr> |
---|
| 337 | <tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 338 | <li><strong>filepath</strong> – path of file to write to</li> |
---|
| 339 | <li><strong>prstate</strong> – P(r) inversion state</li> |
---|
| 340 | </ul> |
---|
| 341 | </td> |
---|
| 342 | </tr> |
---|
| 343 | </tbody> |
---|
| 344 | </table> |
---|
| 345 | </dd></dl> |
---|
| 346 | |
---|
| 347 | <dl class="method"> |
---|
| 348 | <dt id="sans.perspectives.pr.pr.Plugin.set_batch_selection"> |
---|
| 349 | <tt class="descname">set_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
| 350 | <dd><p>the plugin to its batch state if flag is True</p> |
---|
| 351 | </dd></dl> |
---|
| 352 | |
---|
| 353 | <dl class="method"> |
---|
| 354 | <dt id="sans.perspectives.pr.pr.Plugin.set_data"> |
---|
| 355 | <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_data" title="Permalink to this definition">¶</a></dt> |
---|
| 356 | <dd><p>receive a list of data to compute pr</p> |
---|
| 357 | </dd></dl> |
---|
| 358 | |
---|
| 359 | <dl class="method"> |
---|
| 360 | <dt id="sans.perspectives.pr.pr.Plugin.set_default_perspective"> |
---|
| 361 | <tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_default_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 362 | <dd><p>Call back method that True to notify the parent that the current plug-in |
---|
| 363 | can be set as default perspective. |
---|
| 364 | when returning False, the plug-in is not candidate for an automatic |
---|
| 365 | default perspective setting</p> |
---|
| 366 | </dd></dl> |
---|
| 367 | |
---|
| 368 | <dl class="method"> |
---|
| 369 | <dt id="sans.perspectives.pr.pr.Plugin.set_is_active"> |
---|
| 370 | <tt class="descname">set_is_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_is_active" title="Permalink to this definition">¶</a></dt> |
---|
| 371 | <dd></dd></dl> |
---|
| 372 | |
---|
| 373 | <dl class="method"> |
---|
| 374 | <dt id="sans.perspectives.pr.pr.Plugin.set_state"> |
---|
| 375 | <tt class="descname">set_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_state" title="Permalink to this definition">¶</a></dt> |
---|
| 376 | <dd><p>Call-back method for the inversion state reader. |
---|
| 377 | This method is called when a .prv file is loaded.</p> |
---|
| 378 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 379 | <col class="field-name" /> |
---|
| 380 | <col class="field-body" /> |
---|
| 381 | <tbody valign="top"> |
---|
| 382 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 383 | <li><strong>state</strong> – InversionState object</li> |
---|
| 384 | <li><strong>datainfo</strong> – Data1D object [optional]</li> |
---|
| 385 | </ul> |
---|
| 386 | </td> |
---|
| 387 | </tr> |
---|
| 388 | </tbody> |
---|
| 389 | </table> |
---|
| 390 | </dd></dl> |
---|
| 391 | |
---|
| 392 | <dl class="method"> |
---|
| 393 | <dt id="sans.perspectives.pr.pr.Plugin.set_theory"> |
---|
| 394 | <tt class="descname">set_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.set_theory" title="Permalink to this definition">¶</a></dt> |
---|
| 395 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 396 | <col class="field-name" /> |
---|
| 397 | <col class="field-body" /> |
---|
| 398 | <tbody valign="top"> |
---|
| 399 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>theory_list</strong> – list of information</td> |
---|
| 400 | </tr> |
---|
| 401 | </tbody> |
---|
| 402 | </table> |
---|
| 403 | <p>related to available theory state</p> |
---|
| 404 | </dd></dl> |
---|
| 405 | |
---|
| 406 | <dl class="method"> |
---|
| 407 | <dt id="sans.perspectives.pr.pr.Plugin.setup_file_inversion"> |
---|
| 408 | <tt class="descname">setup_file_inversion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.setup_file_inversion" title="Permalink to this definition">¶</a></dt> |
---|
| 409 | <dd></dd></dl> |
---|
| 410 | |
---|
| 411 | <dl class="method"> |
---|
| 412 | <dt id="sans.perspectives.pr.pr.Plugin.setup_plot_inversion"> |
---|
| 413 | <tt class="descname">setup_plot_inversion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.setup_plot_inversion" title="Permalink to this definition">¶</a></dt> |
---|
| 414 | <dd></dd></dl> |
---|
| 415 | |
---|
| 416 | <dl class="method"> |
---|
| 417 | <dt id="sans.perspectives.pr.pr.Plugin.show_data"> |
---|
| 418 | <tt class="descname">show_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_data" title="Permalink to this definition">¶</a></dt> |
---|
| 419 | <dd><p>Show data read from a file</p> |
---|
| 420 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 421 | <col class="field-name" /> |
---|
| 422 | <col class="field-body" /> |
---|
| 423 | <tbody valign="top"> |
---|
| 424 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 425 | <li><strong>path</strong> – file path</li> |
---|
| 426 | <li><strong>reset</strong> – if True all other plottables will be cleared</li> |
---|
| 427 | </ul> |
---|
| 428 | </td> |
---|
| 429 | </tr> |
---|
| 430 | </tbody> |
---|
| 431 | </table> |
---|
| 432 | </dd></dl> |
---|
| 433 | |
---|
| 434 | <dl class="method"> |
---|
| 435 | <dt id="sans.perspectives.pr.pr.Plugin.show_iq"> |
---|
| 436 | <tt class="descname">show_iq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_iq" title="Permalink to this definition">¶</a></dt> |
---|
| 437 | <dd></dd></dl> |
---|
| 438 | |
---|
| 439 | <dl class="method"> |
---|
| 440 | <dt id="sans.perspectives.pr.pr.Plugin.show_pr"> |
---|
| 441 | <tt class="descname">show_pr</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_pr" title="Permalink to this definition">¶</a></dt> |
---|
| 442 | <dd></dd></dl> |
---|
| 443 | |
---|
| 444 | <dl class="method"> |
---|
| 445 | <dt id="sans.perspectives.pr.pr.Plugin.show_shpere"> |
---|
| 446 | <tt class="descname">show_shpere</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.show_shpere" title="Permalink to this definition">¶</a></dt> |
---|
| 447 | <dd></dd></dl> |
---|
| 448 | |
---|
| 449 | <dl class="method"> |
---|
| 450 | <dt id="sans.perspectives.pr.pr.Plugin.start_thread"> |
---|
| 451 | <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> |
---|
| 452 | <dd></dd></dl> |
---|
| 453 | |
---|
| 454 | <dl class="method"> |
---|
| 455 | <dt id="sans.perspectives.pr.pr.Plugin.use_data"> |
---|
| 456 | <tt class="descname">use_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr.Plugin.use_data" title="Permalink to this definition">¶</a></dt> |
---|
| 457 | <dd><p>return True if these plugin use data</p> |
---|
| 458 | </dd></dl> |
---|
| 459 | |
---|
| 460 | </dd></dl> |
---|
| 461 | |
---|
[242eba5] | 462 | </div> |
---|
| 463 | </div> |
---|
| 464 | |
---|
| 465 | |
---|
| 466 | </div> |
---|
| 467 | </div> |
---|
| 468 | </div> |
---|
| 469 | <div class="sphinxsidebar"> |
---|
| 470 | <div class="sphinxsidebarwrapper"> |
---|
| 471 | <h3><a href="../../../index.html">Table Of Contents</a></h3> |
---|
| 472 | <ul> |
---|
| 473 | <li><a class="reference internal" href="#">pr</a><ul> |
---|
| 474 | <li><a class="reference internal" href="#sans-perspectives-pr-pr"><tt class="docutils literal"><span class="pre">sans.perspectives.pr.pr</span></tt></a></li> |
---|
| 475 | </ul> |
---|
| 476 | </li> |
---|
| 477 | </ul> |
---|
| 478 | |
---|
| 479 | <h4>Previous topic</h4> |
---|
[40299ce] | 480 | <p class="topless"><a href="inversion_state.html" |
---|
| 481 | title="previous chapter">inversion_state</a></p> |
---|
| 482 | <h4>Next topic</h4> |
---|
| 483 | <p class="topless"><a href="pr_thread.html" |
---|
| 484 | title="next chapter">pr_thread</a></p> |
---|
[242eba5] | 485 | <h3>This Page</h3> |
---|
| 486 | <ul class="this-page-menu"> |
---|
| 487 | <li><a href="../../../_sources/api/perspectives/pr/pr.txt" |
---|
| 488 | rel="nofollow">Show Source</a></li> |
---|
| 489 | </ul> |
---|
| 490 | <div id="searchbox" style="display: none"> |
---|
| 491 | <h3>Quick search</h3> |
---|
| 492 | <form class="search" action="../../../search.html" method="get"> |
---|
[40299ce] | 493 | <input type="text" name="q" /> |
---|
[242eba5] | 494 | <input type="submit" value="Go" /> |
---|
| 495 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 496 | <input type="hidden" name="area" value="default" /> |
---|
| 497 | </form> |
---|
| 498 | <p class="searchtip" style="font-size: 90%"> |
---|
| 499 | Enter search terms or a module, class or function name. |
---|
| 500 | </p> |
---|
| 501 | </div> |
---|
| 502 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 503 | </div> |
---|
| 504 | </div> |
---|
| 505 | <div class="clearer"></div> |
---|
| 506 | </div> |
---|
| 507 | <div class="related"> |
---|
| 508 | <h3>Navigation</h3> |
---|
| 509 | <ul> |
---|
| 510 | <li class="right" style="margin-right: 10px"> |
---|
| 511 | <a href="../../../genindex.html" title="General Index" |
---|
| 512 | >index</a></li> |
---|
| 513 | <li class="right" > |
---|
[40299ce] | 514 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 515 | >modules</a> |</li> |
---|
| 516 | <li class="right" > |
---|
| 517 | <a href="pr_thread.html" title="pr_thread" |
---|
| 518 | >next</a> |</li> |
---|
| 519 | <li class="right" > |
---|
| 520 | <a href="inversion_state.html" title="inversion_state" |
---|
[242eba5] | 521 | >previous</a> |</li> |
---|
[40299ce] | 522 | <li><a href="../../../index.html">prview 0.1.0 documentation</a> »</li> |
---|
[242eba5] | 523 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 524 | </ul> |
---|
| 525 | </div> |
---|
| 526 | <div class="footer"> |
---|
| 527 | © Copyright 2010, sans group. |
---|
[40299ce] | 528 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
[242eba5] | 529 | </div> |
---|
| 530 | </body> |
---|
| 531 | </html> |
---|