source: sasview/_modules/sas/models/DisperseModel.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.4 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.DisperseModel &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.DisperseModel</h1><div class="highlight"><pre>
52<span class="sd">&quot;&quot;&quot; </span>
53<span class="sd">    Wrapper for the Disperser class extension</span>
54<span class="sd">&quot;&quot;&quot;</span>
55<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
56<span class="kn">from</span> <span class="nn">sas_extension.c_models</span> <span class="kn">import</span> <span class="n">Disperser</span>
57   
58<div class="viewcode-block" id="DisperseModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DisperseModel.DisperseModel">[docs]</a><span class="k">class</span> <span class="nc">DisperseModel</span><span class="p">(</span><span class="n">Disperser</span><span class="p">,</span> <span class="n">BaseComponent</span><span class="p">):</span>
59    <span class="sd">&quot;&quot;&quot; </span>
60<span class="sd">    Wrapper class for the Disperser extension</span>
61<span class="sd">    Python class that takes a model and averages its output</span>
62<span class="sd">    for a distribution of its parameters.</span>
63<span class="sd">      </span>
64<span class="sd">    The parameters to be varied are specified at instantiation time.</span>
65<span class="sd">    The distributions are Gaussian, with std deviations specified for</span>
66<span class="sd">    each parameter at instantiation time.</span>
67<span class="sd">    </span>
68<span class="sd">    Example: ::</span>
69<span class="sd">    </span>
70<span class="sd">        cyl = CylinderModel()</span>
71<span class="sd">        disp = DisperseModel(cyl, [&#39;cyl_phi&#39;], [0.3])</span>
72<span class="sd">        disp.run([0.01, 1.57])</span>
73<span class="sd">        </span>
74<span class="sd">    &quot;&quot;&quot;</span>
75       
76    <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">model</span><span class="p">,</span> <span class="n">paramList</span><span class="p">,</span> <span class="n">sigmaList</span><span class="p">):</span>
77        <span class="sd">&quot;&quot;&quot; </span>
78<span class="sd">        Initialization </span>
79<span class="sd">        </span>
80<span class="sd">        :param model: Model to disperse [BaseComponent]</span>
81<span class="sd">        :param paramList: list of parameters to disperse [List of strings]</span>
82<span class="sd">        :param sigmaList: list of std deviations for Gaussian dispersion</span>
83<span class="sd">                    [List of floats]</span>
84<span class="sd">        </span>
85<span class="sd">        &quot;&quot;&quot;</span>
86       
87        <span class="c"># Initialize BaseComponent first, then sphere</span>
88        <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>
89        <span class="n">Disperser</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">paramList</span><span class="p">,</span> <span class="n">sigmaList</span><span class="p">)</span>
90        <span class="c">## Name of the model</span>
91        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">name</span>
92        <span class="c">## Keep track of the underlying model</span>
93        <span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span>
94        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span><span class="s">&#39;&#39;</span>
95        <span class="c">#list of parameter that cannot be fitted</span>
96        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[]</span>
97       
98<div class="viewcode-block" id="DisperseModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DisperseModel.DisperseModel.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>
99        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
100        <span class="k">return</span> <span class="n">DisperseModel</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;paramList&#39;</span><span class="p">],</span> 
101                             <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;sigmaList&#39;</span><span class="p">])</span> 
102   </div>
103<div class="viewcode-block" id="DisperseModel.setParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DisperseModel.DisperseModel.setParam">[docs]</a>    <span class="k">def</span> <span class="nf">setParam</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>
104        <span class="sd">&quot;&quot;&quot;</span>
105<span class="sd">            Set a parameter value</span>
106<span class="sd">            :param name: parameter name</span>
107<span class="sd">        &quot;&quot;&quot;</span>
108        <span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">:</span>
109            <span class="n">BaseComponent</span><span class="o">.</span><span class="n">setParam</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>
110        <span class="k">else</span><span class="p">:</span>
111            <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
112   </div>
113<div class="viewcode-block" id="DisperseModel.getParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DisperseModel.DisperseModel.getParam">[docs]</a>    <span class="k">def</span> <span class="nf">getParam</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
114        <span class="sd">&quot;&quot;&quot;</span>
115<span class="sd">            Get the value of the given parameter</span>
116<span class="sd">            :param name: parameter name</span>
117<span class="sd">        &quot;&quot;&quot;</span>
118        <span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">:</span>
119            <span class="k">return</span> <span class="n">BaseComponent</span><span class="o">.</span><span class="n">getParam</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
120        <span class="k">else</span><span class="p">:</span>
121            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">getParam</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
122   </div>
123<div class="viewcode-block" id="DisperseModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DisperseModel.DisperseModel.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>
124        <span class="sd">&quot;&quot;&quot; </span>
125<span class="sd">            Evaluate the model</span>
126<span class="sd">            :param x: input q, or [q,phi]</span>
127<span class="sd">            :return: scattering function P(q)</span>
128<span class="sd">        &quot;&quot;&quot;</span>
129        <span class="k">return</span> <span class="n">Disperser</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
130           </div>
131<div class="viewcode-block" id="DisperseModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.DisperseModel.DisperseModel.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>
132        <span class="sd">&quot;&quot;&quot; </span>
133<span class="sd">            Evaluate the model</span>
134<span class="sd">            :param x: input q, or [q,phi]</span>
135<span class="sd">            :return: scattering function P(q)</span>
136<span class="sd">        &quot;&quot;&quot;</span>
137        <span class="k">return</span> <span class="n">Disperser</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
138   
139<span class="c"># End of file</span></div></div>
140</pre></div>
141
142          </div>
143        </div>
144      </div>
145      <div class="sphinxsidebar">
146        <div class="sphinxsidebarwrapper">
147<div id="searchbox" style="display: none">
148  <h3>Quick search</h3>
149    <form class="search" action="../../../search.html" method="get">
150      <input type="text" name="q" />
151      <input type="submit" value="Go" />
152      <input type="hidden" name="check_keywords" value="yes" />
153      <input type="hidden" name="area" value="default" />
154    </form>
155    <p class="searchtip" style="font-size: 90%">
156    Enter search terms or a module, class or function name.
157    </p>
158</div>
159<script type="text/javascript">$('#searchbox').show(0);</script>
160        </div>
161      </div>
162      <div class="clearer"></div>
163    </div>
164    <div class="related">
165      <h3>Navigation</h3>
166      <ul>
167        <li class="right" style="margin-right: 10px">
168          <a href="../../../genindex.html" title="General Index"
169             >index</a></li>
170        <li class="right" >
171          <a href="../../../py-modindex.html" title="Python Module Index"
172             >modules</a> |</li>
173        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
174          <li><a href="../../index.html" >Module code</a> &raquo;</li>
175          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
176      </ul>
177    </div>
178    <div class="footer">
179        &copy; Copyright 2013, The SasView Project.
180      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
181    </div>
182  </body>
183</html>
Note: See TracBrowser for help on using the repository browser.