source: sasview/theoryview/docs/sphinx/_build/html/api/theory.html @ d955bf19

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since d955bf19 was 74755ff, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation theory view
  • Property mode set to 100644
File size: 11.4 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>theory &mdash; theoryview v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="theoryview v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="prev" title="pagestate" href="pagestate.html" /> 
28  </head>
29  <body>
30    <div class="related">
31      <h3>Navigation</h3>
32      <ul>
33        <li class="right" style="margin-right: 10px">
34          <a href="../genindex.html" title="General Index"
35             accesskey="I">index</a></li>
36        <li class="right" >
37          <a href="../py-modindex.html" title="Python Module Index"
38             >modules</a> |</li>
39        <li class="right" >
40          <a href="pagestate.html" title="pagestate"
41             accesskey="P">previous</a> |</li>
42        <li><a href="../index.html">theoryview v0.1.0 documentation</a> &raquo;</li>
43          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
44      </ul>
45    </div> 
46
47    <div class="document">
48      <div class="documentwrapper">
49        <div class="bodywrapper">
50          <div class="body">
51           
52  <div class="section" id="theory">
53<h1>theory<a class="headerlink" href="#theory" title="Permalink to this headline">¶</a></h1>
54<div class="section" id="module-sans.perspectives.theory.theory">
55<span id="sans-perspectives-theory-theory"></span><h2><a class="reference internal" href="#module-sans.perspectives.theory.theory"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.theory.theory</span></tt></a><a class="headerlink" href="#module-sans.perspectives.theory.theory" title="Permalink to this headline">¶</a></h2>
56<dl class="class">
57<dt id="sans.perspectives.theory.theory.PlotInfo">
58<em class="property">class </em><tt class="descclassname">sans.perspectives.theory.theory.</tt><tt class="descname">PlotInfo</tt><a class="headerlink" href="#sans.perspectives.theory.theory.PlotInfo" title="Permalink to this definition">¶</a></dt>
59<dd>store some plotting field</dd></dl>
60
61<dl class="class">
62<dt id="sans.perspectives.theory.theory.Plugin">
63<em class="property">class </em><tt class="descclassname">sans.perspectives.theory.theory.</tt><tt class="descname">Plugin</tt><big>(</big><em>standalone=True</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin" title="Permalink to this definition">¶</a></dt>
64<dd><p>This class defines the interface for a Plugin class
65for calculator perspective</p>
66<dl class="method">
67<dt id="sans.perspectives.theory.theory.Plugin.draw_model">
68<tt class="descname">draw_model</tt><big>(</big><em>model</em>, <em>data=None</em>, <em>smearer=None</em>, <em>enable1D=True</em>, <em>enable2D=False</em>, <em>qmin=0.001</em>, <em>qmax=0.13</em>, <em>qstep=50</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.draw_model" title="Permalink to this definition">¶</a></dt>
69<dd><p>Draw model.</p>
70<table class="docutils field-list" frame="void" rules="none">
71<col class="field-name" />
72<col class="field-body" />
73<tbody valign="top">
74<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
75<li><strong>model</strong> &#8211; the model to draw</li>
76<li><strong>name</strong> &#8211; the name of the model to draw</li>
77<li><strong>data</strong> &#8211; the data on which the model is based to be drawn</li>
78<li><strong>description</strong> &#8211; model&#8217;s description</li>
79<li><strong>enable1D</strong> &#8211; if true enable drawing model 1D</li>
80<li><strong>enable2D</strong> &#8211; if true enable drawing model 2D</li>
81<li><strong>qmin</strong> &#8211; Range&#8217;s minimum value to draw model</li>
82<li><strong>qmax</strong> &#8211; Range&#8217;s maximum value to draw model</li>
83<li><strong>qstep</strong> &#8211; number of step to divide the x and y-axis</li>
84</ul>
85</td>
86</tr>
87</tbody>
88</table>
89</dd></dl>
90
91<dl class="method">
92<dt id="sans.perspectives.theory.theory.Plugin.get_context_menu">
93<tt class="descname">get_context_menu</tt><big>(</big><em>graph=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.get_context_menu" title="Permalink to this definition">¶</a></dt>
94<dd><p>This method is optional.</p>
95<p>When the context menu of a plot is rendered, the
96get_context_menu method will be called to give you a
97chance to add a menu item to the context menu.</p>
98<p>A ref to a Graph object is passed so that you can
99investigate the plot content and decide whether you
100need to add items to the context menu.</p>
101<p>This method returns a list of menu items.
102Each item is itself a list defining the text to
103appear in the menu, a tool-tip help text, and a
104call-back method.</p>
105<table class="docutils field-list" frame="void" rules="none">
106<col class="field-name" />
107<col class="field-body" />
108<tbody valign="top">
109<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
110<li><strong>graph</strong> &#8211; the Graph object to which we attach the context menu</li>
111</ul>
112</td>
113</tr>
114<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list of menu items with call-back function</p>
115</td>
116</tr>
117</tbody>
118</table>
119</dd></dl>
120
121<dl class="method">
122<dt id="sans.perspectives.theory.theory.Plugin.get_panels">
123<tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.get_panels" title="Permalink to this definition">¶</a></dt>
124<dd><p>Create and return the list of wx.Panels for your plug-in.
125Define the plug-in perspective.</p>
126<p>Panels should inherit from DefaultPanel defined below,
127or should present the same interface. They must define
128&#8220;window_caption&#8221; and &#8220;window_name&#8221;.</p>
129<table class="docutils field-list" frame="void" rules="none">
130<col class="field-name" />
131<col class="field-body" />
132<tbody valign="top">
133<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
134<li><strong>parent</strong> &#8211; parent window</li>
135</ul>
136</td>
137</tr>
138<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of panels</p>
139</td>
140</tr>
141</tbody>
142</table>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.perspectives.theory.theory.Plugin.get_perspective">
147<tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.get_perspective" title="Permalink to this definition">¶</a></dt>
148<dd>Get the list of panel names for this perspective</dd></dl>
149
150<dl class="method">
151<dt id="sans.perspectives.theory.theory.Plugin.on_perspective">
152<tt class="descname">on_perspective</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.on_perspective" title="Permalink to this definition">¶</a></dt>
153<dd><p>Call back function for the perspective menu item.
154We notify the parent window that the perspective
155has changed.</p>
156<table class="docutils field-list" frame="void" rules="none">
157<col class="field-name" />
158<col class="field-body" />
159<tbody valign="top">
160<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
161<li><strong>event</strong> &#8211; menu event</li>
162</ul>
163</td>
164</tr>
165</tbody>
166</table>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.perspectives.theory.theory.Plugin.populate_menu">
171<tt class="descname">populate_menu</tt><big>(</big><em>id</em>, <em>owner</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.populate_menu" title="Permalink to this definition">¶</a></dt>
172<dd><p>Create and return the list of application menu
173items for the plug-in.</p>
174<table class="docutils field-list" frame="void" rules="none">
175<col class="field-name" />
176<col class="field-body" />
177<tbody valign="top">
178<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
179<li><strong>id</strong> &#8211; deprecated. Un-used.</li>
180<li><strong>parent</strong> &#8211; parent window</li>
181</ul>
182</td>
183</tr>
184<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">plug-in menu</p>
185</td>
186</tr>
187</tbody>
188</table>
189</dd></dl>
190
191<dl class="method">
192<dt id="sans.perspectives.theory.theory.Plugin.post_init">
193<tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.theory.theory.Plugin.post_init" title="Permalink to this definition">¶</a></dt>
194<dd>Post initialization call back to close the loose ends</dd></dl>
195
196</dd></dl>
197
198</div>
199</div>
200
201
202          </div>
203        </div>
204      </div>
205      <div class="sphinxsidebar">
206        <div class="sphinxsidebarwrapper">
207  <h3><a href="../index.html">Table Of Contents</a></h3>
208  <ul>
209<li><a class="reference internal" href="#">theory</a><ul>
210<li><a class="reference internal" href="#module-sans.perspectives.theory.theory"><tt class="docutils literal"><span class="pre">sans.perspectives.theory.theory</span></tt></a></li>
211</ul>
212</li>
213</ul>
214
215  <h4>Previous topic</h4>
216  <p class="topless"><a href="pagestate.html"
217                        title="previous chapter">pagestate</a></p>
218  <h3>This Page</h3>
219  <ul class="this-page-menu">
220    <li><a href="../_sources/api/theory.txt"
221           rel="nofollow">Show Source</a></li>
222  </ul>
223<div id="searchbox" style="display: none">
224  <h3>Quick search</h3>
225    <form class="search" action="../search.html" method="get">
226      <input type="text" name="q" size="18" />
227      <input type="submit" value="Go" />
228      <input type="hidden" name="check_keywords" value="yes" />
229      <input type="hidden" name="area" value="default" />
230    </form>
231    <p class="searchtip" style="font-size: 90%">
232    Enter search terms or a module, class or function name.
233    </p>
234</div>
235<script type="text/javascript">$('#searchbox').show(0);</script>
236        </div>
237      </div>
238      <div class="clearer"></div>
239    </div>
240    <div class="related">
241      <h3>Navigation</h3>
242      <ul>
243        <li class="right" style="margin-right: 10px">
244          <a href="../genindex.html" title="General Index"
245             >index</a></li>
246        <li class="right" >
247          <a href="../py-modindex.html" title="Python Module Index"
248             >modules</a> |</li>
249        <li class="right" >
250          <a href="pagestate.html" title="pagestate"
251             >previous</a> |</li>
252        <li><a href="../index.html">theoryview v0.1.0 documentation</a> &raquo;</li>
253          <li><a href="index.html" >Reference</a> &raquo;</li> 
254      </ul>
255    </div>
256    <div class="footer">
257        &copy; Copyright 2010, sans group.
258      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
259    </div>
260  </body>
261</html>
Note: See TracBrowser for help on using the repository browser.