source: sasview/guiframe/docs/sphinx/_build/html/api/local_perspectives/plotting/sectorMask.html @ d955bf19

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since d955bf19 was d955bf19, checked in by Gervaise Alina <gervyh@…>, 14 years ago

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