source: sasview/_modules/sas/models/AddComponent.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: 12.2 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.models.AddComponent &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="sas.models" href="../models.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" >Module code</a> &raquo;</li>
42          <li><a href="../models.html" accesskey="U">sas.models</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.models.AddComponent</h1><div class="highlight"><pre>
52<span class="c">#!/usr/bin/env python</span>
53
54<span class="sd">&quot;&quot;&quot; </span>
55<span class="sd">Provide base functionality for all model components</span>
56
57<span class="sd">:author: Mathieu Doucet / UTK</span>
58
59<span class="sd">:contact: mathieu.doucet@nist.gov</span>
60
61<span class="sd">&quot;&quot;&quot;</span>
62
63<span class="c"># info</span>
64<span class="n">__author__</span> <span class="o">=</span> <span class="s">&quot;Mathieu Doucet /  UTK&quot;</span>
65<span class="n">__id__</span> <span class="o">=</span> <span class="s">&quot;$Id: BaseComponent.py,v 1.2 2007/03/14 21:04:40 doucet Exp $&quot;</span>
66   
67<span class="c"># imports   </span>
68<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
69
70<div class="viewcode-block" id="AddComponent"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.AddComponent.AddComponent">[docs]</a><span class="k">class</span> <span class="nc">AddComponent</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
71    <span class="sd">&quot;&quot;&quot; </span>
72<span class="sd">    Basic model component for Addition</span>
73<span class="sd">    Provides basic arithmetics</span>
74<span class="sd">    &quot;&quot;&quot;</span>
75
76    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">base</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">other</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
77        <span class="sd">&quot;&quot;&quot;</span>
78<span class="sd">        :param base: component to add to </span>
79<span class="sd">        :param other: component to add</span>
80<span class="sd">        </span>
81<span class="sd">        &quot;&quot;&quot;</span>
82        <span class="n">BaseComponent</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
83        <span class="c"># Component to add to</span>
84        <span class="bp">self</span><span class="o">.</span><span class="n">operateOn</span> <span class="o">=</span> <span class="n">base</span>
85        <span class="c"># Component to add</span>
86        <span class="bp">self</span><span class="o">.</span><span class="n">other</span> <span class="o">=</span> <span class="n">other</span>
87        <span class="c"># name</span>
88        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&#39;AddComponent&#39;</span>
89       
90<div class="viewcode-block" id="AddComponent.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.AddComponent.AddComponent.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="mi">0</span><span class="p">):</span>
91        <span class="sd">&quot;&quot;&quot;</span>
92<span class="sd">        Evaluate each part of the component and sum the results</span>
93<span class="sd">        </span>
94<span class="sd">        :param x: input parameter</span>
95<span class="sd">        </span>
96<span class="sd">        :return: value of the model at x</span>
97<span class="sd">        </span>
98<span class="sd">        &quot;&quot;&quot;</span>
99        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">operateOn</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
100        </div>
101<div class="viewcode-block" id="AddComponent.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.AddComponent.AddComponent.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="mi">0</span><span class="p">):</span>
102        <span class="sd">&quot;&quot;&quot;</span>
103<span class="sd">        Evaluate each part of the component and sum the results</span>
104<span class="sd">        </span>
105<span class="sd">        :param x: input parameter</span>
106<span class="sd">        </span>
107<span class="sd">        :return: value of the model at x</span>
108<span class="sd">        </span>
109<span class="sd">        &quot;&quot;&quot;</span>
110        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">operateOn</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
111        </div>
112<div class="viewcode-block" id="AddComponent.setParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.AddComponent.AddComponent.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>
113        <span class="sd">&quot;&quot;&quot; </span>
114<span class="sd">        Set the value of a model parameter</span>
115<span class="sd">        </span>
116<span class="sd">        :param name: name of parameter to set</span>
117<span class="sd">        :param value: value to give the paramter</span>
118<span class="sd">        </span>
119<span class="sd">        &quot;&quot;&quot;</span>
120        <span class="k">return</span> <span class="n">BaseComponent</span><span class="o">.</span><span class="n">setParamWithToken</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> 
121                                               <span class="n">value</span><span class="p">,</span> <span class="s">&#39;add&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="p">)</span>
122    </div>
123<div class="viewcode-block" id="AddComponent.getParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.AddComponent.AddComponent.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>
124        <span class="sd">&quot;&quot;&quot; </span>
125<span class="sd">        Set the value of a model parameter</span>
126<span class="sd">        </span>
127<span class="sd">        :param name: name of the parameter</span>
128<span class="sd">        </span>
129<span class="sd">        :return: value of the parameter</span>
130<span class="sd">        </span>
131<span class="sd">        &quot;&quot;&quot;</span>
132        <span class="k">return</span> <span class="n">BaseComponent</span><span class="o">.</span><span class="n">getParamWithToken</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="s">&#39;add&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="p">)</span>
133    </div>
134<div class="viewcode-block" id="AddComponent.getParamList"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.AddComponent.AddComponent.getParamList">[docs]</a>    <span class="k">def</span> <span class="nf">getParamList</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
135        <span class="sd">&quot;&quot;&quot; </span>
136<span class="sd">        Return a list of all available parameters for the model </span>
137<span class="sd">        &quot;&quot;&quot;</span>
138        <span class="k">return</span> <span class="n">BaseComponent</span><span class="o">.</span><span class="n">getParamListWithToken</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&#39;add&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="p">)</span>
139       
140   
141<span class="c"># End of file</span></div></div>
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          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
178      </ul>
179    </div>
180    <div class="footer">
181        &copy; Copyright 2013, The SasView Project.
182      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
183    </div>
184  </body>
185</html>
Note: See TracBrowser for help on using the repository browser.