source: sasview/sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/boxMask.html @ 67cd7c0

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 67cd7c0 was bce8148, checked in by Gervaise Alina <gervyh@…>, 13 years ago

sphinx build
  • Property mode set to 100644
File size: 28.3 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>boxMask &mdash; guiframe 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../../../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../../../_static/jquery.js"></script>
26    <script type="text/javascript" src="../../../_static/underscore.js"></script>
27    <script type="text/javascript" src="../../../_static/doctools.js"></script>
28    <link rel="top" title="guiframe 0.1.0 documentation" href="../../../index.html" />
29    <link rel="up" title="Local Perspective: plotting" href="index.html" />
30    <link rel="next" title="boxSlicer" href="boxSlicer.html" />
31    <link rel="prev" title="binder" href="binder.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../../../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../../../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="boxSlicer.html" title="boxSlicer"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="binder.html" title="binder"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Local Perspective: plotting</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="boxmask">
60<h1>boxMask<a class="headerlink" href="#boxmask" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-guiframe-local-perspectives-plotting-boxmask">
62<h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxMask" title="sans.guiframe.local_perspectives.plotting.boxMask"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxMask</span></tt></a><a class="headerlink" href="#sans-guiframe-local-perspectives-plotting-boxmask" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.guiframe.local_perspectives.plotting.boxMask"></span><dl class="class">
64<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask">
65<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxMask.</tt><tt class="descname">BoxMask</tt><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask" title="Permalink to this definition">¶</a></dt>
66<dd><p>Bases: <a class="reference internal" href="BaseInteractor.html#sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor" title="sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></a></p>
67<p>BoxMask Class: determine 2 rectangular area to find the pixel of
68a Data inside of box.</p>
69<p>Uses PointerInteractor , VerticalDoubleLine,HorizontalDoubleLine.</p>
70<table class="docutils field-list" frame="void" rules="none">
71<col class="field-name" />
72<col class="field-body" />
73<tbody valign="top">
74<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
75<li><strong>zorder</strong> &#8211; Artists with lower zorder values are drawn first.</li>
76<li><strong>x_min</strong> &#8211; the minimum value of the x coordinate</li>
77<li><strong>x_max</strong> &#8211; the maximum value of the x coordinate</li>
78<li><strong>y_min</strong> &#8211; the minimum value of the y coordinate</li>
79<li><strong>y_max</strong> &#8211; the maximum value of the y coordinate</li>
80</ul>
81</td>
82</tr>
83</tbody>
84</table>
85<dl class="method">
86<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.__init__">
87<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.__init__" title="Permalink to this definition">¶</a></dt>
88<dd></dd></dl>
89
90<dl class="attribute">
91<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.__module__">
92<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.local_perspectives.plotting.boxMask'</em><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.__module__" title="Permalink to this definition">¶</a></dt>
93<dd></dd></dl>
94
95<dl class="method">
96<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask._post_data">
97<tt class="descname">_post_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask._post_data" title="Permalink to this definition">¶</a></dt>
98<dd><p>Get the limits of the boxsum and compute the sum of the pixel
99contained in that region and the error on that sum</p>
100</dd></dl>
101
102<dl class="method">
103<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear">
104<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear" title="Permalink to this definition">¶</a></dt>
105<dd><p>Clear the slicer and all connected events related to this slicer</p>
106</dd></dl>
107
108<dl class="method">
109<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear_markers">
110<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear_markers" title="Permalink to this definition">¶</a></dt>
111<dd><p>Clear old markers and interfaces.</p>
112</dd></dl>
113
114<dl class="method">
115<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.connect_markers">
116<tt class="descname">connect_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.connect_markers" title="Permalink to this definition">¶</a></dt>
117<dd><p>Connect markers to callbacks</p>
118</dd></dl>
119
120<dl class="method">
121<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.dpixel">
122<tt class="descname">dpixel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.dpixel" title="Permalink to this definition">¶</a></dt>
123<dd><p>Return the step size in data coordinates for a small
124step in screen coordinates.  If nudge is False (default)
125the step size is one pixel.  If nudge is True, the step
126size is 0.2 pixels.</p>
127</dd></dl>
128
129<dl class="method">
130<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.draw">
131<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.draw" title="Permalink to this definition">¶</a></dt>
132<dd></dd></dl>
133
134<dl class="method">
135<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.freeze_axes">
136<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.freeze_axes" title="Permalink to this definition">¶</a></dt>
137<dd></dd></dl>
138
139<dl class="method">
140<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_mask">
141<tt class="descname">get_mask</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_mask" title="Permalink to this definition">¶</a></dt>
142<dd><p>return mask as a result of boxcut</p>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_params">
147<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_params" title="Permalink to this definition">¶</a></dt>
148<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
149<table class="docutils field-list" frame="void" rules="none">
150<col class="field-name" />
151<col class="field-body" />
152<tbody valign="top">
153<tr class="field-odd field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
154</tr>
155</tbody>
156</table>
157</dd></dl>
158
159<dl class="method">
160<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.move">
161<tt class="descname">move</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.move" title="Permalink to this definition">¶</a></dt>
162<dd><p>Process move to a new position, making sure that the move is allowed.</p>
163</dd></dl>
164
165<dl class="method">
166<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.moveend">
167<tt class="descname">moveend</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.moveend" title="Permalink to this definition">¶</a></dt>
168<dd><p>After a dragging motion this function is called to compute
169the error and the sum of pixel of a given data 2D</p>
170</dd></dl>
171
172<dl class="method">
173<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onClick">
174<tt class="descname">onClick</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onClick" title="Permalink to this definition">¶</a></dt>
175<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
176later restore().</p>
177</dd></dl>
178
179<dl class="method">
180<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onDrag">
181<tt class="descname">onDrag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onDrag" title="Permalink to this definition">¶</a></dt>
182<dd><p>Move the artist.  Calls move() to update the state, or restore() if
183the mouse leaves the window.</p>
184</dd></dl>
185
186<dl class="method">
187<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onHilite">
188<tt class="descname">onHilite</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onHilite" title="Permalink to this definition">¶</a></dt>
189<dd><p>Hilite the artist reporting the event, indicating that it is
190ready to receive a click.</p>
191</dd></dl>
192
193<dl class="method">
194<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onKey">
195<tt class="descname">onKey</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onKey" title="Permalink to this definition">¶</a></dt>
196<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
197restores it to the position before the last click.</p>
198<p>Calls move() to update the state.  Calls restore() on escape.</p>
199</dd></dl>
200
201<dl class="method">
202<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onLeave">
203<tt class="descname">onLeave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onLeave" title="Permalink to this definition">¶</a></dt>
204<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
205</dd></dl>
206
207<dl class="method">
208<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onRelease">
209<tt class="descname">onRelease</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onRelease" title="Permalink to this definition">¶</a></dt>
210<dd></dd></dl>
211
212<dl class="method">
213<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.restore">
214<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.restore" title="Permalink to this definition">¶</a></dt>
215<dd><p>Restore the roughness for this layer.</p>
216</dd></dl>
217
218<dl class="method">
219<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.save">
220<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.save" title="Permalink to this definition">¶</a></dt>
221<dd><p>Remember the roughness for this layer and the next so that we
222can restore on Esc.</p>
223</dd></dl>
224
225<dl class="method">
226<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_cursor">
227<tt class="descname">set_cursor</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_cursor" title="Permalink to this definition">¶</a></dt>
228<dd></dd></dl>
229
230<dl class="method">
231<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_params">
232<tt class="descname">set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_params" title="Permalink to this definition">¶</a></dt>
233<dd><p>Receive a dictionary and reset the slicer with values contained
234in the values of the dictionary.</p>
235<table class="docutils field-list" frame="void" rules="none">
236<col class="field-name" />
237<col class="field-body" />
238<tbody valign="top">
239<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
240values the user assigned to the slicer.</td>
241</tr>
242</tbody>
243</table>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.thaw_axes">
248<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.thaw_axes" title="Permalink to this definition">¶</a></dt>
249<dd></dd></dl>
250
251<dl class="method">
252<dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.update">
253<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.update" title="Permalink to this definition">¶</a></dt>
254<dd><p>Respond to changes in the model by recalculating the profiles and
255resetting the widgets.</p>
256</dd></dl>
257
258</dd></dl>
259
260<dl class="class">
261<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask">
262<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxMask.</tt><tt class="descname">inner_BoxMask</tt><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask" title="Permalink to this definition">¶</a></dt>
263<dd><p>Bases: <a class="reference internal" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask" title="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxMask.BoxMask</span></tt></a></p>
264<dl class="method">
265<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.__call__">
266<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.__call__" title="Permalink to this definition">¶</a></dt>
267<dd></dd></dl>
268
269<dl class="method">
270<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.__init__">
271<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.__init__" title="Permalink to this definition">¶</a></dt>
272<dd></dd></dl>
273
274<dl class="attribute">
275<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.__module__">
276<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.local_perspectives.plotting.boxMask'</em><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.__module__" title="Permalink to this definition">¶</a></dt>
277<dd></dd></dl>
278
279<dl class="method">
280<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask._post_data">
281<tt class="descname">_post_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask._post_data" title="Permalink to this definition">¶</a></dt>
282<dd><p>Get the limits of the boxsum and compute the sum of the pixel
283contained in that region and the error on that sum</p>
284</dd></dl>
285
286<dl class="method">
287<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear">
288<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear" title="Permalink to this definition">¶</a></dt>
289<dd><p>Clear the slicer and all connected events related to this slicer</p>
290</dd></dl>
291
292<dl class="method">
293<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear_markers">
294<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear_markers" title="Permalink to this definition">¶</a></dt>
295<dd><p>Clear old markers and interfaces.</p>
296</dd></dl>
297
298<dl class="method">
299<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.connect_markers">
300<tt class="descname">connect_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.connect_markers" title="Permalink to this definition">¶</a></dt>
301<dd><p>Connect markers to callbacks</p>
302</dd></dl>
303
304<dl class="method">
305<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.dpixel">
306<tt class="descname">dpixel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.dpixel" title="Permalink to this definition">¶</a></dt>
307<dd><p>Return the step size in data coordinates for a small
308step in screen coordinates.  If nudge is False (default)
309the step size is one pixel.  If nudge is True, the step
310size is 0.2 pixels.</p>
311</dd></dl>
312
313<dl class="method">
314<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.draw">
315<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.draw" title="Permalink to this definition">¶</a></dt>
316<dd></dd></dl>
317
318<dl class="method">
319<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.freeze_axes">
320<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.freeze_axes" title="Permalink to this definition">¶</a></dt>
321<dd></dd></dl>
322
323<dl class="method">
324<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_mask">
325<tt class="descname">get_mask</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_mask" title="Permalink to this definition">¶</a></dt>
326<dd><p>return mask as a result of boxcut</p>
327</dd></dl>
328
329<dl class="method">
330<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_params">
331<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_params" title="Permalink to this definition">¶</a></dt>
332<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
333<table class="docutils field-list" frame="void" rules="none">
334<col class="field-name" />
335<col class="field-body" />
336<tbody valign="top">
337<tr class="field-odd field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
338</tr>
339</tbody>
340</table>
341</dd></dl>
342
343<dl class="method">
344<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.move">
345<tt class="descname">move</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.move" title="Permalink to this definition">¶</a></dt>
346<dd><p>Process move to a new position, making sure that the move is allowed.</p>
347</dd></dl>
348
349<dl class="method">
350<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.moveend">
351<tt class="descname">moveend</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.moveend" title="Permalink to this definition">¶</a></dt>
352<dd><p>After a dragging motion this function is called to compute
353the error and the sum of pixel of a given data 2D</p>
354</dd></dl>
355
356<dl class="method">
357<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onClick">
358<tt class="descname">onClick</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onClick" title="Permalink to this definition">¶</a></dt>
359<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
360later restore().</p>
361</dd></dl>
362
363<dl class="method">
364<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onDrag">
365<tt class="descname">onDrag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onDrag" title="Permalink to this definition">¶</a></dt>
366<dd><p>Move the artist.  Calls move() to update the state, or restore() if
367the mouse leaves the window.</p>
368</dd></dl>
369
370<dl class="method">
371<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onHilite">
372<tt class="descname">onHilite</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onHilite" title="Permalink to this definition">¶</a></dt>
373<dd><p>Hilite the artist reporting the event, indicating that it is
374ready to receive a click.</p>
375</dd></dl>
376
377<dl class="method">
378<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onKey">
379<tt class="descname">onKey</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onKey" title="Permalink to this definition">¶</a></dt>
380<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
381restores it to the position before the last click.</p>
382<p>Calls move() to update the state.  Calls restore() on escape.</p>
383</dd></dl>
384
385<dl class="method">
386<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onLeave">
387<tt class="descname">onLeave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onLeave" title="Permalink to this definition">¶</a></dt>
388<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
389</dd></dl>
390
391<dl class="method">
392<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onRelease">
393<tt class="descname">onRelease</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onRelease" title="Permalink to this definition">¶</a></dt>
394<dd></dd></dl>
395
396<dl class="method">
397<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.restore">
398<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.restore" title="Permalink to this definition">¶</a></dt>
399<dd><p>Restore the roughness for this layer.</p>
400</dd></dl>
401
402<dl class="method">
403<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.save">
404<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.save" title="Permalink to this definition">¶</a></dt>
405<dd><p>Remember the roughness for this layer and the next so that we
406can restore on Esc.</p>
407</dd></dl>
408
409<dl class="method">
410<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_cursor">
411<tt class="descname">set_cursor</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_cursor" title="Permalink to this definition">¶</a></dt>
412<dd></dd></dl>
413
414<dl class="method">
415<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_params">
416<tt class="descname">set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_params" title="Permalink to this definition">¶</a></dt>
417<dd><p>Receive a dictionary and reset the slicer with values contained
418in the values of the dictionary.</p>
419<table class="docutils field-list" frame="void" rules="none">
420<col class="field-name" />
421<col class="field-body" />
422<tbody valign="top">
423<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
424values the user assigned to the slicer.</td>
425</tr>
426</tbody>
427</table>
428</dd></dl>
429
430<dl class="method">
431<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.thaw_axes">
432<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.thaw_axes" title="Permalink to this definition">¶</a></dt>
433<dd></dd></dl>
434
435<dl class="method">
436<dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.update">
437<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.update" title="Permalink to this definition">¶</a></dt>
438<dd><p>Respond to changes in the model by recalculating the profiles and
439resetting the widgets.</p>
440</dd></dl>
441
442</dd></dl>
443
444</div>
445</div>
446
447
448          </div>
449        </div>
450      </div>
451      <div class="sphinxsidebar">
452        <div class="sphinxsidebarwrapper">
453  <h3><a href="../../../index.html">Table Of Contents</a></h3>
454  <ul>
455<li><a class="reference internal" href="#">boxMask</a><ul>
456<li><a class="reference internal" href="#sans-guiframe-local-perspectives-plotting-boxmask"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxMask</span></tt></a></li>
457</ul>
458</li>
459</ul>
460
461  <h4>Previous topic</h4>
462  <p class="topless"><a href="binder.html"
463                        title="previous chapter">binder</a></p>
464  <h4>Next topic</h4>
465  <p class="topless"><a href="boxSlicer.html"
466                        title="next chapter">boxSlicer</a></p>
467  <h3>This Page</h3>
468  <ul class="this-page-menu">
469    <li><a href="../../../_sources/api/local_perspectives/plotting/boxMask.txt"
470           rel="nofollow">Show Source</a></li>
471  </ul>
472<div id="searchbox" style="display: none">
473  <h3>Quick search</h3>
474    <form class="search" action="../../../search.html" method="get">
475      <input type="text" name="q" />
476      <input type="submit" value="Go" />
477      <input type="hidden" name="check_keywords" value="yes" />
478      <input type="hidden" name="area" value="default" />
479    </form>
480    <p class="searchtip" style="font-size: 90%">
481    Enter search terms or a module, class or function name.
482    </p>
483</div>
484<script type="text/javascript">$('#searchbox').show(0);</script>
485        </div>
486      </div>
487      <div class="clearer"></div>
488    </div>
489    <div class="related">
490      <h3>Navigation</h3>
491      <ul>
492        <li class="right" style="margin-right: 10px">
493          <a href="../../../genindex.html" title="General Index"
494             >index</a></li>
495        <li class="right" >
496          <a href="../../../py-modindex.html" title="Python Module Index"
497             >modules</a> |</li>
498        <li class="right" >
499          <a href="boxSlicer.html" title="boxSlicer"
500             >next</a> |</li>
501        <li class="right" >
502          <a href="binder.html" title="binder"
503             >previous</a> |</li>
504        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li>
505          <li><a href="index.html" >Local Perspective: plotting</a> &raquo;</li> 
506      </ul>
507    </div>
508    <div class="footer">
509        &copy; Copyright 2010, sans group.
510      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
511    </div>
512  </body>
513</html>
Note: See TracBrowser for help on using the repository browser.