source: sasview/guiframe/docs/sphinx/_build/html/api/local_perspectives/plotting/AnnulusSlicer.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: 37.3 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>AnnulusSlicer &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="Arc" href="Arc.html" />
28    <link rel="prev" title="Local Perspective: Plotting" href="index.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="Arc.html" title="Arc"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="index.html" title="Local Perspective: Plotting"
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="annulusslicer">
57<h1>AnnulusSlicer<a class="headerlink" href="#annulusslicer" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.local_perspectives.plotting.AnnulusSlicer">
59<span id="sans-guiframe-local-perspectives-plotting-annulusslicer"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.AnnulusSlicer"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.AnnulusSlicer</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.AnnulusSlicer" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.AnnulusSlicer.</tt><tt class="descname">AnnulusInteractor</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor" 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.
65This interactor is used to average 2D data  with the region
66defined by 2 radius.
67this class is defined by 2 Ringinterators.</p>
68<dl class="method">
69<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.clear">
70<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.clear" title="Permalink to this definition">¶</a></dt>
71<dd>Clear the slicer and all connected events related to this slicer</dd></dl>
72
73<dl class="method">
74<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.clear_markers">
75<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.clear_markers" title="Permalink to this definition">¶</a></dt>
76<dd>Clear old markers and interfaces.</dd></dl>
77
78<dl class="method">
79<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.connect_markers">
80<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.connect_markers" title="Permalink to this definition">¶</a></dt>
81<dd>Connect markers to callbacks</dd></dl>
82
83<dl class="method">
84<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.dpixel">
85<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.AnnulusSlicer.AnnulusInteractor.dpixel" title="Permalink to this definition">¶</a></dt>
86<dd>Return the step size in data coordinates for a small
87step in screen coordinates.  If nudge is False (default)
88the step size is one pixel.  If nudge is True, the step
89size is 0.2 pixels.</dd></dl>
90
91<dl class="method">
92<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.draw">
93<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.draw" title="Permalink to this definition">¶</a></dt>
94<dd></dd></dl>
95
96<dl class="method">
97<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.freeze_axes">
98<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.freeze_axes" title="Permalink to this definition">¶</a></dt>
99<dd></dd></dl>
100
101<dl class="method">
102<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.get_params">
103<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.get_params" title="Permalink to this definition">¶</a></dt>
104<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</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">Return params:</th><td class="field-body">the dictionary created</td>
110</tr>
111</tbody>
112</table>
113</dd></dl>
114
115<dl class="method">
116<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.move">
117<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.AnnulusSlicer.AnnulusInteractor.move" title="Permalink to this definition">¶</a></dt>
118<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
119
120<dl class="method">
121<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.moveend">
122<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.moveend" title="Permalink to this definition">¶</a></dt>
123<dd>Called when any dragging motion ends.
124Post an event (type =SlicerParameterEvent)
125to plotter 2D with a copy  slicer parameters
126Call  _post_data method</dd></dl>
127
128<dl class="method">
129<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onClick">
130<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onClick" title="Permalink to this definition">¶</a></dt>
131<dd>Prepare to move the artist.  Calls save() to preserve the state for
132later restore().</dd></dl>
133
134<dl class="method">
135<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onDrag">
136<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onDrag" title="Permalink to this definition">¶</a></dt>
137<dd>Move the artist.  Calls move() to update the state, or restore() if
138the mouse leaves the window.</dd></dl>
139
140<dl class="method">
141<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onHilite">
142<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onHilite" title="Permalink to this definition">¶</a></dt>
143<dd>Hilite the artist reporting the event, indicating that it is
144ready to receive a click.</dd></dl>
145
146<dl class="method">
147<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onKey">
148<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onKey" title="Permalink to this definition">¶</a></dt>
149<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
150restores it to the position before the last click.</p>
151<p>Calls move() to update the state.  Calls restore() on escape.</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onLeave">
156<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onLeave" title="Permalink to this definition">¶</a></dt>
157<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
158
159<dl class="method">
160<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onRelease">
161<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.onRelease" title="Permalink to this definition">¶</a></dt>
162<dd></dd></dl>
163
164<dl class="method">
165<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.restore">
166<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.restore" title="Permalink to this definition">¶</a></dt>
167<dd>Restore the roughness for this layer.</dd></dl>
168
169<dl class="method">
170<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.save">
171<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.save" title="Permalink to this definition">¶</a></dt>
172<dd>Remember the roughness for this layer and the next so that we
173can restore on Esc.</dd></dl>
174
175<dl class="method">
176<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.set_cursor">
177<tt class="descname">set_cursor</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.set_cursor" title="Permalink to this definition">¶</a></dt>
178<dd></dd></dl>
179
180<dl class="method">
181<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.set_layer">
182<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.set_layer" title="Permalink to this definition">¶</a></dt>
183<dd><p>Allow adding plot to the same panel</p>
184<table class="docutils field-list" frame="void" rules="none">
185<col class="field-name" />
186<col class="field-body" />
187<tbody valign="top">
188<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
189<li><strong>n</strong> &#8211; the number of layer</li>
190</ul>
191</td>
192</tr>
193</tbody>
194</table>
195</dd></dl>
196
197<dl class="method">
198<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.set_params">
199<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.set_params" title="Permalink to this definition">¶</a></dt>
200<dd><p>Receive a dictionary and reset the slicer with values contained
201in the values of the dictionary.</p>
202<table class="docutils field-list" frame="void" rules="none">
203<col class="field-name" />
204<col class="field-body" />
205<tbody valign="top">
206<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
207<li><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
208values the user assigned to the slicer.</li>
209</ul>
210</td>
211</tr>
212</tbody>
213</table>
214</dd></dl>
215
216<dl class="method">
217<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.thaw_axes">
218<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.thaw_axes" title="Permalink to this definition">¶</a></dt>
219<dd></dd></dl>
220
221<dl class="method">
222<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.update">
223<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.AnnulusInteractor.update" title="Permalink to this definition">¶</a></dt>
224<dd>Respond to changes in the model by recalculating the profiles and
225resetting the widgets.</dd></dl>
226
227</dd></dl>
228
229<dl class="class">
230<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask">
231<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.AnnulusSlicer.</tt><tt class="descname">CircularMask</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='grey'</em>, <em>zorder=3</em>, <em>side=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask" title="Permalink to this definition">¶</a></dt>
232<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
233<p>Draw a ring Given a radius</p>
234<dl class="method">
235<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.clear">
236<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.clear" title="Permalink to this definition">¶</a></dt>
237<dd>Clear the slicer and all connected events related to this slicer</dd></dl>
238
239<dl class="method">
240<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.clear_markers">
241<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.clear_markers" title="Permalink to this definition">¶</a></dt>
242<dd>Clear old markers and interfaces.</dd></dl>
243
244<dl class="method">
245<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.connect_markers">
246<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.connect_markers" title="Permalink to this definition">¶</a></dt>
247<dd>Connect markers to callbacks</dd></dl>
248
249<dl class="method">
250<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.dpixel">
251<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.AnnulusSlicer.CircularMask.dpixel" title="Permalink to this definition">¶</a></dt>
252<dd>Return the step size in data coordinates for a small
253step in screen coordinates.  If nudge is False (default)
254the step size is one pixel.  If nudge is True, the step
255size is 0.2 pixels.</dd></dl>
256
257<dl class="method">
258<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.draw">
259<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.draw" title="Permalink to this definition">¶</a></dt>
260<dd></dd></dl>
261
262<dl class="method">
263<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.freeze_axes">
264<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.freeze_axes" title="Permalink to this definition">¶</a></dt>
265<dd></dd></dl>
266
267<dl class="method">
268<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.get_params">
269<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.get_params" title="Permalink to this definition">¶</a></dt>
270<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
271<table class="docutils field-list" frame="void" rules="none">
272<col class="field-name" />
273<col class="field-body" />
274<tbody valign="top">
275<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
276</tr>
277</tbody>
278</table>
279</dd></dl>
280
281<dl class="method">
282<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.move">
283<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.AnnulusSlicer.CircularMask.move" title="Permalink to this definition">¶</a></dt>
284<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
285
286<dl class="method">
287<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.moveend">
288<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.moveend" title="Permalink to this definition">¶</a></dt>
289<dd>Called when any dragging motion ends.
290Post an event (type =SlicerParameterEvent)
291to plotter 2D with a copy  slicer parameters
292Call  _post_data method</dd></dl>
293
294<dl class="method">
295<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onClick">
296<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onClick" title="Permalink to this definition">¶</a></dt>
297<dd>Prepare to move the artist.  Calls save() to preserve the state for
298later restore().</dd></dl>
299
300<dl class="method">
301<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onDrag">
302<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onDrag" title="Permalink to this definition">¶</a></dt>
303<dd>Move the artist.  Calls move() to update the state, or restore() if
304the mouse leaves the window.</dd></dl>
305
306<dl class="method">
307<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onHilite">
308<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onHilite" title="Permalink to this definition">¶</a></dt>
309<dd>Hilite the artist reporting the event, indicating that it is
310ready to receive a click.</dd></dl>
311
312<dl class="method">
313<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onKey">
314<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onKey" title="Permalink to this definition">¶</a></dt>
315<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
316restores it to the position before the last click.</p>
317<p>Calls move() to update the state.  Calls restore() on escape.</p>
318</dd></dl>
319
320<dl class="method">
321<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onLeave">
322<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onLeave" title="Permalink to this definition">¶</a></dt>
323<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
324
325<dl class="method">
326<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onRelease">
327<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.onRelease" title="Permalink to this definition">¶</a></dt>
328<dd></dd></dl>
329
330<dl class="method">
331<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.restore">
332<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.restore" title="Permalink to this definition">¶</a></dt>
333<dd>Restore the roughness for this layer.</dd></dl>
334
335<dl class="method">
336<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.save">
337<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.save" title="Permalink to this definition">¶</a></dt>
338<dd>Remember the roughness for this layer and the next so that we
339can restore on Esc.</dd></dl>
340
341<dl class="method">
342<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.set_cursor">
343<tt class="descname">set_cursor</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.set_cursor" title="Permalink to this definition">¶</a></dt>
344<dd></dd></dl>
345
346<dl class="method">
347<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.set_layer">
348<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.set_layer" title="Permalink to this definition">¶</a></dt>
349<dd><p>Allow adding plot to the same panel</p>
350<table class="docutils field-list" frame="void" rules="none">
351<col class="field-name" />
352<col class="field-body" />
353<tbody valign="top">
354<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
355<li><strong>n</strong> &#8211; the number of layer</li>
356</ul>
357</td>
358</tr>
359</tbody>
360</table>
361</dd></dl>
362
363<dl class="method">
364<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.set_params">
365<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.set_params" title="Permalink to this definition">¶</a></dt>
366<dd><p>Receive a dictionary and reset the slicer with values contained
367in the values of the dictionary.</p>
368<table class="docutils field-list" frame="void" rules="none">
369<col class="field-name" />
370<col class="field-body" />
371<tbody valign="top">
372<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
373<li><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
374values the user assigned to the slicer.</li>
375</ul>
376</td>
377</tr>
378</tbody>
379</table>
380</dd></dl>
381
382<dl class="method">
383<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.thaw_axes">
384<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.thaw_axes" title="Permalink to this definition">¶</a></dt>
385<dd></dd></dl>
386
387<dl class="method">
388<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.update">
389<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.CircularMask.update" title="Permalink to this definition">¶</a></dt>
390<dd>Respond to changes in the model by recalculating the profiles and
391resetting the widgets.</dd></dl>
392
393</dd></dl>
394
395<dl class="class">
396<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor">
397<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.AnnulusSlicer.</tt><tt class="descname">RingInteractor</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=5</em>, <em>r=1.0</em>, <em>sign=1</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor" title="Permalink to this definition">¶</a></dt>
398<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
399<p>Draw a ring Given a radius</p>
400<dl class="method">
401<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.clear">
402<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.clear" title="Permalink to this definition">¶</a></dt>
403<dd>Clear the slicer and all connected events related to this slicer</dd></dl>
404
405<dl class="method">
406<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.clear_markers">
407<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.clear_markers" title="Permalink to this definition">¶</a></dt>
408<dd>Clear old markers and interfaces.</dd></dl>
409
410<dl class="method">
411<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.connect_markers">
412<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.connect_markers" title="Permalink to this definition">¶</a></dt>
413<dd>Connect markers to callbacks</dd></dl>
414
415<dl class="method">
416<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.dpixel">
417<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.AnnulusSlicer.RingInteractor.dpixel" title="Permalink to this definition">¶</a></dt>
418<dd>Return the step size in data coordinates for a small
419step in screen coordinates.  If nudge is False (default)
420the step size is one pixel.  If nudge is True, the step
421size is 0.2 pixels.</dd></dl>
422
423<dl class="method">
424<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.get_params">
425<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.get_params" title="Permalink to this definition">¶</a></dt>
426<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
427<table class="docutils field-list" frame="void" rules="none">
428<col class="field-name" />
429<col class="field-body" />
430<tbody valign="top">
431<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
432</tr>
433</tbody>
434</table>
435</dd></dl>
436
437<dl class="method">
438<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.get_radius">
439<tt class="descname">get_radius</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.get_radius" title="Permalink to this definition">¶</a></dt>
440<dd><table class="docutils field-list" frame="void" rules="none">
441<col class="field-name" />
442<col class="field-body" />
443<tbody valign="top">
444<tr class="field"><th class="field-name" colspan="2">Return self._inner_mouse_x:</th></tr>
445<tr><td>&nbsp;</td><td class="field-body">the current radius of the ring</td>
446</tr>
447</tbody>
448</table>
449</dd></dl>
450
451<dl class="method">
452<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.move">
453<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.AnnulusSlicer.RingInteractor.move" title="Permalink to this definition">¶</a></dt>
454<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
455
456<dl class="method">
457<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.moveend">
458<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.moveend" title="Permalink to this definition">¶</a></dt>
459<dd>Called after a dragging motion</dd></dl>
460
461<dl class="method">
462<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onClick">
463<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onClick" title="Permalink to this definition">¶</a></dt>
464<dd>Prepare to move the artist.  Calls save() to preserve the state for
465later restore().</dd></dl>
466
467<dl class="method">
468<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onDrag">
469<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onDrag" title="Permalink to this definition">¶</a></dt>
470<dd>Move the artist.  Calls move() to update the state, or restore() if
471the mouse leaves the window.</dd></dl>
472
473<dl class="method">
474<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onHilite">
475<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onHilite" title="Permalink to this definition">¶</a></dt>
476<dd>Hilite the artist reporting the event, indicating that it is
477ready to receive a click.</dd></dl>
478
479<dl class="method">
480<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onKey">
481<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onKey" title="Permalink to this definition">¶</a></dt>
482<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
483restores it to the position before the last click.</p>
484<p>Calls move() to update the state.  Calls restore() on escape.</p>
485</dd></dl>
486
487<dl class="method">
488<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onLeave">
489<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onLeave" title="Permalink to this definition">¶</a></dt>
490<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
491
492<dl class="method">
493<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onRelease">
494<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.onRelease" title="Permalink to this definition">¶</a></dt>
495<dd></dd></dl>
496
497<dl class="method">
498<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.restore">
499<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.restore" title="Permalink to this definition">¶</a></dt>
500<dd>Restore the roughness for this layer.</dd></dl>
501
502<dl class="method">
503<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.save">
504<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.save" title="Permalink to this definition">¶</a></dt>
505<dd>Remember the roughness for this layer and the next so that we
506can restore on Esc.</dd></dl>
507
508<dl class="method">
509<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.set_cursor">
510<tt class="descname">set_cursor</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.set_cursor" title="Permalink to this definition">¶</a></dt>
511<dd>draw the ring given x, y value</dd></dl>
512
513<dl class="method">
514<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.set_layer">
515<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.set_layer" title="Permalink to this definition">¶</a></dt>
516<dd><p>Allow adding plot to the same panel</p>
517<table class="docutils field-list" frame="void" rules="none">
518<col class="field-name" />
519<col class="field-body" />
520<tbody valign="top">
521<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
522<li><strong>n</strong> &#8211; the number of layer</li>
523</ul>
524</td>
525</tr>
526</tbody>
527</table>
528</dd></dl>
529
530<dl class="method">
531<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.set_params">
532<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.set_params" title="Permalink to this definition">¶</a></dt>
533<dd><p>Receive a dictionary and reset the slicer with values contained
534in the values of the dictionary.</p>
535<table class="docutils field-list" frame="void" rules="none">
536<col class="field-name" />
537<col class="field-body" />
538<tbody valign="top">
539<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
540<li><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
541values the user assigned to the slicer.</li>
542</ul>
543</td>
544</tr>
545</tbody>
546</table>
547</dd></dl>
548
549<dl class="method">
550<dt id="sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.update">
551<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.AnnulusSlicer.RingInteractor.update" title="Permalink to this definition">¶</a></dt>
552<dd>Draw the new roughness on the graph.</dd></dl>
553
554</dd></dl>
555
556</div>
557</div>
558
559
560          </div>
561        </div>
562      </div>
563      <div class="sphinxsidebar">
564        <div class="sphinxsidebarwrapper">
565  <h3><a href="../../../index.html">Table Of Contents</a></h3>
566  <ul>
567<li><a class="reference internal" href="#">AnnulusSlicer</a><ul>
568<li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.AnnulusSlicer"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.AnnulusSlicer</span></tt></a></li>
569</ul>
570</li>
571</ul>
572
573  <h4>Previous topic</h4>
574  <p class="topless"><a href="index.html"
575                        title="previous chapter">Local Perspective: Plotting</a></p>
576  <h4>Next topic</h4>
577  <p class="topless"><a href="Arc.html"
578                        title="next chapter">Arc</a></p>
579  <h3>This Page</h3>
580  <ul class="this-page-menu">
581    <li><a href="../../../_sources/api/local_perspectives/plotting/AnnulusSlicer.txt"
582           rel="nofollow">Show Source</a></li>
583  </ul>
584<div id="searchbox" style="display: none">
585  <h3>Quick search</h3>
586    <form class="search" action="../../../search.html" method="get">
587      <input type="text" name="q" size="18" />
588      <input type="submit" value="Go" />
589      <input type="hidden" name="check_keywords" value="yes" />
590      <input type="hidden" name="area" value="default" />
591    </form>
592    <p class="searchtip" style="font-size: 90%">
593    Enter search terms or a module, class or function name.
594    </p>
595</div>
596<script type="text/javascript">$('#searchbox').show(0);</script>
597        </div>
598      </div>
599      <div class="clearer"></div>
600    </div>
601    <div class="related">
602      <h3>Navigation</h3>
603      <ul>
604        <li class="right" style="margin-right: 10px">
605          <a href="../../../genindex.html" title="General Index"
606             >index</a></li>
607        <li class="right" >
608          <a href="../../../py-modindex.html" title="Python Module Index"
609             >modules</a> |</li>
610        <li class="right" >
611          <a href="Arc.html" title="Arc"
612             >next</a> |</li>
613        <li class="right" >
614          <a href="index.html" title="Local Perspective: Plotting"
615             >previous</a> |</li>
616        <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
617          <li><a href="index.html" >Local Perspective: Plotting</a> &raquo;</li> 
618      </ul>
619    </div>
620    <div class="footer">
621        &copy; Copyright 2010, sans group.
622      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
623    </div>
624  </body>
625</html>
Note: See TracBrowser for help on using the repository browser.