[5062bbf] | 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 — 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> »</li> |
---|
| 47 | <li><a href="index.html" accesskey="U">Reference</a> »</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"><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, |
---|
| 64 | a name theory created with that model and the data fitted with the model. |
---|
| 65 | FitProblem is mostly used as value of the dictionary by fitting module.</p> |
---|
| 66 | <dl class="method"> |
---|
| 67 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.add_fit_data"> |
---|
| 68 | <tt class="descname">add_fit_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.add_fit_data" title="Permalink to this definition">¶</a></dt> |
---|
| 69 | <dd><p>save a copy of the data select to fit</p> |
---|
| 70 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 71 | <col class="field-name" /> |
---|
| 72 | <col class="field-body" /> |
---|
| 73 | <tbody valign="top"> |
---|
| 74 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 75 | <li><strong>data</strong> – data selected</li> |
---|
| 76 | </ul> |
---|
| 77 | </td> |
---|
| 78 | </tr> |
---|
| 79 | </tbody> |
---|
| 80 | </table> |
---|
| 81 | </dd></dl> |
---|
| 82 | |
---|
| 83 | <dl class="method"> |
---|
| 84 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.add_plotted_data"> |
---|
| 85 | <tt class="descname">add_plotted_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.add_plotted_data" title="Permalink to this definition">¶</a></dt> |
---|
| 86 | <dd><p>save a copy of the data select to fit</p> |
---|
| 87 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 88 | <col class="field-name" /> |
---|
| 89 | <col class="field-body" /> |
---|
| 90 | <tbody valign="top"> |
---|
| 91 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 92 | <li><strong>data</strong> – data selected</li> |
---|
| 93 | </ul> |
---|
| 94 | </td> |
---|
| 95 | </tr> |
---|
| 96 | </tbody> |
---|
| 97 | </table> |
---|
| 98 | </dd></dl> |
---|
| 99 | |
---|
| 100 | <dl class="method"> |
---|
| 101 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.clear_model_param"> |
---|
| 102 | <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> |
---|
| 103 | <dd>clear constraint info</dd></dl> |
---|
| 104 | |
---|
| 105 | <dl class="method"> |
---|
| 106 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.clone"> |
---|
| 107 | <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> |
---|
| 108 | <dd>copy fitproblem</dd></dl> |
---|
| 109 | |
---|
| 110 | <dl class="method"> |
---|
| 111 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_fit_data"> |
---|
| 112 | <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> |
---|
| 113 | <dd></dd></dl> |
---|
| 114 | |
---|
| 115 | <dl class="method"> |
---|
| 116 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_index"> |
---|
| 117 | <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> |
---|
| 118 | <dd>get index of the model name</dd></dl> |
---|
| 119 | |
---|
| 120 | <dl class="method"> |
---|
| 121 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_model"> |
---|
| 122 | <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> |
---|
| 123 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 124 | <col class="field-name" /> |
---|
| 125 | <col class="field-body" /> |
---|
| 126 | <tbody valign="top"> |
---|
| 127 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body">saved model</td> |
---|
| 128 | </tr> |
---|
| 129 | </tbody> |
---|
| 130 | </table> |
---|
| 131 | </dd></dl> |
---|
| 132 | |
---|
| 133 | <dl class="method"> |
---|
| 134 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_model_param"> |
---|
| 135 | <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> |
---|
| 136 | <dd>return list of couple of parameter name and value</dd></dl> |
---|
| 137 | |
---|
| 138 | <dl class="method"> |
---|
| 139 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_name"> |
---|
| 140 | <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> |
---|
| 141 | <dd></dd></dl> |
---|
| 142 | |
---|
| 143 | <dl class="method"> |
---|
| 144 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_plotted_data"> |
---|
| 145 | <tt class="descname">get_plotted_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitproblem.FitProblem.get_plotted_data" title="Permalink to this definition">¶</a></dt> |
---|
| 146 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 147 | <col class="field-name" /> |
---|
| 148 | <col class="field-body" /> |
---|
| 149 | <tbody valign="top"> |
---|
| 150 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of data dList</td> |
---|
| 151 | </tr> |
---|
| 152 | </tbody> |
---|
| 153 | </table> |
---|
| 154 | </dd></dl> |
---|
| 155 | |
---|
| 156 | <dl class="method"> |
---|
| 157 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_range"> |
---|
| 158 | <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> |
---|
| 159 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 160 | <col class="field-name" /> |
---|
| 161 | <col class="field-body" /> |
---|
| 162 | <tbody valign="top"> |
---|
| 163 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body">fitting range</td> |
---|
| 164 | </tr> |
---|
| 165 | </tbody> |
---|
| 166 | </table> |
---|
| 167 | </dd></dl> |
---|
| 168 | |
---|
| 169 | <dl class="method"> |
---|
| 170 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_scheduled"> |
---|
| 171 | <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> |
---|
| 172 | <dd>return true or false if a problem as being schedule for fitting</dd></dl> |
---|
| 173 | |
---|
| 174 | <dl class="method"> |
---|
| 175 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.get_smearer"> |
---|
| 176 | <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> |
---|
| 177 | <dd>return smear object</dd></dl> |
---|
| 178 | |
---|
| 179 | <dl class="method"> |
---|
| 180 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.save_model_name"> |
---|
| 181 | <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> |
---|
| 182 | <dd></dd></dl> |
---|
| 183 | |
---|
| 184 | <dl class="method"> |
---|
| 185 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.schedule_tofit"> |
---|
| 186 | <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> |
---|
| 187 | <dd>set schedule to true to decide if this fit must be performed</dd></dl> |
---|
| 188 | |
---|
| 189 | <dl class="method"> |
---|
| 190 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_index"> |
---|
| 191 | <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> |
---|
| 192 | <dd>set index of the model name</dd></dl> |
---|
| 193 | |
---|
| 194 | <dl class="method"> |
---|
| 195 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_model"> |
---|
| 196 | <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> |
---|
| 197 | <dd><p>associates each model with its new created name</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"><ul class="first last simple"> |
---|
| 203 | <li><strong>model</strong> – model selected</li> |
---|
| 204 | <li><strong>name</strong> – name created for model</li> |
---|
| 205 | </ul> |
---|
| 206 | </td> |
---|
| 207 | </tr> |
---|
| 208 | </tbody> |
---|
| 209 | </table> |
---|
| 210 | </dd></dl> |
---|
| 211 | |
---|
| 212 | <dl class="method"> |
---|
| 213 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_model_param"> |
---|
| 214 | <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> |
---|
| 215 | <dd><p>Store the name and value of a parameter of this fitproblem’s model</p> |
---|
| 216 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 217 | <col class="field-name" /> |
---|
| 218 | <col class="field-body" /> |
---|
| 219 | <tbody valign="top"> |
---|
| 220 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 221 | <li><strong>name</strong> – name of the given parameter</li> |
---|
| 222 | <li><strong>value</strong> – value of that parameter</li> |
---|
| 223 | </ul> |
---|
| 224 | </td> |
---|
| 225 | </tr> |
---|
| 226 | </tbody> |
---|
| 227 | </table> |
---|
| 228 | </dd></dl> |
---|
| 229 | |
---|
| 230 | <dl class="method"> |
---|
| 231 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_range"> |
---|
| 232 | <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> |
---|
| 233 | <dd>set fitting range</dd></dl> |
---|
| 234 | |
---|
| 235 | <dl class="method"> |
---|
| 236 | <dt id="sans.perspectives.fitting.fitproblem.FitProblem.set_smearer"> |
---|
| 237 | <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> |
---|
| 238 | <dd><p>save reference of smear object on fitdata</p> |
---|
| 239 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 240 | <col class="field-name" /> |
---|
| 241 | <col class="field-body" /> |
---|
| 242 | <tbody valign="top"> |
---|
| 243 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 244 | <li><strong>smear</strong> – smear object from DataLoader</li> |
---|
| 245 | </ul> |
---|
| 246 | </td> |
---|
| 247 | </tr> |
---|
| 248 | </tbody> |
---|
| 249 | </table> |
---|
| 250 | </dd></dl> |
---|
| 251 | |
---|
| 252 | </dd></dl> |
---|
| 253 | |
---|
| 254 | </div> |
---|
| 255 | </div> |
---|
| 256 | |
---|
| 257 | |
---|
| 258 | </div> |
---|
| 259 | </div> |
---|
| 260 | </div> |
---|
| 261 | <div class="sphinxsidebar"> |
---|
| 262 | <div class="sphinxsidebarwrapper"> |
---|
| 263 | <h3><a href="../../../index.html">Table Of Contents</a></h3> |
---|
| 264 | <ul> |
---|
| 265 | <li><a class="reference internal" href="#">fitproblem</a><ul> |
---|
| 266 | <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> |
---|
| 267 | </ul> |
---|
| 268 | </li> |
---|
| 269 | </ul> |
---|
| 270 | |
---|
| 271 | <h4>Previous topic</h4> |
---|
| 272 | <p class="topless"><a href="fitpanel.html" |
---|
| 273 | title="previous chapter">fitpanel</a></p> |
---|
| 274 | <h4>Next topic</h4> |
---|
| 275 | <p class="topless"><a href="fitting.html" |
---|
| 276 | title="next chapter">fitting</a></p> |
---|
| 277 | <h3>This Page</h3> |
---|
| 278 | <ul class="this-page-menu"> |
---|
| 279 | <li><a href="../../../_sources/api/perspectives/fitting/fitproblem.txt" |
---|
| 280 | rel="nofollow">Show Source</a></li> |
---|
| 281 | </ul> |
---|
| 282 | <div id="searchbox" style="display: none"> |
---|
| 283 | <h3>Quick search</h3> |
---|
| 284 | <form class="search" action="../../../search.html" method="get"> |
---|
| 285 | <input type="text" name="q" size="18" /> |
---|
| 286 | <input type="submit" value="Go" /> |
---|
| 287 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 288 | <input type="hidden" name="area" value="default" /> |
---|
| 289 | </form> |
---|
| 290 | <p class="searchtip" style="font-size: 90%"> |
---|
| 291 | Enter search terms or a module, class or function name. |
---|
| 292 | </p> |
---|
| 293 | </div> |
---|
| 294 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 295 | </div> |
---|
| 296 | </div> |
---|
| 297 | <div class="clearer"></div> |
---|
| 298 | </div> |
---|
| 299 | <div class="related"> |
---|
| 300 | <h3>Navigation</h3> |
---|
| 301 | <ul> |
---|
| 302 | <li class="right" style="margin-right: 10px"> |
---|
| 303 | <a href="../../../genindex.html" title="General Index" |
---|
| 304 | >index</a></li> |
---|
| 305 | <li class="right" > |
---|
| 306 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 307 | >modules</a> |</li> |
---|
| 308 | <li class="right" > |
---|
| 309 | <a href="fitting.html" title="fitting" |
---|
| 310 | >next</a> |</li> |
---|
| 311 | <li class="right" > |
---|
| 312 | <a href="fitpanel.html" title="fitpanel" |
---|
| 313 | >previous</a> |</li> |
---|
| 314 | <li><a href="../../../index.html">sansview v0.1.0 documentation</a> »</li> |
---|
| 315 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 316 | </ul> |
---|
| 317 | </div> |
---|
| 318 | <div class="footer"> |
---|
| 319 | © Copyright 2010, sans group. |
---|
| 320 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1. |
---|
| 321 | </div> |
---|
| 322 | </body> |
---|
| 323 | </html> |
---|