source: sasview/sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/AnnulusSlicer.html @ 96cbb53

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 96cbb53 was 96cbb53, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

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