source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/fitting.html @ 09e89b7

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 09e89b7 was 30d3a1b, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc
  • Property mode set to 100644
File size: 43.9 KB
RevLine 
[5a9a98f]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
[30d3a1b]6
[5a9a98f]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[30d3a1b]11    <title>fitting &mdash; sansview 0.1.0 documentation</title>
12   
[5a9a98f]13    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
[30d3a1b]15   
[5a9a98f]16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../../../',
19        VERSION:     '0.1.0',
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>
[30d3a1b]28    <link rel="top" title="sansview 0.1.0 documentation" href="../../../index.html" />
[5a9a98f]29    <link rel="up" title="Reference" href="index.html" />
[30d3a1b]30    <link rel="next" title="fitting_widgets" href="fitting_widgets.html" />
[5a9a98f]31    <link rel="prev" title="fitproblem" href="fitproblem.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" >
[30d3a1b]44          <a href="fitting_widgets.html" title="fitting_widgets"
[5a9a98f]45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="fitproblem.html" title="fitproblem"
48             accesskey="P">previous</a> |</li>
[30d3a1b]49        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
[5a9a98f]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="fitting">
60<h1>fitting<a class="headerlink" href="#fitting" title="Permalink to this headline">¶</a></h1>
[30d3a1b]61<div class="section" id="sans-perspectives-fitting-fitting">
62<h2><a class="reference internal" href="#module-sans.perspectives.fitting.fitting" title="sans.perspectives.fitting.fitting"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.fitting</span></tt></a><a class="headerlink" href="#sans-perspectives-fitting-fitting" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.perspectives.fitting.fitting"></span><dl class="class">
[5a9a98f]64<dt id="sans.perspectives.fitting.fitting.Plugin">
[30d3a1b]65<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.fitting.</tt><tt class="descname">Plugin</tt><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin" title="Permalink to this definition">¶</a></dt>
[5a9a98f]66<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.plugin_base.PluginBase</span></tt></p>
67<p>Fitting plugin is used to perform fit</p>
68<dl class="method">
[30d3a1b]69<dt id="sans.perspectives.fitting.fitting.Plugin.__init__">
70<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.__init__" title="Permalink to this definition">¶</a></dt>
71<dd></dd></dl>
72
73<dl class="attribute">
74<dt id="sans.perspectives.fitting.fitting.Plugin.__module__">
75<tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.fitting.fitting'</em><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.__module__" title="Permalink to this definition">¶</a></dt>
76<dd></dd></dl>
77
78<dl class="method">
79<dt id="sans.perspectives.fitting.fitting.Plugin._batch_fit_complete">
80<tt class="descname">_batch_fit_complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._batch_fit_complete" title="Permalink to this definition">¶</a></dt>
81<dd><p>Display fit result in batch
82:param result: list of objects received fromt fit engines
83:param pars: list of  fitted parameters names
84:param page_id: list of page ids which called fit function
85:param elapsed: time spent at the fitting level</p>
86</dd></dl>
87
88<dl class="method">
89<dt id="sans.perspectives.fitting.fitting.Plugin._cal_chisqr">
90<tt class="descname">_cal_chisqr</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._cal_chisqr" title="Permalink to this definition">¶</a></dt>
91<dd><p>Get handy Chisqr using the output from draw1D and 2D,
92instead of calling expansive CalcChisqr in guithread</p>
93</dd></dl>
94
95<dl class="method">
96<dt id="sans.perspectives.fitting.fitting.Plugin._closed_fitpage">
97<tt class="descname">_closed_fitpage</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._closed_fitpage" title="Permalink to this definition">¶</a></dt>
98<dd><p>request fitpanel to close a given page when its unique data is removed
99from the plot. close fitpage only when the a loaded data is removed</p>
100</dd></dl>
101
102<dl class="method">
103<dt id="sans.perspectives.fitting.fitting.Plugin._complete1D">
104<tt class="descname">_complete1D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._complete1D" title="Permalink to this definition">¶</a></dt>
105<dd><p>Complete plotting 1D data</p>
106</dd></dl>
107
108<dl class="method">
109<dt id="sans.perspectives.fitting.fitting.Plugin._complete2D">
110<tt class="descname">_complete2D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._complete2D" title="Permalink to this definition">¶</a></dt>
111<dd><p>Complete get the result of modelthread and create model 2D
112that can be plot.</p>
113</dd></dl>
114
115<dl class="method">
116<dt id="sans.perspectives.fitting.fitting.Plugin._draw_model1D">
117<tt class="descname">_draw_model1D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._draw_model1D" title="Permalink to this definition">¶</a></dt>
118<dd><p>Draw model 1D from loaded data1D</p>
119<table class="docutils field-list" frame="void" rules="none">
120<col class="field-name" />
121<col class="field-body" />
122<tbody valign="top">
123<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
124<li><strong>data</strong> &#8211; loaded data</li>
125<li><strong>model</strong> &#8211; the model to plot</li>
126</ul>
127</td>
128</tr>
129</tbody>
130</table>
131</dd></dl>
132
133<dl class="method">
134<dt id="sans.perspectives.fitting.fitting.Plugin._draw_model2D">
135<tt class="descname">_draw_model2D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._draw_model2D" title="Permalink to this definition">¶</a></dt>
136<dd><p>draw model in 2D</p>
137<table class="docutils field-list" frame="void" rules="none">
138<col class="field-name" />
139<col class="field-body" />
140<tbody valign="top">
141<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
142<li><strong>model</strong> &#8211; instance of the model to draw</li>
143<li><strong>description</strong> &#8211; the description of the model</li>
144<li><strong>enable2D</strong> &#8211; when True allows to draw model 2D</li>
145<li><strong>qmin</strong> &#8211; the minimum value to  draw model 2D</li>
146<li><strong>qmax</strong> &#8211; the maximum value to draw model 2D</li>
147<li><strong>qstep</strong> &#8211; the number of division of Qx and Qy of the model to draw</li>
148</ul>
149</td>
150</tr>
151</tbody>
152</table>
153</dd></dl>
154
155<dl class="method">
156<dt id="sans.perspectives.fitting.fitting.Plugin._fit_completed">
157<tt class="descname">_fit_completed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._fit_completed" title="Permalink to this definition">¶</a></dt>
158<dd><p>Display result of the fit on related panel(s).
159:param result: list of object generated when fit ends
160:param pars: list of names of parameters fitted
161:param page_id: list of page ids which called fit function
162:param elapsed: time spent at the fitting level</p>
163</dd></dl>
164
165<dl class="method">
166<dt id="sans.perspectives.fitting.fitting.Plugin._fit_helper">
167<tt class="descname">_fit_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._fit_helper" title="Permalink to this definition">¶</a></dt>
168<dd><p>Create and set fit engine with series of data and model
169:param pars: list of fittable parameters
170:param fitter_list: list of fit engine
171:param value:  structure storing data mapped to their model, range etc..</p>
172</dd></dl>
173
174<dl class="method">
175<dt id="sans.perspectives.fitting.fitting.Plugin._mac_sleep">
176<tt class="descname">_mac_sleep</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._mac_sleep" title="Permalink to this definition">¶</a></dt>
177<dd><p>Give sleep to MAC</p>
178</dd></dl>
179
180<dl class="method">
181<dt id="sans.perspectives.fitting.fitting.Plugin._onEVT_SLICER_PANEL">
182<tt class="descname">_onEVT_SLICER_PANEL</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._onEVT_SLICER_PANEL" title="Permalink to this definition">¶</a></dt>
183<dd><p>receive and event telling to update a panel with a name starting with
184event.panel_name. this method update slicer panel
185for a given interactor.</p>
186<table class="docutils field-list" frame="void" rules="none">
187<col class="field-name" />
188<col class="field-body" />
189<tbody valign="top">
190<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; contains type of slicer , paramaters for updating
191the panel and panel_name to find the slicer &#8216;s panel concerned.</td>
192</tr>
193</tbody>
194</table>
195</dd></dl>
196
197<dl class="method">
198<dt id="sans.perspectives.fitting.fitting.Plugin._onSelect">
199<tt class="descname">_onSelect</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._onSelect" title="Permalink to this definition">¶</a></dt>
200<dd><p>when Select data to fit a new page is created .Its reference is
201added to self.page_finder</p>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.perspectives.fitting.fitting.Plugin._on_change_engine">
206<tt class="descname">_on_change_engine</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._on_change_engine" title="Permalink to this definition">¶</a></dt>
207<dd><p>Allow to select the type of engine to perform fit</p>
208<table class="docutils field-list" frame="void" rules="none">
209<col class="field-name" />
210<col class="field-body" />
211<tbody valign="top">
212<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>engine</strong> &#8211; the key work of the engine</td>
213</tr>
214</tbody>
215</table>
216</dd></dl>
217
218<dl class="method">
219<dt id="sans.perspectives.fitting.fitting.Plugin._on_model_panel">
220<tt class="descname">_on_model_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._on_model_panel" title="Permalink to this definition">¶</a></dt>
221<dd><p>react to model selection on any combo box or model menu.plot the model</p>
222<table class="docutils field-list" frame="void" rules="none">
223<col class="field-name" />
224<col class="field-body" />
225<tbody valign="top">
226<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>evt</strong> &#8211; wx.combobox event</td>
227</tr>
228</tbody>
229</table>
230</dd></dl>
231
232<dl class="method">
233<dt id="sans.perspectives.fitting.fitting.Plugin._on_show_panel">
234<tt class="descname">_on_show_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._on_show_panel" title="Permalink to this definition">¶</a></dt>
235<dd></dd></dl>
236
237<dl class="method">
238<dt id="sans.perspectives.fitting.fitting.Plugin._on_slicer_event">
239<tt class="descname">_on_slicer_event</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._on_slicer_event" title="Permalink to this definition">¶</a></dt>
240<dd><p>Receive a panel as event and send it to guiframe</p>
241<table class="docutils field-list" frame="void" rules="none">
242<col class="field-name" />
243<col class="field-body" />
244<tbody valign="top">
245<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; event containing a panel</td>
246</tr>
247</tbody>
248</table>
249</dd></dl>
250
251<dl class="method">
252<dt id="sans.perspectives.fitting.fitting.Plugin._onclearslicer">
253<tt class="descname">_onclearslicer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._onclearslicer" title="Permalink to this definition">¶</a></dt>
254<dd><p>Clear the boxslicer when close the panel associate with this slicer</p>
255</dd></dl>
256
257<dl class="method">
258<dt id="sans.perspectives.fitting.fitting.Plugin._onset_engine_park">
259<tt class="descname">_onset_engine_park</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._onset_engine_park" title="Permalink to this definition">¶</a></dt>
260<dd><p>set engine to park</p>
261</dd></dl>
262
263<dl class="method">
264<dt id="sans.perspectives.fitting.fitting.Plugin._onset_engine_scipy">
265<tt class="descname">_onset_engine_scipy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._onset_engine_scipy" title="Permalink to this definition">¶</a></dt>
266<dd><p>set engine to scipy</p>
267</dd></dl>
268
269<dl class="method">
270<dt id="sans.perspectives.fitting.fitting.Plugin._plot_residuals">
271<tt class="descname">_plot_residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._plot_residuals" title="Permalink to this definition">¶</a></dt>
272<dd><p>Plot the residuals</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>data</strong> &#8211; data</li>
279<li><strong>index</strong> &#8211; index array (bool)</li>
280</ul>
281</td>
282</tr>
283</tbody>
284</table>
285<p>: Note: this is different from the residuals in cal_chisqr()</p>
286</dd></dl>
287
288<dl class="method">
289<dt id="sans.perspectives.fitting.fitting.Plugin._reset_schedule_problem">
290<tt class="descname">_reset_schedule_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._reset_schedule_problem" title="Permalink to this definition">¶</a></dt>
291<dd><p>unschedule or schedule all fitproblem to be fit</p>
292</dd></dl>
293
294<dl class="method">
295<dt id="sans.perspectives.fitting.fitting.Plugin._return_engine_type">
296<tt class="descname">_return_engine_type</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._return_engine_type" title="Permalink to this definition">¶</a></dt>
297<dd><p>return the current type of engine</p>
298</dd></dl>
299
300<dl class="method">
301<dt id="sans.perspectives.fitting.fitting.Plugin._update1D">
302<tt class="descname">_update1D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._update1D" title="Permalink to this definition">¶</a></dt>
303<dd><p>Update the output of plotting model 1D</p>
304</dd></dl>
305
306<dl class="method">
307<dt id="sans.perspectives.fitting.fitting.Plugin._update2D">
308<tt class="descname">_update2D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._update2D" title="Permalink to this definition">¶</a></dt>
309<dd><p>Update the output of plotting model</p>
310</dd></dl>
311
312<dl class="method">
313<dt id="sans.perspectives.fitting.fitting.Plugin._update_fit_button">
314<tt class="descname">_update_fit_button</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin._update_fit_button" title="Permalink to this definition">¶</a></dt>
315<dd><p>Update Fit button when fit stopped</p>
316<p>: parameter page_id: fitpage where the button is</p>
317</dd></dl>
318
319<dl class="method">
[5a9a98f]320<dt id="sans.perspectives.fitting.fitting.Plugin.add_color">
[30d3a1b]321<tt class="descname">add_color</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.add_color" title="Permalink to this definition">¶</a></dt>
[5a9a98f]322<dd><p>adds a color as a key with a plot id as its value to a dictionary</p>
323</dd></dl>
324
325<dl class="method">
326<dt id="sans.perspectives.fitting.fitting.Plugin.add_fit_page">
[30d3a1b]327<tt class="descname">add_fit_page</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.add_fit_page" title="Permalink to this definition">¶</a></dt>
[5a9a98f]328<dd><p>given a data, ask to the fitting panel to create a new fitting page,
[30d3a1b]329get this page and store it into the page_finder of this plug-in
330:param data: is a list of data</p>
[5a9a98f]331</dd></dl>
332
333<dl class="method">
334<dt id="sans.perspectives.fitting.fitting.Plugin.can_load_data">
335<tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.can_load_data" title="Permalink to this definition">¶</a></dt>
336<dd><p>if return True, then call handler to laod data</p>
337</dd></dl>
338
339<dl class="method">
340<dt id="sans.perspectives.fitting.fitting.Plugin.clear_panel">
341<tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.clear_panel" title="Permalink to this definition">¶</a></dt>
342<dd></dd></dl>
343
344<dl class="method">
[30d3a1b]345<dt id="sans.perspectives.fitting.fitting.Plugin.create_fit_problem">
346<tt class="descname">create_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.create_fit_problem" title="Permalink to this definition">¶</a></dt>
347<dd><p>Given an ID create a fitproblem container</p>
348</dd></dl>
349
350<dl class="method">
[5a9a98f]351<dt id="sans.perspectives.fitting.fitting.Plugin.delete_data">
[30d3a1b]352<tt class="descname">delete_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.delete_data" title="Permalink to this definition">¶</a></dt>
[5a9a98f]353<dd><p>delete  the given data from panel</p>
354</dd></dl>
355
356<dl class="method">
[30d3a1b]357<dt id="sans.perspectives.fitting.fitting.Plugin.delete_fit_problem">
358<tt class="descname">delete_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.delete_fit_problem" title="Permalink to this definition">¶</a></dt>
359<dd><p>Given an ID create a fitproblem container</p>
360</dd></dl>
361
362<dl class="method">
[5a9a98f]363<dt id="sans.perspectives.fitting.fitting.Plugin.draw_model">
[30d3a1b]364<tt class="descname">draw_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.draw_model" title="Permalink to this definition">¶</a></dt>
[5a9a98f]365<dd><p>Draw model.</p>
366<table class="docutils field-list" frame="void" rules="none">
367<col class="field-name" />
368<col class="field-body" />
369<tbody valign="top">
[30d3a1b]370<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[5a9a98f]371<li><strong>model</strong> &#8211; the model to draw</li>
372<li><strong>name</strong> &#8211; the name of the model to draw</li>
373<li><strong>data</strong> &#8211; the data on which the model is based to be drawn</li>
374<li><strong>description</strong> &#8211; model&#8217;s description</li>
375<li><strong>enable1D</strong> &#8211; if true enable drawing model 1D</li>
376<li><strong>enable2D</strong> &#8211; if true enable drawing model 2D</li>
377<li><strong>qmin</strong> &#8211; Range&#8217;s minimum value to draw model</li>
378<li><strong>qmax</strong> &#8211; Range&#8217;s maximum value to draw model</li>
379<li><strong>qstep</strong> &#8211; number of step to divide the x and y-axis</li>
380<li><strong>update_chisqr</strong> &#8211; update chisqr [bool]</li>
381</ul>
382</td>
383</tr>
384</tbody>
385</table>
386</dd></dl>
387
388<dl class="method">
[30d3a1b]389<dt id="sans.perspectives.fitting.fitting.Plugin.get_batch_capable">
390<tt class="descname">get_batch_capable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_batch_capable" title="Permalink to this definition">¶</a></dt>
391<dd><p>Check if the plugin has a batch capability</p>
392</dd></dl>
393
394<dl class="method">
[5a9a98f]395<dt id="sans.perspectives.fitting.fitting.Plugin.get_context_menu">
[30d3a1b]396<tt class="descname">get_context_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_context_menu" title="Permalink to this definition">¶</a></dt>
[5a9a98f]397<dd><p>Get the context menu items available for P(r).them allow fitting option
398for Data2D and Data1D only.</p>
399<table class="docutils field-list" frame="void" rules="none">
400<col class="field-name" />
401<col class="field-body" />
402<tbody valign="top">
[30d3a1b]403<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> &#8211; the Graph object to which we attach the context menu</td>
[5a9a98f]404</tr>
[30d3a1b]405<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td>
[5a9a98f]406</tr>
[30d3a1b]407<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">if Data1D was generated from Theory1D 
[5a9a98f]408the fitting option is not allowed</td>
409</tr>
410</tbody>
411</table>
412</dd></dl>
413
414<dl class="method">
415<dt id="sans.perspectives.fitting.fitting.Plugin.get_extensions">
416<tt class="descname">get_extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_extensions" title="Permalink to this definition">¶</a></dt>
417<dd><p>return state reader and its extensions</p>
418</dd></dl>
419
420<dl class="method">
[30d3a1b]421<dt id="sans.perspectives.fitting.fitting.Plugin.get_graph_id">
422<tt class="descname">get_graph_id</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_graph_id" title="Permalink to this definition">¶</a></dt>
423<dd><p>Set graph_id for fitprobelm</p>
424</dd></dl>
425
426<dl class="method">
[5a9a98f]427<dt id="sans.perspectives.fitting.fitting.Plugin.get_page_finder">
428<tt class="descname">get_page_finder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_page_finder" title="Permalink to this definition">¶</a></dt>
429<dd><p>return self.page_finder used also by simfitpage.py</p>
430</dd></dl>
431
432<dl class="method">
433<dt id="sans.perspectives.fitting.fitting.Plugin.get_panels">
[30d3a1b]434<tt class="descname">get_panels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_panels" title="Permalink to this definition">¶</a></dt>
[5a9a98f]435<dd><p>Create and return a list of panel objects</p>
436</dd></dl>
437
438<dl class="method">
439<dt id="sans.perspectives.fitting.fitting.Plugin.get_perspective">
440<tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_perspective" title="Permalink to this definition">¶</a></dt>
441<dd><p>Get the list of panel names for this perspective</p>
442</dd></dl>
443
444<dl class="method">
445<dt id="sans.perspectives.fitting.fitting.Plugin.get_tools">
446<tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_tools" title="Permalink to this definition">¶</a></dt>
447<dd><p>Returns a set of menu entries for tools</p>
448</dd></dl>
449
450<dl class="method">
451<dt id="sans.perspectives.fitting.fitting.Plugin.help">
[30d3a1b]452<tt class="descname">help</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.help" title="Permalink to this definition">¶</a></dt>
[5a9a98f]453<dd><p>Show a general help dialog.</p>
454</dd></dl>
455
456<dl class="method">
457<dt id="sans.perspectives.fitting.fitting.Plugin.is_always_active">
458<tt class="descname">is_always_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.is_always_active" title="Permalink to this definition">¶</a></dt>
459<dd><p>return True is this plugin is always active and it is local to guiframe
460even if the user is switching between perspectives</p>
461</dd></dl>
462
463<dl class="method">
464<dt id="sans.perspectives.fitting.fitting.Plugin.is_in_use">
[30d3a1b]465<tt class="descname">is_in_use</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.is_in_use" title="Permalink to this definition">¶</a></dt>
[5a9a98f]466<dd><dl class="docutils">
467<dt>get a  data id a list of data name if data data is</dt>
468<dd>currently used by the plugin and the name of the plugin</dd>
469</dl>
470<p>data_name = &#8216;None&#8217;
471in_use = False
472example [(data_name, self.sub_menu)]</p>
473</dd></dl>
474
475<dl class="method">
476<dt id="sans.perspectives.fitting.fitting.Plugin.load_data">
[30d3a1b]477<tt class="descname">load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.load_data" title="Permalink to this definition">¶</a></dt>
[5a9a98f]478<dd><p>Load  data</p>
479</dd></dl>
480
481<dl class="method">
482<dt id="sans.perspectives.fitting.fitting.Plugin.load_folder">
[30d3a1b]483<tt class="descname">load_folder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.load_folder" title="Permalink to this definition">¶</a></dt>
[5a9a98f]484<dd><p>Load entire folder</p>
485</dd></dl>
486
487<dl class="method">
488<dt id="sans.perspectives.fitting.fitting.Plugin.onFit">
[30d3a1b]489<tt class="descname">onFit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.onFit" title="Permalink to this definition">¶</a></dt>
490<dd><p>Get series of data, model, associates parameters and range and send then
491to  series of fit engines. Fit data and model, display result to
492corresponding panels.
493:param uid: id related to the panel currently calling this fit function.</p>
[5a9a98f]494</dd></dl>
495
496<dl class="method">
497<dt id="sans.perspectives.fitting.fitting.Plugin.on_add_new_page">
[30d3a1b]498<tt class="descname">on_add_new_page</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_add_new_page" title="Permalink to this definition">¶</a></dt>
[5a9a98f]499<dd><p>ask fit panel to create a new empty page</p>
500</dd></dl>
501
502<dl class="method">
503<dt id="sans.perspectives.fitting.fitting.Plugin.on_add_sim_page">
[30d3a1b]504<tt class="descname">on_add_sim_page</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_add_sim_page" title="Permalink to this definition">¶</a></dt>
[5a9a98f]505<dd><p>Create a page to access simultaneous fit option</p>
506</dd></dl>
507
508<dl class="method">
509<dt id="sans.perspectives.fitting.fitting.Plugin.on_batch_selection">
[30d3a1b]510<tt class="descname">on_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_batch_selection" title="Permalink to this definition">¶</a></dt>
[5a9a98f]511<dd><p>switch the the notebook of batch mode or not</p>
512</dd></dl>
513
514<dl class="method">
515<dt id="sans.perspectives.fitting.fitting.Plugin.on_perspective">
[30d3a1b]516<tt class="descname">on_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_perspective" title="Permalink to this definition">¶</a></dt>
[5a9a98f]517<dd><p>Call back function for the perspective menu item.
518We notify the parent window that the perspective
519has changed.</p>
520<table class="docutils field-list" frame="void" rules="none">
521<col class="field-name" />
522<col class="field-body" />
523<tbody valign="top">
[30d3a1b]524<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> &#8211; menu event</td>
[5a9a98f]525</tr>
526</tbody>
527</table>
528</dd></dl>
529
530<dl class="method">
[30d3a1b]531<dt id="sans.perspectives.fitting.fitting.Plugin.on_reset_batch_flag">
532<tt class="descname">on_reset_batch_flag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_reset_batch_flag" title="Permalink to this definition">¶</a></dt>
533<dd><p>Set batch_reset_flag</p>
534</dd></dl>
535
536<dl class="method">
537<dt id="sans.perspectives.fitting.fitting.Plugin.on_set_batch_result">
538<tt class="descname">on_set_batch_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_set_batch_result" title="Permalink to this definition">¶</a></dt>
539<dd></dd></dl>
540
541<dl class="method">
[5a9a98f]542<dt id="sans.perspectives.fitting.fitting.Plugin.on_set_state_helper">
[30d3a1b]543<tt class="descname">on_set_state_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_set_state_helper" title="Permalink to this definition">¶</a></dt>
[5a9a98f]544<dd><p>Set_state_helper. This actually sets state
545after plotting data from state file.</p>
546<dl class="docutils">
547<dt>: event: FitStateUpdateEvent called </dt>
548<dd>by dataloader.plot_data from guiframe</dd>
549</dl>
550</dd></dl>
551
552<dl class="method">
553<dt id="sans.perspectives.fitting.fitting.Plugin.populate_file_menu">
554<tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.populate_file_menu" title="Permalink to this definition">¶</a></dt>
555<dd><p>Append menu item under file menu item of the frame</p>
556</dd></dl>
557
558<dl class="method">
559<dt id="sans.perspectives.fitting.fitting.Plugin.populate_menu">
[30d3a1b]560<tt class="descname">populate_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.populate_menu" title="Permalink to this definition">¶</a></dt>
[5a9a98f]561<dd><p>Create a menu for the Fitting plug-in</p>
562<table class="docutils field-list" frame="void" rules="none">
563<col class="field-name" />
564<col class="field-body" />
565<tbody valign="top">
[30d3a1b]566<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
[5a9a98f]567<li><strong>id</strong> &#8211; id to create a menu</li>
568<li><strong>owner</strong> &#8211; owner of menu</li>
569</ul>
570</td>
571</tr>
[30d3a1b]572<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of information to populate the main menu</p>
[5a9a98f]573</td>
574</tr>
575</tbody>
576</table>
577</dd></dl>
578
579<dl class="method">
580<dt id="sans.perspectives.fitting.fitting.Plugin.post_init">
581<tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.post_init" title="Permalink to this definition">¶</a></dt>
582<dd><p>Post initialization call back to close the loose ends</p>
583</dd></dl>
584
585<dl class="method">
586<dt id="sans.perspectives.fitting.fitting.Plugin.ready_fit">
[30d3a1b]587<tt class="descname">ready_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.ready_fit" title="Permalink to this definition">¶</a></dt>
[5a9a98f]588<dd><p>Ready for another fit</p>
589</dd></dl>
590
591<dl class="method">
592<dt id="sans.perspectives.fitting.fitting.Plugin.remove_plot">
[30d3a1b]593<tt class="descname">remove_plot</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.remove_plot" title="Permalink to this definition">¶</a></dt>
594<dd><p>remove model plot when a fit page is closed
595:param uid: the id related to the fitpage to close
596:param fid: the id of the fitproblem(data, model, range,etc)</p>
[5a9a98f]597</dd></dl>
598
599<dl class="method">
600<dt id="sans.perspectives.fitting.fitting.Plugin.save_fit_state">
[30d3a1b]601<tt class="descname">save_fit_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.save_fit_state" title="Permalink to this definition">¶</a></dt>
[5a9a98f]602<dd><p>save fit page state into file</p>
603</dd></dl>
604
605<dl class="method">
606<dt id="sans.perspectives.fitting.fitting.Plugin.schedule_for_fit">
[30d3a1b]607<tt class="descname">schedule_for_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.schedule_for_fit" title="Permalink to this definition">¶</a></dt>
[5a9a98f]608<dd><p>Set the fit problem field to 0 or 1 to schedule that problem to fit.
609Schedule the specified fitproblem or get the fit problem related to
[30d3a1b]610the current page and set value.
611:param value: integer 0 or 1
612:param uid: the id related to a page contaning fitting information</p>
[5a9a98f]613</dd></dl>
614
615<dl class="method">
[30d3a1b]616<dt id="sans.perspectives.fitting.fitting.Plugin.select_data">
617<tt class="descname">select_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.select_data" title="Permalink to this definition">¶</a></dt>
618<dd></dd></dl>
619
620<dl class="method">
[5a9a98f]621<dt id="sans.perspectives.fitting.fitting.Plugin.set_batch_selection">
[30d3a1b]622<tt class="descname">set_batch_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_batch_selection" title="Permalink to this definition">¶</a></dt>
[5a9a98f]623<dd><p>the plugin to its batch state if flag is True</p>
624</dd></dl>
625
626<dl class="method">
627<dt id="sans.perspectives.fitting.fitting.Plugin.set_data">
[30d3a1b]628<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_data" title="Permalink to this definition">¶</a></dt>
[5a9a98f]629<dd><p>receive a list of data to fit</p>
630</dd></dl>
631
632<dl class="method">
633<dt id="sans.perspectives.fitting.fitting.Plugin.set_default_perspective">
634<tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_default_perspective" title="Permalink to this definition">¶</a></dt>
635<dd><p>Call back method that True to notify the parent that the current plug-in
636can be set as default  perspective.
637when returning False, the plug-in is not candidate for an automatic
638default perspective setting</p>
639</dd></dl>
640
641<dl class="method">
642<dt id="sans.perspectives.fitting.fitting.Plugin.set_fit_range">
[30d3a1b]643<tt class="descname">set_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_fit_range" title="Permalink to this definition">¶</a></dt>
644<dd><p>Set the fitting range of a given page for all
645its data by default. If fid is provide then set the range
646only for the data with fid as id
647:param uid: id corresponding to a fit page
648:param fid: id corresponding to a fit problem (data, model)
649:param qmin: minimum  value of the fit range
650:param qmax: maximum  value of the fit range</p>
651</dd></dl>
652
653<dl class="method">
654<dt id="sans.perspectives.fitting.fitting.Plugin.set_fit_weight">
655<tt class="descname">set_fit_weight</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_fit_weight" title="Permalink to this definition">¶</a></dt>
656<dd><p>Set the fit weights of a given page for all
657its data by default. If fid is provide then set the range
658only for the data with fid as id
659:param uid: id corresponding to a fit page
660:param fid: id corresponding to a fit problem (data, model)
661:param weight: current dy data</p>
[5a9a98f]662</dd></dl>
663
664<dl class="method">
665<dt id="sans.perspectives.fitting.fitting.Plugin.set_ftol">
[30d3a1b]666<tt class="descname">set_ftol</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_ftol" title="Permalink to this definition">¶</a></dt>
[5a9a98f]667<dd><p>Set ftol: Relative error desired in the sum of chi squares.</p>
668</dd></dl>
669
670<dl class="method">
[30d3a1b]671<dt id="sans.perspectives.fitting.fitting.Plugin.set_graph_id">
672<tt class="descname">set_graph_id</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_graph_id" title="Permalink to this definition">¶</a></dt>
673<dd><p>Set graph_id for fitprobelm</p>
674</dd></dl>
675
676<dl class="method">
[5a9a98f]677<dt id="sans.perspectives.fitting.fitting.Plugin.set_is_active">
[30d3a1b]678<tt class="descname">set_is_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_is_active" title="Permalink to this definition">¶</a></dt>
[5a9a98f]679<dd></dd></dl>
680
681<dl class="method">
682<dt id="sans.perspectives.fitting.fitting.Plugin.set_page_finder">
[30d3a1b]683<tt class="descname">set_page_finder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_page_finder" title="Permalink to this definition">¶</a></dt>
[5a9a98f]684<dd><p>Used by simfitpage.py to reset a parameter given the string constrainst.</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">
[30d3a1b]689<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
[5a9a98f]690<li><strong>modelname</strong> &#8211; the name ot the model for with the parameter
691has to reset</li>
692<li><strong>value</strong> &#8211; can be a string in this case.</li>
693<li><strong>names</strong> &#8211; the paramter name</li>
694</ul>
695</td>
696</tr>
[30d3a1b]697<tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">expecting park used for fit.</p>
[5a9a98f]698</td>
699</tr>
700</tbody>
701</table>
702</dd></dl>
703
704<dl class="method">
[30d3a1b]705<dt id="sans.perspectives.fitting.fitting.Plugin.set_param2fit">
706<tt class="descname">set_param2fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_param2fit" title="Permalink to this definition">¶</a></dt>
707<dd><p>Set the list of param names to fit for fitprobelm</p>
708</dd></dl>
709
710<dl class="method">
[5a9a98f]711<dt id="sans.perspectives.fitting.fitting.Plugin.set_smearer">
[30d3a1b]712<tt class="descname">set_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_smearer" title="Permalink to this definition">¶</a></dt>
713<dd><p>Get a smear object and store it to a fit problem of fid as id. If proper
714flag is enable , will plot the theory with smearing information.</p>
[5a9a98f]715<table class="docutils field-list" frame="void" rules="none">
716<col class="field-name" />
717<col class="field-body" />
718<tbody valign="top">
[30d3a1b]719<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
720<li><strong>smearer</strong> &#8211; smear object to allow smearing data of id fid</li>
721<li><strong>enable_smearer</strong> &#8211; Define whether or not all (data, model) contained
722in the structure of id uid will be smeared before fitting.</li>
723<li><strong>qmin</strong> &#8211; the maximum value of the theory plotting range</li>
724<li><strong>qmax</strong> &#8211; the maximum value of the theory plotting range</li>
725<li><strong>draw</strong> &#8211; Determine if the theory needs to be plot</li>
726</ul>
727</td>
[5a9a98f]728</tr>
729</tbody>
730</table>
731</dd></dl>
732
733<dl class="method">
734<dt id="sans.perspectives.fitting.fitting.Plugin.set_state">
[30d3a1b]735<tt class="descname">set_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_state" title="Permalink to this definition">¶</a></dt>
[5a9a98f]736<dd><p>Call-back method for the fit page state reader.
737This method is called when a .fitv/.svs file is loaded.</p>
738<p>: param state: PageState object
739: param datainfo: data</p>
740</dd></dl>
741
742<dl class="method">
743<dt id="sans.perspectives.fitting.fitting.Plugin.set_theory">
[30d3a1b]744<tt class="descname">set_theory</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_theory" title="Permalink to this definition">¶</a></dt>
[5a9a98f]745<dd></dd></dl>
746
747<dl class="method">
748<dt id="sans.perspectives.fitting.fitting.Plugin.set_top_panel">
749<tt class="descname">set_top_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_top_panel" title="Permalink to this definition">¶</a></dt>
750<dd><p>Close default (welcome) panel</p>
751</dd></dl>
752
753<dl class="method">
754<dt id="sans.perspectives.fitting.fitting.Plugin.show_ftol_dialog">
[30d3a1b]755<tt class="descname">show_ftol_dialog</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.show_ftol_dialog" title="Permalink to this definition">¶</a></dt>
[5a9a98f]756<dd><p>Dialog to select ftol for Scipy</p>
757</dd></dl>
758
759<dl class="method">
760<dt id="sans.perspectives.fitting.fitting.Plugin.split_string">
[30d3a1b]761<tt class="descname">split_string</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.split_string" title="Permalink to this definition">¶</a></dt>
[5a9a98f]762<dd><p>receive a word containing dot and split it. used to split parameterset
763name into model name and parameter name example:</p>
764<div class="highlight-python"><pre>paramaterset (item) = M1.A
765Will return model_name = M1 , parameter name = A</pre>
766</div>
767</dd></dl>
768
769<dl class="method">
770<dt id="sans.perspectives.fitting.fitting.Plugin.stop_fit">
[30d3a1b]771<tt class="descname">stop_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.stop_fit" title="Permalink to this definition">¶</a></dt>
[5a9a98f]772<dd><p>Stop the fit engine</p>
773</dd></dl>
774
775<dl class="method">
776<dt id="sans.perspectives.fitting.fitting.Plugin.store_data">
[30d3a1b]777<tt class="descname">store_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.store_data" title="Permalink to this definition">¶</a></dt>
778<dd><p>Recieve a list of data and store them ans well as a caption of
779the fit page where they come from.
780:param uid: if related to a fit page
781:param data_list: list of data to fit
782:param caption: caption of the window related to these data</p>
[5a9a98f]783</dd></dl>
784
785<dl class="method">
786<dt id="sans.perspectives.fitting.fitting.Plugin.update_fit">
[30d3a1b]787<tt class="descname">update_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.update_fit" title="Permalink to this definition">¶</a></dt>
[5a9a98f]788<dd></dd></dl>
789
790<dl class="method">
791<dt id="sans.perspectives.fitting.fitting.Plugin.use_data">
792<tt class="descname">use_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.use_data" title="Permalink to this definition">¶</a></dt>
793<dd><p>return True if these plugin use data</p>
794</dd></dl>
795
796</dd></dl>
797
798</div>
799</div>
800
801
802          </div>
803        </div>
804      </div>
805      <div class="sphinxsidebar">
806        <div class="sphinxsidebarwrapper">
807  <h3><a href="../../../index.html">Table Of Contents</a></h3>
808  <ul>
809<li><a class="reference internal" href="#">fitting</a><ul>
[30d3a1b]810<li><a class="reference internal" href="#sans-perspectives-fitting-fitting"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.fitting</span></tt></a></li>
[5a9a98f]811</ul>
812</li>
813</ul>
814
815  <h4>Previous topic</h4>
816  <p class="topless"><a href="fitproblem.html"
817                        title="previous chapter">fitproblem</a></p>
818  <h4>Next topic</h4>
[30d3a1b]819  <p class="topless"><a href="fitting_widgets.html"
820                        title="next chapter">fitting_widgets</a></p>
[5a9a98f]821  <h3>This Page</h3>
822  <ul class="this-page-menu">
823    <li><a href="../../../_sources/api/perspectives/fitting/fitting.txt"
824           rel="nofollow">Show Source</a></li>
825  </ul>
826<div id="searchbox" style="display: none">
827  <h3>Quick search</h3>
828    <form class="search" action="../../../search.html" method="get">
[30d3a1b]829      <input type="text" name="q" />
[5a9a98f]830      <input type="submit" value="Go" />
831      <input type="hidden" name="check_keywords" value="yes" />
832      <input type="hidden" name="area" value="default" />
833    </form>
834    <p class="searchtip" style="font-size: 90%">
835    Enter search terms or a module, class or function name.
836    </p>
837</div>
838<script type="text/javascript">$('#searchbox').show(0);</script>
839        </div>
840      </div>
841      <div class="clearer"></div>
842    </div>
843    <div class="related">
844      <h3>Navigation</h3>
845      <ul>
846        <li class="right" style="margin-right: 10px">
847          <a href="../../../genindex.html" title="General Index"
848             >index</a></li>
849        <li class="right" >
850          <a href="../../../py-modindex.html" title="Python Module Index"
851             >modules</a> |</li>
852        <li class="right" >
[30d3a1b]853          <a href="fitting_widgets.html" title="fitting_widgets"
[5a9a98f]854             >next</a> |</li>
855        <li class="right" >
856          <a href="fitproblem.html" title="fitproblem"
857             >previous</a> |</li>
[30d3a1b]858        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
[5a9a98f]859          <li><a href="index.html" >Reference</a> &raquo;</li> 
860      </ul>
861    </div>
862    <div class="footer">
863        &copy; Copyright 2010, sans group.
[30d3a1b]864      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[5a9a98f]865    </div>
866  </body>
867</html>
Note: See TracBrowser for help on using the repository browser.