source: sasview/sansmodels/docs/sphinx/html/api/BaseComponent.html @ 0766d6d

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 0766d6d was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 12.2 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>BaseComponent &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="BaseModel" href="BaseModel.html" />
28    <link rel="prev" title="BarBellModel" href="BarBellModel.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="BaseModel.html" title="BaseModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="BarBellModel.html" title="BarBellModel"
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="basecomponent">
57<h1>BaseComponent<a class="headerlink" href="#basecomponent" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.BaseComponent">
59<span id="sans-models-basecomponent"></span><h2><a class="reference internal" href="#module-sans.models.BaseComponent" title="sans.models.BaseComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BaseComponent</span></tt></a><a class="headerlink" href="#module-sans.models.BaseComponent" title="Permalink to this headline">¶</a></h2>
60<p>Provide base functionality for all model components</p>
61<dl class="class">
62<dt id="sans.models.BaseComponent.BaseComponent">
63<em class="property">class </em><tt class="descclassname">sans.models.BaseComponent.</tt><tt class="descname">BaseComponent</tt><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent" title="Permalink to this definition">¶</a></dt>
64<dd><p>Basic model component</p>
65<p>Since version 0.5.0, basic operations are no longer supported.</p>
66<dl class="method">
67<dt id="sans.models.BaseComponent.BaseComponent.calculate_ER">
68<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.calculate_ER" title="Permalink to this definition">¶</a></dt>
69<dd></dd></dl>
70
71<dl class="method">
72<dt id="sans.models.BaseComponent.BaseComponent.clone">
73<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.clone" title="Permalink to this definition">¶</a></dt>
74<dd><p>Returns a new object identical to the current object</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.models.BaseComponent.BaseComponent.evalDistribution">
79<tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.evalDistribution" title="Permalink to this definition">¶</a></dt>
80<dd><p>Evaluate a distribution of q-values.</p>
81<ul>
82<li><p class="first">For 1D, a numpy array is expected as input:</p>
83<blockquote>
84<div><p>evalDistribution(q)</p>
85</div></blockquote>
86</li>
87</ul>
88<p>where q is a numpy array.</p>
89<ul class="simple">
90<li>For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
91where 1D arrays,</li>
92</ul>
93<p>qx_prime = [ qx[0], qx[1], qx[2], ....]
94and
95qy_prime = [ qy[0], qy[1], qy[2], ....]</p>
96<p>Then get
97q = numpy.sqrt(qx_prime^2+qy_prime^2)</p>
98<p>that is a qr in 1D array;
99q = [q[0], q[1], q[2], ....]</p>
100<table class="docutils field-list" frame="void" rules="none">
101<col class="field-name" />
102<col class="field-body" />
103<tbody valign="top">
104<tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering
105is supported for python models, thus C-models should have</p>
106<blockquote class="last">
107<div><p>their own evalDistribution methods.</p>
108</div></blockquote>
109</td>
110</tr>
111</tbody>
112</table>
113<p>The method is then called the following way:</p>
114<p>evalDistribution(q)
115where q is a numpy array.</p>
116<table class="docutils field-list" frame="void" rules="none">
117<col class="field-name" />
118<col class="field-body" />
119<tbody valign="top">
120<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]
121where qx,qy are 1D ndarrays</td>
122</tr>
123</tbody>
124</table>
125</dd></dl>
126
127<dl class="method">
128<dt id="sans.models.BaseComponent.BaseComponent.getDispParamList">
129<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getDispParamList" title="Permalink to this definition">¶</a></dt>
130<dd><p>Return a list of all available parameters for the model</p>
131</dd></dl>
132
133<dl class="method">
134<dt id="sans.models.BaseComponent.BaseComponent.getParam">
135<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParam" title="Permalink to this definition">¶</a></dt>
136<dd><p>Set the value of a model parameter</p>
137<table class="docutils field-list" frame="void" rules="none">
138<col class="field-name" />
139<col class="field-body" />
140<tbody valign="top">
141<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
142</tr>
143</tbody>
144</table>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.models.BaseComponent.BaseComponent.getParamList">
149<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParamList" title="Permalink to this definition">¶</a></dt>
150<dd><p>Return a list of all available parameters for the model</p>
151</dd></dl>
152
153<dl class="method">
154<dt id="sans.models.BaseComponent.BaseComponent.getParamListWithToken">
155<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
156<dd></dd></dl>
157
158<dl class="method">
159<dt id="sans.models.BaseComponent.BaseComponent.getParamWithToken">
160<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt>
161<dd></dd></dl>
162
163<dl class="method">
164<dt id="sans.models.BaseComponent.BaseComponent.is_fittable">
165<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.is_fittable" title="Permalink to this definition">¶</a></dt>
166<dd><p>Check if a given parameter is fittable or not</p>
167<table class="docutils field-list" frame="void" rules="none">
168<col class="field-name" />
169<col class="field-body" />
170<tbody valign="top">
171<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
172</tr>
173</tbody>
174</table>
175</dd></dl>
176
177<dl class="method">
178<dt id="sans.models.BaseComponent.BaseComponent.run">
179<tt class="descname">run</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.run" title="Permalink to this definition">¶</a></dt>
180<dd></dd></dl>
181
182<dl class="method">
183<dt id="sans.models.BaseComponent.BaseComponent.runXY">
184<tt class="descname">runXY</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.runXY" title="Permalink to this definition">¶</a></dt>
185<dd></dd></dl>
186
187<dl class="method">
188<dt id="sans.models.BaseComponent.BaseComponent.setParam">
189<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.setParam" title="Permalink to this definition">¶</a></dt>
190<dd><p>Set the value of a model parameter</p>
191<table class="docutils field-list" frame="void" rules="none">
192<col class="field-name" />
193<col class="field-body" />
194<tbody valign="top">
195<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
196<li><strong>name</strong> &#8211; name of the parameter</li>
197<li><strong>value</strong> &#8211; value of the parameter</li>
198</ul>
199</td>
200</tr>
201</tbody>
202</table>
203</dd></dl>
204
205<dl class="method">
206<dt id="sans.models.BaseComponent.BaseComponent.setParamWithToken">
207<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.BaseComponent.BaseComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt>
208<dd></dd></dl>
209
210</dd></dl>
211
212</div>
213</div>
214
215
216          </div>
217        </div>
218      </div>
219      <div class="sphinxsidebar">
220        <div class="sphinxsidebarwrapper">
221  <h3><a href="../index.html">Table Of Contents</a></h3>
222  <ul>
223<li><a class="reference internal" href="#">BaseComponent</a><ul>
224<li><a class="reference internal" href="#module-sans.models.BaseComponent"><tt class="docutils literal"><span class="pre">sans.models.BaseComponent</span></tt></a></li>
225</ul>
226</li>
227</ul>
228
229  <h4>Previous topic</h4>
230  <p class="topless"><a href="BarBellModel.html"
231                        title="previous chapter">BarBellModel</a></p>
232  <h4>Next topic</h4>
233  <p class="topless"><a href="BaseModel.html"
234                        title="next chapter">BaseModel</a></p>
235  <h3>This Page</h3>
236  <ul class="this-page-menu">
237    <li><a href="../_sources/api/BaseComponent.txt"
238           rel="nofollow">Show Source</a></li>
239  </ul>
240<div id="searchbox" style="display: none">
241  <h3>Quick search</h3>
242    <form class="search" action="../search.html" method="get">
243      <input type="text" name="q" size="18" />
244      <input type="submit" value="Go" />
245      <input type="hidden" name="check_keywords" value="yes" />
246      <input type="hidden" name="area" value="default" />
247    </form>
248    <p class="searchtip" style="font-size: 90%">
249    Enter search terms or a module, class or function name.
250    </p>
251</div>
252<script type="text/javascript">$('#searchbox').show(0);</script>
253        </div>
254      </div>
255      <div class="clearer"></div>
256    </div>
257    <div class="related">
258      <h3>Navigation</h3>
259      <ul>
260        <li class="right" style="margin-right: 10px">
261          <a href="../genindex.html" title="General Index"
262             >index</a></li>
263        <li class="right" >
264          <a href="../py-modindex.html" title="Python Module Index"
265             >modules</a> |</li>
266        <li class="right" >
267          <a href="BaseModel.html" title="BaseModel"
268             >next</a> |</li>
269        <li class="right" >
270          <a href="BarBellModel.html" title="BarBellModel"
271             >previous</a> |</li>
272        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
273          <li><a href="index.html" >Reference</a> &raquo;</li> 
274      </ul>
275    </div>
276    <div class="footer">
277        &copy; Copyright 2010, sans group.
278      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
279    </div>
280  </body>
281</html>
Note: See TracBrowser for help on using the repository browser.