source: sasview/sansmodels/docs/sphinx/_build/html/api/ModelAdaptor.html @ b94945d

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since b94945d was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

working on documentation
  • Property mode set to 100644
File size: 12.5 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>ModelAdaptor &mdash; sansmodels v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="sansmodels v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="ModelFactory" href="ModelFactory.html" />
28    <link rel="prev" title="LorentzModel" href="LorentzModel.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 class="right" >
41          <a href="ModelFactory.html" title="ModelFactory"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="LorentzModel.html" title="LorentzModel"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="modeladaptor">
57<h1>ModelAdaptor<a class="headerlink" href="#modeladaptor" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.ModelAdaptor">
59<span id="sans-models-modeladaptor"></span><h2><a class="reference internal" href="#module-sans.models.ModelAdaptor"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ModelAdaptor</span></tt></a><a class="headerlink" href="#module-sans.models.ModelAdaptor" title="Permalink to this headline">¶</a></h2>
60<p>This software was developed by the University of Tennessee as part of the
61Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
62project funded by the US National Science Foundation.</p>
63<p>If you use DANSE applications to do scientific research that leads to
64publication, we ask that you acknowledge the use of the software with the
65following sentence:</p>
66<p>&#8220;This work benefited from DANSE software developed under NSF award DMR-0520547.&#8221;</p>
67<p>copyright 2008, University of Tennessee</p>
68<dl class="class">
69<dt id="sans.models.ModelAdaptor.ModelAdaptor">
70<em class="property">class </em><tt class="descclassname">sans.models.ModelAdaptor.</tt><tt class="descname">ModelAdaptor</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ModelAdaptor" title="Permalink to this definition">¶</a></dt>
71<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
72<p>Model adaptor to provide old-style model functionality</p>
73<dl class="method">
74<dt id="sans.models.ModelAdaptor.ModelAdaptor.getParamListWithToken">
75<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ModelAdaptor.ModelAdaptor.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
76<dd></dd></dl>
77
78<dl class="method">
79<dt id="sans.models.ModelAdaptor.ModelAdaptor.getParamWithToken">
80<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ModelAdaptor.ModelAdaptor.getParamWithToken" title="Permalink to this definition">¶</a></dt>
81<dd></dd></dl>
82
83<dl class="method">
84<dt id="sans.models.ModelAdaptor.ModelAdaptor.setParamWithToken">
85<tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ModelAdaptor.ModelAdaptor.setParamWithToken" title="Permalink to this definition">¶</a></dt>
86<dd></dd></dl>
87
88</dd></dl>
89
90<dl class="class">
91<dt id="sans.models.ModelAdaptor.ParameterDict">
92<em class="property">class </em><tt class="descclassname">sans.models.ModelAdaptor.</tt><tt class="descname">ParameterDict</tt><big>(</big><em>parameters</em><big>)</big><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict" title="Permalink to this definition">¶</a></dt>
93<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt></p>
94<p>Parameter dictionary used for backward
95compatibility between the old-style &#8216;params&#8217;
96dictionary and the new-style &#8216;parameters&#8217;
97dictionary.</p>
98<dl class="attribute">
99<dt id="sans.models.ModelAdaptor.ParameterDict.clear">
100<tt class="descname">clear</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.clear" title="Permalink to this definition">¶</a></dt>
101<dd>D.clear() -&gt; None.  Remove all items from D.</dd></dl>
102
103<dl class="attribute">
104<dt id="sans.models.ModelAdaptor.ParameterDict.copy">
105<tt class="descname">copy</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.copy" title="Permalink to this definition">¶</a></dt>
106<dd>D.copy() -&gt; a shallow copy of D</dd></dl>
107
108<dl class="staticmethod">
109<dt id="sans.models.ModelAdaptor.ParameterDict.fromkeys">
110<em class="property">static </em><tt class="descname">fromkeys</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.fromkeys" title="Permalink to this definition">¶</a></dt>
111<dd>dict.fromkeys(S[,v]) -&gt; New dict with keys from S and values equal to v.
112v defaults to None.</dd></dl>
113
114<dl class="attribute">
115<dt id="sans.models.ModelAdaptor.ParameterDict.get">
116<tt class="descname">get</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.get" title="Permalink to this definition">¶</a></dt>
117<dd>D.get(k[,d]) -&gt; D[k] if k in D, else d.  d defaults to None.</dd></dl>
118
119<dl class="attribute">
120<dt id="sans.models.ModelAdaptor.ParameterDict.has_key">
121<tt class="descname">has_key</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.has_key" title="Permalink to this definition">¶</a></dt>
122<dd>D.has_key(k) -&gt; True if D has a key k, else False</dd></dl>
123
124<dl class="attribute">
125<dt id="sans.models.ModelAdaptor.ParameterDict.items">
126<tt class="descname">items</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.items" title="Permalink to this definition">¶</a></dt>
127<dd>D.items() -&gt; list of D&#8217;s (key, value) pairs, as 2-tuples</dd></dl>
128
129<dl class="attribute">
130<dt id="sans.models.ModelAdaptor.ParameterDict.iteritems">
131<tt class="descname">iteritems</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.iteritems" title="Permalink to this definition">¶</a></dt>
132<dd>D.iteritems() -&gt; an iterator over the (key, value) items of D</dd></dl>
133
134<dl class="attribute">
135<dt id="sans.models.ModelAdaptor.ParameterDict.iterkeys">
136<tt class="descname">iterkeys</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.iterkeys" title="Permalink to this definition">¶</a></dt>
137<dd>D.iterkeys() -&gt; an iterator over the keys of D</dd></dl>
138
139<dl class="attribute">
140<dt id="sans.models.ModelAdaptor.ParameterDict.itervalues">
141<tt class="descname">itervalues</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.itervalues" title="Permalink to this definition">¶</a></dt>
142<dd>D.itervalues() -&gt; an iterator over the values of D</dd></dl>
143
144<dl class="attribute">
145<dt id="sans.models.ModelAdaptor.ParameterDict.keys">
146<tt class="descname">keys</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.keys" title="Permalink to this definition">¶</a></dt>
147<dd>D.keys() -&gt; list of D&#8217;s keys</dd></dl>
148
149<dl class="attribute">
150<dt id="sans.models.ModelAdaptor.ParameterDict.pop">
151<tt class="descname">pop</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.pop" title="Permalink to this definition">¶</a></dt>
152<dd>D.pop(k[,d]) -&gt; v, remove specified key and return the corresponding value
153If key is not found, d is returned if given, otherwise KeyError is raised</dd></dl>
154
155<dl class="attribute">
156<dt id="sans.models.ModelAdaptor.ParameterDict.popitem">
157<tt class="descname">popitem</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.popitem" title="Permalink to this definition">¶</a></dt>
158<dd>D.popitem() -&gt; (k, v), remove and return some (key, value) pair as a
1592-tuple; but raise KeyError if D is empty</dd></dl>
160
161<dl class="attribute">
162<dt id="sans.models.ModelAdaptor.ParameterDict.setdefault">
163<tt class="descname">setdefault</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.setdefault" title="Permalink to this definition">¶</a></dt>
164<dd>D.setdefault(k[,d]) -&gt; D.get(k,d), also set D[k]=d if k not in D</dd></dl>
165
166<dl class="attribute">
167<dt id="sans.models.ModelAdaptor.ParameterDict.update">
168<tt class="descname">update</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.update" title="Permalink to this definition">¶</a></dt>
169<dd>D.update(E, <a href="#id1"><span class="problematic" id="id2">**</span></a>F) -&gt; None.  Update D from E and F: for k in E: D[k] = E[k]
170(if E has keys else: for (k, v) in E: D[k] = v) then: for k in F: D[k] = F[k]</dd></dl>
171
172<dl class="attribute">
173<dt id="sans.models.ModelAdaptor.ParameterDict.values">
174<tt class="descname">values</tt><a class="headerlink" href="#sans.models.ModelAdaptor.ParameterDict.values" title="Permalink to this definition">¶</a></dt>
175<dd>D.values() -&gt; list of D&#8217;s values</dd></dl>
176
177</dd></dl>
178
179</div>
180</div>
181
182
183          </div>
184        </div>
185      </div>
186      <div class="sphinxsidebar">
187        <div class="sphinxsidebarwrapper">
188  <h3><a href="../index.html">Table Of Contents</a></h3>
189  <ul>
190<li><a class="reference internal" href="#">ModelAdaptor</a><ul>
191<li><a class="reference internal" href="#module-sans.models.ModelAdaptor"><tt class="docutils literal"><span class="pre">sans.models.ModelAdaptor</span></tt></a></li>
192</ul>
193</li>
194</ul>
195
196  <h4>Previous topic</h4>
197  <p class="topless"><a href="LorentzModel.html"
198                        title="previous chapter">LorentzModel</a></p>
199  <h4>Next topic</h4>
200  <p class="topless"><a href="ModelFactory.html"
201                        title="next chapter">ModelFactory</a></p>
202  <h3>This Page</h3>
203  <ul class="this-page-menu">
204    <li><a href="../_sources/api/ModelAdaptor.txt"
205           rel="nofollow">Show Source</a></li>
206  </ul>
207<div id="searchbox" style="display: none">
208  <h3>Quick search</h3>
209    <form class="search" action="../search.html" method="get">
210      <input type="text" name="q" size="18" />
211      <input type="submit" value="Go" />
212      <input type="hidden" name="check_keywords" value="yes" />
213      <input type="hidden" name="area" value="default" />
214    </form>
215    <p class="searchtip" style="font-size: 90%">
216    Enter search terms or a module, class or function name.
217    </p>
218</div>
219<script type="text/javascript">$('#searchbox').show(0);</script>
220        </div>
221      </div>
222      <div class="clearer"></div>
223    </div>
224    <div class="related">
225      <h3>Navigation</h3>
226      <ul>
227        <li class="right" style="margin-right: 10px">
228          <a href="../genindex.html" title="General Index"
229             >index</a></li>
230        <li class="right" >
231          <a href="../py-modindex.html" title="Python Module Index"
232             >modules</a> |</li>
233        <li class="right" >
234          <a href="ModelFactory.html" title="ModelFactory"
235             >next</a> |</li>
236        <li class="right" >
237          <a href="LorentzModel.html" title="LorentzModel"
238             >previous</a> |</li>
239        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
240          <li><a href="index.html" >Reference</a> &raquo;</li> 
241      </ul>
242    </div>
243    <div class="footer">
244        &copy; Copyright 2010, sans group.
245      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
246    </div>
247  </body>
248</html>
Note: See TracBrowser for help on using the repository browser.