source: sasview/plottools/docs/sphinx/html/api/plottables.html @ 3a3dd9c

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 3a3dd9c was 82a54b8, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

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