source: sasview/_modules/sas/models/ModelAdaptor.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: 13.9 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.ModelAdaptor &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.ModelAdaptor</h1><div class="highlight"><pre>
52<span class="c">#!/usr/bin/env python</span>
53<span class="sd">&quot;&quot;&quot;</span>
54<span class="sd">    This software was developed by the University of Tennessee as part of the</span>
55<span class="sd">    Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
56<span class="sd">    project funded by the US National Science Foundation.</span>
57
58<span class="sd">    If you use DANSE applications to do scientific research that leads to</span>
59<span class="sd">    publication, we ask that you acknowledge the use of the software with the</span>
60<span class="sd">    following sentence:</span>
61
62<span class="sd">    &quot;This work benefited from DANSE software developed under NSF award DMR-0520547.&quot;</span>
63
64<span class="sd">    copyright 2008, University of Tennessee</span>
65<span class="sd">&quot;&quot;&quot;</span>
66
67<span class="sd">&quot;&quot;&quot; </span>
68<span class="sd">    Provide base functionality for all model components</span>
69<span class="sd">    </span>
70<span class="sd">    The following has changed since going from BaseComponent to BaseModel:</span>
71<span class="sd">    </span>
72<span class="sd">        - Arithmetic operation between models is no longer supported.</span>
73<span class="sd">          It was found to be of little use and not very flexible.</span>
74<span class="sd">        </span>
75<span class="sd">        - Parameters are now stored as Parameter object to provide </span>
76<span class="sd">          the necessary extra information like limits, units, etc... </span>
77<span class="sd">&quot;&quot;&quot;</span>
78
79<div class="viewcode-block" id="ParameterDict"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ModelAdaptor.ParameterDict">[docs]</a><span class="k">class</span> <span class="nc">ParameterDict</span><span class="p">(</span><span class="nb">dict</span><span class="p">):</span>
80    <span class="sd">&quot;&quot;&quot;</span>
81<span class="sd">        Parameter dictionary used for backward </span>
82<span class="sd">        compatibility between the old-style &#39;params&#39;</span>
83<span class="sd">        dictionary and the new-style &#39;parameters&#39;</span>
84<span class="sd">        dictionary.</span>
85<span class="sd">    &quot;&quot;&quot;</span>
86    <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">parameters</span><span class="p">):</span>
87        <span class="sd">&quot;&quot;&quot;    </span>
88<span class="sd">        Initialization</span>
89<span class="sd">        param parameters: new-style &#39;parameters&#39; dictionary</span>
90<span class="sd">        &quot;&quot;&quot;</span>
91        <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="n">parameters</span>
92       
93    <span class="k">def</span> <span class="nf">__setitem__</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>
94        <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value</span>
95   
96    <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
97        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">value</span> 
98    </div>
99<div class="viewcode-block" id="ModelAdaptor"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ModelAdaptor.ModelAdaptor">[docs]</a><span class="k">class</span> <span class="nc">ModelAdaptor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
100    <span class="sd">&quot;&quot;&quot; </span>
101<span class="sd">    Model adaptor to provide old-style model functionality</span>
102<span class="sd">    &quot;&quot;&quot;</span>
103    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
104        <span class="sd">&quot;&quot;&quot; Initialization&quot;&quot;&quot;</span>
105        <span class="c">## Dictionary of Parameter objects</span>
106        <span class="bp">self</span><span class="o">.</span><span class="n">parameters</span> <span class="o">=</span> <span class="p">{}</span>
107        <span class="c">## Dictionary of parameters, available for backward compatibility</span>
108        <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">ParameterDict</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parameters</span><span class="p">)</span>
109        <span class="c">## Additional details, provided for backward compatibility</span>
110        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
111        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
112        <span class="c">## Dictionary used to store the dispersity/averaging</span>
113        <span class="c">#  parameters of dispersed/averaged parameters.</span>
114        <span class="c">## Provided for backward compatibility</span>
115        <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="p">{}</span>
116                             
117    <span class="c"># Old-style methods that are no longer used</span>
118<div class="viewcode-block" id="ModelAdaptor.setParamWithToken"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ModelAdaptor.ModelAdaptor.setParamWithToken">[docs]</a>    <span class="k">def</span> <span class="nf">setParamWithToken</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> <span class="n">token</span><span class="p">,</span> <span class="n">member</span><span class="p">):</span> 
119        <span class="sd">&quot;&quot;&quot;</span>
120<span class="sd">        set Param With Token</span>
121<span class="sd">        &quot;&quot;&quot;</span>
122        <span class="k">return</span> <span class="bp">NotImplemented</span>
123    </div>
124<div class="viewcode-block" id="ModelAdaptor.getParamWithToken"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ModelAdaptor.ModelAdaptor.getParamWithToken">[docs]</a>    <span class="k">def</span> <span class="nf">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="n">token</span><span class="p">,</span> <span class="n">member</span><span class="p">):</span> 
125        <span class="sd">&quot;&quot;&quot;</span>
126<span class="sd">        get Param With Token</span>
127<span class="sd">        &quot;&quot;&quot;</span>
128        <span class="k">return</span> <span class="bp">NotImplemented</span>
129    </div>
130<div class="viewcode-block" id="ModelAdaptor.getParamListWithToken"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ModelAdaptor.ModelAdaptor.getParamListWithToken">[docs]</a>    <span class="k">def</span> <span class="nf">getParamListWithToken</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">member</span><span class="p">):</span> 
131        <span class="sd">&quot;&quot;&quot;</span>
132<span class="sd">        get Param List With Token</span>
133<span class="sd">        &quot;&quot;&quot;</span>
134        <span class="k">return</span> <span class="bp">NotImplemented</span></div>
135    <span class="k">def</span> <span class="nf">__add__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> 
136        <span class="sd">&quot;&quot;&quot;</span>
137<span class="sd">        add</span>
138<span class="sd">        &quot;&quot;&quot;</span>
139        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Model operation are no longer supported&quot;</span>
140    <span class="k">def</span> <span class="nf">__sub__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> 
141        <span class="sd">&quot;&quot;&quot;</span>
142<span class="sd">        sub</span>
143<span class="sd">        &quot;&quot;&quot;</span>
144        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Model operation are no longer supported&quot;</span>
145    <span class="k">def</span> <span class="nf">__mul__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> 
146        <span class="sd">&quot;&quot;&quot;</span>
147<span class="sd">        mul</span>
148<span class="sd">        &quot;&quot;&quot;</span>
149        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Model operation are no longer supported&quot;</span>
150    <span class="k">def</span> <span class="nf">__div__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span> 
151        <span class="sd">&quot;&quot;&quot;</span>
152<span class="sd">        div</span>
153<span class="sd">        &quot;&quot;&quot;</span>
154        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Model operation are no longer supported&quot;</span>
155</div>
156<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>
157    <span class="n">b</span> <span class="o">=</span> <span class="n">ModelAdaptor</span><span class="p">()</span> 
158    <span class="c">#print b.operateOn</span>
159   
160</pre></div>
161
162          </div>
163        </div>
164      </div>
165      <div class="sphinxsidebar">
166        <div class="sphinxsidebarwrapper">
167<div id="searchbox" style="display: none">
168  <h3>Quick search</h3>
169    <form class="search" action="../../../search.html" method="get">
170      <input type="text" name="q" />
171      <input type="submit" value="Go" />
172      <input type="hidden" name="check_keywords" value="yes" />
173      <input type="hidden" name="area" value="default" />
174    </form>
175    <p class="searchtip" style="font-size: 90%">
176    Enter search terms or a module, class or function name.
177    </p>
178</div>
179<script type="text/javascript">$('#searchbox').show(0);</script>
180        </div>
181      </div>
182      <div class="clearer"></div>
183    </div>
184    <div class="related">
185      <h3>Navigation</h3>
186      <ul>
187        <li class="right" style="margin-right: 10px">
188          <a href="../../../genindex.html" title="General Index"
189             >index</a></li>
190        <li class="right" >
191          <a href="../../../py-modindex.html" title="Python Module Index"
192             >modules</a> |</li>
193        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
194          <li><a href="../../index.html" >Module code</a> &raquo;</li>
195          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
196      </ul>
197    </div>
198    <div class="footer">
199        &copy; Copyright 2013, The SasView Project.
200      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
201    </div>
202  </body>
203</html>
Note: See TracBrowser for help on using the repository browser.