source: sasview/_modules/sas/models/DivComponent.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: 11.8 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.DivComponent &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.DivComponent</h1><div class="highlight"><pre>
52<span class="c">#!/usr/bin/env python</span>
53<span class="sd">&quot;&quot;&quot; Provide base functionality for all model components</span>
54<span class="sd">    @author: Mathieu Doucet / UTK</span>
55<span class="sd">    @contact: mathieu.doucet@nist.gov</span>
56<span class="sd">&quot;&quot;&quot;</span>
57
58<span class="c"># info</span>
59<span class="n">__author__</span> <span class="o">=</span> <span class="s">&quot;Mathieu Doucet /  UTK&quot;</span>
60<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>
61   
62<span class="c"># imports  </span>
63<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
64
65<div class="viewcode-block" id="DivComponent"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DivComponent.DivComponent">[docs]</a><span class="k">class</span> <span class="nc">DivComponent</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
66    <span class="sd">&quot;&quot;&quot; Basic model component for Division</span>
67<span class="sd">        Provides basic arithmetics</span>
68<span class="sd">    &quot;&quot;&quot;</span>
69
70    <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>
71        <span class="sd">&quot;&quot;&quot;</span>
72<span class="sd">            @param base: component to div</span>
73<span class="sd">            @param other: component to div by</span>
74<span class="sd">        &quot;&quot;&quot;</span>
75        <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>
76        <span class="c"># Component to divide</span>
77        <span class="bp">self</span><span class="o">.</span><span class="n">operateOn</span> <span class="o">=</span> <span class="n">base</span>
78        <span class="c"># Component to divide by</span>
79        <span class="bp">self</span><span class="o">.</span><span class="n">other</span> <span class="o">=</span> <span class="n">other</span>
80        <span class="c"># name</span>
81        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&#39;DivComponent&#39;</span>
82       
83<div class="viewcode-block" id="DivComponent.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DivComponent.DivComponent.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>
84        <span class="sd">&quot;&quot;&quot;</span>
85<span class="sd">            Evaluate each part of the component and sum the results</span>
86<span class="sd">            @param x: input parameter</span>
87<span class="sd">            @return: value of the model at x</span>
88<span class="sd">        &quot;&quot;&quot;</span>
89        <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>
90        </div>
91<div class="viewcode-block" id="DivComponent.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DivComponent.DivComponent.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>
92        <span class="sd">&quot;&quot;&quot;</span>
93<span class="sd">            Evaluate each part of the component and sum the results</span>
94<span class="sd">            @param x: input parameter</span>
95<span class="sd">            @return: value of the model at x</span>
96<span class="sd">        &quot;&quot;&quot;</span>
97        <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>
98        </div>
99<div class="viewcode-block" id="DivComponent.setParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DivComponent.DivComponent.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>
100        <span class="sd">&quot;&quot;&quot; </span>
101<span class="sd">            Set the value of a model parameter</span>
102<span class="sd">            @param name: name of parameter to set</span>
103<span class="sd">            @param value: value to give the paramter</span>
104<span class="sd">        &quot;&quot;&quot;</span>
105        <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> 
106                                               <span class="n">value</span><span class="p">,</span> <span class="s">&#39;div&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="p">)</span>
107    </div>
108<div class="viewcode-block" id="DivComponent.getParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DivComponent.DivComponent.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>
109        <span class="sd">&quot;&quot;&quot; </span>
110<span class="sd">            Set the value of a model parameter</span>
111<span class="sd">            @param name: name of the parameter</span>
112<span class="sd">            @return: value of the parameter</span>
113<span class="sd">        &quot;&quot;&quot;</span>
114        <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;div&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="p">)</span>
115    </div>
116<div class="viewcode-block" id="DivComponent.getParamList"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DivComponent.DivComponent.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>
117        <span class="sd">&quot;&quot;&quot; Return a list of all available parameters for the model </span>
118<span class="sd">        &quot;&quot;&quot;</span>
119        <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;div&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">other</span><span class="p">)</span>
120   
121<span class="c"># End of file</span></div></div>
122</pre></div>
123
124          </div>
125        </div>
126      </div>
127      <div class="sphinxsidebar">
128        <div class="sphinxsidebarwrapper">
129<div id="searchbox" style="display: none">
130  <h3>Quick search</h3>
131    <form class="search" action="../../../search.html" method="get">
132      <input type="text" name="q" />
133      <input type="submit" value="Go" />
134      <input type="hidden" name="check_keywords" value="yes" />
135      <input type="hidden" name="area" value="default" />
136    </form>
137    <p class="searchtip" style="font-size: 90%">
138    Enter search terms or a module, class or function name.
139    </p>
140</div>
141<script type="text/javascript">$('#searchbox').show(0);</script>
142        </div>
143      </div>
144      <div class="clearer"></div>
145    </div>
146    <div class="related">
147      <h3>Navigation</h3>
148      <ul>
149        <li class="right" style="margin-right: 10px">
150          <a href="../../../genindex.html" title="General Index"
151             >index</a></li>
152        <li class="right" >
153          <a href="../../../py-modindex.html" title="Python Module Index"
154             >modules</a> |</li>
155        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
156          <li><a href="../../index.html" >Module code</a> &raquo;</li>
157          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
158      </ul>
159    </div>
160    <div class="footer">
161        &copy; Copyright 2013, The SasView Project.
162      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
163    </div>
164  </body>
165</html>
Note: See TracBrowser for help on using the repository browser.