Changeset 41517a6 in sasview for park_integration/docs/sphinx/_build/html/api/Fitting.html
- Timestamp:
- Aug 9, 2011 1:24:54 PM (13 years ago)
- Branches:
- master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- 032d585
- Parents:
- 6992dfd
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
park_integration/docs/sphinx/_build/html/api/Fitting.html
r0c3003d r41517a6 36 36 accesskey="I">index</a></li> 37 37 <li class="right" > 38 <a href="../py-modindex.html" title="Python Module Index"39 >modules</a> |</li>40 <li class="right" >41 38 <a href="ParkFitting.html" title="ParkFitting" 42 39 accesskey="N">next</a> |</li> … … 56 53 <div class="section" id="fitting"> 57 54 <h1>Fitting<a class="headerlink" href="#fitting" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id="module-sans.fit.Fitting"> 59 <span id="mod-sans-fit-fitting"></span><h2>:mod:` sans.fit.Fitting`<a class="headerlink" href="#module-sans.fit.Fitting" title="Permalink to this headline">¶</a></h2> 60 <p>Class Fit contains ScipyFit and ParkFit methods declaration 61 allows to create instance of type ScipyFit or ParkFit to perform either 62 a park fit or a scipy fit.</p> 63 <dl class="class"> 64 <dt id="sans.fit.Fitting.Fit"> 65 <em class="property">class </em><tt class="descclassname">sans.fit.Fitting.</tt><tt class="descname">Fit</tt><big>(</big><em>engine='scipy'</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit" title="Permalink to this definition">¶</a></dt> 66 <dd><p>Wrap class that allows to select the fitting type.this class 67 can be used as follow :</p> 68 <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sans.fit.Fitting</span> <span class="kn">import</span> <span class="n">Fit</span> 69 <span class="n">fitter</span><span class="o">=</span> <span class="n">Fit</span><span class="p">()</span> 70 <span class="n">fitter</span><span class="o">.</span><span class="n">fit_engine</span><span class="p">(</span><span class="s">'scipy'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">fitter</span><span class="o">.</span><span class="n">fit_engine</span><span class="p">(</span><span class="s">'park'</span><span class="p">)</span> 71 <span class="n">engine</span> <span class="o">=</span> <span class="n">fitter</span><span class="o">.</span><span class="n">returnEngine</span><span class="p">()</span> 72 <span class="n">engine</span><span class="o">.</span><span class="n">set_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span><span class="nb">id</span><span class="p">)</span> 73 <span class="n">engine</span><span class="o">.</span><span class="n">set_param</span><span class="p">(</span> <span class="n">model</span><span class="p">,</span><span class="n">model</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">pars</span><span class="p">)</span> 74 <span class="n">engine</span><span class="o">.</span><span class="n">set_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="nb">id</span><span class="p">)</span> 75 76 <span class="n">chisqr1</span><span class="p">,</span> <span class="n">out1</span><span class="p">,</span> <span class="n">cov1</span><span class="o">=</span><span class="n">engine</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span><span class="n">qmin</span><span class="p">,</span><span class="n">qmax</span><span class="p">)</span> 77 </pre></div> 78 </div> 79 <dl class="method"> 80 <dt id="sans.fit.Fitting.Fit.fit"> 81 <tt class="descname">fit</tt><big>(</big><em>q=None</em>, <em>handler=None</em>, <em>curr_thread=None</em>, <em>ftol=1.49012e-008</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.fit" title="Permalink to this definition">¶</a></dt> 82 <dd><p>Perform the fit</p> 83 </dd></dl> 84 85 <dl class="method"> 86 <dt id="sans.fit.Fitting.Fit.get_model"> 87 <tt class="descname">get_model</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.get_model" title="Permalink to this definition">¶</a></dt> 88 <dd><p>return list of data</p> 89 </dd></dl> 90 91 <dl class="method"> 92 <dt id="sans.fit.Fitting.Fit.get_problem_to_fit"> 93 <tt class="descname">get_problem_to_fit</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 94 <dd><p>return the self.selected value of the fit problem of id</p> 95 <table class="docutils field-list" frame="void" rules="none"> 96 <col class="field-name" /> 97 <col class="field-body" /> 98 <tbody valign="top"> 99 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – the id of the problem</td> 100 </tr> 101 </tbody> 102 </table> 103 </dd></dl> 104 105 <dl class="method"> 106 <dt id="sans.fit.Fitting.Fit.remove_fit_problem"> 107 <tt class="descname">remove_fit_problem</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 108 <dd><p>remove fitarrange in id</p> 109 </dd></dl> 110 111 <dl class="method"> 112 <dt id="sans.fit.Fitting.Fit.select_problem_for_fit"> 113 <tt class="descname">select_problem_for_fit</tt><big>(</big><em>id</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 114 <dd><p>select a couple of model and data at the id position in dictionary 115 and set in self.selected value to value</p> 116 <table class="docutils field-list" frame="void" rules="none"> 117 <col class="field-name" /> 118 <col class="field-body" /> 119 <tbody valign="top"> 120 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting. 121 can only have the value one or zero</td> 122 </tr> 123 </tbody> 124 </table> 125 </dd></dl> 126 127 <dl class="method"> 128 <dt id="sans.fit.Fitting.Fit.set_data"> 129 <tt class="descname">set_data</tt><big>(</big><em>data</em>, <em>id</em>, <em>smearer=None</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.set_data" title="Permalink to this definition">¶</a></dt> 130 <dd><p>Store data to fit at the psotion id of the fit engine</p> 131 <table class="docutils field-list" frame="void" rules="none"> 132 <col class="field-name" /> 133 <col class="field-body" /> 134 <tbody valign="top"> 135 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 136 <li><strong>data</strong> – data to fit</li> 137 <li><strong>smearer</strong> – smearerobject to smear data</li> 138 <li><strong>qmin</strong> – the minimum q range to fit</li> 139 <li><strong>qmax</strong> – the minimum q range to fit</li> 140 </ul> 141 </td> 142 </tr> 143 </tbody> 144 </table> 145 </dd></dl> 146 147 <dl class="method"> 148 <dt id="sans.fit.Fitting.Fit.set_engine"> 149 <tt class="descname">set_engine</tt><big>(</big><em>word</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.set_engine" title="Permalink to this definition">¶</a></dt> 150 <dd><p>Select the type of Fit</p> 151 <table class="docutils field-list" frame="void" rules="none"> 152 <col class="field-name" /> 153 <col class="field-body" /> 154 <tbody valign="top"> 155 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>word</strong> – the keyword to select the fit type</td> 156 </tr> 157 <tr class="field"><th class="field-name">Raise :</th><td class="field-body">if the user does not enter ‘scipy’ or ‘park’, 158 a valueError is raised</td> 159 </tr> 160 </tbody> 161 </table> 162 </dd></dl> 163 164 <dl class="method"> 165 <dt id="sans.fit.Fitting.Fit.set_model"> 166 <tt class="descname">set_model</tt><big>(</big><em>model</em>, <em>id</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.Fitting.Fit.set_model" title="Permalink to this definition">¶</a></dt> 167 <dd><p>store a model model to fit at the position id of the fit engine</p> 168 </dd></dl> 169 170 </dd></dl> 171 55 <div class="section" id="mod-sans-fit-fitting"> 56 <h2>:mod:` sans.fit.Fitting`<a class="headerlink" href="#mod-sans-fit-fitting" title="Permalink to this headline">¶</a></h2> 172 57 </div> 173 58 </div> … … 182 67 <ul> 183 68 <li><a class="reference internal" href="#">Fitting</a><ul> 184 <li><a class="reference internal" href="#mod ule-sans.fit.Fitting">:mod:` sans.fit.Fitting`</a></li>69 <li><a class="reference internal" href="#mod-sans-fit-fitting">:mod:` sans.fit.Fitting`</a></li> 185 70 </ul> 186 71 </li> … … 222 107 >index</a></li> 223 108 <li class="right" > 224 <a href="../py-modindex.html" title="Python Module Index"225 >modules</a> |</li>226 <li class="right" >227 109 <a href="ParkFitting.html" title="ParkFitting" 228 110 >next</a> |</li>
Note: See TracChangeset
for help on using the changeset viewer.
