Ignore:
Timestamp:
Oct 24, 2011 1:37:36 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
f696e2a
Parents:
89b7858
Message:

edit doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • inversionview/docs/sphinx/html/api/perspectives/pr/pr.html

    r242eba5 r40299ce  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
     
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>pr &mdash; prview v0.1.0 documentation</title> 
     11    <title>pr &mdash; prview 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
     
    2326    <script type="text/javascript" src="../../../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../../../_static/doctools.js"></script> 
    25     <link rel="top" title="prview v0.1.0 documentation" href="../../../index.html" /> 
     28    <link rel="top" title="prview 0.1.0 documentation" href="../../../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    27     <link rel="prev" title="pr_widgets" href="pr_widgets.html" />  
     30    <link rel="next" title="pr_thread" href="pr_thread.html" /> 
     31    <link rel="prev" title="inversion_state" href="inversion_state.html" />  
    2832  </head> 
    2933  <body> 
     
    3539             accesskey="I">index</a></li> 
    3640        <li class="right" > 
    37           <a href="pr_widgets.html" title="pr_widgets" 
     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" 
    3848             accesskey="P">previous</a> |</li> 
    39         <li><a href="../../../index.html">prview v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../../../index.html">prview 0.1.0 documentation</a> &raquo;</li> 
    4050          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4151      </ul> 
     
    5060<h1>pr<a class="headerlink" href="#pr" title="Permalink to this headline">¶</a></h1> 
    5161<div class="section" id="sans-perspectives-pr-pr"> 
    52 <h2><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.pr.pr</span></tt><a class="headerlink" href="#sans-perspectives-pr-pr" title="Permalink to this headline">¶</a></h2> 
     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> &#8211; 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 
     191even 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 = &#8216;None&#8217; 
     202in_use = False 
     203example [(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 
     210by 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> &#8211; 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. 
     257We notify the parent window that the perspective 
     258has 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> &#8211; 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 
     300items 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> &#8211; 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.  
     334Then remove the &#8220;prstate&#8221; 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> &#8211; path of file to write to</li> 
     339<li><strong>prstate</strong> &#8211; 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 
     363can be set as default  perspective. 
     364when returning False, the plug-in is not candidate for an automatic  
     365default 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. 
     377This 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> &#8211; InversionState object</li> 
     384<li><strong>datainfo</strong> &#8211; 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> &#8211; 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> &#8211; file path</li> 
     426<li><strong>reset</strong> &#8211; 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 
    53462</div> 
    54463</div> 
     
    69478 
    70479  <h4>Previous topic</h4> 
    71   <p class="topless"><a href="pr_widgets.html" 
    72                         title="previous chapter">pr_widgets</a></p> 
     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> 
    73485  <h3>This Page</h3> 
    74486  <ul class="this-page-menu"> 
     
    79491  <h3>Quick search</h3> 
    80492    <form class="search" action="../../../search.html" method="get"> 
    81       <input type="text" name="q" size="18" /> 
     493      <input type="text" name="q" /> 
    82494      <input type="submit" value="Go" /> 
    83495      <input type="hidden" name="check_keywords" value="yes" /> 
     
    100512             >index</a></li> 
    101513        <li class="right" > 
    102           <a href="pr_widgets.html" title="pr_widgets" 
     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" 
    103521             >previous</a> |</li> 
    104         <li><a href="../../../index.html">prview v0.1.0 documentation</a> &raquo;</li> 
     522        <li><a href="../../../index.html">prview 0.1.0 documentation</a> &raquo;</li> 
    105523          <li><a href="index.html" >Reference</a> &raquo;</li>  
    106524      </ul> 
     
    108526    <div class="footer"> 
    109527        &copy; Copyright 2010, sans group. 
    110       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     528      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    111529    </div> 
    112530  </body> 
Note: See TracChangeset for help on using the changeset viewer.