source: sasview/guiframe/docs/sphinx/_build/html/api/dataFitting.html @ d955bf19

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

working on documentation
  • Property mode set to 100644
File size: 61.1 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>dataFitting &mdash; guiframe v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="guiframe v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="dummyapp" href="dummyapp.html" />
28    <link rel="prev" title="data_loader" href="data_loader.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="dummyapp.html" title="dummyapp"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="data_loader.html" title="data_loader"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="datafitting">
57<h1>dataFitting<a class="headerlink" href="#datafitting" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.dataFitting">
59<span id="sans-guiframe-datafitting"></span><h2><a class="reference internal" href="#module-sans.guiframe.dataFitting"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.dataFitting</span></tt></a><a class="headerlink" href="#module-sans.guiframe.dataFitting" title="Permalink to this headline">¶</a></h2>
60<p>Adapters for fitting module</p>
61<dl class="class">
62<dt id="sans.guiframe.dataFitting.Data1D">
63<em class="property">class </em><tt class="descclassname">sans.guiframe.dataFitting.</tt><tt class="descname">Data1D</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span>, <em>y=</em><span class="optional">[</span><span class="optional">]</span>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D" title="Permalink to this definition">¶</a></dt>
64<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">danse.common.plottools.plottables.Data1D</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.Data1D</span></tt></p>
65<dl class="class">
66<dt id="sans.guiframe.dataFitting.Data1D.View">
67<em class="property">class </em><tt class="descname">View</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View" title="Permalink to this definition">¶</a></dt>
68<dd><p>Representation of the data that might include a transformation</p>
69<dl class="method">
70<dt id="sans.guiframe.dataFitting.Data1D.View.check_data_logX">
71<tt class="descname">check_data_logX</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.check_data_logX" title="Permalink to this definition">¶</a></dt>
72<dd>Remove negative value in x vector to avoid plotting negative
73value of Log10</dd></dl>
74
75<dl class="method">
76<dt id="sans.guiframe.dataFitting.Data1D.View.check_data_logY">
77<tt class="descname">check_data_logY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.check_data_logY" title="Permalink to this definition">¶</a></dt>
78<dd>Remove negative value in y vector
79to avoid plotting negative value of Log10</dd></dl>
80
81<dl class="method">
82<dt id="sans.guiframe.dataFitting.Data1D.View.onFitRangeView">
83<tt class="descname">onFitRangeView</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.onFitRangeView" title="Permalink to this definition">¶</a></dt>
84<dd><p>It limits View data range to plot from min to max</p>
85<table class="docutils field-list" frame="void" rules="none">
86<col class="field-name" />
87<col class="field-body" />
88<tbody valign="top">
89<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
90<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
91<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
92</ul>
93</td>
94</tr>
95</tbody>
96</table>
97</dd></dl>
98
99<dl class="method">
100<dt id="sans.guiframe.dataFitting.Data1D.View.onResetView">
101<tt class="descname">onResetView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.onResetView" title="Permalink to this definition">¶</a></dt>
102<dd>Reset x,y,dx and y in their full range  and in the initial scale
103in case their previous range has changed</dd></dl>
104
105<dl class="method">
106<dt id="sans.guiframe.dataFitting.Data1D.View.returnXview">
107<tt class="descname">returnXview</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.returnXview" title="Permalink to this definition">¶</a></dt>
108<dd>Return View  x,y,dx,dy</dd></dl>
109
110<dl class="method">
111<dt id="sans.guiframe.dataFitting.Data1D.View.setTransformX">
112<tt class="descname">setTransformX</tt><big>(</big><em>funcx</em>, <em>funcdx</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.setTransformX" title="Permalink to this definition">¶</a></dt>
113<dd><p>Receive pointers to function that transform x and dx
114and set corresponding View pointers</p>
115<table class="docutils field-list" frame="void" rules="none">
116<col class="field-name" />
117<col class="field-body" />
118<tbody valign="top">
119<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
120<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
121<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
122</ul>
123</td>
124</tr>
125</tbody>
126</table>
127</dd></dl>
128
129<dl class="method">
130<dt id="sans.guiframe.dataFitting.Data1D.View.setTransformY">
131<tt class="descname">setTransformY</tt><big>(</big><em>funcy</em>, <em>funcdy</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.setTransformY" title="Permalink to this definition">¶</a></dt>
132<dd><p>Receive pointers to function that transform y and dy
133and set corresponding View pointers</p>
134<table class="docutils field-list" frame="void" rules="none">
135<col class="field-name" />
136<col class="field-body" />
137<tbody valign="top">
138<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
139<li><strong>transx</strong> &#8211; pointer to function that transforms y</li>
140<li><strong>transdx</strong> &#8211; pointer to function that transforms dy</li>
141</ul>
142</td>
143</tr>
144</tbody>
145</table>
146</dd></dl>
147
148<dl class="method">
149<dt id="sans.guiframe.dataFitting.Data1D.View.transform">
150<tt class="descname">transform</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.View.transform" title="Permalink to this definition">¶</a></dt>
151<dd><p>Transforms the x,y,dx and dy vectors and stores the output in View parameters</p>
152<table class="docutils field-list" frame="void" rules="none">
153<col class="field-name" />
154<col class="field-body" />
155<tbody valign="top">
156<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
157<li><strong>x</strong> &#8211; array of x values</li>
158<li><strong>y</strong> &#8211; array of y values</li>
159<li><strong>dx</strong> &#8211; array of  errors values on x</li>
160<li><strong>dy</strong> &#8211; array of error values on y</li>
161</ul>
162</td>
163</tr>
164</tbody>
165</table>
166</dd></dl>
167
168</dd></dl>
169
170<dl class="method">
171<dt id="sans.guiframe.dataFitting.Data1D.changed">
172<tt class="descclassname">Data1D.</tt><tt class="descname">changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.changed" title="Permalink to this definition">¶</a></dt>
173<dd></dd></dl>
174
175<dl class="method">
176<dt id="sans.guiframe.dataFitting.Data1D.check_data_PlottableX">
177<tt class="descclassname">Data1D.</tt><tt class="descname">check_data_PlottableX</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.check_data_PlottableX" title="Permalink to this definition">¶</a></dt>
178<dd>Since no transformation is made for log10(x), check that
179no negative values is plot in log scale</dd></dl>
180
181<dl class="method">
182<dt id="sans.guiframe.dataFitting.Data1D.check_data_PlottableY">
183<tt class="descclassname">Data1D.</tt><tt class="descname">check_data_PlottableY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.check_data_PlottableY" title="Permalink to this definition">¶</a></dt>
184<dd>Since no transformation is made for log10(y), check that
185no negative values is plot in log scale</dd></dl>
186
187<dl class="method">
188<dt id="sans.guiframe.dataFitting.Data1D.clone_without_data">
189<tt class="descclassname">Data1D.</tt><tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.clone_without_data" title="Permalink to this definition">¶</a></dt>
190<dd><p>Clone the current object, without copying the data (which
191will be filled out by a subsequent operation).
192The data arrays will be initialized to zero.</p>
193<table class="docutils field-list" frame="void" rules="none">
194<col class="field-name" />
195<col class="field-body" />
196<tbody valign="top">
197<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
198<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
199<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
200</ul>
201</td>
202</tr>
203</tbody>
204</table>
205</dd></dl>
206
207<dl class="method">
208<dt id="sans.guiframe.dataFitting.Data1D.colors">
209<tt class="descclassname">Data1D.</tt><tt class="descname">colors</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.colors" title="Permalink to this definition">¶</a></dt>
210<dd>Return the number of colors need to render the object</dd></dl>
211
212<dl class="method">
213<dt id="sans.guiframe.dataFitting.Data1D.copy_from_datainfo">
214<tt class="descclassname">Data1D.</tt><tt class="descname">copy_from_datainfo</tt><big>(</big><em>data1d</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.copy_from_datainfo" title="Permalink to this definition">¶</a></dt>
215<dd>copy values of Data1D of type DataLaoder.Data_info</dd></dl>
216
217<dl class="method">
218<dt id="sans.guiframe.dataFitting.Data1D.get_xaxis">
219<tt class="descclassname">Data1D.</tt><tt class="descname">get_xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.get_xaxis" title="Permalink to this definition">¶</a></dt>
220<dd>Return the units and name of x-axis</dd></dl>
221
222<dl class="method">
223<dt id="sans.guiframe.dataFitting.Data1D.get_yaxis">
224<tt class="descclassname">Data1D.</tt><tt class="descname">get_yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.get_yaxis" title="Permalink to this definition">¶</a></dt>
225<dd>Return the units and name of y- axis</dd></dl>
226
227<dl class="method">
228<dt id="sans.guiframe.dataFitting.Data1D.is_empty">
229<tt class="descclassname">Data1D.</tt><tt class="descname">is_empty</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.is_empty" title="Permalink to this definition">¶</a></dt>
230<dd>Returns True if there is no data stored in the plottable</dd></dl>
231
232<dl class="method">
233<dt id="sans.guiframe.dataFitting.Data1D.is_slit_smeared">
234<tt class="descclassname">Data1D.</tt><tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt>
235<dd><p>Check whether the data has slit smearing information</p>
236<table class="docutils field-list" frame="void" rules="none">
237<col class="field-name" />
238<col class="field-body" />
239<tbody valign="top">
240<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td>
241</tr>
242</tbody>
243</table>
244</dd></dl>
245
246<dl class="classmethod">
247<dt id="sans.guiframe.dataFitting.Data1D.labels">
248<em class="property">classmethod </em><tt class="descclassname">Data1D.</tt><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.labels" title="Permalink to this definition">¶</a></dt>
249<dd>Build a label mostly unique within a collection</dd></dl>
250
251<dl class="method">
252<dt id="sans.guiframe.dataFitting.Data1D.onFitRange">
253<tt class="descclassname">Data1D.</tt><tt class="descname">onFitRange</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.onFitRange" title="Permalink to this definition">¶</a></dt>
254<dd><p>It limits View data range to plot from min to max</p>
255<table class="docutils field-list" frame="void" rules="none">
256<col class="field-name" />
257<col class="field-body" />
258<tbody valign="top">
259<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
260<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
261<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
262</ul>
263</td>
264</tr>
265</tbody>
266</table>
267</dd></dl>
268
269<dl class="method">
270<dt id="sans.guiframe.dataFitting.Data1D.onReset">
271<tt class="descclassname">Data1D.</tt><tt class="descname">onReset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.onReset" title="Permalink to this definition">¶</a></dt>
272<dd>Reset x, y, dx, dy view with its parameters</dd></dl>
273
274<dl class="method">
275<dt id="sans.guiframe.dataFitting.Data1D.render">
276<tt class="descclassname">Data1D.</tt><tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.render" title="Permalink to this definition">¶</a></dt>
277<dd>Renders the plottable on the graph</dd></dl>
278
279<dl class="method">
280<dt id="sans.guiframe.dataFitting.Data1D.reset_view">
281<tt class="descclassname">Data1D.</tt><tt class="descname">reset_view</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.reset_view" title="Permalink to this definition">¶</a></dt>
282<dd>Reload view with new value to plot</dd></dl>
283
284<dl class="method">
285<dt id="sans.guiframe.dataFitting.Data1D.returnValuesOfView">
286<tt class="descclassname">Data1D.</tt><tt class="descname">returnValuesOfView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.returnValuesOfView" title="Permalink to this definition">¶</a></dt>
287<dd>Return View parameters and it is used by Fit Dialog</dd></dl>
288
289<dl class="method">
290<dt id="sans.guiframe.dataFitting.Data1D.setLabel">
291<tt class="descclassname">Data1D.</tt><tt class="descname">setLabel</tt><big>(</big><em>labelx</em>, <em>labely</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.setLabel" title="Permalink to this definition">¶</a></dt>
292<dd><p>It takes a label of the x and y transformation and set View parameters</p>
293<table class="docutils field-list" frame="void" rules="none">
294<col class="field-name" />
295<col class="field-body" />
296<tbody valign="top">
297<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
298<li><strong>transx</strong> &#8211; The label of x transformation is sent by Properties Dialog</li>
299<li><strong>transy</strong> &#8211; The label of y transformation is sent Properties Dialog</li>
300</ul>
301</td>
302</tr>
303</tbody>
304</table>
305</dd></dl>
306
307<dl class="method">
308<dt id="sans.guiframe.dataFitting.Data1D.set_View">
309<tt class="descclassname">Data1D.</tt><tt class="descname">set_View</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.set_View" title="Permalink to this definition">¶</a></dt>
310<dd>Load View</dd></dl>
311
312<dl class="method">
313<dt id="sans.guiframe.dataFitting.Data1D.set_data">
314<tt class="descclassname">Data1D.</tt><tt class="descname">set_data</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.set_data" title="Permalink to this definition">¶</a></dt>
315<dd></dd></dl>
316
317<dl class="method">
318<dt id="sans.guiframe.dataFitting.Data1D.transformView">
319<tt class="descclassname">Data1D.</tt><tt class="descname">transformView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.transformView" title="Permalink to this definition">¶</a></dt>
320<dd>It transforms x, y before displaying</dd></dl>
321
322<dl class="method">
323<dt id="sans.guiframe.dataFitting.Data1D.transformX">
324<tt class="descclassname">Data1D.</tt><tt class="descname">transformX</tt><big>(</big><em>transx</em>, <em>transdx</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.transformX" title="Permalink to this definition">¶</a></dt>
325<dd><p>Receive pointers to function that transform x and dx
326and set corresponding View pointers</p>
327<table class="docutils field-list" frame="void" rules="none">
328<col class="field-name" />
329<col class="field-body" />
330<tbody valign="top">
331<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
332<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
333<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
334</ul>
335</td>
336</tr>
337</tbody>
338</table>
339</dd></dl>
340
341<dl class="method">
342<dt id="sans.guiframe.dataFitting.Data1D.transformY">
343<tt class="descclassname">Data1D.</tt><tt class="descname">transformY</tt><big>(</big><em>transy</em>, <em>transdy</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.transformY" title="Permalink to this definition">¶</a></dt>
344<dd><p>Receive pointers to function that transform y and dy
345and set corresponding View pointers</p>
346<table class="docutils field-list" frame="void" rules="none">
347<col class="field-name" />
348<col class="field-body" />
349<tbody valign="top">
350<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
351<li><strong>transy</strong> &#8211; pointer to function that transforms y</li>
352<li><strong>transdy</strong> &#8211; pointer to function that transforms dy</li>
353</ul>
354</td>
355</tr>
356</tbody>
357</table>
358</dd></dl>
359
360<dl class="method">
361<dt id="sans.guiframe.dataFitting.Data1D.xaxis">
362<tt class="descclassname">Data1D.</tt><tt class="descname">xaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.xaxis" title="Permalink to this definition">¶</a></dt>
363<dd><p>Set the name and unit of x_axis</p>
364<table class="docutils field-list" frame="void" rules="none">
365<col class="field-name" />
366<col class="field-body" />
367<tbody valign="top">
368<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
369<li><strong>name</strong> &#8211; the name of x-axis</li>
370<li><strong>units</strong> &#8211; the units of x_axis</li>
371</ul>
372</td>
373</tr>
374</tbody>
375</table>
376</dd></dl>
377
378<dl class="method">
379<dt id="sans.guiframe.dataFitting.Data1D.yaxis">
380<tt class="descclassname">Data1D.</tt><tt class="descname">yaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data1D.yaxis" title="Permalink to this definition">¶</a></dt>
381<dd><p>Set the name and unit of y_axis</p>
382<table class="docutils field-list" frame="void" rules="none">
383<col class="field-name" />
384<col class="field-body" />
385<tbody valign="top">
386<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
387<li><strong>name</strong> &#8211; the name of y-axis</li>
388<li><strong>units</strong> &#8211; the units of y_axis</li>
389</ul>
390</td>
391</tr>
392</tbody>
393</table>
394</dd></dl>
395
396</dd></dl>
397
398<dl class="class">
399<dt id="sans.guiframe.dataFitting.Data2D">
400<em class="property">class </em><tt class="descclassname">sans.guiframe.dataFitting.</tt><tt class="descname">Data2D</tt><big>(</big><em>image=None</em>, <em>err_image=None</em>, <em>xmin=None</em>, <em>xmax=None</em>, <em>ymin=None</em>, <em>ymax=None</em>, <em>zmin=None</em>, <em>zmax=None</em>, <em>qx_data=None</em>, <em>qy_data=None</em>, <em>q_data=None</em>, <em>mask=None</em>, <em>dqx_data=None</em>, <em>dqy_data=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D" title="Permalink to this definition">¶</a></dt>
401<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">danse.common.plottools.plottables.Data2D</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.Data2D</span></tt></p>
402<dl class="class">
403<dt id="sans.guiframe.dataFitting.Data2D.View">
404<em class="property">class </em><tt class="descname">View</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View" title="Permalink to this definition">¶</a></dt>
405<dd><p>Representation of the data that might include a transformation</p>
406<dl class="method">
407<dt id="sans.guiframe.dataFitting.Data2D.View.check_data_logX">
408<tt class="descname">check_data_logX</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.check_data_logX" title="Permalink to this definition">¶</a></dt>
409<dd>Remove negative value in x vector to avoid plotting negative
410value of Log10</dd></dl>
411
412<dl class="method">
413<dt id="sans.guiframe.dataFitting.Data2D.View.check_data_logY">
414<tt class="descname">check_data_logY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.check_data_logY" title="Permalink to this definition">¶</a></dt>
415<dd>Remove negative value in y vector
416to avoid plotting negative value of Log10</dd></dl>
417
418<dl class="method">
419<dt id="sans.guiframe.dataFitting.Data2D.View.onFitRangeView">
420<tt class="descname">onFitRangeView</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.onFitRangeView" title="Permalink to this definition">¶</a></dt>
421<dd><p>It limits View data range to plot from min to max</p>
422<table class="docutils field-list" frame="void" rules="none">
423<col class="field-name" />
424<col class="field-body" />
425<tbody valign="top">
426<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
427<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
428<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
429</ul>
430</td>
431</tr>
432</tbody>
433</table>
434</dd></dl>
435
436<dl class="method">
437<dt id="sans.guiframe.dataFitting.Data2D.View.onResetView">
438<tt class="descname">onResetView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.onResetView" title="Permalink to this definition">¶</a></dt>
439<dd>Reset x,y,dx and y in their full range  and in the initial scale
440in case their previous range has changed</dd></dl>
441
442<dl class="method">
443<dt id="sans.guiframe.dataFitting.Data2D.View.returnXview">
444<tt class="descname">returnXview</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.returnXview" title="Permalink to this definition">¶</a></dt>
445<dd>Return View  x,y,dx,dy</dd></dl>
446
447<dl class="method">
448<dt id="sans.guiframe.dataFitting.Data2D.View.setTransformX">
449<tt class="descname">setTransformX</tt><big>(</big><em>funcx</em>, <em>funcdx</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.setTransformX" title="Permalink to this definition">¶</a></dt>
450<dd><p>Receive pointers to function that transform x and dx
451and set corresponding View pointers</p>
452<table class="docutils field-list" frame="void" rules="none">
453<col class="field-name" />
454<col class="field-body" />
455<tbody valign="top">
456<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
457<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
458<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
459</ul>
460</td>
461</tr>
462</tbody>
463</table>
464</dd></dl>
465
466<dl class="method">
467<dt id="sans.guiframe.dataFitting.Data2D.View.setTransformY">
468<tt class="descname">setTransformY</tt><big>(</big><em>funcy</em>, <em>funcdy</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.setTransformY" title="Permalink to this definition">¶</a></dt>
469<dd><p>Receive pointers to function that transform y and dy
470and set corresponding View pointers</p>
471<table class="docutils field-list" frame="void" rules="none">
472<col class="field-name" />
473<col class="field-body" />
474<tbody valign="top">
475<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
476<li><strong>transx</strong> &#8211; pointer to function that transforms y</li>
477<li><strong>transdx</strong> &#8211; pointer to function that transforms dy</li>
478</ul>
479</td>
480</tr>
481</tbody>
482</table>
483</dd></dl>
484
485<dl class="method">
486<dt id="sans.guiframe.dataFitting.Data2D.View.transform">
487<tt class="descname">transform</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.View.transform" title="Permalink to this definition">¶</a></dt>
488<dd><p>Transforms the x,y,dx and dy vectors and stores the output in View parameters</p>
489<table class="docutils field-list" frame="void" rules="none">
490<col class="field-name" />
491<col class="field-body" />
492<tbody valign="top">
493<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
494<li><strong>x</strong> &#8211; array of x values</li>
495<li><strong>y</strong> &#8211; array of y values</li>
496<li><strong>dx</strong> &#8211; array of  errors values on x</li>
497<li><strong>dy</strong> &#8211; array of error values on y</li>
498</ul>
499</td>
500</tr>
501</tbody>
502</table>
503</dd></dl>
504
505</dd></dl>
506
507<dl class="method">
508<dt id="sans.guiframe.dataFitting.Data2D.changed">
509<tt class="descclassname">Data2D.</tt><tt class="descname">changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.changed" title="Permalink to this definition">¶</a></dt>
510<dd></dd></dl>
511
512<dl class="method">
513<dt id="sans.guiframe.dataFitting.Data2D.check_data_PlottableX">
514<tt class="descclassname">Data2D.</tt><tt class="descname">check_data_PlottableX</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.check_data_PlottableX" title="Permalink to this definition">¶</a></dt>
515<dd>Since no transformation is made for log10(x), check that
516no negative values is plot in log scale</dd></dl>
517
518<dl class="method">
519<dt id="sans.guiframe.dataFitting.Data2D.check_data_PlottableY">
520<tt class="descclassname">Data2D.</tt><tt class="descname">check_data_PlottableY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.check_data_PlottableY" title="Permalink to this definition">¶</a></dt>
521<dd>Since no transformation is made for log10(y), check that
522no negative values is plot in log scale</dd></dl>
523
524<dl class="method">
525<dt id="sans.guiframe.dataFitting.Data2D.clone_without_data">
526<tt class="descclassname">Data2D.</tt><tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.clone_without_data" title="Permalink to this definition">¶</a></dt>
527<dd><p>Clone the current object, without copying the data (which
528will be filled out by a subsequent operation).
529The data arrays will be initialized to zero.</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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
535<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
536<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
537</ul>
538</td>
539</tr>
540</tbody>
541</table>
542</dd></dl>
543
544<dl class="method">
545<dt id="sans.guiframe.dataFitting.Data2D.colors">
546<tt class="descclassname">Data2D.</tt><tt class="descname">colors</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.colors" title="Permalink to this definition">¶</a></dt>
547<dd>Return the number of colors need to render the object</dd></dl>
548
549<dl class="method">
550<dt id="sans.guiframe.dataFitting.Data2D.copy_from_datainfo">
551<tt class="descclassname">Data2D.</tt><tt class="descname">copy_from_datainfo</tt><big>(</big><em>data2d</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.copy_from_datainfo" title="Permalink to this definition">¶</a></dt>
552<dd>copy value of Data2D of type DataLoader.data_info</dd></dl>
553
554<dl class="method">
555<dt id="sans.guiframe.dataFitting.Data2D.get_xaxis">
556<tt class="descclassname">Data2D.</tt><tt class="descname">get_xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.get_xaxis" title="Permalink to this definition">¶</a></dt>
557<dd>Return the units and name of x-axis</dd></dl>
558
559<dl class="method">
560<dt id="sans.guiframe.dataFitting.Data2D.get_yaxis">
561<tt class="descclassname">Data2D.</tt><tt class="descname">get_yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.get_yaxis" title="Permalink to this definition">¶</a></dt>
562<dd>Return the units and name of y- axis</dd></dl>
563
564<dl class="method">
565<dt id="sans.guiframe.dataFitting.Data2D.is_empty">
566<tt class="descclassname">Data2D.</tt><tt class="descname">is_empty</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.is_empty" title="Permalink to this definition">¶</a></dt>
567<dd>Returns True if there is no data stored in the plottable</dd></dl>
568
569<dl class="classmethod">
570<dt id="sans.guiframe.dataFitting.Data2D.labels">
571<em class="property">classmethod </em><tt class="descclassname">Data2D.</tt><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.labels" title="Permalink to this definition">¶</a></dt>
572<dd>Build a label mostly unique within a collection</dd></dl>
573
574<dl class="method">
575<dt id="sans.guiframe.dataFitting.Data2D.onFitRange">
576<tt class="descclassname">Data2D.</tt><tt class="descname">onFitRange</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.onFitRange" title="Permalink to this definition">¶</a></dt>
577<dd><p>It limits View data range to plot from min to max</p>
578<table class="docutils field-list" frame="void" rules="none">
579<col class="field-name" />
580<col class="field-body" />
581<tbody valign="top">
582<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
583<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
584<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
585</ul>
586</td>
587</tr>
588</tbody>
589</table>
590</dd></dl>
591
592<dl class="method">
593<dt id="sans.guiframe.dataFitting.Data2D.onReset">
594<tt class="descclassname">Data2D.</tt><tt class="descname">onReset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.onReset" title="Permalink to this definition">¶</a></dt>
595<dd>Reset x, y, dx, dy view with its parameters</dd></dl>
596
597<dl class="method">
598<dt id="sans.guiframe.dataFitting.Data2D.render">
599<tt class="descclassname">Data2D.</tt><tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.render" title="Permalink to this definition">¶</a></dt>
600<dd>Renders the plottable on the graph</dd></dl>
601
602<dl class="method">
603<dt id="sans.guiframe.dataFitting.Data2D.reset_view">
604<tt class="descclassname">Data2D.</tt><tt class="descname">reset_view</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.reset_view" title="Permalink to this definition">¶</a></dt>
605<dd>Reload view with new value to plot</dd></dl>
606
607<dl class="method">
608<dt id="sans.guiframe.dataFitting.Data2D.returnValuesOfView">
609<tt class="descclassname">Data2D.</tt><tt class="descname">returnValuesOfView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.returnValuesOfView" title="Permalink to this definition">¶</a></dt>
610<dd>Return View parameters and it is used by Fit Dialog</dd></dl>
611
612<dl class="method">
613<dt id="sans.guiframe.dataFitting.Data2D.setLabel">
614<tt class="descclassname">Data2D.</tt><tt class="descname">setLabel</tt><big>(</big><em>labelx</em>, <em>labely</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.setLabel" title="Permalink to this definition">¶</a></dt>
615<dd><p>It takes a label of the x and y transformation and set View parameters</p>
616<table class="docutils field-list" frame="void" rules="none">
617<col class="field-name" />
618<col class="field-body" />
619<tbody valign="top">
620<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
621<li><strong>transx</strong> &#8211; The label of x transformation is sent by Properties Dialog</li>
622<li><strong>transy</strong> &#8211; The label of y transformation is sent Properties Dialog</li>
623</ul>
624</td>
625</tr>
626</tbody>
627</table>
628</dd></dl>
629
630<dl class="method">
631<dt id="sans.guiframe.dataFitting.Data2D.setValues">
632<tt class="descclassname">Data2D.</tt><tt class="descname">setValues</tt><big>(</big><em>datainfo=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.setValues" title="Permalink to this definition">¶</a></dt>
633<dd><p>Use datainfo object to initialize data2D</p>
634<table class="docutils field-list" frame="void" rules="none">
635<col class="field-name" />
636<col class="field-body" />
637<tbody valign="top">
638<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
639<li><strong>datainfo</strong> &#8211; object</li>
640</ul>
641</td>
642</tr>
643</tbody>
644</table>
645</dd></dl>
646
647<dl class="method">
648<dt id="sans.guiframe.dataFitting.Data2D.set_View">
649<tt class="descclassname">Data2D.</tt><tt class="descname">set_View</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.set_View" title="Permalink to this definition">¶</a></dt>
650<dd>Load View</dd></dl>
651
652<dl class="method">
653<dt id="sans.guiframe.dataFitting.Data2D.set_data">
654<tt class="descclassname">Data2D.</tt><tt class="descname">set_data</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.set_data" title="Permalink to this definition">¶</a></dt>
655<dd></dd></dl>
656
657<dl class="method">
658<dt id="sans.guiframe.dataFitting.Data2D.set_zrange">
659<tt class="descclassname">Data2D.</tt><tt class="descname">set_zrange</tt><big>(</big><em>zmin=None</em>, <em>zmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.set_zrange" title="Permalink to this definition">¶</a></dt>
660<dd></dd></dl>
661
662<dl class="method">
663<dt id="sans.guiframe.dataFitting.Data2D.transformView">
664<tt class="descclassname">Data2D.</tt><tt class="descname">transformView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.transformView" title="Permalink to this definition">¶</a></dt>
665<dd>It transforms x, y before displaying</dd></dl>
666
667<dl class="method">
668<dt id="sans.guiframe.dataFitting.Data2D.transformX">
669<tt class="descclassname">Data2D.</tt><tt class="descname">transformX</tt><big>(</big><em>transx</em>, <em>transdx</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.transformX" title="Permalink to this definition">¶</a></dt>
670<dd><p>Receive pointers to function that transform x and dx
671and set corresponding View pointers</p>
672<table class="docutils field-list" frame="void" rules="none">
673<col class="field-name" />
674<col class="field-body" />
675<tbody valign="top">
676<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
677<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
678<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
679</ul>
680</td>
681</tr>
682</tbody>
683</table>
684</dd></dl>
685
686<dl class="method">
687<dt id="sans.guiframe.dataFitting.Data2D.transformY">
688<tt class="descclassname">Data2D.</tt><tt class="descname">transformY</tt><big>(</big><em>transy</em>, <em>transdy</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.transformY" title="Permalink to this definition">¶</a></dt>
689<dd><p>Receive pointers to function that transform y and dy
690and set corresponding View pointers</p>
691<table class="docutils field-list" frame="void" rules="none">
692<col class="field-name" />
693<col class="field-body" />
694<tbody valign="top">
695<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
696<li><strong>transy</strong> &#8211; pointer to function that transforms y</li>
697<li><strong>transdy</strong> &#8211; pointer to function that transforms dy</li>
698</ul>
699</td>
700</tr>
701</tbody>
702</table>
703</dd></dl>
704
705<dl class="method">
706<dt id="sans.guiframe.dataFitting.Data2D.xaxis">
707<tt class="descclassname">Data2D.</tt><tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.xaxis" title="Permalink to this definition">¶</a></dt>
708<dd><p>set x-axis</p>
709<table class="docutils field-list" frame="void" rules="none">
710<col class="field-name" />
711<col class="field-body" />
712<tbody valign="top">
713<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
714<li><strong>label</strong> &#8211; x-axis label</li>
715<li><strong>unit</strong> &#8211; x-axis unit</li>
716</ul>
717</td>
718</tr>
719</tbody>
720</table>
721</dd></dl>
722
723<dl class="method">
724<dt id="sans.guiframe.dataFitting.Data2D.yaxis">
725<tt class="descclassname">Data2D.</tt><tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.yaxis" title="Permalink to this definition">¶</a></dt>
726<dd><p>set y-axis</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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
732<li><strong>label</strong> &#8211; y-axis label</li>
733<li><strong>unit</strong> &#8211; y-axis unit</li>
734</ul>
735</td>
736</tr>
737</tbody>
738</table>
739</dd></dl>
740
741<dl class="method">
742<dt id="sans.guiframe.dataFitting.Data2D.zaxis">
743<tt class="descclassname">Data2D.</tt><tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Data2D.zaxis" title="Permalink to this definition">¶</a></dt>
744<dd><p>set z-axis</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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
750<li><strong>label</strong> &#8211; z-axis label</li>
751<li><strong>unit</strong> &#8211; z-axis unit</li>
752</ul>
753</td>
754</tr>
755</tbody>
756</table>
757</dd></dl>
758
759</dd></dl>
760
761<dl class="class">
762<dt id="sans.guiframe.dataFitting.Theory1D">
763<em class="property">class </em><tt class="descclassname">sans.guiframe.dataFitting.</tt><tt class="descname">Theory1D</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span>, <em>y=</em><span class="optional">[</span><span class="optional">]</span>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D" title="Permalink to this definition">¶</a></dt>
764<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">danse.common.plottools.plottables.Theory1D</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.Data1D</span></tt></p>
765<dl class="class">
766<dt id="sans.guiframe.dataFitting.Theory1D.View">
767<em class="property">class </em><tt class="descname">View</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View" title="Permalink to this definition">¶</a></dt>
768<dd><p>Representation of the data that might include a transformation</p>
769<dl class="method">
770<dt id="sans.guiframe.dataFitting.Theory1D.View.check_data_logX">
771<tt class="descname">check_data_logX</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.check_data_logX" title="Permalink to this definition">¶</a></dt>
772<dd>Remove negative value in x vector to avoid plotting negative
773value of Log10</dd></dl>
774
775<dl class="method">
776<dt id="sans.guiframe.dataFitting.Theory1D.View.check_data_logY">
777<tt class="descname">check_data_logY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.check_data_logY" title="Permalink to this definition">¶</a></dt>
778<dd>Remove negative value in y vector
779to avoid plotting negative value of Log10</dd></dl>
780
781<dl class="method">
782<dt id="sans.guiframe.dataFitting.Theory1D.View.onFitRangeView">
783<tt class="descname">onFitRangeView</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.onFitRangeView" title="Permalink to this definition">¶</a></dt>
784<dd><p>It limits View data range to plot from min to max</p>
785<table class="docutils field-list" frame="void" rules="none">
786<col class="field-name" />
787<col class="field-body" />
788<tbody valign="top">
789<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
790<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
791<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
792</ul>
793</td>
794</tr>
795</tbody>
796</table>
797</dd></dl>
798
799<dl class="method">
800<dt id="sans.guiframe.dataFitting.Theory1D.View.onResetView">
801<tt class="descname">onResetView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.onResetView" title="Permalink to this definition">¶</a></dt>
802<dd>Reset x,y,dx and y in their full range  and in the initial scale
803in case their previous range has changed</dd></dl>
804
805<dl class="method">
806<dt id="sans.guiframe.dataFitting.Theory1D.View.returnXview">
807<tt class="descname">returnXview</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.returnXview" title="Permalink to this definition">¶</a></dt>
808<dd>Return View  x,y,dx,dy</dd></dl>
809
810<dl class="method">
811<dt id="sans.guiframe.dataFitting.Theory1D.View.setTransformX">
812<tt class="descname">setTransformX</tt><big>(</big><em>funcx</em>, <em>funcdx</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.setTransformX" title="Permalink to this definition">¶</a></dt>
813<dd><p>Receive pointers to function that transform x and dx
814and set corresponding View pointers</p>
815<table class="docutils field-list" frame="void" rules="none">
816<col class="field-name" />
817<col class="field-body" />
818<tbody valign="top">
819<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
820<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
821<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
822</ul>
823</td>
824</tr>
825</tbody>
826</table>
827</dd></dl>
828
829<dl class="method">
830<dt id="sans.guiframe.dataFitting.Theory1D.View.setTransformY">
831<tt class="descname">setTransformY</tt><big>(</big><em>funcy</em>, <em>funcdy</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.setTransformY" title="Permalink to this definition">¶</a></dt>
832<dd><p>Receive pointers to function that transform y and dy
833and set corresponding View pointers</p>
834<table class="docutils field-list" frame="void" rules="none">
835<col class="field-name" />
836<col class="field-body" />
837<tbody valign="top">
838<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
839<li><strong>transx</strong> &#8211; pointer to function that transforms y</li>
840<li><strong>transdx</strong> &#8211; pointer to function that transforms dy</li>
841</ul>
842</td>
843</tr>
844</tbody>
845</table>
846</dd></dl>
847
848<dl class="method">
849<dt id="sans.guiframe.dataFitting.Theory1D.View.transform">
850<tt class="descname">transform</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.View.transform" title="Permalink to this definition">¶</a></dt>
851<dd><p>Transforms the x,y,dx and dy vectors and stores the output in View parameters</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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
857<li><strong>x</strong> &#8211; array of x values</li>
858<li><strong>y</strong> &#8211; array of y values</li>
859<li><strong>dx</strong> &#8211; array of  errors values on x</li>
860<li><strong>dy</strong> &#8211; array of error values on y</li>
861</ul>
862</td>
863</tr>
864</tbody>
865</table>
866</dd></dl>
867
868</dd></dl>
869
870<dl class="method">
871<dt id="sans.guiframe.dataFitting.Theory1D.changed">
872<tt class="descclassname">Theory1D.</tt><tt class="descname">changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.changed" title="Permalink to this definition">¶</a></dt>
873<dd></dd></dl>
874
875<dl class="method">
876<dt id="sans.guiframe.dataFitting.Theory1D.check_data_PlottableX">
877<tt class="descclassname">Theory1D.</tt><tt class="descname">check_data_PlottableX</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.check_data_PlottableX" title="Permalink to this definition">¶</a></dt>
878<dd>Since no transformation is made for log10(x), check that
879no negative values is plot in log scale</dd></dl>
880
881<dl class="method">
882<dt id="sans.guiframe.dataFitting.Theory1D.check_data_PlottableY">
883<tt class="descclassname">Theory1D.</tt><tt class="descname">check_data_PlottableY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.check_data_PlottableY" title="Permalink to this definition">¶</a></dt>
884<dd>Since no transformation is made for log10(y), check that
885no negative values is plot in log scale</dd></dl>
886
887<dl class="method">
888<dt id="sans.guiframe.dataFitting.Theory1D.clone_without_data">
889<tt class="descclassname">Theory1D.</tt><tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.clone_without_data" title="Permalink to this definition">¶</a></dt>
890<dd><p>Clone the current object, without copying the data (which
891will be filled out by a subsequent operation).
892The data arrays will be initialized to zero.</p>
893<table class="docutils field-list" frame="void" rules="none">
894<col class="field-name" />
895<col class="field-body" />
896<tbody valign="top">
897<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
898<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
899<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
900</ul>
901</td>
902</tr>
903</tbody>
904</table>
905</dd></dl>
906
907<dl class="method">
908<dt id="sans.guiframe.dataFitting.Theory1D.colors">
909<tt class="descclassname">Theory1D.</tt><tt class="descname">colors</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.colors" title="Permalink to this definition">¶</a></dt>
910<dd>Return the number of colors need to render the object</dd></dl>
911
912<dl class="method">
913<dt id="sans.guiframe.dataFitting.Theory1D.copy_from_datainfo">
914<tt class="descclassname">Theory1D.</tt><tt class="descname">copy_from_datainfo</tt><big>(</big><em>data1d</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.copy_from_datainfo" title="Permalink to this definition">¶</a></dt>
915<dd>copy values of Data1D of type DataLaoder.Data_info</dd></dl>
916
917<dl class="method">
918<dt id="sans.guiframe.dataFitting.Theory1D.get_xaxis">
919<tt class="descclassname">Theory1D.</tt><tt class="descname">get_xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.get_xaxis" title="Permalink to this definition">¶</a></dt>
920<dd>Return the units and name of x-axis</dd></dl>
921
922<dl class="method">
923<dt id="sans.guiframe.dataFitting.Theory1D.get_yaxis">
924<tt class="descclassname">Theory1D.</tt><tt class="descname">get_yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.get_yaxis" title="Permalink to this definition">¶</a></dt>
925<dd>Return the units and name of y- axis</dd></dl>
926
927<dl class="method">
928<dt id="sans.guiframe.dataFitting.Theory1D.is_empty">
929<tt class="descclassname">Theory1D.</tt><tt class="descname">is_empty</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.is_empty" title="Permalink to this definition">¶</a></dt>
930<dd>Returns True if there is no data stored in the plottable</dd></dl>
931
932<dl class="method">
933<dt id="sans.guiframe.dataFitting.Theory1D.is_slit_smeared">
934<tt class="descclassname">Theory1D.</tt><tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt>
935<dd><p>Check whether the data has slit smearing information</p>
936<table class="docutils field-list" frame="void" rules="none">
937<col class="field-name" />
938<col class="field-body" />
939<tbody valign="top">
940<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td>
941</tr>
942</tbody>
943</table>
944</dd></dl>
945
946<dl class="classmethod">
947<dt id="sans.guiframe.dataFitting.Theory1D.labels">
948<em class="property">classmethod </em><tt class="descclassname">Theory1D.</tt><tt class="descname">labels</tt><big>(</big><em>collection</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.labels" title="Permalink to this definition">¶</a></dt>
949<dd>Build a label mostly unique within a collection</dd></dl>
950
951<dl class="method">
952<dt id="sans.guiframe.dataFitting.Theory1D.onFitRange">
953<tt class="descclassname">Theory1D.</tt><tt class="descname">onFitRange</tt><big>(</big><em>xmin=None</em>, <em>xmax=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.onFitRange" title="Permalink to this definition">¶</a></dt>
954<dd><p>It limits View data range to plot from min to max</p>
955<table class="docutils field-list" frame="void" rules="none">
956<col class="field-name" />
957<col class="field-body" />
958<tbody valign="top">
959<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
960<li><strong>xmin</strong> &#8211; the minimum value of x to plot.</li>
961<li><strong>xmax</strong> &#8211; the maximum value of x to plot</li>
962</ul>
963</td>
964</tr>
965</tbody>
966</table>
967</dd></dl>
968
969<dl class="method">
970<dt id="sans.guiframe.dataFitting.Theory1D.onReset">
971<tt class="descclassname">Theory1D.</tt><tt class="descname">onReset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.onReset" title="Permalink to this definition">¶</a></dt>
972<dd>Reset x, y, dx, dy view with its parameters</dd></dl>
973
974<dl class="method">
975<dt id="sans.guiframe.dataFitting.Theory1D.render">
976<tt class="descclassname">Theory1D.</tt><tt class="descname">render</tt><big>(</big><em>plot</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.render" title="Permalink to this definition">¶</a></dt>
977<dd></dd></dl>
978
979<dl class="method">
980<dt id="sans.guiframe.dataFitting.Theory1D.reset_view">
981<tt class="descclassname">Theory1D.</tt><tt class="descname">reset_view</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.reset_view" title="Permalink to this definition">¶</a></dt>
982<dd>Reload view with new value to plot</dd></dl>
983
984<dl class="method">
985<dt id="sans.guiframe.dataFitting.Theory1D.returnValuesOfView">
986<tt class="descclassname">Theory1D.</tt><tt class="descname">returnValuesOfView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.returnValuesOfView" title="Permalink to this definition">¶</a></dt>
987<dd>Return View parameters and it is used by Fit Dialog</dd></dl>
988
989<dl class="method">
990<dt id="sans.guiframe.dataFitting.Theory1D.setLabel">
991<tt class="descclassname">Theory1D.</tt><tt class="descname">setLabel</tt><big>(</big><em>labelx</em>, <em>labely</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.setLabel" title="Permalink to this definition">¶</a></dt>
992<dd><p>It takes a label of the x and y transformation and set View parameters</p>
993<table class="docutils field-list" frame="void" rules="none">
994<col class="field-name" />
995<col class="field-body" />
996<tbody valign="top">
997<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
998<li><strong>transx</strong> &#8211; The label of x transformation is sent by Properties Dialog</li>
999<li><strong>transy</strong> &#8211; The label of y transformation is sent Properties Dialog</li>
1000</ul>
1001</td>
1002</tr>
1003</tbody>
1004</table>
1005</dd></dl>
1006
1007<dl class="method">
1008<dt id="sans.guiframe.dataFitting.Theory1D.set_View">
1009<tt class="descclassname">Theory1D.</tt><tt class="descname">set_View</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.set_View" title="Permalink to this definition">¶</a></dt>
1010<dd>Load View</dd></dl>
1011
1012<dl class="method">
1013<dt id="sans.guiframe.dataFitting.Theory1D.set_data">
1014<tt class="descclassname">Theory1D.</tt><tt class="descname">set_data</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.set_data" title="Permalink to this definition">¶</a></dt>
1015<dd></dd></dl>
1016
1017<dl class="method">
1018<dt id="sans.guiframe.dataFitting.Theory1D.transformView">
1019<tt class="descclassname">Theory1D.</tt><tt class="descname">transformView</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.transformView" title="Permalink to this definition">¶</a></dt>
1020<dd>It transforms x, y before displaying</dd></dl>
1021
1022<dl class="method">
1023<dt id="sans.guiframe.dataFitting.Theory1D.transformX">
1024<tt class="descclassname">Theory1D.</tt><tt class="descname">transformX</tt><big>(</big><em>transx</em>, <em>transdx</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.transformX" title="Permalink to this definition">¶</a></dt>
1025<dd><p>Receive pointers to function that transform x and dx
1026and set corresponding View pointers</p>
1027<table class="docutils field-list" frame="void" rules="none">
1028<col class="field-name" />
1029<col class="field-body" />
1030<tbody valign="top">
1031<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1032<li><strong>transx</strong> &#8211; pointer to function that transforms x</li>
1033<li><strong>transdx</strong> &#8211; pointer to function that transforms dx</li>
1034</ul>
1035</td>
1036</tr>
1037</tbody>
1038</table>
1039</dd></dl>
1040
1041<dl class="method">
1042<dt id="sans.guiframe.dataFitting.Theory1D.transformY">
1043<tt class="descclassname">Theory1D.</tt><tt class="descname">transformY</tt><big>(</big><em>transy</em>, <em>transdy</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.transformY" title="Permalink to this definition">¶</a></dt>
1044<dd><p>Receive pointers to function that transform y and dy
1045and set corresponding View pointers</p>
1046<table class="docutils field-list" frame="void" rules="none">
1047<col class="field-name" />
1048<col class="field-body" />
1049<tbody valign="top">
1050<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1051<li><strong>transy</strong> &#8211; pointer to function that transforms y</li>
1052<li><strong>transdy</strong> &#8211; pointer to function that transforms dy</li>
1053</ul>
1054</td>
1055</tr>
1056</tbody>
1057</table>
1058</dd></dl>
1059
1060<dl class="method">
1061<dt id="sans.guiframe.dataFitting.Theory1D.xaxis">
1062<tt class="descclassname">Theory1D.</tt><tt class="descname">xaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.xaxis" title="Permalink to this definition">¶</a></dt>
1063<dd><p>Set the name and unit of x_axis</p>
1064<table class="docutils field-list" frame="void" rules="none">
1065<col class="field-name" />
1066<col class="field-body" />
1067<tbody valign="top">
1068<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1069<li><strong>name</strong> &#8211; the name of x-axis</li>
1070<li><strong>units</strong> &#8211; the units of x_axis</li>
1071</ul>
1072</td>
1073</tr>
1074</tbody>
1075</table>
1076</dd></dl>
1077
1078<dl class="method">
1079<dt id="sans.guiframe.dataFitting.Theory1D.yaxis">
1080<tt class="descclassname">Theory1D.</tt><tt class="descname">yaxis</tt><big>(</big><em>name</em>, <em>units</em><big>)</big><a class="headerlink" href="#sans.guiframe.dataFitting.Theory1D.yaxis" title="Permalink to this definition">¶</a></dt>
1081<dd><p>Set the name and unit of y_axis</p>
1082<table class="docutils field-list" frame="void" rules="none">
1083<col class="field-name" />
1084<col class="field-body" />
1085<tbody valign="top">
1086<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1087<li><strong>name</strong> &#8211; the name of y-axis</li>
1088<li><strong>units</strong> &#8211; the units of y_axis</li>
1089</ul>
1090</td>
1091</tr>
1092</tbody>
1093</table>
1094</dd></dl>
1095
1096</dd></dl>
1097
1098</div>
1099</div>
1100
1101
1102          </div>
1103        </div>
1104      </div>
1105      <div class="sphinxsidebar">
1106        <div class="sphinxsidebarwrapper">
1107  <h3><a href="../index.html">Table Of Contents</a></h3>
1108  <ul>
1109<li><a class="reference internal" href="#">dataFitting</a><ul>
1110<li><a class="reference internal" href="#module-sans.guiframe.dataFitting"><tt class="docutils literal"><span class="pre">sans.guiframe.dataFitting</span></tt></a></li>
1111</ul>
1112</li>
1113</ul>
1114
1115  <h4>Previous topic</h4>
1116  <p class="topless"><a href="data_loader.html"
1117                        title="previous chapter">data_loader</a></p>
1118  <h4>Next topic</h4>
1119  <p class="topless"><a href="dummyapp.html"
1120                        title="next chapter">dummyapp</a></p>
1121  <h3>This Page</h3>
1122  <ul class="this-page-menu">
1123    <li><a href="../_sources/api/dataFitting.txt"
1124           rel="nofollow">Show Source</a></li>
1125  </ul>
1126<div id="searchbox" style="display: none">
1127  <h3>Quick search</h3>
1128    <form class="search" action="../search.html" method="get">
1129      <input type="text" name="q" size="18" />
1130      <input type="submit" value="Go" />
1131      <input type="hidden" name="check_keywords" value="yes" />
1132      <input type="hidden" name="area" value="default" />
1133    </form>
1134    <p class="searchtip" style="font-size: 90%">
1135    Enter search terms or a module, class or function name.
1136    </p>
1137</div>
1138<script type="text/javascript">$('#searchbox').show(0);</script>
1139        </div>
1140      </div>
1141      <div class="clearer"></div>
1142    </div>
1143    <div class="related">
1144      <h3>Navigation</h3>
1145      <ul>
1146        <li class="right" style="margin-right: 10px">
1147          <a href="../genindex.html" title="General Index"
1148             >index</a></li>
1149        <li class="right" >
1150          <a href="../py-modindex.html" title="Python Module Index"
1151             >modules</a> |</li>
1152        <li class="right" >
1153          <a href="dummyapp.html" title="dummyapp"
1154             >next</a> |</li>
1155        <li class="right" >
1156          <a href="data_loader.html" title="data_loader"
1157             >previous</a> |</li>
1158        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
1159          <li><a href="index.html" >Reference</a> &raquo;</li> 
1160      </ul>
1161    </div>
1162    <div class="footer">
1163        &copy; Copyright 2010, sans group.
1164      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
1165    </div>
1166  </body>
1167</html>
Note: See TracBrowser for help on using the repository browser.