source: sasview/plottools/docs/sphinx/html/api/LineModel.html @ 82a54b8

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 82a54b8 was 82a54b8, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

adding plottools Part 2
  • Property mode set to 100644
File size: 7.6 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>LineModel &mdash; plottools 0.10 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.10',
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>
28    <link rel="top" title="plottools 0.10 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="PlotPanel" href="PlotPanel.html" />
31    <link rel="prev" title="fittings" href="fittings.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" >
44          <a href="PlotPanel.html" title="PlotPanel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="fittings.html" title="fittings"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">plottools 0.10 documentation</a> &raquo;</li>
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="linemodel">
60<h1>LineModel<a class="headerlink" href="#linemodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="danse-common-plottools-linemodel">
62<h2><a class="reference internal" href="#module-danse.common.plottools.LineModel" title="danse.common.plottools.LineModel"><tt class="xref py py-mod docutils literal"><span class="pre">danse.common.plottools.LineModel</span></tt></a><a class="headerlink" href="#danse-common-plottools-linemodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-danse.common.plottools.LineModel"></span><p>Provide Line function (y= A + Bx)</p>
64<dl class="class">
65<dt id="danse.common.plottools.LineModel.LineModel">
66<em class="property">class </em><tt class="descclassname">danse.common.plottools.LineModel.</tt><tt class="descname">LineModel</tt><a class="headerlink" href="#danse.common.plottools.LineModel.LineModel" title="Permalink to this definition">¶</a></dt>
67<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
68<p>Class that evaluates a linear model.</p>
69<p>f(x) = A + Bx</p>
70<p>List of default parameters:
71A = 0.0
72B = 0.0</p>
73<dl class="method">
74<dt id="danse.common.plottools.LineModel.LineModel.getParam">
75<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.LineModel.LineModel.getParam" title="Permalink to this definition">¶</a></dt>
76<dd></dd></dl>
77
78<dl class="method">
79<dt id="danse.common.plottools.LineModel.LineModel.run">
80<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.LineModel.LineModel.run" title="Permalink to this definition">¶</a></dt>
81<dd><p>Evaluate the model</p>
82<table class="docutils field-list" frame="void" rules="none">
83<col class="field-name" />
84<col class="field-body" />
85<tbody valign="top">
86<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; simple value</td>
87</tr>
88<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(Line value)</td>
89</tr>
90</tbody>
91</table>
92</dd></dl>
93
94<dl class="method">
95<dt id="danse.common.plottools.LineModel.LineModel.runXY">
96<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.LineModel.LineModel.runXY" title="Permalink to this definition">¶</a></dt>
97<dd><p>Evaluate the model</p>
98<table class="docutils field-list" frame="void" rules="none">
99<col class="field-name" />
100<col class="field-body" />
101<tbody valign="top">
102<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; simple value</td>
103</tr>
104<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Line value</td>
105</tr>
106</tbody>
107</table>
108</dd></dl>
109
110<dl class="method">
111<dt id="danse.common.plottools.LineModel.LineModel.setParam">
112<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#danse.common.plottools.LineModel.LineModel.setParam" title="Permalink to this definition">¶</a></dt>
113<dd></dd></dl>
114
115</dd></dl>
116
117</div>
118</div>
119
120
121          </div>
122        </div>
123      </div>
124      <div class="sphinxsidebar">
125        <div class="sphinxsidebarwrapper">
126  <h3><a href="../index.html">Table Of Contents</a></h3>
127  <ul>
128<li><a class="reference internal" href="#">LineModel</a><ul>
129<li><a class="reference internal" href="#danse-common-plottools-linemodel"><tt class="docutils literal"><span class="pre">danse.common.plottools.LineModel</span></tt></a></li>
130</ul>
131</li>
132</ul>
133
134  <h4>Previous topic</h4>
135  <p class="topless"><a href="fittings.html"
136                        title="previous chapter">fittings</a></p>
137  <h4>Next topic</h4>
138  <p class="topless"><a href="PlotPanel.html"
139                        title="next chapter">PlotPanel</a></p>
140  <h3>This Page</h3>
141  <ul class="this-page-menu">
142    <li><a href="../_sources/api/LineModel.txt"
143           rel="nofollow">Show Source</a></li>
144  </ul>
145<div id="searchbox" style="display: none">
146  <h3>Quick search</h3>
147    <form class="search" action="../search.html" method="get">
148      <input type="text" name="q" />
149      <input type="submit" value="Go" />
150      <input type="hidden" name="check_keywords" value="yes" />
151      <input type="hidden" name="area" value="default" />
152    </form>
153    <p class="searchtip" style="font-size: 90%">
154    Enter search terms or a module, class or function name.
155    </p>
156</div>
157<script type="text/javascript">$('#searchbox').show(0);</script>
158        </div>
159      </div>
160      <div class="clearer"></div>
161    </div>
162    <div class="related">
163      <h3>Navigation</h3>
164      <ul>
165        <li class="right" style="margin-right: 10px">
166          <a href="../genindex.html" title="General Index"
167             >index</a></li>
168        <li class="right" >
169          <a href="../py-modindex.html" title="Python Module Index"
170             >modules</a> |</li>
171        <li class="right" >
172          <a href="PlotPanel.html" title="PlotPanel"
173             >next</a> |</li>
174        <li class="right" >
175          <a href="fittings.html" title="fittings"
176             >previous</a> |</li>
177        <li><a href="../index.html">plottools 0.10 documentation</a> &raquo;</li>
178          <li><a href="index.html" >Reference</a> &raquo;</li> 
179      </ul>
180    </div>
181    <div class="footer">
182        &copy; Copyright 2010, sans/reflectometry group.
183      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
184    </div>
185  </body>
186</html>
Note: See TracBrowser for help on using the repository browser.