source: sasview/dev/api/sas.plottools.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 138.5 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.plottools package &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../index.html" />
28    <link rel="up" title="sas package" href="sas.html" />
29    <link rel="next" title="sas.pr package" href="sas.pr.html" />
30    <link rel="prev" title="sas.perspectives.pr package" href="sas.perspectives.pr.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="sas.pr.html" title="sas.pr package"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="sas.perspectives.pr.html" title="sas.perspectives.pr package"
47             accesskey="P">previous</a> |</li>
48        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
49          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
50          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
51          <li><a href="sas.html" accesskey="U">sas package</a> &raquo;</li> 
52      </ul>
53    </div> 
54
55    <div class="document">
56      <div class="documentwrapper">
57        <div class="bodywrapper">
58          <div class="body">
59           
60  <div class="section" id="sas-plottools-package">
61<h1>sas.plottools package</h1>
62<div class="section" id="submodules">
63<h2>Submodules</h2>
64</div>
65<div class="section" id="module-sas.plottools.BaseInteractor">
66<span id="sas-plottools-baseinteractor-module"></span><h2>sas.plottools.BaseInteractor module</h2>
67</div>
68<div class="section" id="module-sas.plottools.LabelDialog">
69<span id="sas-plottools-labeldialog-module"></span><h2>sas.plottools.LabelDialog module</h2>
70<dl class="class">
71<dt id="sas.plottools.LabelDialog.LabelDialog">
72<em class="property">class </em><tt class="descclassname">sas.plottools.LabelDialog.</tt><tt class="descname">LabelDialog</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em>, <em>label</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/LabelDialog.html#LabelDialog"><span class="viewcode-link">[source]</span></a></dt>
73<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
74<dl class="method">
75<dt id="sas.plottools.LabelDialog.LabelDialog.getText">
76<tt class="descname">getText</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/LabelDialog.html#LabelDialog.getText"><span class="viewcode-link">[source]</span></a></dt>
77<dd></dd></dl>
78
79</dd></dl>
80
81</div>
82<div class="section" id="module-sas.plottools.LineModel">
83<span id="sas-plottools-linemodel-module"></span><h2>sas.plottools.LineModel module</h2>
84<p>Provide Line function (y= A + Bx)</p>
85<dl class="class">
86<dt id="sas.plottools.LineModel.LineModel">
87<em class="property">class </em><tt class="descclassname">sas.plottools.LineModel.</tt><tt class="descname">LineModel</tt><a class="reference internal" href="../../_modules/sas/plottools/LineModel.html#LineModel"><span class="viewcode-link">[source]</span></a></dt>
88<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
89<p>Class that evaluates a linear model.</p>
90<p>f(x) = A + Bx</p>
91<p>List of default parameters:
92A = 0.0
93B = 0.0</p>
94<dl class="method">
95<dt id="sas.plottools.LineModel.LineModel.getParam">
96<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/LineModel.html#LineModel.getParam"><span class="viewcode-link">[source]</span></a></dt>
97<dd></dd></dl>
98
99<dl class="method">
100<dt id="sas.plottools.LineModel.LineModel.run">
101<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/LineModel.html#LineModel.run"><span class="viewcode-link">[source]</span></a></dt>
102<dd><p>Evaluate the model</p>
103<table class="docutils field-list" frame="void" rules="none">
104<col class="field-name" />
105<col class="field-body" />
106<tbody valign="top">
107<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; simple value</td>
108</tr>
109<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(Line value)</td>
110</tr>
111</tbody>
112</table>
113</dd></dl>
114
115<dl class="method">
116<dt id="sas.plottools.LineModel.LineModel.runXY">
117<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/LineModel.html#LineModel.runXY"><span class="viewcode-link">[source]</span></a></dt>
118<dd><p>Evaluate the model</p>
119<table class="docutils field-list" frame="void" rules="none">
120<col class="field-name" />
121<col class="field-body" />
122<tbody valign="top">
123<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; simple value</td>
124</tr>
125<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Line value</td>
126</tr>
127</tbody>
128</table>
129</dd></dl>
130
131<dl class="method">
132<dt id="sas.plottools.LineModel.LineModel.setParam">
133<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/LineModel.html#LineModel.setParam"><span class="viewcode-link">[source]</span></a></dt>
134<dd></dd></dl>
135
136</dd></dl>
137
138</div>
139<div class="section" id="module-sas.plottools.PlotPanel">
140<span id="sas-plottools-plotpanel-module"></span><h2>sas.plottools.PlotPanel module</h2>
141<dl class="function">
142<dt id="sas.plottools.PlotPanel.CopyImage">
143<tt class="descclassname">sas.plottools.PlotPanel.</tt><tt class="descname">CopyImage</tt><big>(</big><em>canvas</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#CopyImage"><span class="viewcode-link">[source]</span></a></dt>
144<dd><p>0: matplotlib plot
1451: wx.lib.plot
1462: other</p>
147</dd></dl>
148
149<dl class="class">
150<dt id="sas.plottools.PlotPanel.NoRepaintCanvas">
151<em class="property">class </em><tt class="descclassname">sas.plottools.PlotPanel.</tt><tt class="descname">NoRepaintCanvas</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#NoRepaintCanvas"><span class="viewcode-link">[source]</span></a></dt>
152<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">matplotlib.backends.backend_wxagg.FigureCanvasWxAgg</span></tt></p>
153<p>We subclass FigureCanvasWxAgg, overriding the _onPaint method, so that
154the draw method is only called for the first two paint events. After that,
155the canvas will only be redrawn when it is resized.</p>
156</dd></dl>
157
158<dl class="class">
159<dt id="sas.plottools.PlotPanel.PlotPanel">
160<em class="property">class </em><tt class="descclassname">sas.plottools.PlotPanel.</tt><tt class="descname">PlotPanel</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>xtransform=None</em>, <em>ytransform=None</em>, <em>scale='log_{10}'</em>, <em>color=None</em>, <em>dpi=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel"><span class="viewcode-link">[source]</span></a></dt>
161<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Panel</span></tt></p>
162<p>The PlotPanel has a Figure and a Canvas. OnSize events simply set a
163flag, and the actually redrawing of the
164figure is triggered by an Idle event.</p>
165<dl class="method">
166<dt id="sas.plottools.PlotPanel.PlotPanel.ChangeLegendLoc">
167<tt class="descname">ChangeLegendLoc</tt><big>(</big><em>label</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.ChangeLegendLoc"><span class="viewcode-link">[source]</span></a></dt>
168<dd><p>Changes legend loc based on user input</p>
169</dd></dl>
170
171<dl class="method">
172<dt id="sas.plottools.PlotPanel.PlotPanel.OnCopyFigureMenu">
173<tt class="descname">OnCopyFigureMenu</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.OnCopyFigureMenu"><span class="viewcode-link">[source]</span></a></dt>
174<dd><p>Copy the current figure to clipboard</p>
175</dd></dl>
176
177<dl class="method">
178<dt id="sas.plottools.PlotPanel.PlotPanel.On_Paint">
179<tt class="descname">On_Paint</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.On_Paint"><span class="viewcode-link">[source]</span></a></dt>
180<dd></dd></dl>
181
182<dl class="method">
183<dt id="sas.plottools.PlotPanel.PlotPanel.SetColor">
184<tt class="descname">SetColor</tt><big>(</big><em>rgbtuple</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.SetColor"><span class="viewcode-link">[source]</span></a></dt>
185<dd><p>Set figure and canvas colours to be the same</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="sas.plottools.PlotPanel.PlotPanel.add_toolbar">
190<tt class="descname">add_toolbar</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.add_toolbar"><span class="viewcode-link">[source]</span></a></dt>
191<dd><p>add toolbar</p>
192</dd></dl>
193
194<dl class="method">
195<dt id="sas.plottools.PlotPanel.PlotPanel.clear">
196<tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.clear"><span class="viewcode-link">[source]</span></a></dt>
197<dd><p>Reset the plot</p>
198</dd></dl>
199
200<dl class="method">
201<dt id="sas.plottools.PlotPanel.PlotPanel.curve">
202<tt class="descname">curve</tt><big>(</big><em>x</em>, <em>y</em>, <em>dy=None</em>, <em>color=0</em>, <em>symbol=0</em>, <em>label=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.curve"><span class="viewcode-link">[source]</span></a></dt>
203<dd><p>Draw a line on a graph, possibly with confidence intervals.</p>
204</dd></dl>
205
206<dl class="method">
207<dt id="sas.plottools.PlotPanel.PlotPanel.cusor_line">
208<tt class="descname">cusor_line</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.cusor_line"><span class="viewcode-link">[source]</span></a></dt>
209<dd></dd></dl>
210
211<dl class="method">
212<dt id="sas.plottools.PlotPanel.PlotPanel.draw">
213<tt class="descname">draw</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.draw"><span class="viewcode-link">[source]</span></a></dt>
214<dd><p>Where the actual drawing happens</p>
215</dd></dl>
216
217<dl class="method">
218<dt id="sas.plottools.PlotPanel.PlotPanel.get_loc_label">
219<tt class="descname">get_loc_label</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.get_loc_label"><span class="viewcode-link">[source]</span></a></dt>
220<dd><p>Associates label to a specific legend location</p>
221</dd></dl>
222
223<dl class="method">
224<dt id="sas.plottools.PlotPanel.PlotPanel.get_xscale">
225<tt class="descname">get_xscale</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.get_xscale"><span class="viewcode-link">[source]</span></a></dt>
226<dd><table class="docutils field-list" frame="void" rules="none">
227<col class="field-name" />
228<col class="field-body" />
229<tbody valign="top">
230<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">x-axis scale</td>
231</tr>
232</tbody>
233</table>
234</dd></dl>
235
236<dl class="method">
237<dt id="sas.plottools.PlotPanel.PlotPanel.get_yscale">
238<tt class="descname">get_yscale</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.get_yscale"><span class="viewcode-link">[source]</span></a></dt>
239<dd><table class="docutils field-list" frame="void" rules="none">
240<col class="field-name" />
241<col class="field-body" />
242<tbody valign="top">
243<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Y-axis scale</td>
244</tr>
245</tbody>
246</table>
247</dd></dl>
248
249<dl class="method">
250<dt id="sas.plottools.PlotPanel.PlotPanel.image">
251<tt class="descname">image</tt><big>(</big><em>data</em>, <em>qx_data</em>, <em>qy_data</em>, <em>xmin</em>, <em>xmax</em>, <em>ymin</em>, <em>ymax</em>, <em>zmin</em>, <em>zmax</em>, <em>color=0</em>, <em>symbol=0</em>, <em>markersize=0</em>, <em>label='data2D'</em>, <em>cmap=&lt;matplotlib.colors.LinearSegmentedColormap object at 0x10cd9a5d0&gt;</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.image"><span class="viewcode-link">[source]</span></a></dt>
252<dd><p>Render the current data</p>
253</dd></dl>
254
255<dl class="method">
256<dt id="sas.plottools.PlotPanel.PlotPanel.interactive_curve">
257<tt class="descname">interactive_curve</tt><big>(</big><em>x</em>, <em>y</em>, <em>dy=None</em>, <em>name=''</em>, <em>color=0</em>, <em>symbol=0</em>, <em>zorder=1</em>, <em>id=None</em>, <em>label=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.interactive_curve"><span class="viewcode-link">[source]</span></a></dt>
258<dd><p>Draw markers with error bars</p>
259</dd></dl>
260
261<dl class="method">
262<dt id="sas.plottools.PlotPanel.PlotPanel.interactive_points">
263<tt class="descname">interactive_points</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>name=''</em>, <em>color=0</em>, <em>symbol=0</em>, <em>markersize=5</em>, <em>zorder=1</em>, <em>id=None</em>, <em>label=None</em>, <em>hide_error=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.interactive_points"><span class="viewcode-link">[source]</span></a></dt>
264<dd><p>Draw markers with error bars</p>
265</dd></dl>
266
267<dl class="attribute">
268<dt id="sas.plottools.PlotPanel.PlotPanel.is_zoomed">
269<tt class="descname">is_zoomed</tt><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.is_zoomed"><span class="viewcode-link">[source]</span></a></dt>
270<dd></dd></dl>
271
272<dl class="method">
273<dt id="sas.plottools.PlotPanel.PlotPanel.legend_picker">
274<tt class="descname">legend_picker</tt><big>(</big><em>legend</em>, <em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.legend_picker"><span class="viewcode-link">[source]</span></a></dt>
275<dd><p>Pick up the legend patch</p>
276</dd></dl>
277
278<dl class="method">
279<dt id="sas.plottools.PlotPanel.PlotPanel.linear_plottable_fit">
280<tt class="descname">linear_plottable_fit</tt><big>(</big><em>plot</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.linear_plottable_fit"><span class="viewcode-link">[source]</span></a></dt>
281<dd><p>when clicking on linear Fit on context menu, display Fitting Dialog</p>
282<table class="docutils field-list" frame="void" rules="none">
283<col class="field-name" />
284<col class="field-body" />
285<tbody valign="top">
286<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>plot</strong> &#8211; PlotPanel owning the graph</td>
287</tr>
288</tbody>
289</table>
290</dd></dl>
291
292<dl class="method">
293<dt id="sas.plottools.PlotPanel.PlotPanel.onChangeCaption">
294<tt class="descname">onChangeCaption</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onChangeCaption"><span class="viewcode-link">[source]</span></a></dt>
295<dd></dd></dl>
296
297<dl class="method">
298<dt id="sas.plottools.PlotPanel.PlotPanel.onChangeLegendLoc">
299<tt class="descname">onChangeLegendLoc</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onChangeLegendLoc"><span class="viewcode-link">[source]</span></a></dt>
300<dd><p>Changes legend loc based on user input</p>
301</dd></dl>
302
303<dl class="method">
304<dt id="sas.plottools.PlotPanel.PlotPanel.onContextMenu">
305<tt class="descname">onContextMenu</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onContextMenu"><span class="viewcode-link">[source]</span></a></dt>
306<dd><p>Default context menu for a plot panel</p>
307</dd></dl>
308
309<dl class="method">
310<dt id="sas.plottools.PlotPanel.PlotPanel.onFitDisplay">
311<tt class="descname">onFitDisplay</tt><big>(</big><em>tempx</em>, <em>tempy</em>, <em>xminView</em>, <em>xmaxView</em>, <em>xmin</em>, <em>xmax</em>, <em>func</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onFitDisplay"><span class="viewcode-link">[source]</span></a></dt>
312<dd><p>Add a new plottable into the graph .In this case this plottable
313will be used to fit some data</p>
314<table class="docutils field-list" frame="void" rules="none">
315<col class="field-name" />
316<col class="field-body" />
317<tbody valign="top">
318<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
319<li><strong>tempx</strong> &#8211; The x data of fit line</li>
320<li><strong>tempy</strong> &#8211; The y data of fit line</li>
321<li><strong>xminView</strong> &#8211; the lower bound of fitting range</li>
322<li><strong>xminView</strong> &#8211; the upper bound of  fitting range</li>
323<li><strong>xmin</strong> &#8211; the lowest value of data to fit to the line</li>
324<li><strong>xmax</strong> &#8211; the highest value of data to fit to the line</li>
325</ul>
326</td>
327</tr>
328</tbody>
329</table>
330</dd></dl>
331
332<dl class="method">
333<dt id="sas.plottools.PlotPanel.PlotPanel.onFitting">
334<tt class="descname">onFitting</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onFitting"><span class="viewcode-link">[source]</span></a></dt>
335<dd><p>when clicking on linear Fit on context menu , display Fitting Dialog</p>
336</dd></dl>
337
338<dl class="method">
339<dt id="sas.plottools.PlotPanel.PlotPanel.onGridOnOff">
340<tt class="descname">onGridOnOff</tt><big>(</big><em>gridon_off</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onGridOnOff"><span class="viewcode-link">[source]</span></a></dt>
341<dd><p>Allows ON/OFF Grid</p>
342</dd></dl>
343
344<dl class="method">
345<dt id="sas.plottools.PlotPanel.PlotPanel.onLeftDown">
346<tt class="descname">onLeftDown</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onLeftDown"><span class="viewcode-link">[source]</span></a></dt>
347<dd><p>left button down and ready to drag</p>
348</dd></dl>
349
350<dl class="method">
351<dt id="sas.plottools.PlotPanel.PlotPanel.onLeftUp">
352<tt class="descname">onLeftUp</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onLeftUp"><span class="viewcode-link">[source]</span></a></dt>
353<dd><p>Dragging is done</p>
354</dd></dl>
355
356<dl class="method">
357<dt id="sas.plottools.PlotPanel.PlotPanel.onLegend">
358<tt class="descname">onLegend</tt><big>(</big><em>legOnOff</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onLegend"><span class="viewcode-link">[source]</span></a></dt>
359<dd><p>Toggles whether legend is visible/not visible</p>
360</dd></dl>
361
362<dl class="method">
363<dt id="sas.plottools.PlotPanel.PlotPanel.onMouseMotion">
364<tt class="descname">onMouseMotion</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onMouseMotion"><span class="viewcode-link">[source]</span></a></dt>
365<dd><p>check if the left button is press and the mouse in moving.
366computer delta for x and y coordinates and then calls draghelper
367to perform the drag</p>
368</dd></dl>
369
370<dl class="method">
371<dt id="sas.plottools.PlotPanel.PlotPanel.onPick">
372<tt class="descname">onPick</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onPick"><span class="viewcode-link">[source]</span></a></dt>
373<dd><p>On pick legend</p>
374</dd></dl>
375
376<dl class="method">
377<dt id="sas.plottools.PlotPanel.PlotPanel.onPrint">
378<tt class="descname">onPrint</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onPrint"><span class="viewcode-link">[source]</span></a></dt>
379<dd></dd></dl>
380
381<dl class="method">
382<dt id="sas.plottools.PlotPanel.PlotPanel.onPrinterPreview">
383<tt class="descname">onPrinterPreview</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onPrinterPreview"><span class="viewcode-link">[source]</span></a></dt>
384<dd></dd></dl>
385
386<dl class="method">
387<dt id="sas.plottools.PlotPanel.PlotPanel.onPrinterSetup">
388<tt class="descname">onPrinterSetup</tt><big>(</big><em>event=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onPrinterSetup"><span class="viewcode-link">[source]</span></a></dt>
389<dd></dd></dl>
390
391<dl class="method">
392<dt id="sas.plottools.PlotPanel.PlotPanel.onResetGraph">
393<tt class="descname">onResetGraph</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onResetGraph"><span class="viewcode-link">[source]</span></a></dt>
394<dd><p>Reset the graph by plotting the full range of data</p>
395</dd></dl>
396
397<dl class="method">
398<dt id="sas.plottools.PlotPanel.PlotPanel.onSaveImage">
399<tt class="descname">onSaveImage</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onSaveImage"><span class="viewcode-link">[source]</span></a></dt>
400<dd><p>Implement save image</p>
401</dd></dl>
402
403<dl class="method">
404<dt id="sas.plottools.PlotPanel.PlotPanel.onToolContextMenu">
405<tt class="descname">onToolContextMenu</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onToolContextMenu"><span class="viewcode-link">[source]</span></a></dt>
406<dd><p>ContextMenu from toolbar</p>
407<table class="docutils field-list" frame="void" rules="none">
408<col class="field-name" />
409<col class="field-body" />
410<tbody valign="top">
411<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; toolbar event</td>
412</tr>
413</tbody>
414</table>
415</dd></dl>
416
417<dl class="method">
418<dt id="sas.plottools.PlotPanel.PlotPanel.onWheel">
419<tt class="descname">onWheel</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.onWheel"><span class="viewcode-link">[source]</span></a></dt>
420<dd><p>Process mouse wheel as zoom events</p>
421<table class="docutils field-list" frame="void" rules="none">
422<col class="field-name" />
423<col class="field-body" />
424<tbody valign="top">
425<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; Wheel event</td>
426</tr>
427</tbody>
428</table>
429</dd></dl>
430
431<dl class="method">
432<dt id="sas.plottools.PlotPanel.PlotPanel.on_kill_focus">
433<tt class="descname">on_kill_focus</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.on_kill_focus"><span class="viewcode-link">[source]</span></a></dt>
434<dd><p>Reset the panel color</p>
435</dd></dl>
436
437<dl class="method">
438<dt id="sas.plottools.PlotPanel.PlotPanel.on_set_focus">
439<tt class="descname">on_set_focus</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.on_set_focus"><span class="viewcode-link">[source]</span></a></dt>
440<dd><p>Send to the parenet the current panel on focus</p>
441</dd></dl>
442
443<dl class="method">
444<dt id="sas.plottools.PlotPanel.PlotPanel.plottable_selected">
445<tt class="descname">plottable_selected</tt><big>(</big><em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.plottable_selected"><span class="viewcode-link">[source]</span></a></dt>
446<dd><p>Called to register a plottable as selected</p>
447</dd></dl>
448
449<dl class="method">
450<dt id="sas.plottools.PlotPanel.PlotPanel.points">
451<tt class="descname">points</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>color=0</em>, <em>symbol=0</em>, <em>marker_size=5</em>, <em>label=None</em>, <em>id=None</em>, <em>hide_error=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.points"><span class="viewcode-link">[source]</span></a></dt>
452<dd><p>Draw markers with error bars</p>
453</dd></dl>
454
455<dl class="method">
456<dt id="sas.plottools.PlotPanel.PlotPanel.properties">
457<tt class="descname">properties</tt><big>(</big><em>prop</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.properties"><span class="viewcode-link">[source]</span></a></dt>
458<dd><p>Set some properties of the graph.
459The set of properties is not yet determined.</p>
460</dd></dl>
461
462<dl class="method">
463<dt id="sas.plottools.PlotPanel.PlotPanel.remove_legend">
464<tt class="descname">remove_legend</tt><big>(</big><em>ax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.remove_legend"><span class="viewcode-link">[source]</span></a></dt>
465<dd><p>Remove legend for ax or the current axes.</p>
466</dd></dl>
467
468<dl class="method">
469<dt id="sas.plottools.PlotPanel.PlotPanel.render">
470<tt class="descname">render</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.render"><span class="viewcode-link">[source]</span></a></dt>
471<dd><p>Commit the plot after all objects are drawn</p>
472</dd></dl>
473
474<dl class="method">
475<dt id="sas.plottools.PlotPanel.PlotPanel.resetFitView">
476<tt class="descname">resetFitView</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.resetFitView"><span class="viewcode-link">[source]</span></a></dt>
477<dd><p>For fit Dialog initial display</p>
478</dd></dl>
479
480<dl class="method">
481<dt id="sas.plottools.PlotPanel.PlotPanel.returnTrans">
482<tt class="descname">returnTrans</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.returnTrans"><span class="viewcode-link">[source]</span></a></dt>
483<dd><p>Return values and labels used by Fit Dialog</p>
484</dd></dl>
485
486<dl class="method">
487<dt id="sas.plottools.PlotPanel.PlotPanel.schedule_full_draw">
488<tt class="descname">schedule_full_draw</tt><big>(</big><em>func='append'</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.schedule_full_draw"><span class="viewcode-link">[source]</span></a></dt>
489<dd><p>Put self in schedule to full redraw list</p>
490</dd></dl>
491
492<dl class="method">
493<dt id="sas.plottools.PlotPanel.PlotPanel.setTrans">
494<tt class="descname">setTrans</tt><big>(</big><em>xtrans</em>, <em>ytrans</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.setTrans"><span class="viewcode-link">[source]</span></a></dt>
495<dd><table class="docutils field-list" frame="void" rules="none">
496<col class="field-name" />
497<col class="field-body" />
498<tbody valign="top">
499<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
500<li><strong>xtrans</strong> &#8211; set x transformation on Property dialog</li>
501<li><strong>ytrans</strong> &#8211; set y transformation on Property dialog</li>
502</ul>
503</td>
504</tr>
505</tbody>
506</table>
507</dd></dl>
508
509<dl class="method">
510<dt id="sas.plottools.PlotPanel.PlotPanel.set_legend_alpha">
511<tt class="descname">set_legend_alpha</tt><big>(</big><em>alpha=1</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.set_legend_alpha"><span class="viewcode-link">[source]</span></a></dt>
512<dd><p>Set legend alpha</p>
513</dd></dl>
514
515<dl class="method">
516<dt id="sas.plottools.PlotPanel.PlotPanel.set_resizing">
517<tt class="descname">set_resizing</tt><big>(</big><em>resizing=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.set_resizing"><span class="viewcode-link">[source]</span></a></dt>
518<dd><p>Set the resizing (True/False)</p>
519</dd></dl>
520
521<dl class="method">
522<dt id="sas.plottools.PlotPanel.PlotPanel.set_selected_from_menu">
523<tt class="descname">set_selected_from_menu</tt><big>(</big><em>menu</em>, <em>id</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.set_selected_from_menu"><span class="viewcode-link">[source]</span></a></dt>
524<dd><p>Set selected_plottable from context menu selection</p>
525<table class="docutils field-list" frame="void" rules="none">
526<col class="field-name" />
527<col class="field-body" />
528<tbody valign="top">
529<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
530<li><strong>menu</strong> &#8211; context menu item</li>
531<li><strong>id</strong> &#8211; menu item id</li>
532</ul>
533</td>
534</tr>
535</tbody>
536</table>
537</dd></dl>
538
539<dl class="method">
540<dt id="sas.plottools.PlotPanel.PlotPanel.set_xscale">
541<tt class="descname">set_xscale</tt><big>(</big><em>scale='linear'</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.set_xscale"><span class="viewcode-link">[source]</span></a></dt>
542<dd><p>Set the scale on x-axis</p>
543<table class="docutils field-list" frame="void" rules="none">
544<col class="field-name" />
545<col class="field-body" />
546<tbody valign="top">
547<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scale</strong> &#8211; the scale of x-axis</td>
548</tr>
549</tbody>
550</table>
551</dd></dl>
552
553<dl class="method">
554<dt id="sas.plottools.PlotPanel.PlotPanel.set_yscale">
555<tt class="descname">set_yscale</tt><big>(</big><em>scale='linear'</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.set_yscale"><span class="viewcode-link">[source]</span></a></dt>
556<dd><p>Set the scale on Y-axis</p>
557<table class="docutils field-list" frame="void" rules="none">
558<col class="field-name" />
559<col class="field-body" />
560<tbody valign="top">
561<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scale</strong> &#8211; the scale of y-axis</td>
562</tr>
563</tbody>
564</table>
565</dd></dl>
566
567<dl class="method">
568<dt id="sas.plottools.PlotPanel.PlotPanel.xaxis">
569<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>units</em>, <em>font=None</em>, <em>color='black'</em>, <em>t_font=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.xaxis"><span class="viewcode-link">[source]</span></a></dt>
570<dd><p>xaxis label and units.</p>
571<p>Axis labels know about units.</p>
572<p>We need to do this so that we can detect when axes are not
573commesurate.  Currently this is ignored other than for formatting
574purposes.</p>
575</dd></dl>
576
577<dl class="method">
578<dt id="sas.plottools.PlotPanel.PlotPanel.yaxis">
579<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>units</em>, <em>font=None</em>, <em>color='black'</em>, <em>t_font=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#PlotPanel.yaxis"><span class="viewcode-link">[source]</span></a></dt>
580<dd><p>yaxis label and units.</p>
581</dd></dl>
582
583</dd></dl>
584
585<dl class="function">
586<dt id="sas.plottools.PlotPanel.show_tree">
587<tt class="descclassname">sas.plottools.PlotPanel.</tt><tt class="descname">show_tree</tt><big>(</big><em>obj</em>, <em>d=0</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PlotPanel.html#show_tree"><span class="viewcode-link">[source]</span></a></dt>
588<dd><p>Handy function for displaying a tree of graph objects</p>
589</dd></dl>
590
591</div>
592<div class="section" id="module-sas.plottools.PropertyDialog">
593<span id="sas-plottools-propertydialog-module"></span><h2>sas.plottools.PropertyDialog module</h2>
594<dl class="class">
595<dt id="sas.plottools.PropertyDialog.Properties">
596<em class="property">class </em><tt class="descclassname">sas.plottools.PropertyDialog.</tt><tt class="descname">Properties</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>title='Select the scale of the graph'</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PropertyDialog.html#Properties"><span class="viewcode-link">[source]</span></a></dt>
597<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
598<dl class="method">
599<dt id="sas.plottools.PropertyDialog.Properties.getValues">
600<tt class="descname">getValues</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PropertyDialog.html#Properties.getValues"><span class="viewcode-link">[source]</span></a></dt>
601<dd></dd></dl>
602
603<dl class="method">
604<dt id="sas.plottools.PropertyDialog.Properties.setValues">
605<tt class="descname">setValues</tt><big>(</big><em>x</em>, <em>y</em>, <em>view</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/PropertyDialog.html#Properties.setValues"><span class="viewcode-link">[source]</span></a></dt>
606<dd></dd></dl>
607
608</dd></dl>
609
610</div>
611<div class="section" id="module-sas.plottools.SimpleFont">
612<span id="sas-plottools-simplefont-module"></span><h2>sas.plottools.SimpleFont module</h2>
613<p>This software was developed by Institut Laue-Langevin as part of
614Distributed Data Analysis of Neutron Scattering Experiments (DANSE).</p>
615<p>Copyright 2012 Institut Laue-Langevin</p>
616<dl class="class">
617<dt id="sas.plottools.SimpleFont.SimpleFont">
618<em class="property">class </em><tt class="descclassname">sas.plottools.SimpleFont.</tt><tt class="descname">SimpleFont</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SimpleFont.html#SimpleFont"><span class="viewcode-link">[source]</span></a></dt>
619<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
620<dl class="method">
621<dt id="sas.plottools.SimpleFont.SimpleFont.InitUI">
622<tt class="descname">InitUI</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SimpleFont.html#SimpleFont.InitUI"><span class="viewcode-link">[source]</span></a></dt>
623<dd></dd></dl>
624
625<dl class="method">
626<dt id="sas.plottools.SimpleFont.SimpleFont.get_font">
627<tt class="descname">get_font</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SimpleFont.html#SimpleFont.get_font"><span class="viewcode-link">[source]</span></a></dt>
628<dd></dd></dl>
629
630<dl class="method">
631<dt id="sas.plottools.SimpleFont.SimpleFont.get_ticklabel_check">
632<tt class="descname">get_ticklabel_check</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SimpleFont.html#SimpleFont.get_ticklabel_check"><span class="viewcode-link">[source]</span></a></dt>
633<dd><p>Get tick label check value</p>
634</dd></dl>
635
636<dl class="method">
637<dt id="sas.plottools.SimpleFont.SimpleFont.set_default_font">
638<tt class="descname">set_default_font</tt><big>(</big><em>font</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SimpleFont.html#SimpleFont.set_default_font"><span class="viewcode-link">[source]</span></a></dt>
639<dd></dd></dl>
640
641<dl class="method">
642<dt id="sas.plottools.SimpleFont.SimpleFont.set_ticklabel_check">
643<tt class="descname">set_ticklabel_check</tt><big>(</big><em>check=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SimpleFont.html#SimpleFont.set_ticklabel_check"><span class="viewcode-link">[source]</span></a></dt>
644<dd><p>Set tick label check value</p>
645</dd></dl>
646
647</dd></dl>
648
649</div>
650<div class="section" id="module-sas.plottools.SizeDialog">
651<span id="sas-plottools-sizedialog-module"></span><h2>sas.plottools.SizeDialog module</h2>
652<dl class="class">
653<dt id="sas.plottools.SizeDialog.SizeDialog">
654<em class="property">class </em><tt class="descclassname">sas.plottools.SizeDialog.</tt><tt class="descname">SizeDialog</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SizeDialog.html#SizeDialog"><span class="viewcode-link">[source]</span></a></dt>
655<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
656<dl class="method">
657<dt id="sas.plottools.SizeDialog.SizeDialog.getText">
658<tt class="descname">getText</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/SizeDialog.html#SizeDialog.getText"><span class="viewcode-link">[source]</span></a></dt>
659<dd><p>Get text typed</p>
660</dd></dl>
661
662</dd></dl>
663
664</div>
665<div class="section" id="module-sas.plottools.TextDialog">
666<span id="sas-plottools-textdialog-module"></span><h2>sas.plottools.TextDialog module</h2>
667<dl class="class">
668<dt id="sas.plottools.TextDialog.TextDialog">
669<em class="property">class </em><tt class="descclassname">sas.plottools.TextDialog.</tt><tt class="descname">TextDialog</tt><big>(</big><em>parent</em>, <em>id</em>, <em>title</em>, <em>label=''</em>, <em>unit=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog"><span class="viewcode-link">[source]</span></a></dt>
670<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
671<dl class="method">
672<dt id="sas.plottools.TextDialog.TextDialog.getColor">
673<tt class="descname">getColor</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getColor"><span class="viewcode-link">[source]</span></a></dt>
674<dd><p>Returns font size for the text box</p>
675</dd></dl>
676
677<dl class="method">
678<dt id="sas.plottools.TextDialog.TextDialog.getFamily">
679<tt class="descname">getFamily</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getFamily"><span class="viewcode-link">[source]</span></a></dt>
680<dd><p>Returns font family for the text box</p>
681</dd></dl>
682
683<dl class="method">
684<dt id="sas.plottools.TextDialog.TextDialog.getSize">
685<tt class="descname">getSize</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getSize"><span class="viewcode-link">[source]</span></a></dt>
686<dd><p>Returns font size for the text box</p>
687</dd></dl>
688
689<dl class="method">
690<dt id="sas.plottools.TextDialog.TextDialog.getStyle">
691<tt class="descname">getStyle</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getStyle"><span class="viewcode-link">[source]</span></a></dt>
692<dd><p>Returns font tyle for the text box</p>
693</dd></dl>
694
695<dl class="method">
696<dt id="sas.plottools.TextDialog.TextDialog.getText">
697<tt class="descname">getText</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getText"><span class="viewcode-link">[source]</span></a></dt>
698<dd><p>Returns text string as input by user.</p>
699</dd></dl>
700
701<dl class="method">
702<dt id="sas.plottools.TextDialog.TextDialog.getTickLabel">
703<tt class="descname">getTickLabel</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getTickLabel"><span class="viewcode-link">[source]</span></a></dt>
704<dd><p>Bool for use on tick label</p>
705</dd></dl>
706
707<dl class="method">
708<dt id="sas.plottools.TextDialog.TextDialog.getUnit">
709<tt class="descname">getUnit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getUnit"><span class="viewcode-link">[source]</span></a></dt>
710<dd><p>Returns unit string as input by user.</p>
711</dd></dl>
712
713<dl class="method">
714<dt id="sas.plottools.TextDialog.TextDialog.getWeight">
715<tt class="descname">getWeight</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getWeight"><span class="viewcode-link">[source]</span></a></dt>
716<dd><p>Returns font weight for the text box</p>
717</dd></dl>
718
719<dl class="method">
720<dt id="sas.plottools.TextDialog.TextDialog.getX">
721<tt class="descname">getX</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getX"><span class="viewcode-link">[source]</span></a></dt>
722<dd><p>Returns x coordinate of text box</p>
723</dd></dl>
724
725<dl class="method">
726<dt id="sas.plottools.TextDialog.TextDialog.getY">
727<tt class="descname">getY</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.getY"><span class="viewcode-link">[source]</span></a></dt>
728<dd><p>Returns y coordinate of text box</p>
729</dd></dl>
730
731<dl class="method">
732<dt id="sas.plottools.TextDialog.TextDialog.on_color">
733<tt class="descname">on_color</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.on_color"><span class="viewcode-link">[source]</span></a></dt>
734<dd><p>Set the color</p>
735</dd></dl>
736
737<dl class="method">
738<dt id="sas.plottools.TextDialog.TextDialog.on_family">
739<tt class="descname">on_family</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.on_family"><span class="viewcode-link">[source]</span></a></dt>
740<dd><p>Set the family</p>
741</dd></dl>
742
743<dl class="method">
744<dt id="sas.plottools.TextDialog.TextDialog.on_size">
745<tt class="descname">on_size</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.on_size"><span class="viewcode-link">[source]</span></a></dt>
746<dd><p>Set the size</p>
747</dd></dl>
748
749<dl class="method">
750<dt id="sas.plottools.TextDialog.TextDialog.on_style">
751<tt class="descname">on_style</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.on_style"><span class="viewcode-link">[source]</span></a></dt>
752<dd><p>Set the style</p>
753</dd></dl>
754
755<dl class="method">
756<dt id="sas.plottools.TextDialog.TextDialog.on_tick_label">
757<tt class="descname">on_tick_label</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.on_tick_label"><span class="viewcode-link">[source]</span></a></dt>
758<dd><p>Set the font for tick label</p>
759</dd></dl>
760
761<dl class="method">
762<dt id="sas.plottools.TextDialog.TextDialog.on_weight">
763<tt class="descname">on_weight</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/TextDialog.html#TextDialog.on_weight"><span class="viewcode-link">[source]</span></a></dt>
764<dd><p>Set the weight</p>
765</dd></dl>
766
767</dd></dl>
768
769</div>
770<div class="section" id="module-sas.plottools.arrow3d">
771<span id="sas-plottools-arrow3d-module"></span><h2>sas.plottools.arrow3d module</h2>
772<p>Module that draws multiple arrows in 3D coordinates</p>
773<dl class="class">
774<dt id="sas.plottools.arrow3d.Arrow3D">
775<em class="property">class </em><tt class="descclassname">sas.plottools.arrow3d.</tt><tt class="descname">Arrow3D</tt><big>(</big><em>base</em>, <em>xs</em>, <em>ys</em>, <em>zs</em>, <em>colors</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/arrow3d.html#Arrow3D"><span class="viewcode-link">[source]</span></a></dt>
776<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">matplotlib.patches.FancyArrowPatch</span></tt></p>
777<p>Draw 3D arrow</p>
778<dl class="method">
779<dt id="sas.plottools.arrow3d.Arrow3D.draw">
780<tt class="descname">draw</tt><big>(</big><em>renderer</em>, <em>rasterized=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/arrow3d.html#Arrow3D.draw"><span class="viewcode-link">[source]</span></a></dt>
781<dd><p>Drawing actually happens here</p>
782</dd></dl>
783
784<dl class="method">
785<dt id="sas.plottools.arrow3d.Arrow3D.onLeftDown">
786<tt class="descname">onLeftDown</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/arrow3d.html#Arrow3D.onLeftDown"><span class="viewcode-link">[source]</span></a></dt>
787<dd></dd></dl>
788
789<dl class="method">
790<dt id="sas.plottools.arrow3d.Arrow3D.onLeftUp">
791<tt class="descname">onLeftUp</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/arrow3d.html#Arrow3D.onLeftUp"><span class="viewcode-link">[source]</span></a></dt>
792<dd></dd></dl>
793
794</dd></dl>
795
796</div>
797<div class="section" id="module-sas.plottools.binder">
798<span id="sas-plottools-binder-module"></span><h2>sas.plottools.binder module</h2>
799<p>Extension to MPL to support the binding of artists to key/mouse events.</p>
800<dl class="class">
801<dt id="sas.plottools.binder.BindArtist">
802<em class="property">class </em><tt class="descclassname">sas.plottools.binder.</tt><tt class="descname">BindArtist</tt><big>(</big><em>figure</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/binder.html#BindArtist"><span class="viewcode-link">[source]</span></a></dt>
803<dd><dl class="attribute">
804<dt id="sas.plottools.binder.BindArtist.alt">
805<tt class="descname">alt</tt><em class="property"> = False</em></dt>
806<dd></dd></dl>
807
808<dl class="method">
809<dt id="sas.plottools.binder.BindArtist.clear">
810<tt class="descname">clear</tt><big>(</big><em>h1</em>, <em>h2</em>, <em>...</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/binder.html#BindArtist.clear"><span class="viewcode-link">[source]</span></a></dt>
811<dd><blockquote>
812<div>Remove connections for artists h1, h2, ...</div></blockquote>
813<p>Use clearall() to reset all connections.</p>
814</dd></dl>
815
816<dl class="method">
817<dt id="sas.plottools.binder.BindArtist.clearall">
818<tt class="descname">clearall</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/binder.html#BindArtist.clearall"><span class="viewcode-link">[source]</span></a></dt>
819<dd><p>Clear connections to all artists.</p>
820<p>Use clear(h1,h2,...) to reset specific artists.</p>
821</dd></dl>
822
823<dl class="attribute">
824<dt id="sas.plottools.binder.BindArtist.control">
825<tt class="descname">control</tt><em class="property"> = False</em></dt>
826<dd></dd></dl>
827
828<dl class="attribute">
829<dt id="sas.plottools.binder.BindArtist.dclick_threshhold">
830<tt class="descname">dclick_threshhold</tt><em class="property"> = 0.25</em></dt>
831<dd></dd></dl>
832
833<dl class="method">
834<dt id="sas.plottools.binder.BindArtist.disconnect">
835<tt class="descname">disconnect</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/binder.html#BindArtist.disconnect"><span class="viewcode-link">[source]</span></a></dt>
836<dd><p>In case we need to disconnect from the canvas...</p>
837</dd></dl>
838
839<dl class="attribute">
840<dt id="sas.plottools.binder.BindArtist.events">
841<tt class="descname">events</tt><em class="property"> = ['enter', 'leave', 'motion', 'click', 'dclick', 'drag', 'release', 'scroll', 'key', 'keyup']</em></dt>
842<dd></dd></dl>
843
844<dl class="attribute">
845<dt id="sas.plottools.binder.BindArtist.meta">
846<tt class="descname">meta</tt><em class="property"> = False</em></dt>
847<dd></dd></dl>
848
849<dl class="attribute">
850<dt id="sas.plottools.binder.BindArtist.shift">
851<tt class="descname">shift</tt><em class="property"> = False</em></dt>
852<dd></dd></dl>
853
854<dl class="method">
855<dt id="sas.plottools.binder.BindArtist.trigger">
856<tt class="descname">trigger</tt><big>(</big><em>actor</em>, <em>action</em>, <em>ev</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/binder.html#BindArtist.trigger"><span class="viewcode-link">[source]</span></a></dt>
857<dd><p>Trigger a particular event for the artist.  Fallback to axes,
858to figure, and to &#8216;all&#8217; if the event is not processed.</p>
859</dd></dl>
860
861</dd></dl>
862
863<dl class="class">
864<dt id="sas.plottools.binder.Selection">
865<em class="property">class </em><tt class="descclassname">sas.plottools.binder.</tt><tt class="descname">Selection</tt><big>(</big><em>artist=None</em>, <em>prop={}</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/binder.html#Selection"><span class="viewcode-link">[source]</span></a></dt>
866<dd><p>Store and compare selections.</p>
867<dl class="attribute">
868<dt id="sas.plottools.binder.Selection.artist">
869<tt class="descname">artist</tt><em class="property"> = None</em></dt>
870<dd></dd></dl>
871
872<dl class="attribute">
873<dt id="sas.plottools.binder.Selection.prop">
874<tt class="descname">prop</tt><em class="property"> = {}</em></dt>
875<dd></dd></dl>
876
877</dd></dl>
878
879</div>
880<div class="section" id="module-sas.plottools.canvas">
881<span id="sas-plottools-canvas-module"></span><h2>sas.plottools.canvas module</h2>
882<p>This module implements a faster canvas for plotting.
883it ovewrites some matplolib methods to allow printing on sys.platform==&#8217;win32&#8217;</p>
884<dl class="class">
885<dt id="sas.plottools.canvas.FigureCanvas">
886<em class="property">class </em><tt class="descclassname">sas.plottools.canvas.</tt><tt class="descname">FigureCanvas</tt><big>(</big><em>*args</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#FigureCanvas"><span class="viewcode-link">[source]</span></a></dt>
887<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">matplotlib.backends.backend_wxagg.FigureCanvasWxAgg</span></tt></p>
888<p>Add features to the wx agg canvas for better support of AUI and
889faster plotting.</p>
890<dl class="method">
891<dt id="sas.plottools.canvas.FigureCanvas.draw">
892<tt class="descname">draw</tt><big>(</big><em>drawDC=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#FigureCanvas.draw"><span class="viewcode-link">[source]</span></a></dt>
893<dd><p>Render the figure using agg.</p>
894</dd></dl>
895
896<dl class="method">
897<dt id="sas.plottools.canvas.FigureCanvas.draw_idle">
898<tt class="descname">draw_idle</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#FigureCanvas.draw_idle"><span class="viewcode-link">[source]</span></a></dt>
899<dd><p>Render after a delay if no other render requests have been made.</p>
900</dd></dl>
901
902<dl class="method">
903<dt id="sas.plottools.canvas.FigureCanvas.scroll_event">
904<tt class="descname">scroll_event</tt><big>(</big><em>x</em>, <em>y</em>, <em>step=1</em>, <em>guiEvent=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#FigureCanvas.scroll_event"><span class="viewcode-link">[source]</span></a></dt>
905<dd><p>Backend derived classes should call this function on any
906scroll wheel event.  x,y are the canvas coords: 0,0 is lower,
907left.  button and key are as defined in MouseEvent</p>
908</dd></dl>
909
910<dl class="method">
911<dt id="sas.plottools.canvas.FigureCanvas.set_panel">
912<tt class="descname">set_panel</tt><big>(</big><em>panel</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#FigureCanvas.set_panel"><span class="viewcode-link">[source]</span></a></dt>
913<dd><p>Set axes</p>
914</dd></dl>
915
916<dl class="method">
917<dt id="sas.plottools.canvas.FigureCanvas.set_resizing">
918<tt class="descname">set_resizing</tt><big>(</big><em>resizing=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#FigureCanvas.set_resizing"><span class="viewcode-link">[source]</span></a></dt>
919<dd><p>Setting the resizing</p>
920</dd></dl>
921
922</dd></dl>
923
924<dl class="function">
925<dt id="sas.plottools.canvas.OnPrintPage">
926<tt class="descclassname">sas.plottools.canvas.</tt><tt class="descname">OnPrintPage</tt><big>(</big><em>self</em>, <em>page</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#OnPrintPage"><span class="viewcode-link">[source]</span></a></dt>
927<dd><p>override printPage of matplotlib</p>
928</dd></dl>
929
930<dl class="function">
931<dt id="sas.plottools.canvas.draw_image">
932<tt class="descclassname">sas.plottools.canvas.</tt><tt class="descname">draw_image</tt><big>(</big><em>self</em>, <em>x</em>, <em>y</em>, <em>im</em>, <em>bbox</em>, <em>clippath=None</em>, <em>clippath_trans=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#draw_image"><span class="viewcode-link">[source]</span></a></dt>
933<dd><p>Draw the image instance into the current axes;</p>
934<table class="docutils field-list" frame="void" rules="none">
935<col class="field-name" />
936<col class="field-body" />
937<tbody valign="top">
938<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
939<li><strong>x</strong> &#8211; is the distance in pixels from the left hand side of the canvas.</li>
940<li><strong>y</strong> &#8211; the distance from the origin.  That is, if origin is
941upper, y is the distance from top.  If origin is lower, y
942is the distance from bottom</li>
943<li><strong>im</strong> &#8211; the class`matplotlib._image.Image` instance</li>
944<li><strong>bbox</strong> &#8211; a class <cite>matplotlib.transforms.Bbox</cite> instance for clipping, or
945None</li>
946</ul>
947</td>
948</tr>
949</tbody>
950</table>
951</dd></dl>
952
953<dl class="function">
954<dt id="sas.plottools.canvas.select">
955<tt class="descclassname">sas.plottools.canvas.</tt><tt class="descname">select</tt><big>(</big><em>self</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#select"><span class="viewcode-link">[source]</span></a></dt>
956<dd></dd></dl>
957
958<dl class="function">
959<dt id="sas.plottools.canvas.unselect">
960<tt class="descclassname">sas.plottools.canvas.</tt><tt class="descname">unselect</tt><big>(</big><em>self</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/canvas.html#unselect"><span class="viewcode-link">[source]</span></a></dt>
961<dd></dd></dl>
962
963</div>
964<div class="section" id="module-sas.plottools.config">
965<span id="sas-plottools-config-module"></span><h2>sas.plottools.config module</h2>
966<p>Configure plotter for plottools.</p>
967<p>This must be imported first in __init__.py for plottools.</p>
968<p>If your application uses matplotlib outside plottools, then
969please do the following at the start of your application:</p>
970<blockquote>
971<div># Select matplotlib version and backend
972import sas.plottools.config</div></blockquote>
973<p>Note that plottools requires particular versions of matplotlib
974and a particular backend.  As of this writing it is the WXAgg
975backend for matplotlib&gt;=0.98.</p>
976<p>The plottools package uses pkg_resources if available to select
977the correct version of matplotlib.  If you need multiple matplotlib
978versions in your path, be sure to use &#8220;easy_install -m&#8221; for all
979of them.  If a version is installed without &#8220;-m&#8221; that does not
980meet the requirements, then pkg_resources.require() will fail,
981even if you have installed a suitable version with &#8220;-m&#8221;.  In this
982case you will need to fix up your site-packages directory,
983probably by removing site-packages/matplotlib and the associated
984egg file for that version, and reinstalling with &#8220;-m&#8221;.  You may
985also need to edit site-packages/easy-install.pth.</p>
986</div>
987<div class="section" id="module-sas.plottools.fitDialog">
988<span id="sas-plottools-fitdialog-module"></span><h2>sas.plottools.fitDialog module</h2>
989<dl class="class">
990<dt id="sas.plottools.fitDialog.LinearFit">
991<em class="property">class </em><tt class="descclassname">sas.plottools.fitDialog.</tt><tt class="descname">LinearFit</tt><big>(</big><em>parent</em>, <em>plottable</em>, <em>push_data</em>, <em>transform</em>, <em>title</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit"><span class="viewcode-link">[source]</span></a></dt>
992<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Dialog</span></tt></p>
993<dl class="method">
994<dt id="sas.plottools.fitDialog.LinearFit.checkFitValues">
995<tt class="descname">checkFitValues</tt><big>(</big><em>item</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.checkFitValues"><span class="viewcode-link">[source]</span></a></dt>
996<dd><p>Check the validity of input values</p>
997</dd></dl>
998
999<dl class="method">
1000<dt id="sas.plottools.fitDialog.LinearFit.floatForwardTransform">
1001<tt class="descname">floatForwardTransform</tt><big>(</big><em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.floatForwardTransform"><span class="viewcode-link">[source]</span></a></dt>
1002<dd><p>transform a float.</p>
1003</dd></dl>
1004
1005<dl class="method">
1006<dt id="sas.plottools.fitDialog.LinearFit.floatInvTransform">
1007<tt class="descname">floatInvTransform</tt><big>(</big><em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.floatInvTransform"><span class="viewcode-link">[source]</span></a></dt>
1008<dd><p>transform a float.It is use to determine the x.View min and x.View
1009max for values not in x</p>
1010</dd></dl>
1011
1012<dl class="method">
1013<dt id="sas.plottools.fitDialog.LinearFit.floatTransform">
1014<tt class="descname">floatTransform</tt><big>(</big><em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.floatTransform"><span class="viewcode-link">[source]</span></a></dt>
1015<dd><p>transform a float.It is use to determine the x.
1016View min and x.View max for values
1017not in x</p>
1018</dd></dl>
1019
1020<dl class="method">
1021<dt id="sas.plottools.fitDialog.LinearFit.register_close">
1022<tt class="descname">register_close</tt><big>(</big><em>owner</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.register_close"><span class="viewcode-link">[source]</span></a></dt>
1023<dd><p>Method to register the close event to a parent
1024window that needs notification when the dialog
1025is closed</p>
1026<table class="docutils field-list" frame="void" rules="none">
1027<col class="field-name" />
1028<col class="field-body" />
1029<tbody valign="top">
1030<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>owner</strong> &#8211; parent window</td>
1031</tr>
1032</tbody>
1033</table>
1034</dd></dl>
1035
1036<dl class="method">
1037<dt id="sas.plottools.fitDialog.LinearFit.setFitRange">
1038<tt class="descname">setFitRange</tt><big>(</big><em>xmin</em>, <em>xmax</em>, <em>xminTrans</em>, <em>xmaxTrans</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.setFitRange"><span class="viewcode-link">[source]</span></a></dt>
1039<dd><p>Set fit parameters</p>
1040</dd></dl>
1041
1042<dl class="method">
1043<dt id="sas.plottools.fitDialog.LinearFit.set_fit_region">
1044<tt class="descname">set_fit_region</tt><big>(</big><em>xmin</em>, <em>xmax</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#LinearFit.set_fit_region"><span class="viewcode-link">[source]</span></a></dt>
1045<dd><p>Set the fit region
1046:param xmin: minimum x-value to be included in fit
1047:param xmax: maximum x-value to be included in fit</p>
1048</dd></dl>
1049
1050</dd></dl>
1051
1052<dl class="class">
1053<dt id="sas.plottools.fitDialog.MyApp">
1054<em class="property">class </em><tt class="descclassname">sas.plottools.fitDialog.</tt><tt class="descname">MyApp</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#MyApp"><span class="viewcode-link">[source]</span></a></dt>
1055<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
1056<dl class="method">
1057<dt id="sas.plottools.fitDialog.MyApp.OnInit">
1058<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#MyApp.OnInit"><span class="viewcode-link">[source]</span></a></dt>
1059<dd></dd></dl>
1060
1061<dl class="method">
1062<dt id="sas.plottools.fitDialog.MyApp.onFitDisplay">
1063<tt class="descname">onFitDisplay</tt><big>(</big><em>tempx</em>, <em>tempy</em>, <em>xminView</em>, <em>xmaxView</em>, <em>xmin</em>, <em>xmax</em>, <em>func</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#MyApp.onFitDisplay"><span class="viewcode-link">[source]</span></a></dt>
1064<dd></dd></dl>
1065
1066<dl class="method">
1067<dt id="sas.plottools.fitDialog.MyApp.returnTrans">
1068<tt class="descname">returnTrans</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#MyApp.returnTrans"><span class="viewcode-link">[source]</span></a></dt>
1069<dd></dd></dl>
1070
1071</dd></dl>
1072
1073<dl class="function">
1074<dt id="sas.plottools.fitDialog.format_number">
1075<tt class="descclassname">sas.plottools.fitDialog.</tt><tt class="descname">format_number</tt><big>(</big><em>value</em>, <em>high=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fitDialog.html#format_number"><span class="viewcode-link">[source]</span></a></dt>
1076<dd><p>Return a float in a standardized, human-readable formatted string</p>
1077</dd></dl>
1078
1079</div>
1080<div class="section" id="module-sas.plottools.fittings">
1081<span id="sas-plottools-fittings-module"></span><h2>sas.plottools.fittings module</h2>
1082<dl class="class">
1083<dt id="sas.plottools.fittings.Parameter">
1084<em class="property">class </em><tt class="descclassname">sas.plottools.fittings.</tt><tt class="descname">Parameter</tt><big>(</big><em>model</em>, <em>name</em>, <em>value=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fittings.html#Parameter"><span class="viewcode-link">[source]</span></a></dt>
1085<dd><p>Class to handle model parameters</p>
1086<dl class="method">
1087<dt id="sas.plottools.fittings.Parameter.set">
1088<tt class="descname">set</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fittings.html#Parameter.set"><span class="viewcode-link">[source]</span></a></dt>
1089<dd><p>Set the value of the parameter</p>
1090</dd></dl>
1091
1092</dd></dl>
1093
1094<dl class="function">
1095<dt id="sas.plottools.fittings.calcCommandline">
1096<tt class="descclassname">sas.plottools.fittings.</tt><tt class="descname">calcCommandline</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fittings.html#calcCommandline"><span class="viewcode-link">[source]</span></a></dt>
1097<dd></dd></dl>
1098
1099<dl class="function">
1100<dt id="sas.plottools.fittings.sasfit">
1101<tt class="descclassname">sas.plottools.fittings.</tt><tt class="descname">sasfit</tt><big>(</big><em>model</em>, <em>pars</em>, <em>x</em>, <em>y</em>, <em>err_y</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/fittings.html#sasfit"><span class="viewcode-link">[source]</span></a></dt>
1102<dd><p>Fit function</p>
1103<table class="docutils field-list" frame="void" rules="none">
1104<col class="field-name" />
1105<col class="field-body" />
1106<tbody valign="top">
1107<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1108<li><strong>model</strong> &#8211; sas model object</li>
1109<li><strong>pars</strong> &#8211; list of parameters</li>
1110<li><strong>x</strong> &#8211; vector of x data</li>
1111<li><strong>y</strong> &#8211; vector of y data</li>
1112<li><strong>err_y</strong> &#8211; vector of y errors</li>
1113</ul>
1114</td>
1115</tr>
1116</tbody>
1117</table>
1118</dd></dl>
1119
1120</div>
1121<div class="section" id="module-sas.plottools.plottable_interactor">
1122<span id="sas-plottools-plottable-interactor-module"></span><h2>sas.plottools.plottable_interactor module</h2>
1123<p>This module allows more interaction with the plot</p>
1124<dl class="class">
1125<dt id="sas.plottools.plottable_interactor.PointInteractor">
1126<em class="property">class </em><tt class="descclassname">sas.plottools.plottable_interactor.</tt><tt class="descname">PointInteractor</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em>, <em>id=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor"><span class="viewcode-link">[source]</span></a></dt>
1127<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.BaseInteractor._BaseInteractor</span></tt></p>
1128<dl class="method">
1129<dt id="sas.plottools.plottable_interactor.PointInteractor.clear">
1130<tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.clear"><span class="viewcode-link">[source]</span></a></dt>
1131<dd></dd></dl>
1132
1133<dl class="method">
1134<dt id="sas.plottools.plottable_interactor.PointInteractor.connect_markers">
1135<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.connect_markers"><span class="viewcode-link">[source]</span></a></dt>
1136<dd><p>Connect markers to callbacks</p>
1137</dd></dl>
1138
1139<dl class="method">
1140<dt id="sas.plottools.plottable_interactor.PointInteractor.curve">
1141<tt class="descname">curve</tt><big>(</big><em>x</em>, <em>y</em>, <em>dy=None</em>, <em>color=0</em>, <em>symbol=0</em>, <em>zorder=10</em>, <em>label=None</em>, <em>width=2.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.curve"><span class="viewcode-link">[source]</span></a></dt>
1142<dd></dd></dl>
1143
1144<dl class="method">
1145<dt id="sas.plottools.plottable_interactor.PointInteractor.points">
1146<tt class="descname">points</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>color=0</em>, <em>symbol=0</em>, <em>zorder=1</em>, <em>markersize=5</em>, <em>label=None</em>, <em>hide_error=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.points"><span class="viewcode-link">[source]</span></a></dt>
1147<dd></dd></dl>
1148
1149<dl class="method">
1150<dt id="sas.plottools.plottable_interactor.PointInteractor.step">
1151<tt class="descname">step</tt><big>(</big><em>x</em>, <em>y</em>, <em>dy=None</em>, <em>color=0</em>, <em>symbol=0</em>, <em>zorder=1</em>, <em>label=None</em>, <em>width=2.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.step"><span class="viewcode-link">[source]</span></a></dt>
1152<dd></dd></dl>
1153
1154<dl class="method">
1155<dt id="sas.plottools.plottable_interactor.PointInteractor.update">
1156<tt class="descname">update</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.update"><span class="viewcode-link">[source]</span></a></dt>
1157<dd><p>Update</p>
1158</dd></dl>
1159
1160<dl class="method">
1161<dt id="sas.plottools.plottable_interactor.PointInteractor.vline">
1162<tt class="descname">vline</tt><big>(</big><em>x</em>, <em>y</em>, <em>dy=None</em>, <em>color=0</em>, <em>symbol=0</em>, <em>zorder=1</em>, <em>label=None</em>, <em>width=2.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottable_interactor.html#PointInteractor.vline"><span class="viewcode-link">[source]</span></a></dt>
1163<dd></dd></dl>
1164
1165</dd></dl>
1166
1167</div>
1168<div class="section" id="module-sas.plottools.plottables">
1169<span id="sas-plottools-plottables-module"></span><h2>sas.plottools.plottables module</h2>
1170<p>Prototype plottable object support.</p>
1171<p>The main point of this prototype is to provide a clean separation between
1172the style (plotter details: color, grids, widgets, etc.) and substance
1173(application details: which information to plot).  Programmers should not be
1174dictating line colours and plotting symbols.</p>
1175<p>Unlike the problem of style in CSS or Word, where most paragraphs look
1176the same, each line on a graph has to be distinguishable from its neighbours.
1177Our solution is to provide parametric styles, in which a number of
1178different classes of object (e.g., reflectometry data, reflectometry
1179theory) representing multiple graph primitives cycle through a colour
1180palette provided by the underlying plotter.</p>
1181<p>A full treatment would provide perceptual dimensions of prominence and
1182distinctiveness rather than a simple colour number.</p>
1183<dl class="class">
1184<dt id="sas.plottools.plottables.Chisq">
1185<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Chisq</tt><big>(</big><em>chisq=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Chisq"><span class="viewcode-link">[source]</span></a></dt>
1186<dd><p>Bases: <a class="reference internal" href="#sas.plottools.plottables.Plottable" title="sas.plottools.plottables.Plottable"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Plottable</span></tt></a></p>
1187<p>Chisq plottable plots the chisq</p>
1188<dl class="method">
1189<dt id="sas.plottools.plottables.Chisq.render">
1190<tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Chisq.render"><span class="viewcode-link">[source]</span></a></dt>
1191<dd></dd></dl>
1192
1193<dl class="method">
1194<dt id="sas.plottools.plottables.Chisq.setChisq">
1195<tt class="descname">setChisq</tt><big>(</big><em>chisq</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Chisq.setChisq"><span class="viewcode-link">[source]</span></a></dt>
1196<dd><p>Set the chisq value.</p>
1197</dd></dl>
1198
1199</dd></dl>
1200
1201<dl class="class">
1202<dt id="sas.plottools.plottables.Data1D">
1203<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Data1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data1D"><span class="viewcode-link">[source]</span></a></dt>
1204<dd><p>Bases: <a class="reference internal" href="#sas.plottools.plottables.Plottable" title="sas.plottools.plottables.Plottable"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Plottable</span></tt></a></p>
1205<p>Data plottable: scatter plot of x,y with errors in x and y.</p>
1206<dl class="method">
1207<dt id="sas.plottools.plottables.Data1D.changed">
1208<tt class="descname">changed</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data1D.changed"><span class="viewcode-link">[source]</span></a></dt>
1209<dd></dd></dl>
1210
1211<dl class="classmethod">
1212<dt id="sas.plottools.plottables.Data1D.labels">
1213<em class="property">classmethod </em><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data1D.labels"><span class="viewcode-link">[source]</span></a></dt>
1214<dd><p>Build a label mostly unique within a collection</p>
1215</dd></dl>
1216
1217<dl class="method">
1218<dt id="sas.plottools.plottables.Data1D.render">
1219<tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data1D.render"><span class="viewcode-link">[source]</span></a></dt>
1220<dd><p>Renders the plottable on the graph</p>
1221</dd></dl>
1222
1223</dd></dl>
1224
1225<dl class="class">
1226<dt id="sas.plottools.plottables.Data2D">
1227<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Data2D</tt><big>(</big><em>image=None</em>, <em>qx_data=None</em>, <em>qy_data=None</em>, <em>err_image=None</em>, <em>xmin=None</em>, <em>xmax=None</em>, <em>ymin=None</em>, <em>ymax=None</em>, <em>zmin=None</em>, <em>zmax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D"><span class="viewcode-link">[source]</span></a></dt>
1228<dd><p>Bases: <a class="reference internal" href="#sas.plottools.plottables.Plottable" title="sas.plottools.plottables.Plottable"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Plottable</span></tt></a></p>
1229<p>2D data class for image plotting</p>
1230<dl class="method">
1231<dt id="sas.plottools.plottables.Data2D.changed">
1232<tt class="descname">changed</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.changed"><span class="viewcode-link">[source]</span></a></dt>
1233<dd></dd></dl>
1234
1235<dl class="classmethod">
1236<dt id="sas.plottools.plottables.Data2D.labels">
1237<em class="property">classmethod </em><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.labels"><span class="viewcode-link">[source]</span></a></dt>
1238<dd><p>Build a label mostly unique within a collection</p>
1239</dd></dl>
1240
1241<dl class="method">
1242<dt id="sas.plottools.plottables.Data2D.render">
1243<tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.render"><span class="viewcode-link">[source]</span></a></dt>
1244<dd><p>Renders the plottable on the graph</p>
1245</dd></dl>
1246
1247<dl class="method">
1248<dt id="sas.plottools.plottables.Data2D.setValues">
1249<tt class="descname">setValues</tt><big>(</big><em>datainfo=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.setValues"><span class="viewcode-link">[source]</span></a></dt>
1250<dd><p>Use datainfo object to initialize data2D</p>
1251<table class="docutils field-list" frame="void" rules="none">
1252<col class="field-name" />
1253<col class="field-body" />
1254<tbody valign="top">
1255<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> &#8211; object</td>
1256</tr>
1257</tbody>
1258</table>
1259</dd></dl>
1260
1261<dl class="method">
1262<dt id="sas.plottools.plottables.Data2D.set_zrange">
1263<tt class="descname">set_zrange</tt><big>(</big><em>zmin=None</em>, <em>zmax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.set_zrange"><span class="viewcode-link">[source]</span></a></dt>
1264<dd></dd></dl>
1265
1266<dl class="method">
1267<dt id="sas.plottools.plottables.Data2D.xaxis">
1268<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.xaxis"><span class="viewcode-link">[source]</span></a></dt>
1269<dd><p>set x-axis</p>
1270<table class="docutils field-list" frame="void" rules="none">
1271<col class="field-name" />
1272<col class="field-body" />
1273<tbody valign="top">
1274<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1275<li><strong>label</strong> &#8211; x-axis label</li>
1276<li><strong>unit</strong> &#8211; x-axis unit</li>
1277</ul>
1278</td>
1279</tr>
1280</tbody>
1281</table>
1282</dd></dl>
1283
1284<dl class="method">
1285<dt id="sas.plottools.plottables.Data2D.yaxis">
1286<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.yaxis"><span class="viewcode-link">[source]</span></a></dt>
1287<dd><p>set y-axis</p>
1288<table class="docutils field-list" frame="void" rules="none">
1289<col class="field-name" />
1290<col class="field-body" />
1291<tbody valign="top">
1292<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1293<li><strong>label</strong> &#8211; y-axis label</li>
1294<li><strong>unit</strong> &#8211; y-axis unit</li>
1295</ul>
1296</td>
1297</tr>
1298</tbody>
1299</table>
1300</dd></dl>
1301
1302<dl class="method">
1303<dt id="sas.plottools.plottables.Data2D.zaxis">
1304<tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Data2D.zaxis"><span class="viewcode-link">[source]</span></a></dt>
1305<dd><p>set z-axis</p>
1306<table class="docutils field-list" frame="void" rules="none">
1307<col class="field-name" />
1308<col class="field-body" />
1309<tbody valign="top">
1310<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1311<li><strong>label</strong> &#8211; z-axis label</li>
1312<li><strong>unit</strong> &#8211; z-axis unit</li>
1313</ul>
1314</td>
1315</tr>
1316</tbody>
1317</table>
1318</dd></dl>
1319
1320</dd></dl>
1321
1322<dl class="class">
1323<dt id="sas.plottools.plottables.Fit1D">
1324<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Fit1D</tt><big>(</big><em>data=None</em>, <em>theory=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Fit1D"><span class="viewcode-link">[source]</span></a></dt>
1325<dd><p>Bases: <a class="reference internal" href="#sas.plottools.plottables.Plottable" title="sas.plottools.plottables.Plottable"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Plottable</span></tt></a></p>
1326<p>Fit plottable: composed of a data line plus a theory line.  This
1327is treated like a single object from the perspective of the graph,
1328except that it will have two legend entries, one for the data and
1329one for the theory.</p>
1330<p>The color of the data and theory will be shared.</p>
1331<dl class="method">
1332<dt id="sas.plottools.plottables.Fit1D.changed">
1333<tt class="descname">changed</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Fit1D.changed"><span class="viewcode-link">[source]</span></a></dt>
1334<dd></dd></dl>
1335
1336<dl class="method">
1337<dt id="sas.plottools.plottables.Fit1D.render">
1338<tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Fit1D.render"><span class="viewcode-link">[source]</span></a></dt>
1339<dd></dd></dl>
1340
1341</dd></dl>
1342
1343<dl class="class">
1344<dt id="sas.plottools.plottables.Graph">
1345<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Graph</tt><big>(</big><em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph"><span class="viewcode-link">[source]</span></a></dt>
1346<dd><p>Generic plottables graph structure.</p>
1347<p>Plot styles are based on color/symbol lists.  The user gets to select
1348the list of colors/symbols/sizes to choose from, not the application
1349developer.  The programmer only gets to add/remove lines from the
1350plot and move to the next symbol/color.</p>
1351<p>Another dimension is prominence, which refers to line sizes/point sizes.</p>
1352<p>Axis transformations allow the user to select the coordinate view
1353which provides clarity to the data.  There is no way we can provide
1354every possible transformation for every application generically, so
1355the plottable objects themselves will need to provide the transformations.
1356Here are some examples from reflectometry:</p>
1357<div class="highlight-python"><div class="highlight"><pre>independent: x -&gt; f(x)
1358   monitor scaling: y -&gt; M*y
1359   log:  y -&gt; log(y if y &gt; min else min)
1360   cos:  y -&gt; cos(y*pi/180)
1361dependent:   x -&gt; f(x,y)
1362   Q4:      y -&gt; y*x^4
1363   fresnel: y -&gt; y*fresnel(x)
1364coordinated: x,y = f(x,y)
1365   Q:    x -&gt; 2*pi/L (cos(x*pi/180) - cos(y*pi/180))
1366         y -&gt; 2*pi/L (sin(x*pi/180) + sin(y*pi/180))
1367reducing: x,y = f(x1,x2,y1,y2)
1368   spin asymmetry: x -&gt; x1, y -&gt; (y1 - y2)/(y1 + y2)
1369   vector net: x -&gt; x1, y -&gt; y1*cos(y2*pi/180)
1370</pre></div>
1371</div>
1372<p>Multiple transformations are possible, such as Q4 spin asymmetry</p>
1373<p>Axes have further complications in that the units of what are being
1374plotted should correspond to the units on the axes.  Plotting multiple
1375types on the same graph should be handled gracefully, e.g., by creating
1376a separate tab for each available axis type, breaking into subplots,
1377showing multiple axes on the same plot, or generating inset plots.
1378Ultimately the decision should be left to the user.</p>
1379<p>Graph properties such as grids/crosshairs should be under user control,
1380as should the sizes of items such as axis fonts, etc.  No direct
1381access will be provided to the application.</p>
1382<p>Axis limits are mostly under user control.  If the user has zoomed or
1383panned then those limits are preserved even if new data is plotted.
1384The exception is when, e.g., scanning through a set of related lines
1385in which the user may want to fix the limits so that user can compare
1386the values directly.  Another exception is when creating multiple
1387graphs sharing the same limits, though this case may be important
1388enough that it is handled by the graph widget itself.  Axis limits
1389will of course have to understand the effects of axis transformations.</p>
1390<p>High level plottable objects may be composed of low level primitives.
1391Operations such as legend/hide/show copy/paste, etc. need to operate
1392on these primitives as a group.  E.g., allowing the user to have a
1393working canvas where they can drag lines they want to save and annotate
1394them.</p>
1395<p>Graphs need to be printable.  A page layout program for entire plots
1396would be nice.</p>
1397<dl class="method">
1398<dt id="sas.plottools.plottables.Graph.add">
1399<tt class="descname">add</tt><big>(</big><em>plottable</em>, <em>color=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.add"><span class="viewcode-link">[source]</span></a></dt>
1400<dd><p>Add a new plottable to the graph</p>
1401</dd></dl>
1402
1403<dl class="method">
1404<dt id="sas.plottools.plottables.Graph.changed">
1405<tt class="descname">changed</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.changed"><span class="viewcode-link">[source]</span></a></dt>
1406<dd><p>Detect if any graphed plottables have changed</p>
1407</dd></dl>
1408
1409<dl class="method">
1410<dt id="sas.plottools.plottables.Graph.delete">
1411<tt class="descname">delete</tt><big>(</big><em>plottable</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.delete"><span class="viewcode-link">[source]</span></a></dt>
1412<dd><p>Remove an existing plottable from the graph</p>
1413</dd></dl>
1414
1415<dl class="method">
1416<dt id="sas.plottools.plottables.Graph.get">
1417<tt class="descname">get</tt><big>(</big><em>key</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.get"><span class="viewcode-link">[source]</span></a></dt>
1418<dd><p>Get the graph properties</p>
1419</dd></dl>
1420
1421<dl class="method">
1422<dt id="sas.plottools.plottables.Graph.get_plottable">
1423<tt class="descname">get_plottable</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.get_plottable"><span class="viewcode-link">[source]</span></a></dt>
1424<dd><p>Return the plottable with the given
1425name if it exists. Otherwise return None</p>
1426</dd></dl>
1427
1428<dl class="method">
1429<dt id="sas.plottools.plottables.Graph.get_range">
1430<tt class="descname">get_range</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.get_range"><span class="viewcode-link">[source]</span></a></dt>
1431<dd><p>Return the range of all displayed plottables</p>
1432</dd></dl>
1433
1434<dl class="method">
1435<dt id="sas.plottools.plottables.Graph.isPlotted">
1436<tt class="descname">isPlotted</tt><big>(</big><em>plottable</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.isPlotted"><span class="viewcode-link">[source]</span></a></dt>
1437<dd><p>Return True is the plottable is already on the graph</p>
1438</dd></dl>
1439
1440<dl class="method">
1441<dt id="sas.plottools.plottables.Graph.render">
1442<tt class="descname">render</tt><big>(</big><em>plot</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.render"><span class="viewcode-link">[source]</span></a></dt>
1443<dd><p>Redraw the graph</p>
1444</dd></dl>
1445
1446<dl class="method">
1447<dt id="sas.plottools.plottables.Graph.replace">
1448<tt class="descname">replace</tt><big>(</big><em>plottable</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.replace"><span class="viewcode-link">[source]</span></a></dt>
1449<dd><p>Replace an existing plottable from the graph</p>
1450</dd></dl>
1451
1452<dl class="method">
1453<dt id="sas.plottools.plottables.Graph.reset">
1454<tt class="descname">reset</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.reset"><span class="viewcode-link">[source]</span></a></dt>
1455<dd><p>Reset the graph.</p>
1456</dd></dl>
1457
1458<dl class="method">
1459<dt id="sas.plottools.plottables.Graph.reset_scale">
1460<tt class="descname">reset_scale</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.reset_scale"><span class="viewcode-link">[source]</span></a></dt>
1461<dd><p>Resets the scale transformation data to the underlying data</p>
1462</dd></dl>
1463
1464<dl class="method">
1465<dt id="sas.plottools.plottables.Graph.returnPlottable">
1466<tt class="descname">returnPlottable</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.returnPlottable"><span class="viewcode-link">[source]</span></a></dt>
1467<dd><p>This method returns a dictionary of plottables contained in graph
1468It is just by Plotpanel to interact with the complete list of plottables
1469inside the graph.</p>
1470</dd></dl>
1471
1472<dl class="method">
1473<dt id="sas.plottools.plottables.Graph.set">
1474<tt class="descname">set</tt><big>(</big><em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.set"><span class="viewcode-link">[source]</span></a></dt>
1475<dd><p>Set the graph properties</p>
1476</dd></dl>
1477
1478<dl class="method">
1479<dt id="sas.plottools.plottables.Graph.title">
1480<tt class="descname">title</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.title"><span class="viewcode-link">[source]</span></a></dt>
1481<dd><p>Graph title</p>
1482</dd></dl>
1483
1484<dl class="method">
1485<dt id="sas.plottools.plottables.Graph.xaxis">
1486<tt class="descname">xaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.xaxis"><span class="viewcode-link">[source]</span></a></dt>
1487<dd><p>Properties of the x axis.</p>
1488</dd></dl>
1489
1490<dl class="method">
1491<dt id="sas.plottools.plottables.Graph.yaxis">
1492<tt class="descname">yaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Graph.yaxis"><span class="viewcode-link">[source]</span></a></dt>
1493<dd><p>Properties of the y axis.</p>
1494</dd></dl>
1495
1496</dd></dl>
1497
1498<dl class="class">
1499<dt id="sas.plottools.plottables.Plottable">
1500<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Plottable</tt><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable"><span class="viewcode-link">[source]</span></a></dt>
1501<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1502<dl class="method">
1503<dt id="sas.plottools.plottables.Plottable.check_data_PlottableX">
1504<tt class="descname">check_data_PlottableX</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.check_data_PlottableX"><span class="viewcode-link">[source]</span></a></dt>
1505<dd><p>Since no transformation is made for log10(x), check that
1506no negative values is plot in log scale</p>
1507</dd></dl>
1508
1509<dl class="method">
1510<dt id="sas.plottools.plottables.Plottable.check_data_PlottableY">
1511<tt class="descname">check_data_PlottableY</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.check_data_PlottableY"><span class="viewcode-link">[source]</span></a></dt>
1512<dd><p>Since no transformation is made for log10(y), check that
1513no negative values is plot in log scale</p>
1514</dd></dl>
1515
1516<dl class="method">
1517<dt id="sas.plottools.plottables.Plottable.colors">
1518<tt class="descname">colors</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.colors"><span class="viewcode-link">[source]</span></a></dt>
1519<dd><p>Return the number of colors need to render the object</p>
1520</dd></dl>
1521
1522<dl class="attribute">
1523<dt id="sas.plottools.plottables.Plottable.custom_color">
1524<tt class="descname">custom_color</tt><em class="property"> = None</em></dt>
1525<dd></dd></dl>
1526
1527<dl class="attribute">
1528<dt id="sas.plottools.plottables.Plottable.dx">
1529<tt class="descname">dx</tt><em class="property"> = None</em></dt>
1530<dd></dd></dl>
1531
1532<dl class="attribute">
1533<dt id="sas.plottools.plottables.Plottable.dy">
1534<tt class="descname">dy</tt><em class="property"> = None</em></dt>
1535<dd></dd></dl>
1536
1537<dl class="method">
1538<dt id="sas.plottools.plottables.Plottable.get_xaxis">
1539<tt class="descname">get_xaxis</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.get_xaxis"><span class="viewcode-link">[source]</span></a></dt>
1540<dd><p>Return the units and name of x-axis</p>
1541</dd></dl>
1542
1543<dl class="method">
1544<dt id="sas.plottools.plottables.Plottable.get_yaxis">
1545<tt class="descname">get_yaxis</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.get_yaxis"><span class="viewcode-link">[source]</span></a></dt>
1546<dd><p>Return the units and name of y- axis</p>
1547</dd></dl>
1548
1549<dl class="attribute">
1550<dt id="sas.plottools.plottables.Plottable.hidden">
1551<tt class="descname">hidden</tt><em class="property"> = False</em></dt>
1552<dd></dd></dl>
1553
1554<dl class="attribute">
1555<dt id="sas.plottools.plottables.Plottable.interactive">
1556<tt class="descname">interactive</tt><em class="property"> = True</em></dt>
1557<dd></dd></dl>
1558
1559<dl class="method">
1560<dt id="sas.plottools.plottables.Plottable.is_empty">
1561<tt class="descname">is_empty</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.is_empty"><span class="viewcode-link">[source]</span></a></dt>
1562<dd><p>Returns True if there is no data stored in the plottable</p>
1563</dd></dl>
1564
1565<dl class="classmethod">
1566<dt id="sas.plottools.plottables.Plottable.labels">
1567<em class="property">classmethod </em><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.labels"><span class="viewcode-link">[source]</span></a></dt>
1568<dd><p>Construct a set of unique labels for a collection of plottables of
1569the same type.</p>
1570<p>Returns a map from plottable to name.</p>
1571</dd></dl>
1572
1573<dl class="attribute">
1574<dt id="sas.plottools.plottables.Plottable.markersize">
1575<tt class="descname">markersize</tt><em class="property"> = 5</em></dt>
1576<dd></dd></dl>
1577
1578<dl class="attribute">
1579<dt id="sas.plottools.plottables.Plottable.name">
1580<tt class="descname">name</tt><em class="property"> = None</em></dt>
1581<dd></dd></dl>
1582
1583<dl class="method">
1584<dt id="sas.plottools.plottables.Plottable.onFitRange">
1585<tt class="descname">onFitRange</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.onFitRange"><span class="viewcode-link">[source]</span></a></dt>
1586<dd><p>It limits View data range to plot from min to max</p>
1587<table class="docutils field-list" frame="void" rules="none">
1588<col class="field-name" />
1589<col class="field-body" />
1590<tbody valign="top">
1591<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1592<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
1593<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
1594</ul>
1595</td>
1596</tr>
1597</tbody>
1598</table>
1599</dd></dl>
1600
1601<dl class="method">
1602<dt id="sas.plottools.plottables.Plottable.onReset">
1603<tt class="descname">onReset</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.onReset"><span class="viewcode-link">[source]</span></a></dt>
1604<dd><p>Reset x, y, dx, dy view with its parameters</p>
1605</dd></dl>
1606
1607<dl class="method">
1608<dt id="sas.plottools.plottables.Plottable.render">
1609<tt class="descname">render</tt><big>(</big><em>plot</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.render"><span class="viewcode-link">[source]</span></a></dt>
1610<dd><p>The base class makes sure the correct units are being used for
1611subsequent plottable.</p>
1612<p>For now it is assumed that the graphs are commensurate, and if you
1613put a Qx object on a Temperature graph then you had better hope
1614that it makes sense.</p>
1615</dd></dl>
1616
1617<dl class="method">
1618<dt id="sas.plottools.plottables.Plottable.reset_view">
1619<tt class="descname">reset_view</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.reset_view"><span class="viewcode-link">[source]</span></a></dt>
1620<dd><p>Reload view with new value to plot</p>
1621</dd></dl>
1622
1623<dl class="method">
1624<dt id="sas.plottools.plottables.Plottable.returnValuesOfView">
1625<tt class="descname">returnValuesOfView</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.returnValuesOfView"><span class="viewcode-link">[source]</span></a></dt>
1626<dd><p>Return View parameters and it is used by Fit Dialog</p>
1627</dd></dl>
1628
1629<dl class="method">
1630<dt id="sas.plottools.plottables.Plottable.setLabel">
1631<tt class="descname">setLabel</tt><big>(</big><em>labelx</em>, <em>labely</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.setLabel"><span class="viewcode-link">[source]</span></a></dt>
1632<dd><p>It takes a label of the x and y transformation and set View parameters</p>
1633<table class="docutils field-list" frame="void" rules="none">
1634<col class="field-name" />
1635<col class="field-body" />
1636<tbody valign="top">
1637<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1638<li><strong>transx</strong> &#8211; The label of x transformation is sent by Properties Dialog</li>
1639<li><strong>transy</strong> &#8211; The label of y transformation is sent Properties Dialog</li>
1640</ul>
1641</td>
1642</tr>
1643</tbody>
1644</table>
1645</dd></dl>
1646
1647<dl class="method">
1648<dt id="sas.plottools.plottables.Plottable.set_View">
1649<tt class="descname">set_View</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.set_View"><span class="viewcode-link">[source]</span></a></dt>
1650<dd><p>Load View</p>
1651</dd></dl>
1652
1653<dl class="method">
1654<dt id="sas.plottools.plottables.Plottable.set_data">
1655<tt class="descname">set_data</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.set_data"><span class="viewcode-link">[source]</span></a></dt>
1656<dd></dd></dl>
1657
1658<dl class="attribute">
1659<dt id="sas.plottools.plottables.Plottable.short_name">
1660<tt class="descname">short_name</tt><em class="property"> = None</em></dt>
1661<dd></dd></dl>
1662
1663<dl class="method">
1664<dt id="sas.plottools.plottables.Plottable.transformView">
1665<tt class="descname">transformView</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.transformView"><span class="viewcode-link">[source]</span></a></dt>
1666<dd><p>It transforms x, y before displaying</p>
1667</dd></dl>
1668
1669<dl class="method">
1670<dt id="sas.plottools.plottables.Plottable.transformX">
1671<tt class="descname">transformX</tt><big>(</big><em>transx</em>, <em>transdx</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.transformX"><span class="viewcode-link">[source]</span></a></dt>
1672<dd><p>Receive pointers to function that transform x and dx
1673and set corresponding View pointers</p>
1674<table class="docutils field-list" frame="void" rules="none">
1675<col class="field-name" />
1676<col class="field-body" />
1677<tbody valign="top">
1678<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1679<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
1680<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
1681</ul>
1682</td>
1683</tr>
1684</tbody>
1685</table>
1686</dd></dl>
1687
1688<dl class="method">
1689<dt id="sas.plottools.plottables.Plottable.transformY">
1690<tt class="descname">transformY</tt><big>(</big><em>transy</em>, <em>transdy</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.transformY"><span class="viewcode-link">[source]</span></a></dt>
1691<dd><p>Receive pointers to function that transform y and dy
1692and set corresponding View pointers</p>
1693<table class="docutils field-list" frame="void" rules="none">
1694<col class="field-name" />
1695<col class="field-body" />
1696<tbody valign="top">
1697<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1698<li><strong>transy</strong> &#8211; pointer to function that transforms y</li>
1699<li><strong>transdy</strong> &#8211; pointer to function that transforms dy</li>
1700</ul>
1701</td>
1702</tr>
1703</tbody>
1704</table>
1705</dd></dl>
1706
1707<dl class="attribute">
1708<dt id="sas.plottools.plottables.Plottable.x">
1709<tt class="descname">x</tt><em class="property"> = None</em></dt>
1710<dd></dd></dl>
1711
1712<dl class="method">
1713<dt id="sas.plottools.plottables.Plottable.xaxis">
1714<tt class="descname">xaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.xaxis"><span class="viewcode-link">[source]</span></a></dt>
1715<dd><p>Set the name and unit of x_axis</p>
1716<table class="docutils field-list" frame="void" rules="none">
1717<col class="field-name" />
1718<col class="field-body" />
1719<tbody valign="top">
1720<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1721<li><strong>name</strong> &#8211; the name of x-axis</li>
1722<li><strong>units</strong> &#8211; the units of x_axis</li>
1723</ul>
1724</td>
1725</tr>
1726</tbody>
1727</table>
1728</dd></dl>
1729
1730<dl class="attribute">
1731<dt id="sas.plottools.plottables.Plottable.y">
1732<tt class="descname">y</tt><em class="property"> = None</em></dt>
1733<dd></dd></dl>
1734
1735<dl class="method">
1736<dt id="sas.plottools.plottables.Plottable.yaxis">
1737<tt class="descname">yaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Plottable.yaxis"><span class="viewcode-link">[source]</span></a></dt>
1738<dd><p>Set the name and unit of y_axis</p>
1739<table class="docutils field-list" frame="void" rules="none">
1740<col class="field-name" />
1741<col class="field-body" />
1742<tbody valign="top">
1743<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1744<li><strong>name</strong> &#8211; the name of y-axis</li>
1745<li><strong>units</strong> &#8211; the units of y_axis</li>
1746</ul>
1747</td>
1748</tr>
1749</tbody>
1750</table>
1751</dd></dl>
1752
1753</dd></dl>
1754
1755<dl class="class">
1756<dt id="sas.plottools.plottables.Text">
1757<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Text</tt><big>(</big><em>text=None</em>, <em>xpos=0.5</em>, <em>ypos=0.9</em>, <em>name='text'</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Text"><span class="viewcode-link">[source]</span></a></dt>
1758<dd><p>Bases: <a class="reference internal" href="#sas.plottools.plottables.Plottable" title="sas.plottools.plottables.Plottable"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Plottable</span></tt></a></p>
1759<dl class="method">
1760<dt id="sas.plottools.plottables.Text.getText">
1761<tt class="descname">getText</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Text.getText"><span class="viewcode-link">[source]</span></a></dt>
1762<dd><p>Get the text string.</p>
1763</dd></dl>
1764
1765<dl class="method">
1766<dt id="sas.plottools.plottables.Text.render">
1767<tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Text.render"><span class="viewcode-link">[source]</span></a></dt>
1768<dd></dd></dl>
1769
1770<dl class="method">
1771<dt id="sas.plottools.plottables.Text.setText">
1772<tt class="descname">setText</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Text.setText"><span class="viewcode-link">[source]</span></a></dt>
1773<dd><p>Set the text string.</p>
1774</dd></dl>
1775
1776<dl class="method">
1777<dt id="sas.plottools.plottables.Text.set_x">
1778<tt class="descname">set_x</tt><big>(</big><em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Text.set_x"><span class="viewcode-link">[source]</span></a></dt>
1779<dd><p>Set the x position of the text
1780ACCEPTS: float</p>
1781</dd></dl>
1782
1783<dl class="method">
1784<dt id="sas.plottools.plottables.Text.set_y">
1785<tt class="descname">set_y</tt><big>(</big><em>y</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Text.set_y"><span class="viewcode-link">[source]</span></a></dt>
1786<dd><p>Set the y position of the text
1787ACCEPTS: float</p>
1788</dd></dl>
1789
1790</dd></dl>
1791
1792<dl class="class">
1793<dt id="sas.plottools.plottables.Theory1D">
1794<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Theory1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Theory1D"><span class="viewcode-link">[source]</span></a></dt>
1795<dd><p>Bases: <a class="reference internal" href="#sas.plottools.plottables.Plottable" title="sas.plottools.plottables.Plottable"><tt class="xref py py-class docutils literal"><span class="pre">sas.plottools.plottables.Plottable</span></tt></a></p>
1796<p>Theory plottable: line plot of x,y with confidence interval y.</p>
1797<dl class="method">
1798<dt id="sas.plottools.plottables.Theory1D.changed">
1799<tt class="descname">changed</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Theory1D.changed"><span class="viewcode-link">[source]</span></a></dt>
1800<dd></dd></dl>
1801
1802<dl class="classmethod">
1803<dt id="sas.plottools.plottables.Theory1D.labels">
1804<em class="property">classmethod </em><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Theory1D.labels"><span class="viewcode-link">[source]</span></a></dt>
1805<dd><p>Build a label mostly unique within a collection</p>
1806</dd></dl>
1807
1808<dl class="method">
1809<dt id="sas.plottools.plottables.Theory1D.render">
1810<tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Theory1D.render"><span class="viewcode-link">[source]</span></a></dt>
1811<dd></dd></dl>
1812
1813</dd></dl>
1814
1815<dl class="class">
1816<dt id="sas.plottools.plottables.Transform">
1817<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">Transform</tt><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#Transform"><span class="viewcode-link">[source]</span></a></dt>
1818<dd><p>Define a transform plugin to the plottable architecture.</p>
1819<p>Transforms operate on axes.  The plottable defines the
1820set of transforms available for it, and the axes on which
1821they operate.  These transforms can operate on the x axis
1822only, the y axis only or on the x and y axes together.</p>
1823<p>This infrastructure is not able to support transformations
1824such as log and polar plots as these require full control
1825over the drawing of axes and grids.</p>
1826<p>A transform has a number of attributes.</p>
1827<dl class="docutils">
1828<dt>name</dt>
1829<dd>user visible name for the transform.  This will
1830appear in the context menu for the axis and the transform
1831menu for the graph.</dd>
1832<dt>type</dt>
1833<dd>operational axis.  This determines whether the
1834transform should appear on x,y or z axis context
1835menus, or if it should appear in the context menu for
1836the graph.</dd>
1837<dt>inventory</dt>
1838<dd>(not implemented)
1839a dictionary of user settable parameter names and
1840their associated types.  These should appear as keyword
1841arguments to the transform call.  For example, Fresnel
1842reflectivity requires the substrate density:
1843<tt class="docutils literal"><span class="pre">{</span> <span class="pre">'rho':</span> <span class="pre">type.Value(10e-6/units.angstrom**2)</span> <span class="pre">}</span></tt>       
1844Supply reasonable defaults in the callback so that
1845limited plotting clients work even though they cannot
1846set the inventory.</dd>
1847</dl>
1848</dd></dl>
1849
1850<dl class="class">
1851<dt id="sas.plottools.plottables.View">
1852<em class="property">class </em><tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">View</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View"><span class="viewcode-link">[source]</span></a></dt>
1853<dd><p>Representation of the data that might include a transformation</p>
1854<dl class="method">
1855<dt id="sas.plottools.plottables.View.check_data_logX">
1856<tt class="descname">check_data_logX</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.check_data_logX"><span class="viewcode-link">[source]</span></a></dt>
1857<dd><p>Remove negative value in x vector to avoid plotting negative
1858value of Log10</p>
1859</dd></dl>
1860
1861<dl class="method">
1862<dt id="sas.plottools.plottables.View.check_data_logY">
1863<tt class="descname">check_data_logY</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.check_data_logY"><span class="viewcode-link">[source]</span></a></dt>
1864<dd><p>Remove negative value in y vector
1865to avoid plotting negative value of Log10</p>
1866</dd></dl>
1867
1868<dl class="attribute">
1869<dt id="sas.plottools.plottables.View.dx">
1870<tt class="descname">dx</tt><em class="property"> = None</em></dt>
1871<dd></dd></dl>
1872
1873<dl class="attribute">
1874<dt id="sas.plottools.plottables.View.dy">
1875<tt class="descname">dy</tt><em class="property"> = None</em></dt>
1876<dd></dd></dl>
1877
1878<dl class="method">
1879<dt id="sas.plottools.plottables.View.onFitRangeView">
1880<tt class="descname">onFitRangeView</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.onFitRangeView"><span class="viewcode-link">[source]</span></a></dt>
1881<dd><p>It limits View data range to plot from min to max</p>
1882<table class="docutils field-list" frame="void" rules="none">
1883<col class="field-name" />
1884<col class="field-body" />
1885<tbody valign="top">
1886<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1887<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
1888<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
1889</ul>
1890</td>
1891</tr>
1892</tbody>
1893</table>
1894</dd></dl>
1895
1896<dl class="method">
1897<dt id="sas.plottools.plottables.View.onResetView">
1898<tt class="descname">onResetView</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.onResetView"><span class="viewcode-link">[source]</span></a></dt>
1899<dd><p>Reset x,y,dx and y in their full range  and in the initial scale
1900in case their previous range has changed</p>
1901</dd></dl>
1902
1903<dl class="method">
1904<dt id="sas.plottools.plottables.View.returnXview">
1905<tt class="descname">returnXview</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.returnXview"><span class="viewcode-link">[source]</span></a></dt>
1906<dd><p>Return View  x,y,dx,dy</p>
1907</dd></dl>
1908
1909<dl class="method">
1910<dt id="sas.plottools.plottables.View.setTransformX">
1911<tt class="descname">setTransformX</tt><big>(</big><em>funcx</em>, <em>funcdx</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.setTransformX"><span class="viewcode-link">[source]</span></a></dt>
1912<dd><p>Receive pointers to function that transform x and dx
1913and set corresponding View pointers</p>
1914<table class="docutils field-list" frame="void" rules="none">
1915<col class="field-name" />
1916<col class="field-body" />
1917<tbody valign="top">
1918<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1919<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
1920<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
1921</ul>
1922</td>
1923</tr>
1924</tbody>
1925</table>
1926</dd></dl>
1927
1928<dl class="method">
1929<dt id="sas.plottools.plottables.View.setTransformY">
1930<tt class="descname">setTransformY</tt><big>(</big><em>funcy</em>, <em>funcdy</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.setTransformY"><span class="viewcode-link">[source]</span></a></dt>
1931<dd><p>Receive pointers to function that transform y and dy
1932and set corresponding View pointers</p>
1933<table class="docutils field-list" frame="void" rules="none">
1934<col class="field-name" />
1935<col class="field-body" />
1936<tbody valign="top">
1937<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1938<li><strong>transx</strong> &#8211; pointer to function that transforms y</li>
1939<li><strong>transdx</strong> &#8211; pointer to function that transforms dy</li>
1940</ul>
1941</td>
1942</tr>
1943</tbody>
1944</table>
1945</dd></dl>
1946
1947<dl class="method">
1948<dt id="sas.plottools.plottables.View.transform">
1949<tt class="descname">transform</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#View.transform"><span class="viewcode-link">[source]</span></a></dt>
1950<dd><dl class="docutils">
1951<dt>Transforms the x,y,dx and dy vectors and stores</dt>
1952<dd>the output in View parameters</dd>
1953</dl>
1954<table class="docutils field-list" frame="void" rules="none">
1955<col class="field-name" />
1956<col class="field-body" />
1957<tbody valign="top">
1958<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1959<li><strong>x</strong> &#8211; array of x values</li>
1960<li><strong>y</strong> &#8211; array of y values</li>
1961<li><strong>dx</strong> &#8211; array of  errors values on x</li>
1962<li><strong>dy</strong> &#8211; array of error values on y</li>
1963</ul>
1964</td>
1965</tr>
1966</tbody>
1967</table>
1968</dd></dl>
1969
1970<dl class="attribute">
1971<dt id="sas.plottools.plottables.View.x">
1972<tt class="descname">x</tt><em class="property"> = None</em></dt>
1973<dd></dd></dl>
1974
1975<dl class="attribute">
1976<dt id="sas.plottools.plottables.View.y">
1977<tt class="descname">y</tt><em class="property"> = None</em></dt>
1978<dd></dd></dl>
1979
1980</dd></dl>
1981
1982<dl class="function">
1983<dt id="sas.plottools.plottables.all">
1984<tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">all</tt><big>(</big><em>L</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#all"><span class="viewcode-link">[source]</span></a></dt>
1985<dd></dd></dl>
1986
1987<dl class="function">
1988<dt id="sas.plottools.plottables.any">
1989<tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">any</tt><big>(</big><em>L</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#any"><span class="viewcode-link">[source]</span></a></dt>
1990<dd></dd></dl>
1991
1992<dl class="function">
1993<dt id="sas.plottools.plottables.demo_plotter">
1994<tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">demo_plotter</tt><big>(</big><em>graph</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#demo_plotter"><span class="viewcode-link">[source]</span></a></dt>
1995<dd></dd></dl>
1996
1997<dl class="function">
1998<dt id="sas.plottools.plottables.sample_graph">
1999<tt class="descclassname">sas.plottools.plottables.</tt><tt class="descname">sample_graph</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/plottables.html#sample_graph"><span class="viewcode-link">[source]</span></a></dt>
2000<dd></dd></dl>
2001
2002</div>
2003<div class="section" id="module-sas.plottools.toolbar">
2004<span id="sas-plottools-toolbar-module"></span><h2>sas.plottools.toolbar module</h2>
2005<p>This module overwrites matplotlib toolbar</p>
2006<dl class="class">
2007<dt id="sas.plottools.toolbar.NavigationToolBar">
2008<em class="property">class </em><tt class="descclassname">sas.plottools.toolbar.</tt><tt class="descname">NavigationToolBar</tt><big>(</big><em>canvas</em>, <em>parent=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/toolbar.html#NavigationToolBar"><span class="viewcode-link">[source]</span></a></dt>
2009<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">matplotlib.backends.backend_wxagg.NavigationToolbar2WxAgg</span></tt></p>
2010<p>Overwrite matplotlib toolbar</p>
2011<dl class="method">
2012<dt id="sas.plottools.toolbar.NavigationToolBar.on_menu">
2013<tt class="descname">on_menu</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/toolbar.html#NavigationToolBar.on_menu"><span class="viewcode-link">[source]</span></a></dt>
2014<dd><p>Plot menu</p>
2015</dd></dl>
2016
2017<dl class="method">
2018<dt id="sas.plottools.toolbar.NavigationToolBar.on_print">
2019<tt class="descname">on_print</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/toolbar.html#NavigationToolBar.on_print"><span class="viewcode-link">[source]</span></a></dt>
2020<dd><p>Print</p>
2021</dd></dl>
2022
2023<dl class="method">
2024<dt id="sas.plottools.toolbar.NavigationToolBar.on_reset">
2025<tt class="descname">on_reset</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/toolbar.html#NavigationToolBar.on_reset"><span class="viewcode-link">[source]</span></a></dt>
2026<dd><p>Reset plot</p>
2027</dd></dl>
2028
2029</dd></dl>
2030
2031<dl class="function">
2032<dt id="sas.plottools.toolbar.bind">
2033<tt class="descclassname">sas.plottools.toolbar.</tt><tt class="descname">bind</tt><big>(</big><em>actor</em>, <em>event</em>, <em>action</em>, <em>**kw</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/toolbar.html#bind"><span class="viewcode-link">[source]</span></a></dt>
2034<dd></dd></dl>
2035
2036</div>
2037<div class="section" id="module-sas.plottools.transform">
2038<span id="sas-plottools-transform-module"></span><h2>sas.plottools.transform module</h2>
2039<dl class="function">
2040<dt id="sas.plottools.transform.errFromX2">
2041<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errFromX2</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errFromX2"><span class="viewcode-link">[source]</span></a></dt>
2042<dd><p>calculate error of sqrt(x)</p>
2043<table class="docutils field-list" frame="void" rules="none">
2044<col class="field-name" />
2045<col class="field-body" />
2046<tbody valign="top">
2047<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2048<li><strong>x</strong> &#8211; float value</li>
2049<li><strong>dx</strong> &#8211; float value</li>
2050</ul>
2051</td>
2052</tr>
2053</tbody>
2054</table>
2055</dd></dl>
2056
2057<dl class="function">
2058<dt id="sas.plottools.transform.errFromX4">
2059<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errFromX4</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errFromX4"><span class="viewcode-link">[source]</span></a></dt>
2060<dd><p>calculate error of x^1/4</p>
2061<table class="docutils field-list" frame="void" rules="none">
2062<col class="field-name" />
2063<col class="field-body" />
2064<tbody valign="top">
2065<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2066<li><strong>x</strong> &#8211; float value</li>
2067<li><strong>dx</strong> &#8211; float value</li>
2068</ul>
2069</td>
2070</tr>
2071</tbody>
2072</table>
2073</dd></dl>
2074
2075<dl class="function">
2076<dt id="sas.plottools.transform.errOneOverSqrtX">
2077<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errOneOverSqrtX</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errOneOverSqrtX"><span class="viewcode-link">[source]</span></a></dt>
2078<dd><p>Calculate error on 1/sqrt(x)</p>
2079</dd></dl>
2080
2081<dl class="function">
2082<dt id="sas.plottools.transform.errOneOverX">
2083<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errOneOverX</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errOneOverX"><span class="viewcode-link">[source]</span></a></dt>
2084<dd><p>calculate error on 1/x</p>
2085</dd></dl>
2086
2087<dl class="function">
2088<dt id="sas.plottools.transform.errToLog10X">
2089<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToLog10X</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToLog10X"><span class="viewcode-link">[source]</span></a></dt>
2090<dd><p>calculate error of Log(x)</p>
2091<table class="docutils field-list" frame="void" rules="none">
2092<col class="field-name" />
2093<col class="field-body" />
2094<tbody valign="top">
2095<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2096<li><strong>x</strong> &#8211; float value</li>
2097<li><strong>dx</strong> &#8211; float value</li>
2098</ul>
2099</td>
2100</tr>
2101</tbody>
2102</table>
2103</dd></dl>
2104
2105<dl class="function">
2106<dt id="sas.plottools.transform.errToLogX">
2107<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToLogX</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToLogX"><span class="viewcode-link">[source]</span></a></dt>
2108<dd><p>calculate error of Log(x)</p>
2109<table class="docutils field-list" frame="void" rules="none">
2110<col class="field-name" />
2111<col class="field-body" />
2112<tbody valign="top">
2113<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2114<li><strong>x</strong> &#8211; float value</li>
2115<li><strong>dx</strong> &#8211; float value</li>
2116</ul>
2117</td>
2118</tr>
2119</tbody>
2120</table>
2121</dd></dl>
2122
2123<dl class="function">
2124<dt id="sas.plottools.transform.errToLogXY">
2125<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToLogXY</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToLogXY"><span class="viewcode-link">[source]</span></a></dt>
2126<dd><p>calculate error of Log(xy)</p>
2127</dd></dl>
2128
2129<dl class="function">
2130<dt id="sas.plottools.transform.errToLogYX2">
2131<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToLogYX2</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToLogYX2"><span class="viewcode-link">[source]</span></a></dt>
2132<dd><p>calculate error of Log(yx**2)</p>
2133</dd></dl>
2134
2135<dl class="function">
2136<dt id="sas.plottools.transform.errToLogYX4">
2137<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToLogYX4</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToLogYX4"><span class="viewcode-link">[source]</span></a></dt>
2138<dd><p>error for ln(y*x^(4))</p>
2139<table class="docutils field-list" frame="void" rules="none">
2140<col class="field-name" />
2141<col class="field-body" />
2142<tbody valign="top">
2143<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2144</tr>
2145</tbody>
2146</table>
2147</dd></dl>
2148
2149<dl class="function">
2150<dt id="sas.plottools.transform.errToX">
2151<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToX</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToX"><span class="viewcode-link">[source]</span></a></dt>
2152<dd><p>calculate error of x**2</p>
2153<table class="docutils field-list" frame="void" rules="none">
2154<col class="field-name" />
2155<col class="field-body" />
2156<tbody valign="top">
2157<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2158<li><strong>x</strong> &#8211; float value</li>
2159<li><strong>dx</strong> &#8211; float value</li>
2160</ul>
2161</td>
2162</tr>
2163</tbody>
2164</table>
2165</dd></dl>
2166
2167<dl class="function">
2168<dt id="sas.plottools.transform.errToX2">
2169<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToX2</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToX2"><span class="viewcode-link">[source]</span></a></dt>
2170<dd><p>calculate error of x**2</p>
2171<table class="docutils field-list" frame="void" rules="none">
2172<col class="field-name" />
2173<col class="field-body" />
2174<tbody valign="top">
2175<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2176<li><strong>x</strong> &#8211; float value</li>
2177<li><strong>dx</strong> &#8211; float value</li>
2178</ul>
2179</td>
2180</tr>
2181</tbody>
2182</table>
2183</dd></dl>
2184
2185<dl class="function">
2186<dt id="sas.plottools.transform.errToX4">
2187<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToX4</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToX4"><span class="viewcode-link">[source]</span></a></dt>
2188<dd><p>calculate error of x**4</p>
2189<table class="docutils field-list" frame="void" rules="none">
2190<col class="field-name" />
2191<col class="field-body" />
2192<tbody valign="top">
2193<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2194<li><strong>x</strong> &#8211; float value</li>
2195<li><strong>dx</strong> &#8211; float value</li>
2196</ul>
2197</td>
2198</tr>
2199</tbody>
2200</table>
2201</dd></dl>
2202
2203<dl class="function">
2204<dt id="sas.plottools.transform.errToX_pos">
2205<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToX_pos</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToX_pos"><span class="viewcode-link">[source]</span></a></dt>
2206<dd><p>calculate error of x**2</p>
2207<table class="docutils field-list" frame="void" rules="none">
2208<col class="field-name" />
2209<col class="field-body" />
2210<tbody valign="top">
2211<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2212<li><strong>x</strong> &#8211; float value</li>
2213<li><strong>dx</strong> &#8211; float value</li>
2214</ul>
2215</td>
2216</tr>
2217</tbody>
2218</table>
2219</dd></dl>
2220
2221<dl class="function">
2222<dt id="sas.plottools.transform.errToYX2">
2223<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToYX2</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToYX2"><span class="viewcode-link">[source]</span></a></dt>
2224<dd></dd></dl>
2225
2226<dl class="function">
2227<dt id="sas.plottools.transform.errToYX4">
2228<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">errToYX4</tt><big>(</big><em>x</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#errToYX4"><span class="viewcode-link">[source]</span></a></dt>
2229<dd><p>error for (y*x^(4))</p>
2230<table class="docutils field-list" frame="void" rules="none">
2231<col class="field-name" />
2232<col class="field-body" />
2233<tbody valign="top">
2234<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2235</tr>
2236</tbody>
2237</table>
2238</dd></dl>
2239
2240<dl class="function">
2241<dt id="sas.plottools.transform.fromX2">
2242<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">fromX2</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#fromX2"><span class="viewcode-link">[source]</span></a></dt>
2243<dd><p>This function is used to load value on Plottable.View
2244Calculate square root of x</p>
2245<table class="docutils field-list" frame="void" rules="none">
2246<col class="field-name" />
2247<col class="field-body" />
2248<tbody valign="top">
2249<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2250</tr>
2251</tbody>
2252</table>
2253</dd></dl>
2254
2255<dl class="function">
2256<dt id="sas.plottools.transform.fromX4">
2257<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">fromX4</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#fromX4"><span class="viewcode-link">[source]</span></a></dt>
2258<dd><p>This function is used to load value on Plottable.View
2259Calculate square root of x</p>
2260<table class="docutils field-list" frame="void" rules="none">
2261<col class="field-name" />
2262<col class="field-body" />
2263<tbody valign="top">
2264<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2265</tr>
2266</tbody>
2267</table>
2268</dd></dl>
2269
2270<dl class="function">
2271<dt id="sas.plottools.transform.toLogX">
2272<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toLogX</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toLogX"><span class="viewcode-link">[source]</span></a></dt>
2273<dd><p>This function is used to load value on Plottable.View
2274calculate log x</p>
2275<table class="docutils field-list" frame="void" rules="none">
2276<col class="field-name" />
2277<col class="field-body" />
2278<tbody valign="top">
2279<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2280</tr>
2281</tbody>
2282</table>
2283</dd></dl>
2284
2285<dl class="function">
2286<dt id="sas.plottools.transform.toLogXY">
2287<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toLogXY</tt><big>(</big><em>y</em>, <em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toLogXY"><span class="viewcode-link">[source]</span></a></dt>
2288<dd><p>This function is used to load value on Plottable.View
2289calculate log x</p>
2290<table class="docutils field-list" frame="void" rules="none">
2291<col class="field-name" />
2292<col class="field-body" />
2293<tbody valign="top">
2294<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2295</tr>
2296</tbody>
2297</table>
2298</dd></dl>
2299
2300<dl class="function">
2301<dt id="sas.plottools.transform.toLogYX2">
2302<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toLogYX2</tt><big>(</big><em>y</em>, <em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toLogYX2"><span class="viewcode-link">[source]</span></a></dt>
2303<dd></dd></dl>
2304
2305<dl class="function">
2306<dt id="sas.plottools.transform.toLogYX4">
2307<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toLogYX4</tt><big>(</big><em>y</em>, <em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toLogYX4"><span class="viewcode-link">[source]</span></a></dt>
2308<dd></dd></dl>
2309
2310<dl class="function">
2311<dt id="sas.plottools.transform.toOneOverSqrtX">
2312<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toOneOverSqrtX</tt><big>(</big><em>y</em>, <em>x=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toOneOverSqrtX"><span class="viewcode-link">[source]</span></a></dt>
2313<dd></dd></dl>
2314
2315<dl class="function">
2316<dt id="sas.plottools.transform.toOneOverX">
2317<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toOneOverX</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toOneOverX"><span class="viewcode-link">[source]</span></a></dt>
2318<dd></dd></dl>
2319
2320<dl class="function">
2321<dt id="sas.plottools.transform.toX">
2322<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toX</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toX"><span class="viewcode-link">[source]</span></a></dt>
2323<dd><p>This function is used to load value on Plottable.View</p>
2324<table class="docutils field-list" frame="void" rules="none">
2325<col class="field-name" />
2326<col class="field-body" />
2327<tbody valign="top">
2328<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; Float value</td>
2329</tr>
2330<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">x</td>
2331</tr>
2332</tbody>
2333</table>
2334</dd></dl>
2335
2336<dl class="function">
2337<dt id="sas.plottools.transform.toX2">
2338<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toX2</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toX2"><span class="viewcode-link">[source]</span></a></dt>
2339<dd><p>This function is used to load value on Plottable.View</p>
2340<p>Calculate x^(2)</p>
2341<table class="docutils field-list" frame="void" rules="none">
2342<col class="field-name" />
2343<col class="field-body" />
2344<tbody valign="top">
2345<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2346</tr>
2347</tbody>
2348</table>
2349</dd></dl>
2350
2351<dl class="function">
2352<dt id="sas.plottools.transform.toX4">
2353<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toX4</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toX4"><span class="viewcode-link">[source]</span></a></dt>
2354<dd><p>This function is used to load value on Plottable.View</p>
2355<p>Calculate x^(4)</p>
2356<table class="docutils field-list" frame="void" rules="none">
2357<col class="field-name" />
2358<col class="field-body" />
2359<tbody valign="top">
2360<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; float value</td>
2361</tr>
2362</tbody>
2363</table>
2364</dd></dl>
2365
2366<dl class="function">
2367<dt id="sas.plottools.transform.toX_pos">
2368<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toX_pos</tt><big>(</big><em>x</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toX_pos"><span class="viewcode-link">[source]</span></a></dt>
2369<dd><p>This function is used to load value on Plottable.View</p>
2370<table class="docutils field-list" frame="void" rules="none">
2371<col class="field-name" />
2372<col class="field-body" />
2373<tbody valign="top">
2374<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; Float value</td>
2375</tr>
2376<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">x</td>
2377</tr>
2378</tbody>
2379</table>
2380</dd></dl>
2381
2382<dl class="function">
2383<dt id="sas.plottools.transform.toYX2">
2384<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toYX2</tt><big>(</big><em>y</em>, <em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toYX2"><span class="viewcode-link">[source]</span></a></dt>
2385<dd></dd></dl>
2386
2387<dl class="function">
2388<dt id="sas.plottools.transform.toYX4">
2389<tt class="descclassname">sas.plottools.transform.</tt><tt class="descname">toYX4</tt><big>(</big><em>y</em>, <em>x</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/transform.html#toYX4"><span class="viewcode-link">[source]</span></a></dt>
2390<dd></dd></dl>
2391
2392</div>
2393<div class="section" id="module-sas.plottools.unitConverter">
2394<span id="sas-plottools-unitconverter-module"></span><h2>sas.plottools.unitConverter module</h2>
2395<dl class="function">
2396<dt id="sas.plottools.unitConverter.UnitConvertion">
2397<tt class="descclassname">sas.plottools.unitConverter.</tt><tt class="descname">UnitConvertion</tt><big>(</big><em>pow</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/plottools/unitConverter.html#UnitConvertion"><span class="viewcode-link">[source]</span></a></dt>
2398<dd></dd></dl>
2399
2400</div>
2401<div class="section" id="module-sas.plottools">
2402<span id="module-contents"></span><h2>Module contents</h2>
2403</div>
2404</div>
2405
2406
2407          </div>
2408        </div>
2409      </div>
2410      <div class="sphinxsidebar">
2411        <div class="sphinxsidebarwrapper">
2412  <h3><a href="../../index.html">Table Of Contents</a></h3>
2413  <ul>
2414<li><a class="reference internal" href="#">sas.plottools package</a><ul>
2415<li><a class="reference internal" href="#submodules">Submodules</a></li>
2416<li><a class="reference internal" href="#module-sas.plottools.BaseInteractor">sas.plottools.BaseInteractor module</a></li>
2417<li><a class="reference internal" href="#module-sas.plottools.LabelDialog">sas.plottools.LabelDialog module</a></li>
2418<li><a class="reference internal" href="#module-sas.plottools.LineModel">sas.plottools.LineModel module</a></li>
2419<li><a class="reference internal" href="#module-sas.plottools.PlotPanel">sas.plottools.PlotPanel module</a></li>
2420<li><a class="reference internal" href="#module-sas.plottools.PropertyDialog">sas.plottools.PropertyDialog module</a></li>
2421<li><a class="reference internal" href="#module-sas.plottools.SimpleFont">sas.plottools.SimpleFont module</a></li>
2422<li><a class="reference internal" href="#module-sas.plottools.SizeDialog">sas.plottools.SizeDialog module</a></li>
2423<li><a class="reference internal" href="#module-sas.plottools.TextDialog">sas.plottools.TextDialog module</a></li>
2424<li><a class="reference internal" href="#module-sas.plottools.arrow3d">sas.plottools.arrow3d module</a></li>
2425<li><a class="reference internal" href="#module-sas.plottools.binder">sas.plottools.binder module</a></li>
2426<li><a class="reference internal" href="#module-sas.plottools.canvas">sas.plottools.canvas module</a></li>
2427<li><a class="reference internal" href="#module-sas.plottools.config">sas.plottools.config module</a></li>
2428<li><a class="reference internal" href="#module-sas.plottools.fitDialog">sas.plottools.fitDialog module</a></li>
2429<li><a class="reference internal" href="#module-sas.plottools.fittings">sas.plottools.fittings module</a></li>
2430<li><a class="reference internal" href="#module-sas.plottools.plottable_interactor">sas.plottools.plottable_interactor module</a></li>
2431<li><a class="reference internal" href="#module-sas.plottools.plottables">sas.plottools.plottables module</a></li>
2432<li><a class="reference internal" href="#module-sas.plottools.toolbar">sas.plottools.toolbar module</a></li>
2433<li><a class="reference internal" href="#module-sas.plottools.transform">sas.plottools.transform module</a></li>
2434<li><a class="reference internal" href="#module-sas.plottools.unitConverter">sas.plottools.unitConverter module</a></li>
2435<li><a class="reference internal" href="#module-sas.plottools">Module contents</a></li>
2436</ul>
2437</li>
2438</ul>
2439
2440  <h4>Previous topic</h4>
2441  <p class="topless"><a href="sas.perspectives.pr.html"
2442                        title="previous chapter">sas.perspectives.pr package</a></p>
2443  <h4>Next topic</h4>
2444  <p class="topless"><a href="sas.pr.html"
2445                        title="next chapter">sas.pr package</a></p>
2446  <h3>This Page</h3>
2447  <ul class="this-page-menu">
2448    <li><a href="../../_sources/dev/api/sas.plottools.txt"
2449           rel="nofollow">Show Source</a></li>
2450  </ul>
2451<div id="searchbox" style="display: none">
2452  <h3>Quick search</h3>
2453    <form class="search" action="../../search.html" method="get">
2454      <input type="text" name="q" />
2455      <input type="submit" value="Go" />
2456      <input type="hidden" name="check_keywords" value="yes" />
2457      <input type="hidden" name="area" value="default" />
2458    </form>
2459    <p class="searchtip" style="font-size: 90%">
2460    Enter search terms or a module, class or function name.
2461    </p>
2462</div>
2463<script type="text/javascript">$('#searchbox').show(0);</script>
2464        </div>
2465      </div>
2466      <div class="clearer"></div>
2467    </div>
2468    <div class="related">
2469      <h3>Navigation</h3>
2470      <ul>
2471        <li class="right" style="margin-right: 10px">
2472          <a href="../../genindex.html" title="General Index"
2473             >index</a></li>
2474        <li class="right" >
2475          <a href="../../py-modindex.html" title="Python Module Index"
2476             >modules</a> |</li>
2477        <li class="right" >
2478          <a href="sas.pr.html" title="sas.pr package"
2479             >next</a> |</li>
2480        <li class="right" >
2481          <a href="sas.perspectives.pr.html" title="sas.perspectives.pr package"
2482             >previous</a> |</li>
2483        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
2484          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
2485          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
2486          <li><a href="sas.html" >sas package</a> &raquo;</li> 
2487      </ul>
2488    </div>
2489    <div class="footer">
2490        &copy; Copyright 2013, The SasView Project.
2491      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
2492    </div>
2493  </body>
2494</html>
Note: See TracBrowser for help on using the repository browser.