source: sasview/_modules/sas/models/Sin.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: 10.7 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.Sin &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.Sin</h1><div class="highlight"><pre>
52<span class="c">#!/usr/bin/env python</span>
53<span class="sd">&quot;&quot;&quot; Provide sin(x) function as a BaseComponent model</span>
54<span class="sd">&quot;&quot;&quot;</span>
55
56<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
57<span class="kn">import</span> <span class="nn">math</span>
58 
59<div class="viewcode-block" id="Sin"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Sin.Sin">[docs]</a><span class="k">class</span> <span class="nc">Sin</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
60    <span class="sd">&quot;&quot;&quot; Class that evaluates a sin(x) model. </span>
61<span class="sd">    &quot;&quot;&quot;</span>
62       
63    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
64        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
65       
66        <span class="c"># Initialize BaseComponent first, then sphere</span>
67        <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>
68       
69        <span class="c">## Name of the model</span>
70        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;Sin&quot;</span>
71        <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="o">=</span><span class="s">&quot;&quot;&quot; the sin model</span>
72<span class="s">        F(x)=sin(x)</span>
73<span class="s">        &quot;&quot;&quot;</span>
74        <span class="c">## Parameter details [units, min, max]</span>
75        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
76        <span class="c">#list of parameter that cannot be fitted</span>
77        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span><span class="o">=</span> <span class="p">[]</span>
78<div class="viewcode-block" id="Sin.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Sin.Sin.clone">[docs]</a>    <span class="k">def</span> <span class="nf">clone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
79        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
80        <span class="k">return</span> <span class="n">Sin</span><span class="p">()</span>
81   </div>
82<div class="viewcode-block" id="Sin.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Sin.Sin.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>
83        <span class="sd">&quot;&quot;&quot; Evaluate the model</span>
84<span class="sd">            @param x: input x, or [x, phi] [radian]</span>
85<span class="sd">            @return: sin(x) or sin(x*cos(phi))*sin(x*sin(phi))</span>
86<span class="sd">        &quot;&quot;&quot;</span>
87        <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>
88            <span class="k">return</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">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><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">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>
89        <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>
90            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Tuples are not allowed as input to BaseComponent models&quot;</span>
91        <span class="k">else</span><span class="p">:</span>
92            <span class="k">return</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>
93   </div>
94<div class="viewcode-block" id="Sin.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Sin.Sin.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>
95        <span class="sd">&quot;&quot;&quot; Evaluate the model</span>
96<span class="sd">            @param x: input x, or [x, y] [radian]</span>
97<span class="sd">            @return: sin(x) or sin(x)*sin(y)</span>
98<span class="sd">        &quot;&quot;&quot;</span>
99        <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>
100            <span class="k">return</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">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>
101        <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>
102            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Tuples are not allowed as input to BaseComponent models&quot;</span>
103        <span class="k">else</span><span class="p">:</span>
104            <span class="k">return</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>
105   
106<span class="c"># End of file</span></div></div>
107</pre></div>
108
109          </div>
110        </div>
111      </div>
112      <div class="sphinxsidebar">
113        <div class="sphinxsidebarwrapper">
114<div id="searchbox" style="display: none">
115  <h3>Quick search</h3>
116    <form class="search" action="../../../search.html" method="get">
117      <input type="text" name="q" />
118      <input type="submit" value="Go" />
119      <input type="hidden" name="check_keywords" value="yes" />
120      <input type="hidden" name="area" value="default" />
121    </form>
122    <p class="searchtip" style="font-size: 90%">
123    Enter search terms or a module, class or function name.
124    </p>
125</div>
126<script type="text/javascript">$('#searchbox').show(0);</script>
127        </div>
128      </div>
129      <div class="clearer"></div>
130    </div>
131    <div class="related">
132      <h3>Navigation</h3>
133      <ul>
134        <li class="right" style="margin-right: 10px">
135          <a href="../../../genindex.html" title="General Index"
136             >index</a></li>
137        <li class="right" >
138          <a href="../../../py-modindex.html" title="Python Module Index"
139             >modules</a> |</li>
140        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
141          <li><a href="../../index.html" >Module code</a> &raquo;</li>
142          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
143      </ul>
144    </div>
145    <div class="footer">
146        &copy; Copyright 2013, The SasView Project.
147      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
148    </div>
149  </body>
150</html>
Note: See TracBrowser for help on using the repository browser.