source: sasview/park_integration/docs/sphinx/_build/html/api/AbstractFitEngine.html @ d84a90c

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 d84a90c was aa36f96, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 35.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>AbstractFitEngine &mdash; park_integration 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="park_integration v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="Fitting" href="Fitting.html" />
28    <link rel="prev" title="Reference" href="index.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="Fitting.html" title="Fitting"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="index.html" title="Reference"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">park_integration 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="abstractfitengine">
57<h1>AbstractFitEngine<a class="headerlink" href="#abstractfitengine" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.fit.AbstractFitEngine">
59<span id="mod-sans-fit-abstractfitengine"></span><h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#module-sans.fit.AbstractFitEngine" title="Permalink to this headline">¶</a></h2>
60<dl class="exception">
61<dt id="sans.fit.AbstractFitEngine.FitAbort">
62<em class="property">exception </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitAbort</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
64<p>Exception raise to stop the fit</p>
65<dl class="attribute">
66<dt id="sans.fit.AbstractFitEngine.FitAbort.args">
67<tt class="descname">args</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.args" title="Permalink to this definition">¶</a></dt>
68<dd></dd></dl>
69
70<dl class="attribute">
71<dt id="sans.fit.AbstractFitEngine.FitAbort.message">
72<tt class="descname">message</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.message" title="Permalink to this definition">¶</a></dt>
73<dd>exception message</dd></dl>
74
75</dd></dl>
76
77<dl class="class">
78<dt id="sans.fit.AbstractFitEngine.FitArrange">
79<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitArrange</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange" title="Permalink to this definition">¶</a></dt>
80<dd><dl class="method">
81<dt id="sans.fit.AbstractFitEngine.FitArrange.add_data">
82<tt class="descname">add_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.add_data" title="Permalink to this definition">¶</a></dt>
83<dd><p>add_data fill a self.dList with data to fit</p>
84<table class="docutils field-list" frame="void" rules="none">
85<col class="field-name" />
86<col class="field-body" />
87<tbody valign="top">
88<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
89<li><strong>data</strong> &#8211; Data to add in the list</li>
90</ul>
91</td>
92</tr>
93</tbody>
94</table>
95</dd></dl>
96
97<dl class="method">
98<dt id="sans.fit.AbstractFitEngine.FitArrange.get_data">
99<tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_data" title="Permalink to this definition">¶</a></dt>
100<dd><table class="docutils field-list" frame="void" rules="none">
101<col class="field-name" />
102<col class="field-body" />
103<tbody valign="top">
104<tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of data dList</td>
105</tr>
106</tbody>
107</table>
108</dd></dl>
109
110<dl class="method">
111<dt id="sans.fit.AbstractFitEngine.FitArrange.get_model">
112<tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_model" title="Permalink to this definition">¶</a></dt>
113<dd><table class="docutils field-list" frame="void" rules="none">
114<col class="field-name" />
115<col class="field-body" />
116<tbody valign="top">
117<tr class="field"><th class="field-name">Returns:</th><td class="field-body">saved model</td>
118</tr>
119</tbody>
120</table>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.fit.AbstractFitEngine.FitArrange.get_to_fit">
125<tt class="descname">get_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_to_fit" title="Permalink to this definition">¶</a></dt>
126<dd>return self.selected value</dd></dl>
127
128<dl class="method">
129<dt id="sans.fit.AbstractFitEngine.FitArrange.remove_data">
130<tt class="descname">remove_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.remove_data" title="Permalink to this definition">¶</a></dt>
131<dd><p>Remove one element from the list</p>
132<table class="docutils field-list" frame="void" rules="none">
133<col class="field-name" />
134<col class="field-body" />
135<tbody valign="top">
136<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
137<li><strong>data</strong> &#8211; Data to remove from dList</li>
138</ul>
139</td>
140</tr>
141</tbody>
142</table>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.fit.AbstractFitEngine.FitArrange.set_model">
147<tt class="descname">set_model</tt><big>(</big><em>model</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_model" title="Permalink to this definition">¶</a></dt>
148<dd><p>set_model save a copy of the model</p>
149<table class="docutils field-list" frame="void" rules="none">
150<col class="field-name" />
151<col class="field-body" />
152<tbody valign="top">
153<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
154<li><strong>model</strong> &#8211; the model being set</li>
155</ul>
156</td>
157</tr>
158</tbody>
159</table>
160</dd></dl>
161
162<dl class="method">
163<dt id="sans.fit.AbstractFitEngine.FitArrange.set_to_fit">
164<tt class="descname">set_to_fit</tt><big>(</big><em>value=0</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_to_fit" title="Permalink to this definition">¶</a></dt>
165<dd><p>set self.selected to 0 or 1  for other values raise an exception</p>
166<table class="docutils field-list" frame="void" rules="none">
167<col class="field-name" />
168<col class="field-body" />
169<tbody valign="top">
170<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
171<li><strong>value</strong> &#8211; integer between 0 or 1</li>
172</ul>
173</td>
174</tr>
175</tbody>
176</table>
177</dd></dl>
178
179</dd></dl>
180
181<dl class="class">
182<dt id="sans.fit.AbstractFitEngine.FitData1D">
183<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>smearer=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D" title="Permalink to this definition">¶</a></dt>
184<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.Data1D</span></tt></p>
185<p>Wrapper class  for SANS data
186FitData1D inherits from DataLoader.data_info.Data1D. Implements
187a way to get residuals from data.</p>
188<dl class="method">
189<dt id="sans.fit.AbstractFitEngine.FitData1D.clone_without_data">
190<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.clone_without_data" title="Permalink to this definition">¶</a></dt>
191<dd><p>Clone the current object, without copying the data (which
192will be filled out by a subsequent operation).
193The data arrays will be initialized to zero.</p>
194<table class="docutils field-list" frame="void" rules="none">
195<col class="field-name" />
196<col class="field-body" />
197<tbody valign="top">
198<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
199<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
200<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
201</ul>
202</td>
203</tr>
204</tbody>
205</table>
206</dd></dl>
207
208<dl class="method">
209<dt id="sans.fit.AbstractFitEngine.FitData1D.getFitRange">
210<tt class="descname">getFitRange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.getFitRange" title="Permalink to this definition">¶</a></dt>
211<dd>return the range of data.x to fit</dd></dl>
212
213<dl class="method">
214<dt id="sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared">
215<tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt>
216<dd><p>Check whether the data has slit smearing information</p>
217<table class="docutils field-list" frame="void" rules="none">
218<col class="field-name" />
219<col class="field-body" />
220<tbody valign="top">
221<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td>
222</tr>
223</tbody>
224</table>
225</dd></dl>
226
227<dl class="method">
228<dt id="sans.fit.AbstractFitEngine.FitData1D.residuals">
229<tt class="descname">residuals</tt><big>(</big><em>fn</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals" title="Permalink to this definition">¶</a></dt>
230<dd><p>Compute residuals.</p>
231<p>If self.smearer has been set, use if to smear
232the data before computing chi squared.</p>
233<table class="docutils field-list" frame="void" rules="none">
234<col class="field-name" />
235<col class="field-body" />
236<tbody valign="top">
237<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
238<li><strong>fn</strong> &#8211; function that return model value</li>
239</ul>
240</td>
241</tr>
242<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">residuals</p>
243</td>
244</tr>
245</tbody>
246</table>
247</dd></dl>
248
249<dl class="method">
250<dt id="sans.fit.AbstractFitEngine.FitData1D.residuals_deriv">
251<tt class="descname">residuals_deriv</tt><big>(</big><em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv" title="Permalink to this definition">¶</a></dt>
252<dd><table class="docutils field-list" frame="void" rules="none">
253<col class="field-name" />
254<col class="field-body" />
255<tbody valign="top">
256<tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td>
257</tr>
258<tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td>
259</tr>
260</tbody>
261</table>
262</dd></dl>
263
264<dl class="method">
265<dt id="sans.fit.AbstractFitEngine.FitData1D.setFitRange">
266<tt class="descname">setFitRange</tt><big>(</big><em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.setFitRange" title="Permalink to this definition">¶</a></dt>
267<dd>to set the fit range</dd></dl>
268
269<dl class="method">
270<dt id="sans.fit.AbstractFitEngine.FitData1D.xaxis">
271<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.xaxis" title="Permalink to this definition">¶</a></dt>
272<dd></dd></dl>
273
274<dl class="method">
275<dt id="sans.fit.AbstractFitEngine.FitData1D.yaxis">
276<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.yaxis" title="Permalink to this definition">¶</a></dt>
277<dd></dd></dl>
278
279</dd></dl>
280
281<dl class="class">
282<dt id="sans.fit.AbstractFitEngine.FitData2D">
283<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData2D</tt><big>(</big><em>sans_data2d</em>, <em>data=None</em>, <em>err_data=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D" title="Permalink to this definition">¶</a></dt>
284<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.Data2D</span></tt></p>
285<p>Wrapper class  for SANS data</p>
286<dl class="method">
287<dt id="sans.fit.AbstractFitEngine.FitData2D.clone_without_data">
288<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.clone_without_data" title="Permalink to this definition">¶</a></dt>
289<dd><p>Clone the current object, without copying the data (which
290will be filled out by a subsequent operation).
291The data arrays will be initialized to zero.</p>
292<table class="docutils field-list" frame="void" rules="none">
293<col class="field-name" />
294<col class="field-body" />
295<tbody valign="top">
296<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
297<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
298<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
299</ul>
300</td>
301</tr>
302</tbody>
303</table>
304</dd></dl>
305
306<dl class="method">
307<dt id="sans.fit.AbstractFitEngine.FitData2D.getFitRange">
308<tt class="descname">getFitRange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.getFitRange" title="Permalink to this definition">¶</a></dt>
309<dd>return the range of data.x to fit</dd></dl>
310
311<dl class="method">
312<dt id="sans.fit.AbstractFitEngine.FitData2D.residuals">
313<tt class="descname">residuals</tt><big>(</big><em>fn</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals" title="Permalink to this definition">¶</a></dt>
314<dd>return the residuals</dd></dl>
315
316<dl class="method">
317<dt id="sans.fit.AbstractFitEngine.FitData2D.residuals_deriv">
318<tt class="descname">residuals_deriv</tt><big>(</big><em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv" title="Permalink to this definition">¶</a></dt>
319<dd><table class="docutils field-list" frame="void" rules="none">
320<col class="field-name" />
321<col class="field-body" />
322<tbody valign="top">
323<tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td>
324</tr>
325<tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td>
326</tr>
327</tbody>
328</table>
329</dd></dl>
330
331<dl class="method">
332<dt id="sans.fit.AbstractFitEngine.FitData2D.setFitRange">
333<tt class="descname">setFitRange</tt><big>(</big><em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.setFitRange" title="Permalink to this definition">¶</a></dt>
334<dd>to set the fit range</dd></dl>
335
336<dl class="method">
337<dt id="sans.fit.AbstractFitEngine.FitData2D.set_data">
338<tt class="descname">set_data</tt><big>(</big><em>sans_data2d</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_data" title="Permalink to this definition">¶</a></dt>
339<dd>Determine the correct qx_data and qy_data within range to fit</dd></dl>
340
341<dl class="method">
342<dt id="sans.fit.AbstractFitEngine.FitData2D.set_smearer">
343<tt class="descname">set_smearer</tt><big>(</big><em>smearer</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_smearer" title="Permalink to this definition">¶</a></dt>
344<dd>Set smearer</dd></dl>
345
346<dl class="method">
347<dt id="sans.fit.AbstractFitEngine.FitData2D.xaxis">
348<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xaxis" title="Permalink to this definition">¶</a></dt>
349<dd></dd></dl>
350
351<dl class="method">
352<dt id="sans.fit.AbstractFitEngine.FitData2D.yaxis">
353<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.yaxis" title="Permalink to this definition">¶</a></dt>
354<dd></dd></dl>
355
356<dl class="method">
357<dt id="sans.fit.AbstractFitEngine.FitData2D.zaxis">
358<tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.zaxis" title="Permalink to this definition">¶</a></dt>
359<dd></dd></dl>
360
361</dd></dl>
362
363<dl class="class">
364<dt id="sans.fit.AbstractFitEngine.FitEngine">
365<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitEngine</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine" title="Permalink to this definition">¶</a></dt>
366<dd><dl class="method">
367<dt id="sans.fit.AbstractFitEngine.FitEngine.get_model">
368<tt class="descname">get_model</tt><big>(</big><em>Uid</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_model" title="Permalink to this definition">¶</a></dt>
369<dd><table class="docutils field-list" frame="void" rules="none">
370<col class="field-name" />
371<col class="field-body" />
372<tbody valign="top">
373<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
374<li><strong>Uid</strong> &#8211; Uid is key in the dictionary containing the model to return</li>
375</ul>
376</td>
377</tr>
378<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a model at this uid or None if no FitArrange element was created
379with this Uid</p>
380</td>
381</tr>
382</tbody>
383</table>
384</dd></dl>
385
386<dl class="method">
387<dt id="sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit">
388<tt class="descname">get_problem_to_fit</tt><big>(</big><em>Uid</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit" title="Permalink to this definition">¶</a></dt>
389<dd><p>return the self.selected value of the fit problem of Uid</p>
390<table class="docutils field-list" frame="void" rules="none">
391<col class="field-name" />
392<col class="field-body" />
393<tbody valign="top">
394<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
395<li><strong>Uid</strong> &#8211; the Uid of the problem</li>
396</ul>
397</td>
398</tr>
399</tbody>
400</table>
401</dd></dl>
402
403<dl class="method">
404<dt id="sans.fit.AbstractFitEngine.FitEngine.remove_Fit_Problem">
405<tt class="descname">remove_Fit_Problem</tt><big>(</big><em>Uid</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.remove_Fit_Problem" title="Permalink to this definition">¶</a></dt>
406<dd>remove   fitarrange in Uid</dd></dl>
407
408<dl class="method">
409<dt id="sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit">
410<tt class="descname">select_problem_for_fit</tt><big>(</big><em>Uid</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit" title="Permalink to this definition">¶</a></dt>
411<dd><p>select a couple of model and data at the Uid position in dictionary
412and set in self.selected value to value</p>
413<table class="docutils field-list" frame="void" rules="none">
414<col class="field-name" />
415<col class="field-body" />
416<tbody valign="top">
417<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
418<li><strong>value</strong> &#8211; the value to allow fitting.
419can only have the value one or zero</li>
420</ul>
421</td>
422</tr>
423</tbody>
424</table>
425</dd></dl>
426
427<dl class="method">
428<dt id="sans.fit.AbstractFitEngine.FitEngine.set_data">
429<tt class="descname">set_data</tt><big>(</big><em>data</em>, <em>Uid</em>, <em>smearer=None</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_data" title="Permalink to this definition">¶</a></dt>
430<dd><p>Receives plottable, creates a list of data to fit,set data
431in a FitArrange object and adds that object in a dictionary
432with key Uid.</p>
433<table class="docutils field-list" frame="void" rules="none">
434<col class="field-name" />
435<col class="field-body" />
436<tbody valign="top">
437<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
438<li><strong>data</strong> &#8211; data added</li>
439<li><strong>Uid</strong> &#8211; unique key corresponding to a fitArrange object with data</li>
440</ul>
441</td>
442</tr>
443</tbody>
444</table>
445</dd></dl>
446
447<dl class="method">
448<dt id="sans.fit.AbstractFitEngine.FitEngine.set_model">
449<tt class="descname">set_model</tt><big>(</big><em>model</em>, <em>Uid</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span>, <em>constraints=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_model" title="Permalink to this definition">¶</a></dt>
450<dd><p>set a model on a given uid in the fit engine.</p>
451<table class="docutils field-list" frame="void" rules="none">
452<col class="field-name" />
453<col class="field-body" />
454<tbody valign="top">
455<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
456<li><strong>model</strong> &#8211; sans.models type</li>
457<li><strong>Uid</strong> &#8211; is the key of the fitArrange dictionary where model is
458saved as a value</li>
459<li><strong>pars</strong> &#8211; the list of parameters to fit</li>
460<li><strong>constraints</strong> &#8211; <p>list of
461tuple (name of parameter, value of parameters)
462the value of parameter must be a string to constraint 2 different
463parameters.
464Example: 
465we want to fit 2 model M1 and M2 both have parameters A and B.
466constraints can be:</p>
467<blockquote>
468constraints = [(M1.A, M2.B+2), (M1.B= M2.A <a href="#id1"><span class="problematic" id="id2">*</span></a>5),...,]</blockquote>
469</li>
470</ul>
471</td>
472</tr>
473<tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">pars must contains only name of existing model&#8217;s parameters</p>
474</td>
475</tr>
476</tbody>
477</table>
478</dd></dl>
479
480</dd></dl>
481
482<dl class="class">
483<dt id="sans.fit.AbstractFitEngine.Model">
484<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">Model</tt><big>(</big><em>sans_model</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model" title="Permalink to this definition">¶</a></dt>
485<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.model.Model</span></tt></p>
486<p>PARK wrapper for SANS models.</p>
487<dl class="method">
488<dt id="sans.fit.AbstractFitEngine.Model.eval">
489<tt class="descname">eval</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval" title="Permalink to this definition">¶</a></dt>
490<dd><p>override eval method of park model.</p>
491<table class="docutils field-list" frame="void" rules="none">
492<col class="field-name" />
493<col class="field-body" />
494<tbody valign="top">
495<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
496<li><strong>x</strong> &#8211; the x value used to compute a function</li>
497</ul>
498</td>
499</tr>
500</tbody>
501</table>
502</dd></dl>
503
504<dl class="method">
505<dt id="sans.fit.AbstractFitEngine.Model.eval_derivs">
506<tt class="descname">eval_derivs</tt><big>(</big><em>x</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval_derivs" title="Permalink to this definition">¶</a></dt>
507<dd><p>Evaluate the model and derivatives wrt pars at x.</p>
508<p>pars is a list of the names of the parameters for which derivatives
509are desired.</p>
510<p>This method needs to be specialized in the model to evaluate the
511model function.  Alternatively, the model can implement is own
512version of residuals which calculates the residuals directly
513instead of calling eval.</p>
514</dd></dl>
515
516<dl class="method">
517<dt id="sans.fit.AbstractFitEngine.Model.getParams">
518<tt class="descname">getParams</tt><big>(</big><em>fitparams</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.getParams" title="Permalink to this definition">¶</a></dt>
519<dd><p>return a list of value of paramter to fit</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">
524<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
525<li><strong>fitparams</strong> &#8211; list of paramaters name to fit</li>
526</ul>
527</td>
528</tr>
529</tbody>
530</table>
531</dd></dl>
532
533<dl class="method">
534<dt id="sans.fit.AbstractFitEngine.Model.set">
535<tt class="descname">set</tt><big>(</big><em>**kw</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set" title="Permalink to this definition">¶</a></dt>
536<dd><p>Set the initial value for a set of parameters.</p>
537<p>E.g., model.set(width=3,center=5)</p>
538</dd></dl>
539
540<dl class="method">
541<dt id="sans.fit.AbstractFitEngine.Model.setParams">
542<tt class="descname">setParams</tt><big>(</big><em>paramlist</em>, <em>params</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.setParams" title="Permalink to this definition">¶</a></dt>
543<dd><p>Set value for parameters to fit</p>
544<table class="docutils field-list" frame="void" rules="none">
545<col class="field-name" />
546<col class="field-body" />
547<tbody valign="top">
548<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
549<li><strong>params</strong> &#8211; list of value for parameters to fit</li>
550</ul>
551</td>
552</tr>
553</tbody>
554</table>
555</dd></dl>
556
557</dd></dl>
558
559<dl class="class">
560<dt id="sans.fit.AbstractFitEngine.SansAssembly">
561<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansAssembly</tt><big>(</big><em>paramlist</em>, <em>model=None</em>, <em>data=None</em>, <em>fitresult=None</em>, <em>handler=None</em>, <em>curr_thread=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly" title="Permalink to this definition">¶</a></dt>
562<dd><p>Sans Assembly class a class wrapper to be call in optimizer.leastsq method</p>
563<dl class="method">
564<dt id="sans.fit.AbstractFitEngine.SansAssembly.chisq">
565<tt class="descname">chisq</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.chisq" title="Permalink to this definition">¶</a></dt>
566<dd><p>Calculates chi^2</p>
567<table class="docutils field-list" frame="void" rules="none">
568<col class="field-name" />
569<col class="field-body" />
570<tbody valign="top">
571<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
572<li><strong>params</strong> &#8211; list of parameter values</li>
573</ul>
574</td>
575</tr>
576<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">chi^2</p>
577</td>
578</tr>
579</tbody>
580</table>
581</dd></dl>
582
583</dd></dl>
584
585<dl class="class">
586<dt id="sans.fit.AbstractFitEngine.SansParameter">
587<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansParameter</tt><big>(</big><em>name</em>, <em>model</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter" title="Permalink to this definition">¶</a></dt>
588<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.parameter.Parameter</span></tt></p>
589<p>SANS model parameters for use in the PARK fitting service.
590The parameter attribute value is redirected to the underlying
591parameter value in the SANS model.</p>
592<dl class="method">
593<dt id="sans.fit.AbstractFitEngine.SansParameter.get">
594<tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.get" title="Permalink to this definition">¶</a></dt>
595<dd>Return the current value for a parameter.</dd></dl>
596
597<dl class="method">
598<dt id="sans.fit.AbstractFitEngine.SansParameter.iscomputed">
599<tt class="descname">iscomputed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.iscomputed" title="Permalink to this definition">¶</a></dt>
600<dd></dd></dl>
601
602<dl class="method">
603<dt id="sans.fit.AbstractFitEngine.SansParameter.isfeasible">
604<tt class="descname">isfeasible</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfeasible" title="Permalink to this definition">¶</a></dt>
605<dd>Return true if the value is in the range</dd></dl>
606
607<dl class="method">
608<dt id="sans.fit.AbstractFitEngine.SansParameter.isfitted">
609<tt class="descname">isfitted</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfitted" title="Permalink to this definition">¶</a></dt>
610<dd></dd></dl>
611
612<dl class="method">
613<dt id="sans.fit.AbstractFitEngine.SansParameter.isfixed">
614<tt class="descname">isfixed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfixed" title="Permalink to this definition">¶</a></dt>
615<dd></dd></dl>
616
617<dl class="method">
618<dt id="sans.fit.AbstractFitEngine.SansParameter.isrestrained">
619<tt class="descname">isrestrained</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isrestrained" title="Permalink to this definition">¶</a></dt>
620<dd></dd></dl>
621
622<dl class="attribute">
623<dt id="sans.fit.AbstractFitEngine.SansParameter.name">
624<tt class="descname">name</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.name" title="Permalink to this definition">¶</a></dt>
625<dd>parameter name</dd></dl>
626
627<dl class="attribute">
628<dt id="sans.fit.AbstractFitEngine.SansParameter.range">
629<tt class="descname">range</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.range" title="Permalink to this definition">¶</a></dt>
630<dd>Override _getrange of park parameter
631return the range of parameter</dd></dl>
632
633<dl class="method">
634<dt id="sans.fit.AbstractFitEngine.SansParameter.set">
635<tt class="descname">set</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.set" title="Permalink to this definition">¶</a></dt>
636<dd><p>Set a parameter to a value, a range or an expression.  If it is a value,
637the parameter will be fixed for the fit.  If it is a range, the value
638will be varying for the fit.  If it is an expression, the parameter will
639be calculated from the values of other parameters in the fit.</p>
640<p>Raises ValueError if the value could not be interpreted.</p>
641</dd></dl>
642
643<dl class="method">
644<dt id="sans.fit.AbstractFitEngine.SansParameter.setprefix">
645<tt class="descname">setprefix</tt><big>(</big><em>prefix</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.setprefix" title="Permalink to this definition">¶</a></dt>
646<dd>Set the full path to the parameter as used in expressions involving
647the parameter name.</dd></dl>
648
649<dl class="method">
650<dt id="sans.fit.AbstractFitEngine.SansParameter.summarize">
651<tt class="descname">summarize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.summarize" title="Permalink to this definition">¶</a></dt>
652<dd><p>Return parameter range string.</p>
653<p>E.g.,  &#8221;       Gold .....|.... 5.2043 in [2,7]&#8221;</p>
654</dd></dl>
655
656<dl class="attribute">
657<dt id="sans.fit.AbstractFitEngine.SansParameter.value">
658<tt class="descname">value</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.value" title="Permalink to this definition">¶</a></dt>
659<dd><p>override the _getvalue of park parameter</p>
660<p>:return value the parameter associates with self.name</p>
661</dd></dl>
662
663</dd></dl>
664
665</div>
666</div>
667
668
669          </div>
670        </div>
671      </div>
672      <div class="sphinxsidebar">
673        <div class="sphinxsidebarwrapper">
674  <h3><a href="../index.html">Table Of Contents</a></h3>
675  <ul>
676<li><a class="reference internal" href="#">AbstractFitEngine</a><ul>
677<li><a class="reference internal" href="#module-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li>
678</ul>
679</li>
680</ul>
681
682  <h4>Previous topic</h4>
683  <p class="topless"><a href="index.html"
684                        title="previous chapter">Reference</a></p>
685  <h4>Next topic</h4>
686  <p class="topless"><a href="Fitting.html"
687                        title="next chapter">Fitting</a></p>
688  <h3>This Page</h3>
689  <ul class="this-page-menu">
690    <li><a href="../_sources/api/AbstractFitEngine.txt"
691           rel="nofollow">Show Source</a></li>
692  </ul>
693<div id="searchbox" style="display: none">
694  <h3>Quick search</h3>
695    <form class="search" action="../search.html" method="get">
696      <input type="text" name="q" size="18" />
697      <input type="submit" value="Go" />
698      <input type="hidden" name="check_keywords" value="yes" />
699      <input type="hidden" name="area" value="default" />
700    </form>
701    <p class="searchtip" style="font-size: 90%">
702    Enter search terms or a module, class or function name.
703    </p>
704</div>
705<script type="text/javascript">$('#searchbox').show(0);</script>
706        </div>
707      </div>
708      <div class="clearer"></div>
709    </div>
710    <div class="related">
711      <h3>Navigation</h3>
712      <ul>
713        <li class="right" style="margin-right: 10px">
714          <a href="../genindex.html" title="General Index"
715             >index</a></li>
716        <li class="right" >
717          <a href="../py-modindex.html" title="Python Module Index"
718             >modules</a> |</li>
719        <li class="right" >
720          <a href="Fitting.html" title="Fitting"
721             >next</a> |</li>
722        <li class="right" >
723          <a href="index.html" title="Reference"
724             >previous</a> |</li>
725        <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li>
726          <li><a href="index.html" >Reference</a> &raquo;</li> 
727      </ul>
728    </div>
729    <div class="footer">
730        &copy; Copyright 2010, sans group.
731      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
732    </div>
733  </body>
734</html>
Note: See TracBrowser for help on using the repository browser.