source: sasview/_modules/sas/plottools/LineModel.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 14.1 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.plottools.LineModel &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../../index.html" />
28    <link rel="up" title="Module code" 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><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
42      </ul>
43    </div> 
44
45    <div class="document">
46      <div class="documentwrapper">
47        <div class="bodywrapper">
48          <div class="body">
49           
50  <h1>Source code for sas.plottools.LineModel</h1><div class="highlight"><pre>
51<span class="c">#!/usr/bin/env python</span>
52<span class="sd">&quot;&quot;&quot; </span>
53<span class="sd">Provide Line function (y= A + Bx) </span>
54<span class="sd">&quot;&quot;&quot;</span>
55
56<span class="kn">import</span> <span class="nn">math</span>
57
58<div class="viewcode-block" id="LineModel"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.LineModel.LineModel">[docs]</a><span class="k">class</span> <span class="nc">LineModel</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
59    <span class="sd">&quot;&quot;&quot; </span>
60<span class="sd">    Class that evaluates a linear model.</span>
61<span class="sd">    </span>
62<span class="sd">    f(x) = A + Bx</span>
63<span class="sd">     </span>
64<span class="sd">    List of default parameters:</span>
65<span class="sd">    A = 0.0</span>
66<span class="sd">    B = 0.0 </span>
67<span class="sd">    &quot;&quot;&quot;</span>
68       
69    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
70        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
71        <span class="c">## Name of the model</span>
72        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;LineModel&quot;</span>
73
74        <span class="c">## Define parameters</span>
75        <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="p">{}</span>
76        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span>
77        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;B&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span>
78
79        <span class="c">## Parameter details [units, min, max]</span>
80        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
81        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
82        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;B&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
83               
84<div class="viewcode-block" id="LineModel.getParam"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.LineModel.LineModel.getParam">[docs]</a>    <span class="k">def</span> <span class="nf">getParam</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
85        <span class="sd">&quot;&quot;&quot;</span>
86<span class="sd">        &quot;&quot;&quot;</span>
87        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">upper</span><span class="p">()]</span>
88    </div>
89<div class="viewcode-block" id="LineModel.setParam"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.LineModel.LineModel.setParam">[docs]</a>    <span class="k">def</span> <span class="nf">setParam</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
90        <span class="sd">&quot;&quot;&quot;</span>
91<span class="sd">        &quot;&quot;&quot;</span>
92        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">upper</span><span class="p">()]</span> <span class="o">=</span> <span class="n">value</span>
93    </div>
94    <span class="k">def</span> <span class="nf">_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
95        <span class="sd">&quot;&quot;&quot;</span>
96<span class="sd">        Evaluate the function</span>
97<span class="sd">        </span>
98<span class="sd">        :param x: x-value</span>
99<span class="sd">        </span>
100<span class="sd">        :return: function value</span>
101<span class="sd">        </span>
102<span class="sd">        &quot;&quot;&quot;</span>
103        <span class="k">return</span>  <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="p">(</span><span class="n">x</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;B&#39;</span><span class="p">])</span>
104   
105<div class="viewcode-block" id="LineModel.run"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.LineModel.LineModel.run">[docs]</a>    <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span>
106        <span class="sd">&quot;&quot;&quot; </span>
107<span class="sd">        Evaluate the model</span>
108<span class="sd">        </span>
109<span class="sd">        :param x: simple value</span>
110<span class="sd">        </span>
111<span class="sd">        :return: (Line value)</span>
112<span class="sd">        &quot;&quot;&quot;</span>
113        <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;list&#39;</span><span class="p">:</span>
114            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span> <span class="o">*</span> \
115                                <span class="bp">self</span><span class="o">.</span><span class="n">_line</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
116        <span class="k">elif</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;tuple&#39;</span><span class="p">:</span>
117            <span class="n">msg</span>  <span class="o">=</span> <span class="s">&quot;Tuples are not allowed as input to BaseComponent models&quot;</span>
118            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="n">msg</span>
119        <span class="k">else</span><span class="p">:</span>
120            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
121   </div>
122<div class="viewcode-block" id="LineModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.LineModel.LineModel.runXY">[docs]</a>    <span class="k">def</span> <span class="nf">runXY</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span>
123        <span class="sd">&quot;&quot;&quot; </span>
124<span class="sd">        Evaluate the model</span>
125<span class="sd">            </span>
126<span class="sd">        :param x: simple value</span>
127<span class="sd">        </span>
128<span class="sd">        :return: Line value</span>
129<span class="sd">        </span>
130<span class="sd">        &quot;&quot;&quot;</span>
131        <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;list&#39;</span><span class="p">:</span>
132            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
133        <span class="k">elif</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;tuple&#39;</span><span class="p">:</span>
134            <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Tuples are not allowed as input to BaseComponent models&quot;</span>
135            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="n">msg</span>
136        <span class="k">else</span><span class="p">:</span>
137            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
138   
139</div></div>
140<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&quot;__main__&quot;</span><span class="p">:</span> 
141    <span class="n">l</span> <span class="o">=</span> <span class="n">Line</span><span class="p">()</span>
142</pre></div>
143
144          </div>
145        </div>
146      </div>
147      <div class="sphinxsidebar">
148        <div class="sphinxsidebarwrapper">
149<div id="searchbox" style="display: none">
150  <h3>Quick search</h3>
151    <form class="search" action="../../../search.html" method="get">
152      <input type="text" name="q" />
153      <input type="submit" value="Go" />
154      <input type="hidden" name="check_keywords" value="yes" />
155      <input type="hidden" name="area" value="default" />
156    </form>
157    <p class="searchtip" style="font-size: 90%">
158    Enter search terms or a module, class or function name.
159    </p>
160</div>
161<script type="text/javascript">$('#searchbox').show(0);</script>
162        </div>
163      </div>
164      <div class="clearer"></div>
165    </div>
166    <div class="related">
167      <h3>Navigation</h3>
168      <ul>
169        <li class="right" style="margin-right: 10px">
170          <a href="../../../genindex.html" title="General Index"
171             >index</a></li>
172        <li class="right" >
173          <a href="../../../py-modindex.html" title="Python Module Index"
174             >modules</a> |</li>
175        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
176          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
177      </ul>
178    </div>
179    <div class="footer">
180        &copy; Copyright 2013, The SasView Project.
181      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
182    </div>
183  </body>
184</html>
Note: See TracBrowser for help on using the repository browser.