source: sasview/sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/sectorMask.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: 15.2 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>sectorMask &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="SectorSlicer" href="SectorSlicer.html" />
28    <link rel="prev" title="profile_dialog" href="profile_dialog.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="SectorSlicer.html" title="SectorSlicer"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="profile_dialog.html" title="profile_dialog"
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="sectormask">
57<h1>sectorMask<a class="headerlink" href="#sectormask" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.local_perspectives.plotting.sectorMask">
59<span id="sans-guiframe-local-perspectives-plotting-sectormask"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask" title="sans.guiframe.local_perspectives.plotting.sectorMask"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.sectorMask.</tt><tt class="descname">SectorMask</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='gray'</em>, <em>zorder=3</em>, <em>side=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask" 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>Draw a sector slicer.Allow to find the data 2D inside of the sector lines</p>
65<dl class="method">
66<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear">
67<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear" title="Permalink to this definition">¶</a></dt>
68<dd><p>Clear the slicer and all connected events related to this slicer</p>
69</dd></dl>
70
71<dl class="method">
72<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear_markers">
73<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear_markers" title="Permalink to this definition">¶</a></dt>
74<dd><p>Clear old markers and interfaces.</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers">
79<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers" title="Permalink to this definition">¶</a></dt>
80<dd><p>Connect markers to callbacks</p>
81</dd></dl>
82
83<dl class="method">
84<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.dpixel">
85<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.dpixel" title="Permalink to this definition">¶</a></dt>
86<dd><p>Return the step size in data coordinates for a small
87step in screen coordinates.  If nudge is False (default)
88the step size is one pixel.  If nudge is True, the step
89size is 0.2 pixels.</p>
90</dd></dl>
91
92<dl class="method">
93<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.draw">
94<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.draw" title="Permalink to this definition">¶</a></dt>
95<dd></dd></dl>
96
97<dl class="method">
98<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.freeze_axes">
99<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.freeze_axes" title="Permalink to this definition">¶</a></dt>
100<dd></dd></dl>
101
102<dl class="method">
103<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.get_params">
104<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.get_params" title="Permalink to this definition">¶</a></dt>
105<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
106<table class="docutils field-list" frame="void" rules="none">
107<col class="field-name" />
108<col class="field-body" />
109<tbody valign="top">
110<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
111</tr>
112</tbody>
113</table>
114</dd></dl>
115
116<dl class="method">
117<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.move">
118<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.sectorMask.SectorMask.move" title="Permalink to this definition">¶</a></dt>
119<dd><p>Process move to a new position, making sure that the move is allowed.</p>
120</dd></dl>
121
122<dl class="method">
123<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend">
124<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend" title="Permalink to this definition">¶</a></dt>
125<dd><p>Called a dragging motion ends.Get slicer event</p>
126</dd></dl>
127
128<dl class="method">
129<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick">
130<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick" title="Permalink to this definition">¶</a></dt>
131<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
132later restore().</p>
133</dd></dl>
134
135<dl class="method">
136<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag">
137<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag" title="Permalink to this definition">¶</a></dt>
138<dd><p>Move the artist.  Calls move() to update the state, or restore() if
139the mouse leaves the window.</p>
140</dd></dl>
141
142<dl class="method">
143<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite">
144<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite" title="Permalink to this definition">¶</a></dt>
145<dd><p>Hilite the artist reporting the event, indicating that it is
146ready to receive a click.</p>
147</dd></dl>
148
149<dl class="method">
150<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey">
151<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey" title="Permalink to this definition">¶</a></dt>
152<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
153restores it to the position before the last click.</p>
154<p>Calls move() to update the state.  Calls restore() on escape.</p>
155</dd></dl>
156
157<dl class="method">
158<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave">
159<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave" title="Permalink to this definition">¶</a></dt>
160<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
161</dd></dl>
162
163<dl class="method">
164<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease">
165<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease" title="Permalink to this definition">¶</a></dt>
166<dd></dd></dl>
167
168<dl class="method">
169<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.restore">
170<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.restore" title="Permalink to this definition">¶</a></dt>
171<dd><p>Restore the roughness for this layer.</p>
172</dd></dl>
173
174<dl class="method">
175<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save">
176<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save" title="Permalink to this definition">¶</a></dt>
177<dd><p>Remember the roughness for this layer and the next so that we
178can restore on Esc.</p>
179</dd></dl>
180
181<dl class="method">
182<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_cursor">
183<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.sectorMask.SectorMask.set_cursor" title="Permalink to this definition">¶</a></dt>
184<dd></dd></dl>
185
186<dl class="method">
187<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params">
188<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params" title="Permalink to this definition">¶</a></dt>
189<dd><p>Receive a dictionary and reset the slicer with values contained
190in the values of the dictionary.</p>
191<table class="docutils field-list" frame="void" rules="none">
192<col class="field-name" />
193<col class="field-body" />
194<tbody valign="top">
195<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
196values the user assigned to the slicer.</td>
197</tr>
198</tbody>
199</table>
200</dd></dl>
201
202<dl class="method">
203<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.thaw_axes">
204<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.thaw_axes" title="Permalink to this definition">¶</a></dt>
205<dd></dd></dl>
206
207<dl class="method">
208<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.update">
209<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.update" title="Permalink to this definition">¶</a></dt>
210<dd><p>Respond to changes in the model by recalculating the profiles and
211resetting the widgets.</p>
212</dd></dl>
213
214</dd></dl>
215
216</div>
217</div>
218
219
220          </div>
221        </div>
222      </div>
223      <div class="sphinxsidebar">
224        <div class="sphinxsidebarwrapper">
225  <h3><a href="../../../index.html">Table Of Contents</a></h3>
226  <ul>
227<li><a class="reference internal" href="#">sectorMask</a><ul>
228<li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a></li>
229</ul>
230</li>
231</ul>
232
233  <h4>Previous topic</h4>
234  <p class="topless"><a href="profile_dialog.html"
235                        title="previous chapter">profile_dialog</a></p>
236  <h4>Next topic</h4>
237  <p class="topless"><a href="SectorSlicer.html"
238                        title="next chapter">SectorSlicer</a></p>
239  <h3>This Page</h3>
240  <ul class="this-page-menu">
241    <li><a href="../../../_sources/api/local_perspectives/plotting/sectorMask.txt"
242           rel="nofollow">Show Source</a></li>
243  </ul>
244<div id="searchbox" style="display: none">
245  <h3>Quick search</h3>
246    <form class="search" action="../../../search.html" method="get">
247      <input type="text" name="q" size="18" />
248      <input type="submit" value="Go" />
249      <input type="hidden" name="check_keywords" value="yes" />
250      <input type="hidden" name="area" value="default" />
251    </form>
252    <p class="searchtip" style="font-size: 90%">
253    Enter search terms or a module, class or function name.
254    </p>
255</div>
256<script type="text/javascript">$('#searchbox').show(0);</script>
257        </div>
258      </div>
259      <div class="clearer"></div>
260    </div>
261    <div class="related">
262      <h3>Navigation</h3>
263      <ul>
264        <li class="right" style="margin-right: 10px">
265          <a href="../../../genindex.html" title="General Index"
266             >index</a></li>
267        <li class="right" >
268          <a href="../../../py-modindex.html" title="Python Module Index"
269             >modules</a> |</li>
270        <li class="right" >
271          <a href="SectorSlicer.html" title="SectorSlicer"
272             >next</a> |</li>
273        <li class="right" >
274          <a href="profile_dialog.html" title="profile_dialog"
275             >previous</a> |</li>
276        <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
277          <li><a href="index.html" >Local Perspective: plotting</a> &raquo;</li> 
278      </ul>
279    </div>
280    <div class="footer">
281        &copy; Copyright 2010, sans group.
282      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
283    </div>
284  </body>
285</html>
Note: See TracBrowser for help on using the repository browser.