source: sasview/_modules/sas/models/pluginmodel.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.pluginmodel &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.pluginmodel</h1><div class="highlight"><pre>
52<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
53<span class="kn">import</span> <span class="nn">math</span>
54
55<span class="k">class</span> <span class="nc">Model1DPlugin</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
56<div class="viewcode-block" id="Model1DPlugin"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.pluginmodel.Model1DPlugin">[docs]</a>    <span class="c">## Name of the model</span>
57   
58    <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">name</span><span class="o">=</span><span class="s">&quot;Plugin Model&quot;</span> <span class="p">):</span>
59        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
60        <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>
61        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
62        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
63        <span class="bp">self</span><span class="o">.</span><span class="n">params</span>  <span class="o">=</span> <span class="p">{}</span>
64        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&#39;plugin model&#39;</span>
65       
66    <span class="k">def</span> <span class="nf">function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
67<div class="viewcode-block" id="Model1DPlugin.function"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.pluginmodel.Model1DPlugin.function">[docs]</a>        <span class="sd">&quot;&quot;&quot;</span>
68<span class="sd">        Function to be implemented by the plug-in writer</span>
69<span class="sd">        &quot;&quot;&quot;</span>
70        <span class="k">return</span> <span class="n">x</span>
71       
72    <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></div>
73<div class="viewcode-block" id="Model1DPlugin.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.pluginmodel.Model1DPlugin.run">[docs]</a>        <span class="sd">&quot;&quot;&quot; </span>
74<span class="sd">        Evaluate the model</span>
75<span class="sd">        </span>
76<span class="sd">        :param x: input x, or [x, phi] [radian]</span>
77<span class="sd">        </span>
78<span class="sd">        :return: function value</span>
79<span class="sd">        </span>
80<span class="sd">        &quot;&quot;&quot;</span>
81        <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>
82            <span class="n">x_val</span> <span class="o">=</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>
83            <span class="n">y_val</span> <span class="o">=</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>
84            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">(</span><span class="n">x_val</span><span class="p">)</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">(</span><span class="n">y_val</span><span class="p">)</span>
85        <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>
86            <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>
87        <span class="k">else</span><span class="p">:</span>
88            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
89       
90   
91    <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></div>
92<div class="viewcode-block" id="Model1DPlugin.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.pluginmodel.Model1DPlugin.runXY">[docs]</a>        <span class="sd">&quot;&quot;&quot; </span>
93<span class="sd">        Evaluate the model</span>
94<span class="sd">        </span>
95<span class="sd">        :param x: input x, or [x, y] </span>
96<span class="sd">        </span>
97<span class="sd">        :return: function value</span>
98<span class="sd">        </span>
99<span class="sd">        &quot;&quot;&quot;</span>
100        <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>
101            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</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">function</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
102        <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>
103            <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>
104        <span class="k">else</span><span class="p">:</span>
105            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
106       
107    <span class="k">def</span> <span class="nf">set_details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
108<div class="viewcode-block" id="Model1DPlugin.set_details"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.pluginmodel.Model1DPlugin.set_details">[docs]</a>        <span class="sd">&quot;&quot;&quot;</span>
109<span class="sd">        Set default details</span>
110<span class="sd">        &quot;&quot;&quot;</span>
111        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">:</span>
112            <span class="k">return</span> <span class="p">{}</span>
113           
114        <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
115            <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="n">key</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>
116</pre></div></div></div>
117
118          </div>
119        </div>
120      </div>
121      <div class="sphinxsidebar">
122        <div class="sphinxsidebarwrapper">
123<div id="searchbox" style="display: none">
124  <h3>Quick search</h3>
125    <form class="search" action="../../../search.html" method="get">
126      <input type="text" name="q" />
127      <input type="submit" value="Go" />
128      <input type="hidden" name="check_keywords" value="yes" />
129      <input type="hidden" name="area" value="default" />
130    </form>
131    <p class="searchtip" style="font-size: 90%">
132    Enter search terms or a module, class or function name.
133    </p>
134</div>
135<script type="text/javascript">$('#searchbox').show(0);</script>
136        </div>
137      </div>
138      <div class="clearer"></div>
139    </div>
140    <div class="related">
141      <h3>Navigation</h3>
142      <ul>
143        <li class="right" style="margin-right: 10px">
144          <a href="../../../genindex.html" title="General Index"
145             >index</a></li>
146        <li class="right" >
147          <a href="../../../py-modindex.html" title="Python Module Index"
148             >modules</a> |</li>
149        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
150          <li><a href="../../index.html" >Module code</a> &raquo;</li>
151          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
152      </ul>
153    </div>
154    <div class="footer">
155        &copy; Copyright 2013, The SasView Project.
156      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
157    </div>
158  </body>
159</html>
Note: See TracBrowser for help on using the repository browser.