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