source: sasview/sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/boxSlicer.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: 57.7 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>boxSlicer &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="boxSum" href="boxSum.html" />
28    <link rel="prev" title="boxMask" href="boxMask.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="boxSum.html" title="boxSum"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="boxMask.html" title="boxMask"
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="boxslicer">
57<h1>boxSlicer<a class="headerlink" href="#boxslicer" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.local_perspectives.plotting.boxSlicer">
59<span id="sans-guiframe-local-perspectives-plotting-boxslicer"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxSlicer" title="sans.guiframe.local_perspectives.plotting.boxSlicer"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.boxSlicer" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">BoxInteractor</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.boxSlicer.BoxInteractor" 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>BoxInteractor define a rectangle that return data1D average of Data2D
65in a rectangle area defined by -x, x ,y, -y</p>
66<dl class="method">
67<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear">
68<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear" title="Permalink to this definition">¶</a></dt>
69<dd><p>Clear the slicer and all connected events related to this slicer</p>
70</dd></dl>
71
72<dl class="method">
73<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear_markers">
74<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear_markers" title="Permalink to this definition">¶</a></dt>
75<dd><p>Clear old markers and interfaces.</p>
76</dd></dl>
77
78<dl class="method">
79<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.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.boxSlicer.BoxInteractor.connect_markers" title="Permalink to this definition">¶</a></dt>
81<dd><p>Connect markers to callbacks</p>
82</dd></dl>
83
84<dl class="method">
85<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.dpixel">
86<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.boxSlicer.BoxInteractor.dpixel" title="Permalink to this definition">¶</a></dt>
87<dd><p>Return the step size in data coordinates for a small
88step in screen coordinates.  If nudge is False (default)
89the step size is one pixel.  If nudge is True, the step
90size is 0.2 pixels.</p>
91</dd></dl>
92
93<dl class="method">
94<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.draw">
95<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.draw" title="Permalink to this definition">¶</a></dt>
96<dd></dd></dl>
97
98<dl class="method">
99<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.freeze_axes">
100<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.freeze_axes" title="Permalink to this definition">¶</a></dt>
101<dd></dd></dl>
102
103<dl class="method">
104<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.get_params">
105<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.get_params" title="Permalink to this definition">¶</a></dt>
106<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
107<table class="docutils field-list" frame="void" rules="none">
108<col class="field-name" />
109<col class="field-body" />
110<tbody valign="top">
111<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
112</tr>
113</tbody>
114</table>
115</dd></dl>
116
117<dl class="method">
118<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.move">
119<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.boxSlicer.BoxInteractor.move" title="Permalink to this definition">¶</a></dt>
120<dd><p>Process move to a new position, making sure that the move is allowed.</p>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.moveend">
125<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.moveend" title="Permalink to this definition">¶</a></dt>
126<dd><p>Called after a dragging event.
127Post the slicer new parameters and creates a new Data1D
128corresponding to the new average</p>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onClick">
133<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onClick" title="Permalink to this definition">¶</a></dt>
134<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
135later restore().</p>
136</dd></dl>
137
138<dl class="method">
139<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onDrag">
140<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onDrag" title="Permalink to this definition">¶</a></dt>
141<dd><p>Move the artist.  Calls move() to update the state, or restore() if
142the mouse leaves the window.</p>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onHilite">
147<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onHilite" title="Permalink to this definition">¶</a></dt>
148<dd><p>Hilite the artist reporting the event, indicating that it is
149ready to receive a click.</p>
150</dd></dl>
151
152<dl class="method">
153<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onKey">
154<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onKey" title="Permalink to this definition">¶</a></dt>
155<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
156restores it to the position before the last click.</p>
157<p>Calls move() to update the state.  Calls restore() on escape.</p>
158</dd></dl>
159
160<dl class="method">
161<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onLeave">
162<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onLeave" title="Permalink to this definition">¶</a></dt>
163<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
164</dd></dl>
165
166<dl class="method">
167<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onRelease">
168<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onRelease" title="Permalink to this definition">¶</a></dt>
169<dd></dd></dl>
170
171<dl class="method">
172<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.post_data">
173<tt class="descname">post_data</tt><big>(</big><em>new_slab=None</em>, <em>nbins=None</em>, <em>direction=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.post_data" title="Permalink to this definition">¶</a></dt>
174<dd><p>post data averaging in Qx or Qy given new_slab type</p>
175<table class="docutils field-list" frame="void" rules="none">
176<col class="field-name" />
177<col class="field-body" />
178<tbody valign="top">
179<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
180<li><strong>new_slab</strong> &#8211; slicer that determine with direction to average</li>
181<li><strong>nbins</strong> &#8211; the number of points plotted when averaging</li>
182<li><strong>direction</strong> &#8211; the direction of averaging</li>
183</ul>
184</td>
185</tr>
186</tbody>
187</table>
188</dd></dl>
189
190<dl class="method">
191<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.restore">
192<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.restore" title="Permalink to this definition">¶</a></dt>
193<dd><p>Restore the roughness for this layer.</p>
194</dd></dl>
195
196<dl class="method">
197<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.save">
198<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.save" title="Permalink to this definition">¶</a></dt>
199<dd><p>Remember the roughness for this layer and the next so that we
200can restore on Esc.</p>
201</dd></dl>
202
203<dl class="method">
204<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_cursor">
205<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.boxSlicer.BoxInteractor.set_cursor" title="Permalink to this definition">¶</a></dt>
206<dd></dd></dl>
207
208<dl class="method">
209<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_layer">
210<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_layer" title="Permalink to this definition">¶</a></dt>
211<dd><p>Allow adding plot to the same panel</p>
212<table class="docutils field-list" frame="void" rules="none">
213<col class="field-name" />
214<col class="field-body" />
215<tbody valign="top">
216<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> &#8211; the number of layer</td>
217</tr>
218</tbody>
219</table>
220</dd></dl>
221
222<dl class="method">
223<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_params">
224<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_params" title="Permalink to this definition">¶</a></dt>
225<dd><p>Receive a dictionary and reset the slicer with values contained
226in the values of the dictionary.</p>
227<table class="docutils field-list" frame="void" rules="none">
228<col class="field-name" />
229<col class="field-body" />
230<tbody valign="top">
231<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
232values the user assigned to the slicer.</td>
233</tr>
234</tbody>
235</table>
236</dd></dl>
237
238<dl class="method">
239<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.thaw_axes">
240<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.thaw_axes" title="Permalink to this definition">¶</a></dt>
241<dd></dd></dl>
242
243<dl class="method">
244<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update">
245<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update" title="Permalink to this definition">¶</a></dt>
246<dd><p>Respond to changes in the model by recalculating the profiles and
247resetting the widgets.</p>
248</dd></dl>
249
250<dl class="method">
251<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update_and_post">
252<tt class="descname">update_and_post</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update_and_post" title="Permalink to this definition">¶</a></dt>
253<dd><p>Update the slicer and plot the resulting data</p>
254</dd></dl>
255
256</dd></dl>
257
258<dl class="class">
259<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX">
260<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">BoxInteractorX</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.boxSlicer.BoxInteractorX" title="Permalink to this definition">¶</a></dt>
261<dd><p>Bases: <a class="reference internal" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor" title="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor</span></tt></a></p>
262<p>Average in Qx direction</p>
263<dl class="method">
264<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear">
265<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear" title="Permalink to this definition">¶</a></dt>
266<dd><p>Clear the slicer and all connected events related to this slicer</p>
267</dd></dl>
268
269<dl class="method">
270<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear_markers">
271<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear_markers" title="Permalink to this definition">¶</a></dt>
272<dd><p>Clear old markers and interfaces.</p>
273</dd></dl>
274
275<dl class="method">
276<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.connect_markers">
277<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.connect_markers" title="Permalink to this definition">¶</a></dt>
278<dd><p>Connect markers to callbacks</p>
279</dd></dl>
280
281<dl class="method">
282<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.dpixel">
283<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.boxSlicer.BoxInteractorX.dpixel" title="Permalink to this definition">¶</a></dt>
284<dd><p>Return the step size in data coordinates for a small
285step in screen coordinates.  If nudge is False (default)
286the step size is one pixel.  If nudge is True, the step
287size is 0.2 pixels.</p>
288</dd></dl>
289
290<dl class="method">
291<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.draw">
292<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.draw" title="Permalink to this definition">¶</a></dt>
293<dd></dd></dl>
294
295<dl class="method">
296<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.freeze_axes">
297<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.freeze_axes" title="Permalink to this definition">¶</a></dt>
298<dd></dd></dl>
299
300<dl class="method">
301<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.get_params">
302<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.get_params" title="Permalink to this definition">¶</a></dt>
303<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
304<table class="docutils field-list" frame="void" rules="none">
305<col class="field-name" />
306<col class="field-body" />
307<tbody valign="top">
308<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
309</tr>
310</tbody>
311</table>
312</dd></dl>
313
314<dl class="method">
315<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.move">
316<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.boxSlicer.BoxInteractorX.move" title="Permalink to this definition">¶</a></dt>
317<dd><p>Process move to a new position, making sure that the move is allowed.</p>
318</dd></dl>
319
320<dl class="method">
321<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.moveend">
322<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.moveend" title="Permalink to this definition">¶</a></dt>
323<dd><p>Called after a dragging event.
324Post the slicer new parameters and creates a new Data1D
325corresponding to the new average</p>
326</dd></dl>
327
328<dl class="method">
329<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onClick">
330<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onClick" title="Permalink to this definition">¶</a></dt>
331<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
332later restore().</p>
333</dd></dl>
334
335<dl class="method">
336<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onDrag">
337<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onDrag" title="Permalink to this definition">¶</a></dt>
338<dd><p>Move the artist.  Calls move() to update the state, or restore() if
339the mouse leaves the window.</p>
340</dd></dl>
341
342<dl class="method">
343<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onHilite">
344<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onHilite" title="Permalink to this definition">¶</a></dt>
345<dd><p>Hilite the artist reporting the event, indicating that it is
346ready to receive a click.</p>
347</dd></dl>
348
349<dl class="method">
350<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onKey">
351<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onKey" title="Permalink to this definition">¶</a></dt>
352<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
353restores it to the position before the last click.</p>
354<p>Calls move() to update the state.  Calls restore() on escape.</p>
355</dd></dl>
356
357<dl class="method">
358<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onLeave">
359<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onLeave" title="Permalink to this definition">¶</a></dt>
360<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
361</dd></dl>
362
363<dl class="method">
364<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onRelease">
365<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onRelease" title="Permalink to this definition">¶</a></dt>
366<dd></dd></dl>
367
368<dl class="method">
369<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.post_data">
370<tt class="descname">post_data</tt><big>(</big><em>new_slab=None</em>, <em>nbins=None</em>, <em>direction=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.post_data" title="Permalink to this definition">¶</a></dt>
371<dd><p>post data averaging in Qx or Qy given new_slab type</p>
372<table class="docutils field-list" frame="void" rules="none">
373<col class="field-name" />
374<col class="field-body" />
375<tbody valign="top">
376<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
377<li><strong>new_slab</strong> &#8211; slicer that determine with direction to average</li>
378<li><strong>nbins</strong> &#8211; the number of points plotted when averaging</li>
379<li><strong>direction</strong> &#8211; the direction of averaging</li>
380</ul>
381</td>
382</tr>
383</tbody>
384</table>
385</dd></dl>
386
387<dl class="method">
388<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.restore">
389<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.restore" title="Permalink to this definition">¶</a></dt>
390<dd><p>Restore the roughness for this layer.</p>
391</dd></dl>
392
393<dl class="method">
394<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.save">
395<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.save" title="Permalink to this definition">¶</a></dt>
396<dd><p>Remember the roughness for this layer and the next so that we
397can restore on Esc.</p>
398</dd></dl>
399
400<dl class="method">
401<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_cursor">
402<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.boxSlicer.BoxInteractorX.set_cursor" title="Permalink to this definition">¶</a></dt>
403<dd></dd></dl>
404
405<dl class="method">
406<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_layer">
407<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_layer" title="Permalink to this definition">¶</a></dt>
408<dd><p>Allow adding plot to the same panel</p>
409<table class="docutils field-list" frame="void" rules="none">
410<col class="field-name" />
411<col class="field-body" />
412<tbody valign="top">
413<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> &#8211; the number of layer</td>
414</tr>
415</tbody>
416</table>
417</dd></dl>
418
419<dl class="method">
420<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_params">
421<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_params" title="Permalink to this definition">¶</a></dt>
422<dd><p>Receive a dictionary and reset the slicer with values contained
423in the values of the dictionary.</p>
424<table class="docutils field-list" frame="void" rules="none">
425<col class="field-name" />
426<col class="field-body" />
427<tbody valign="top">
428<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
429values the user assigned to the slicer.</td>
430</tr>
431</tbody>
432</table>
433</dd></dl>
434
435<dl class="method">
436<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.thaw_axes">
437<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.thaw_axes" title="Permalink to this definition">¶</a></dt>
438<dd></dd></dl>
439
440<dl class="method">
441<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update">
442<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update" title="Permalink to this definition">¶</a></dt>
443<dd><p>Respond to changes in the model by recalculating the profiles and
444resetting the widgets.</p>
445</dd></dl>
446
447<dl class="method">
448<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update_and_post">
449<tt class="descname">update_and_post</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update_and_post" title="Permalink to this definition">¶</a></dt>
450<dd><p>Update the slicer and plot the resulting data</p>
451</dd></dl>
452
453</dd></dl>
454
455<dl class="class">
456<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY">
457<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">BoxInteractorY</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.boxSlicer.BoxInteractorY" title="Permalink to this definition">¶</a></dt>
458<dd><p>Bases: <a class="reference internal" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor" title="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor</span></tt></a></p>
459<p>Average in Qy direction</p>
460<dl class="method">
461<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear">
462<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear" title="Permalink to this definition">¶</a></dt>
463<dd><p>Clear the slicer and all connected events related to this slicer</p>
464</dd></dl>
465
466<dl class="method">
467<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear_markers">
468<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear_markers" title="Permalink to this definition">¶</a></dt>
469<dd><p>Clear old markers and interfaces.</p>
470</dd></dl>
471
472<dl class="method">
473<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.connect_markers">
474<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.connect_markers" title="Permalink to this definition">¶</a></dt>
475<dd><p>Connect markers to callbacks</p>
476</dd></dl>
477
478<dl class="method">
479<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.dpixel">
480<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.boxSlicer.BoxInteractorY.dpixel" title="Permalink to this definition">¶</a></dt>
481<dd><p>Return the step size in data coordinates for a small
482step in screen coordinates.  If nudge is False (default)
483the step size is one pixel.  If nudge is True, the step
484size is 0.2 pixels.</p>
485</dd></dl>
486
487<dl class="method">
488<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.draw">
489<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.draw" title="Permalink to this definition">¶</a></dt>
490<dd></dd></dl>
491
492<dl class="method">
493<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.freeze_axes">
494<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.freeze_axes" title="Permalink to this definition">¶</a></dt>
495<dd></dd></dl>
496
497<dl class="method">
498<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.get_params">
499<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.get_params" title="Permalink to this definition">¶</a></dt>
500<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
501<table class="docutils field-list" frame="void" rules="none">
502<col class="field-name" />
503<col class="field-body" />
504<tbody valign="top">
505<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
506</tr>
507</tbody>
508</table>
509</dd></dl>
510
511<dl class="method">
512<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.move">
513<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.boxSlicer.BoxInteractorY.move" title="Permalink to this definition">¶</a></dt>
514<dd><p>Process move to a new position, making sure that the move is allowed.</p>
515</dd></dl>
516
517<dl class="method">
518<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.moveend">
519<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.moveend" title="Permalink to this definition">¶</a></dt>
520<dd><p>Called after a dragging event.
521Post the slicer new parameters and creates a new Data1D
522corresponding to the new average</p>
523</dd></dl>
524
525<dl class="method">
526<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onClick">
527<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onClick" title="Permalink to this definition">¶</a></dt>
528<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
529later restore().</p>
530</dd></dl>
531
532<dl class="method">
533<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onDrag">
534<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onDrag" title="Permalink to this definition">¶</a></dt>
535<dd><p>Move the artist.  Calls move() to update the state, or restore() if
536the mouse leaves the window.</p>
537</dd></dl>
538
539<dl class="method">
540<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onHilite">
541<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onHilite" title="Permalink to this definition">¶</a></dt>
542<dd><p>Hilite the artist reporting the event, indicating that it is
543ready to receive a click.</p>
544</dd></dl>
545
546<dl class="method">
547<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onKey">
548<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onKey" title="Permalink to this definition">¶</a></dt>
549<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
550restores it to the position before the last click.</p>
551<p>Calls move() to update the state.  Calls restore() on escape.</p>
552</dd></dl>
553
554<dl class="method">
555<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onLeave">
556<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onLeave" title="Permalink to this definition">¶</a></dt>
557<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
558</dd></dl>
559
560<dl class="method">
561<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onRelease">
562<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onRelease" title="Permalink to this definition">¶</a></dt>
563<dd></dd></dl>
564
565<dl class="method">
566<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.post_data">
567<tt class="descname">post_data</tt><big>(</big><em>new_slab=None</em>, <em>nbins=None</em>, <em>direction=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.post_data" title="Permalink to this definition">¶</a></dt>
568<dd><p>post data averaging in Qx or Qy given new_slab type</p>
569<table class="docutils field-list" frame="void" rules="none">
570<col class="field-name" />
571<col class="field-body" />
572<tbody valign="top">
573<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
574<li><strong>new_slab</strong> &#8211; slicer that determine with direction to average</li>
575<li><strong>nbins</strong> &#8211; the number of points plotted when averaging</li>
576<li><strong>direction</strong> &#8211; the direction of averaging</li>
577</ul>
578</td>
579</tr>
580</tbody>
581</table>
582</dd></dl>
583
584<dl class="method">
585<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.restore">
586<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.restore" title="Permalink to this definition">¶</a></dt>
587<dd><p>Restore the roughness for this layer.</p>
588</dd></dl>
589
590<dl class="method">
591<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.save">
592<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.save" title="Permalink to this definition">¶</a></dt>
593<dd><p>Remember the roughness for this layer and the next so that we
594can restore on Esc.</p>
595</dd></dl>
596
597<dl class="method">
598<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_cursor">
599<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.boxSlicer.BoxInteractorY.set_cursor" title="Permalink to this definition">¶</a></dt>
600<dd></dd></dl>
601
602<dl class="method">
603<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_layer">
604<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_layer" title="Permalink to this definition">¶</a></dt>
605<dd><p>Allow adding plot to the same panel</p>
606<table class="docutils field-list" frame="void" rules="none">
607<col class="field-name" />
608<col class="field-body" />
609<tbody valign="top">
610<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> &#8211; the number of layer</td>
611</tr>
612</tbody>
613</table>
614</dd></dl>
615
616<dl class="method">
617<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_params">
618<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_params" title="Permalink to this definition">¶</a></dt>
619<dd><p>Receive a dictionary and reset the slicer with values contained
620in the values of the dictionary.</p>
621<table class="docutils field-list" frame="void" rules="none">
622<col class="field-name" />
623<col class="field-body" />
624<tbody valign="top">
625<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
626values the user assigned to the slicer.</td>
627</tr>
628</tbody>
629</table>
630</dd></dl>
631
632<dl class="method">
633<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.thaw_axes">
634<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.thaw_axes" title="Permalink to this definition">¶</a></dt>
635<dd></dd></dl>
636
637<dl class="method">
638<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update">
639<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update" title="Permalink to this definition">¶</a></dt>
640<dd><p>Respond to changes in the model by recalculating the profiles and
641resetting the widgets.</p>
642</dd></dl>
643
644<dl class="method">
645<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update_and_post">
646<tt class="descname">update_and_post</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update_and_post" title="Permalink to this definition">¶</a></dt>
647<dd><p>Update the slicer and plot the resulting data</p>
648</dd></dl>
649
650</dd></dl>
651
652<dl class="class">
653<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines">
654<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">HorizontalLines</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=5</em>, <em>x=0.5</em>, <em>y=0.5</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines" title="Permalink to this definition">¶</a></dt>
655<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
656<p>Draw 2 Horizontal lines centered on (0,0) that can move
657on the x- direction and in opposite direction</p>
658<dl class="method">
659<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear">
660<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear" title="Permalink to this definition">¶</a></dt>
661<dd><p>Clear this slicer  and its markers</p>
662</dd></dl>
663
664<dl class="method">
665<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear_markers">
666<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear_markers" title="Permalink to this definition">¶</a></dt>
667<dd><p>Clear old markers and interfaces.</p>
668</dd></dl>
669
670<dl class="method">
671<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.connect_markers">
672<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.connect_markers" title="Permalink to this definition">¶</a></dt>
673<dd><p>Connect markers to callbacks</p>
674</dd></dl>
675
676<dl class="method">
677<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.dpixel">
678<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.boxSlicer.HorizontalLines.dpixel" title="Permalink to this definition">¶</a></dt>
679<dd><p>Return the step size in data coordinates for a small
680step in screen coordinates.  If nudge is False (default)
681the step size is one pixel.  If nudge is True, the step
682size is 0.2 pixels.</p>
683</dd></dl>
684
685<dl class="method">
686<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.move">
687<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.boxSlicer.HorizontalLines.move" title="Permalink to this definition">¶</a></dt>
688<dd><p>Process move to a new position, making sure that the move is allowed.</p>
689</dd></dl>
690
691<dl class="method">
692<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.moveend">
693<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.moveend" title="Permalink to this definition">¶</a></dt>
694<dd><p>Called after a dragging this edge and set self.has_move to False
695to specify the end of dragging motion</p>
696</dd></dl>
697
698<dl class="method">
699<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onClick">
700<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onClick" title="Permalink to this definition">¶</a></dt>
701<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
702later restore().</p>
703</dd></dl>
704
705<dl class="method">
706<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onDrag">
707<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onDrag" title="Permalink to this definition">¶</a></dt>
708<dd><p>Move the artist.  Calls move() to update the state, or restore() if
709the mouse leaves the window.</p>
710</dd></dl>
711
712<dl class="method">
713<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onHilite">
714<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onHilite" title="Permalink to this definition">¶</a></dt>
715<dd><p>Hilite the artist reporting the event, indicating that it is
716ready to receive a click.</p>
717</dd></dl>
718
719<dl class="method">
720<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onKey">
721<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onKey" title="Permalink to this definition">¶</a></dt>
722<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
723restores it to the position before the last click.</p>
724<p>Calls move() to update the state.  Calls restore() on escape.</p>
725</dd></dl>
726
727<dl class="method">
728<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onLeave">
729<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onLeave" title="Permalink to this definition">¶</a></dt>
730<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
731</dd></dl>
732
733<dl class="method">
734<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onRelease">
735<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onRelease" title="Permalink to this definition">¶</a></dt>
736<dd></dd></dl>
737
738<dl class="method">
739<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.restore">
740<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.restore" title="Permalink to this definition">¶</a></dt>
741<dd><p>Restore the roughness for this layer.</p>
742</dd></dl>
743
744<dl class="method">
745<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.save">
746<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.save" title="Permalink to this definition">¶</a></dt>
747<dd><p>Remember the roughness for this layer and the next so that we
748can restore on Esc.</p>
749</dd></dl>
750
751<dl class="method">
752<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.set_layer">
753<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.set_layer" title="Permalink to this definition">¶</a></dt>
754<dd><p>Allow adding plot to the same panel</p>
755<table class="docutils field-list" frame="void" rules="none">
756<col class="field-name" />
757<col class="field-body" />
758<tbody valign="top">
759<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> &#8211; the number of layer</td>
760</tr>
761</tbody>
762</table>
763</dd></dl>
764
765<dl class="method">
766<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.update">
767<tt class="descname">update</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.update" title="Permalink to this definition">¶</a></dt>
768<dd><p>Draw the new roughness on the graph.</p>
769<table class="docutils field-list" frame="void" rules="none">
770<col class="field-name" />
771<col class="field-body" />
772<tbody valign="top">
773<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
774<li><strong>x</strong> &#8211; x-coordinates to reset current class x</li>
775<li><strong>y</strong> &#8211; y-coordinates to reset current class y</li>
776</ul>
777</td>
778</tr>
779</tbody>
780</table>
781</dd></dl>
782
783</dd></dl>
784
785<dl class="class">
786<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines">
787<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">VerticalLines</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=5</em>, <em>x=0.5</em>, <em>y=0.5</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines" title="Permalink to this definition">¶</a></dt>
788<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
789<p>Select an annulus through a 2D plot</p>
790<dl class="method">
791<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear">
792<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear" title="Permalink to this definition">¶</a></dt>
793<dd><p>Clear this slicer  and its markers</p>
794</dd></dl>
795
796<dl class="method">
797<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear_markers">
798<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear_markers" title="Permalink to this definition">¶</a></dt>
799<dd><p>Clear old markers and interfaces.</p>
800</dd></dl>
801
802<dl class="method">
803<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.connect_markers">
804<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.connect_markers" title="Permalink to this definition">¶</a></dt>
805<dd><p>Connect markers to callbacks</p>
806</dd></dl>
807
808<dl class="method">
809<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.dpixel">
810<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.boxSlicer.VerticalLines.dpixel" title="Permalink to this definition">¶</a></dt>
811<dd><p>Return the step size in data coordinates for a small
812step in screen coordinates.  If nudge is False (default)
813the step size is one pixel.  If nudge is True, the step
814size is 0.2 pixels.</p>
815</dd></dl>
816
817<dl class="method">
818<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.move">
819<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.boxSlicer.VerticalLines.move" title="Permalink to this definition">¶</a></dt>
820<dd><p>Process move to a new position, making sure that the move is allowed.</p>
821</dd></dl>
822
823<dl class="method">
824<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.moveend">
825<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.moveend" title="Permalink to this definition">¶</a></dt>
826<dd><p>Called after a dragging this edge and set self.has_move to False
827to specify the end of dragging motion</p>
828</dd></dl>
829
830<dl class="method">
831<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onClick">
832<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onClick" title="Permalink to this definition">¶</a></dt>
833<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
834later restore().</p>
835</dd></dl>
836
837<dl class="method">
838<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onDrag">
839<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onDrag" title="Permalink to this definition">¶</a></dt>
840<dd><p>Move the artist.  Calls move() to update the state, or restore() if
841the mouse leaves the window.</p>
842</dd></dl>
843
844<dl class="method">
845<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onHilite">
846<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onHilite" title="Permalink to this definition">¶</a></dt>
847<dd><p>Hilite the artist reporting the event, indicating that it is
848ready to receive a click.</p>
849</dd></dl>
850
851<dl class="method">
852<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onKey">
853<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onKey" title="Permalink to this definition">¶</a></dt>
854<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
855restores it to the position before the last click.</p>
856<p>Calls move() to update the state.  Calls restore() on escape.</p>
857</dd></dl>
858
859<dl class="method">
860<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onLeave">
861<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onLeave" title="Permalink to this definition">¶</a></dt>
862<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
863</dd></dl>
864
865<dl class="method">
866<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onRelease">
867<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onRelease" title="Permalink to this definition">¶</a></dt>
868<dd></dd></dl>
869
870<dl class="method">
871<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.restore">
872<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.restore" title="Permalink to this definition">¶</a></dt>
873<dd><p>Restore the roughness for this layer.</p>
874</dd></dl>
875
876<dl class="method">
877<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.save">
878<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.save" title="Permalink to this definition">¶</a></dt>
879<dd><p>Remember the roughness for this layer and the next so that we
880can restore on Esc.</p>
881</dd></dl>
882
883<dl class="method">
884<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.set_layer">
885<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.set_layer" title="Permalink to this definition">¶</a></dt>
886<dd><p>Allow adding plot to the same panel</p>
887<table class="docutils field-list" frame="void" rules="none">
888<col class="field-name" />
889<col class="field-body" />
890<tbody valign="top">
891<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> &#8211; the number of layer</td>
892</tr>
893</tbody>
894</table>
895</dd></dl>
896
897<dl class="method">
898<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.update">
899<tt class="descname">update</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.update" title="Permalink to this definition">¶</a></dt>
900<dd><p>Draw the new roughness on the graph.</p>
901<table class="docutils field-list" frame="void" rules="none">
902<col class="field-name" />
903<col class="field-body" />
904<tbody valign="top">
905<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
906<li><strong>x</strong> &#8211; x-coordinates to reset current class x</li>
907<li><strong>y</strong> &#8211; y-coordinates to reset current class y</li>
908</ul>
909</td>
910</tr>
911</tbody>
912</table>
913</dd></dl>
914
915</dd></dl>
916
917</div>
918</div>
919
920
921          </div>
922        </div>
923      </div>
924      <div class="sphinxsidebar">
925        <div class="sphinxsidebarwrapper">
926  <h3><a href="../../../index.html">Table Of Contents</a></h3>
927  <ul>
928<li><a class="reference internal" href="#">boxSlicer</a><ul>
929<li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxSlicer"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer</span></tt></a></li>
930</ul>
931</li>
932</ul>
933
934  <h4>Previous topic</h4>
935  <p class="topless"><a href="boxMask.html"
936                        title="previous chapter">boxMask</a></p>
937  <h4>Next topic</h4>
938  <p class="topless"><a href="boxSum.html"
939                        title="next chapter">boxSum</a></p>
940  <h3>This Page</h3>
941  <ul class="this-page-menu">
942    <li><a href="../../../_sources/api/local_perspectives/plotting/boxSlicer.txt"
943           rel="nofollow">Show Source</a></li>
944  </ul>
945<div id="searchbox" style="display: none">
946  <h3>Quick search</h3>
947    <form class="search" action="../../../search.html" method="get">
948      <input type="text" name="q" size="18" />
949      <input type="submit" value="Go" />
950      <input type="hidden" name="check_keywords" value="yes" />
951      <input type="hidden" name="area" value="default" />
952    </form>
953    <p class="searchtip" style="font-size: 90%">
954    Enter search terms or a module, class or function name.
955    </p>
956</div>
957<script type="text/javascript">$('#searchbox').show(0);</script>
958        </div>
959      </div>
960      <div class="clearer"></div>
961    </div>
962    <div class="related">
963      <h3>Navigation</h3>
964      <ul>
965        <li class="right" style="margin-right: 10px">
966          <a href="../../../genindex.html" title="General Index"
967             >index</a></li>
968        <li class="right" >
969          <a href="../../../py-modindex.html" title="Python Module Index"
970             >modules</a> |</li>
971        <li class="right" >
972          <a href="boxSum.html" title="boxSum"
973             >next</a> |</li>
974        <li class="right" >
975          <a href="boxMask.html" title="boxMask"
976             >previous</a> |</li>
977        <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
978          <li><a href="index.html" >Local Perspective: plotting</a> &raquo;</li> 
979      </ul>
980    </div>
981    <div class="footer">
982        &copy; Copyright 2010, sans group.
983      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
984    </div>
985  </body>
986</html>
Note: See TracBrowser for help on using the repository browser.