source: sasview/guiframe/docs/sphinx/_build/html/api/local_perspectives/plotting/Edge.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 d955bf19, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 13.7 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>Edge &mdash; guiframe 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="guiframe v0.1.0 documentation" href="../../../index.html" />
26    <link rel="up" title="Local Perspective: Plotting" href="index.html" />
27    <link rel="next" title="masking" href="masking.html" />
28    <link rel="prev" title="detector_dialog" href="detector_dialog.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="masking.html" title="masking"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="detector_dialog.html" title="detector_dialog"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Local Perspective: Plotting</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="edge">
57<h1>Edge<a class="headerlink" href="#edge" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.local_perspectives.plotting.Edge">
59<span id="sans-guiframe-local-perspectives-plotting-edge"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.Edge"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.Edge</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.Edge" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.Edge.</tt><tt class="descname">RadiusInteractor</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=5</em>, <em>arc1=None</em>, <em>arc2=None</em>, <em>theta=0.39269908169872414</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
64<p>Select an annulus through a 2D plot</p>
65<dl class="method">
66<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.clear">
67<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.clear" title="Permalink to this definition">¶</a></dt>
68<dd></dd></dl>
69
70<dl class="method">
71<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.clear_markers">
72<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.clear_markers" title="Permalink to this definition">¶</a></dt>
73<dd>Clear old markers and interfaces.</dd></dl>
74
75<dl class="method">
76<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.connect_markers">
77<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.connect_markers" title="Permalink to this definition">¶</a></dt>
78<dd>Connect markers to callbacks</dd></dl>
79
80<dl class="method">
81<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.dpixel">
82<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.dpixel" title="Permalink to this definition">¶</a></dt>
83<dd>Return the step size in data coordinates for a small
84step in screen coordinates.  If nudge is False (default)
85the step size is one pixel.  If nudge is True, the step
86size is 0.2 pixels.</dd></dl>
87
88<dl class="method">
89<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.get_angle">
90<tt class="descname">get_angle</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.get_angle" title="Permalink to this definition">¶</a></dt>
91<dd></dd></dl>
92
93<dl class="method">
94<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.get_params">
95<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.get_params" title="Permalink to this definition">¶</a></dt>
96<dd></dd></dl>
97
98<dl class="method">
99<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.move">
100<tt class="descname">move</tt><big>(</big><em>x</em>, <em>y</em>, <em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.move" title="Permalink to this definition">¶</a></dt>
101<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
102
103<dl class="method">
104<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.moveend">
105<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.moveend" title="Permalink to this definition">¶</a></dt>
106<dd></dd></dl>
107
108<dl class="method">
109<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onClick">
110<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onClick" title="Permalink to this definition">¶</a></dt>
111<dd>Prepare to move the artist.  Calls save() to preserve the state for
112later restore().</dd></dl>
113
114<dl class="method">
115<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onDrag">
116<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onDrag" title="Permalink to this definition">¶</a></dt>
117<dd>Move the artist.  Calls move() to update the state, or restore() if
118the mouse leaves the window.</dd></dl>
119
120<dl class="method">
121<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onHilite">
122<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onHilite" title="Permalink to this definition">¶</a></dt>
123<dd>Hilite the artist reporting the event, indicating that it is
124ready to receive a click.</dd></dl>
125
126<dl class="method">
127<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onKey">
128<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onKey" title="Permalink to this definition">¶</a></dt>
129<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
130restores it to the position before the last click.</p>
131<p>Calls move() to update the state.  Calls restore() on escape.</p>
132</dd></dl>
133
134<dl class="method">
135<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onLeave">
136<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onLeave" title="Permalink to this definition">¶</a></dt>
137<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
138
139<dl class="method">
140<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onRelease">
141<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.onRelease" title="Permalink to this definition">¶</a></dt>
142<dd></dd></dl>
143
144<dl class="method">
145<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.restore">
146<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.restore" title="Permalink to this definition">¶</a></dt>
147<dd>Restore the roughness for this layer.</dd></dl>
148
149<dl class="method">
150<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.save">
151<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.save" title="Permalink to this definition">¶</a></dt>
152<dd>Remember the roughness for this layer and the next so that we
153can restore on Esc.</dd></dl>
154
155<dl class="method">
156<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.set_cursor">
157<tt class="descname">set_cursor</tt><big>(</big><em>r_min</em>, <em>r_max</em>, <em>theta</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.set_cursor" title="Permalink to this definition">¶</a></dt>
158<dd></dd></dl>
159
160<dl class="method">
161<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.set_layer">
162<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.set_layer" title="Permalink to this definition">¶</a></dt>
163<dd></dd></dl>
164
165<dl class="method">
166<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.set_params">
167<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.set_params" title="Permalink to this definition">¶</a></dt>
168<dd></dd></dl>
169
170<dl class="method">
171<dt id="sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.update">
172<tt class="descname">update</tt><big>(</big><em>r1=None</em>, <em>r2=None</em>, <em>theta=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.Edge.RadiusInteractor.update" title="Permalink to this definition">¶</a></dt>
173<dd>Draw the new roughness on the graph.</dd></dl>
174
175</dd></dl>
176
177</div>
178</div>
179
180
181          </div>
182        </div>
183      </div>
184      <div class="sphinxsidebar">
185        <div class="sphinxsidebarwrapper">
186  <h3><a href="../../../index.html">Table Of Contents</a></h3>
187  <ul>
188<li><a class="reference internal" href="#">Edge</a><ul>
189<li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.Edge"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.Edge</span></tt></a></li>
190</ul>
191</li>
192</ul>
193
194  <h4>Previous topic</h4>
195  <p class="topless"><a href="detector_dialog.html"
196                        title="previous chapter">detector_dialog</a></p>
197  <h4>Next topic</h4>
198  <p class="topless"><a href="masking.html"
199                        title="next chapter">masking</a></p>
200  <h3>This Page</h3>
201  <ul class="this-page-menu">
202    <li><a href="../../../_sources/api/local_perspectives/plotting/Edge.txt"
203           rel="nofollow">Show Source</a></li>
204  </ul>
205<div id="searchbox" style="display: none">
206  <h3>Quick search</h3>
207    <form class="search" action="../../../search.html" method="get">
208      <input type="text" name="q" size="18" />
209      <input type="submit" value="Go" />
210      <input type="hidden" name="check_keywords" value="yes" />
211      <input type="hidden" name="area" value="default" />
212    </form>
213    <p class="searchtip" style="font-size: 90%">
214    Enter search terms or a module, class or function name.
215    </p>
216</div>
217<script type="text/javascript">$('#searchbox').show(0);</script>
218        </div>
219      </div>
220      <div class="clearer"></div>
221    </div>
222    <div class="related">
223      <h3>Navigation</h3>
224      <ul>
225        <li class="right" style="margin-right: 10px">
226          <a href="../../../genindex.html" title="General Index"
227             >index</a></li>
228        <li class="right" >
229          <a href="../../../py-modindex.html" title="Python Module Index"
230             >modules</a> |</li>
231        <li class="right" >
232          <a href="masking.html" title="masking"
233             >next</a> |</li>
234        <li class="right" >
235          <a href="detector_dialog.html" title="detector_dialog"
236             >previous</a> |</li>
237        <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
238          <li><a href="index.html" >Local Perspective: Plotting</a> &raquo;</li> 
239      </ul>
240    </div>
241    <div class="footer">
242        &copy; Copyright 2010, sans group.
243      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
244    </div>
245  </body>
246</html>
Note: See TracBrowser for help on using the repository browser.