source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/fitproblem.html @ 5a9a98f

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 5a9a98f was 5a9a98f, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 18.6 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
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>fitproblem &mdash; sansview 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="sansview 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="fitpanel" href="fitpanel.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="fitpanel.html" title="fitpanel"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../../../index.html">sansview 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="fitproblem">
57<h1>fitproblem<a class="headerlink" href="#fitproblem" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.perspectives.fitting.fitproblem">
59<span id="sans-perspectives-fitting-fitproblem"></span><h2><a class="reference internal" href="#module-sans.perspectives.fitting.fitproblem" title="sans.perspectives.fitting.fitproblem"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.fitproblem</span></tt></a><a class="headerlink" href="#module-sans.perspectives.fitting.fitproblem" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.perspectives.fitting.fitproblem.FitProblem">
62<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.fitproblem.</tt><tt class="descname">FitProblem</tt><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem" title="Permalink to this definition">¶</a></dt>
63<dd><p>FitProblem class allows to link a model with the new name created in _on_model,
64a name theory created with that model  and the data fitted with the model.
65FitProblem is mostly used  as value of the dictionary by fitting module.</p>
66<dl class="method">
67<dt id="sans.perspectives.fitting.fitproblem.FitProblem.clear_model_param">
68<tt class="descname">clear_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.clear_model_param" title="Permalink to this definition">¶</a></dt>
69<dd><p>clear constraint info</p>
70</dd></dl>
71
72<dl class="method">
73<dt id="sans.perspectives.fitting.fitproblem.FitProblem.clone">
74<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.clone" title="Permalink to this definition">¶</a></dt>
75<dd><p>copy fitproblem</p>
76</dd></dl>
77
78<dl class="method">
79<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_enable2D">
80<tt class="descname">get_enable2D</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_enable2D" title="Permalink to this definition">¶</a></dt>
81<dd></dd></dl>
82
83<dl class="method">
84<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_fit_data">
85<tt class="descname">get_fit_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_fit_data" title="Permalink to this definition">¶</a></dt>
86<dd></dd></dl>
87
88<dl class="method">
89<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_fit_data_list">
90<tt class="descname">get_fit_data_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_fit_data_list" title="Permalink to this definition">¶</a></dt>
91<dd></dd></dl>
92
93<dl class="method">
94<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_fit_tab_caption">
95<tt class="descname">get_fit_tab_caption</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_fit_tab_caption" title="Permalink to this definition">¶</a></dt>
96<dd></dd></dl>
97
98<dl class="method">
99<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_index">
100<tt class="descname">get_index</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_index" title="Permalink to this definition">¶</a></dt>
101<dd><p>get index of the model name</p>
102</dd></dl>
103
104<dl class="method">
105<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_model">
106<tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_model" title="Permalink to this definition">¶</a></dt>
107<dd><table class="docutils field-list" frame="void" rules="none">
108<col class="field-name" />
109<col class="field-body" />
110<tbody valign="top">
111<tr class="field"><th class="field-name">Returns:</th><td class="field-body">saved model</td>
112</tr>
113</tbody>
114</table>
115</dd></dl>
116
117<dl class="method">
118<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_model_param">
119<tt class="descname">get_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_model_param" title="Permalink to this definition">¶</a></dt>
120<dd><p>return list of couple of parameter name and value</p>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_name">
125<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_name" title="Permalink to this definition">¶</a></dt>
126<dd></dd></dl>
127
128<dl class="method">
129<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_pointer_to_fitproblem">
130<tt class="descname">get_pointer_to_fitproblem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_pointer_to_fitproblem" title="Permalink to this definition">¶</a></dt>
131<dd><p>return dictionary of id of fitproblem</p>
132</dd></dl>
133
134<dl class="method">
135<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_range">
136<tt class="descname">get_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_range" title="Permalink to this definition">¶</a></dt>
137<dd><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"><th class="field-name">Returns:</th><td class="field-body">fitting range</td>
142</tr>
143</tbody>
144</table>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_result">
149<tt class="descname">get_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_result" title="Permalink to this definition">¶</a></dt>
150<dd><p>get result</p>
151</dd></dl>
152
153<dl class="method">
154<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_scheduled">
155<tt class="descname">get_scheduled</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_scheduled" title="Permalink to this definition">¶</a></dt>
156<dd><p>return true or false if a problem as being schedule for fitting</p>
157</dd></dl>
158
159<dl class="method">
160<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_smearer">
161<tt class="descname">get_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_smearer" title="Permalink to this definition">¶</a></dt>
162<dd><p>return smear object</p>
163</dd></dl>
164
165<dl class="method">
166<dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_theory_data">
167<tt class="descname">get_theory_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_theory_data" title="Permalink to this definition">¶</a></dt>
168<dd><table class="docutils field-list" frame="void" rules="none">
169<col class="field-name" />
170<col class="field-body" />
171<tbody valign="top">
172<tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of data dList</td>
173</tr>
174</tbody>
175</table>
176</dd></dl>
177
178<dl class="method">
179<dt id="sans.perspectives.fitting.fitproblem.FitProblem.save_model_name">
180<tt class="descname">save_model_name</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.save_model_name" title="Permalink to this definition">¶</a></dt>
181<dd></dd></dl>
182
183<dl class="method">
184<dt id="sans.perspectives.fitting.fitproblem.FitProblem.schedule_tofit">
185<tt class="descname">schedule_tofit</tt><big>(</big><em>schedule=0</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.schedule_tofit" title="Permalink to this definition">¶</a></dt>
186<dd><p>set schedule to true to decide if this fit  must be performed</p>
187</dd></dl>
188
189<dl class="method">
190<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_enable2D">
191<tt class="descname">set_enable2D</tt><big>(</big><em>enable2D</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_enable2D" title="Permalink to this definition">¶</a></dt>
192<dd></dd></dl>
193
194<dl class="method">
195<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_fit_data">
196<tt class="descname">set_fit_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_fit_data" title="Permalink to this definition">¶</a></dt>
197<dd><p>save a copy of the data select to fit</p>
198<table class="docutils field-list" frame="void" rules="none">
199<col class="field-name" />
200<col class="field-body" />
201<tbody valign="top">
202<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; data selected</td>
203</tr>
204</tbody>
205</table>
206</dd></dl>
207
208<dl class="method">
209<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_fit_data_list">
210<tt class="descname">set_fit_data_list</tt><big>(</big><em>data_list</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_fit_data_list" title="Permalink to this definition">¶</a></dt>
211<dd><p>save a copy of a list of data</p>
212<table class="docutils field-list" frame="void" rules="none">
213<col class="field-name" />
214<col class="field-body" />
215<tbody valign="top">
216<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data_list</strong> &#8211; list of data</td>
217</tr>
218</tbody>
219</table>
220</dd></dl>
221
222<dl class="method">
223<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_fit_tab_caption">
224<tt class="descname">set_fit_tab_caption</tt><big>(</big><em>caption</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_fit_tab_caption" title="Permalink to this definition">¶</a></dt>
225<dd></dd></dl>
226
227<dl class="method">
228<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_index">
229<tt class="descname">set_index</tt><big>(</big><em>index</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_index" title="Permalink to this definition">¶</a></dt>
230<dd><p>set index of the model name</p>
231</dd></dl>
232
233<dl class="method">
234<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_model">
235<tt class="descname">set_model</tt><big>(</big><em>model</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_model" title="Permalink to this definition">¶</a></dt>
236<dd><p>associates each model with its new created name</p>
237<table class="docutils field-list" frame="void" rules="none">
238<col class="field-name" />
239<col class="field-body" />
240<tbody valign="top">
241<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
242<li><strong>model</strong> &#8211; model selected</li>
243<li><strong>name</strong> &#8211; name created for model</li>
244</ul>
245</td>
246</tr>
247</tbody>
248</table>
249</dd></dl>
250
251<dl class="method">
252<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_model_param">
253<tt class="descname">set_model_param</tt><big>(</big><em>name</em>, <em>value=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_model_param" title="Permalink to this definition">¶</a></dt>
254<dd><p>Store the name and value of a parameter of this fitproblem&#8217;s model</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>name</strong> &#8211; name of the given parameter</li>
261<li><strong>value</strong> &#8211; value of that parameter</li>
262</ul>
263</td>
264</tr>
265</tbody>
266</table>
267</dd></dl>
268
269<dl class="method">
270<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_pointer_to_fitproblem">
271<tt class="descname">set_pointer_to_fitproblem</tt><big>(</big><em>data_id</em>, <em>page_id</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_pointer_to_fitproblem" title="Permalink to this definition">¶</a></dt>
272<dd></dd></dl>
273
274<dl class="method">
275<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_range">
276<tt class="descname">set_range</tt><big>(</big><em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_range" title="Permalink to this definition">¶</a></dt>
277<dd><p>set fitting range</p>
278</dd></dl>
279
280<dl class="method">
281<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_result">
282<tt class="descname">set_result</tt><big>(</big><em>result</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_result" title="Permalink to this definition">¶</a></dt>
283<dd><p>set a list of result</p>
284</dd></dl>
285
286<dl class="method">
287<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_smearer">
288<tt class="descname">set_smearer</tt><big>(</big><em>smearer</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_smearer" title="Permalink to this definition">¶</a></dt>
289<dd><p>save reference of  smear object on fitdata</p>
290<table class="docutils field-list" frame="void" rules="none">
291<col class="field-name" />
292<col class="field-body" />
293<tbody valign="top">
294<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smear</strong> &#8211; smear object from DataLoader</td>
295</tr>
296</tbody>
297</table>
298</dd></dl>
299
300<dl class="method">
301<dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_theory_data">
302<tt class="descname">set_theory_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.set_theory_data" title="Permalink to this definition">¶</a></dt>
303<dd><p>save a copy of the data select to fit</p>
304<table class="docutils field-list" frame="void" rules="none">
305<col class="field-name" />
306<col class="field-body" />
307<tbody valign="top">
308<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; data selected</td>
309</tr>
310</tbody>
311</table>
312</dd></dl>
313
314</dd></dl>
315
316</div>
317</div>
318
319
320          </div>
321        </div>
322      </div>
323      <div class="sphinxsidebar">
324        <div class="sphinxsidebarwrapper">
325  <h3><a href="../../../index.html">Table Of Contents</a></h3>
326  <ul>
327<li><a class="reference internal" href="#">fitproblem</a><ul>
328<li><a class="reference internal" href="#module-sans.perspectives.fitting.fitproblem"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.fitproblem</span></tt></a></li>
329</ul>
330</li>
331</ul>
332
333  <h4>Previous topic</h4>
334  <p class="topless"><a href="fitpanel.html"
335                        title="previous chapter">fitpanel</a></p>
336  <h4>Next topic</h4>
337  <p class="topless"><a href="fitting.html"
338                        title="next chapter">fitting</a></p>
339  <h3>This Page</h3>
340  <ul class="this-page-menu">
341    <li><a href="../../../_sources/api/perspectives/fitting/fitproblem.txt"
342           rel="nofollow">Show Source</a></li>
343  </ul>
344<div id="searchbox" style="display: none">
345  <h3>Quick search</h3>
346    <form class="search" action="../../../search.html" method="get">
347      <input type="text" name="q" size="18" />
348      <input type="submit" value="Go" />
349      <input type="hidden" name="check_keywords" value="yes" />
350      <input type="hidden" name="area" value="default" />
351    </form>
352    <p class="searchtip" style="font-size: 90%">
353    Enter search terms or a module, class or function name.
354    </p>
355</div>
356<script type="text/javascript">$('#searchbox').show(0);</script>
357        </div>
358      </div>
359      <div class="clearer"></div>
360    </div>
361    <div class="related">
362      <h3>Navigation</h3>
363      <ul>
364        <li class="right" style="margin-right: 10px">
365          <a href="../../../genindex.html" title="General Index"
366             >index</a></li>
367        <li class="right" >
368          <a href="../../../py-modindex.html" title="Python Module Index"
369             >modules</a> |</li>
370        <li class="right" >
371          <a href="fitting.html" title="fitting"
372             >next</a> |</li>
373        <li class="right" >
374          <a href="fitpanel.html" title="fitpanel"
375             >previous</a> |</li>
376        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
377          <li><a href="index.html" >Reference</a> &raquo;</li> 
378      </ul>
379    </div>
380    <div class="footer">
381        &copy; Copyright 2010, sans group.
382      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
383    </div>
384  </body>
385</html>
Note: See TracBrowser for help on using the repository browser.