source: sasview/_modules/sas/models/OnionModel.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: 45.7 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.OnionModel &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.OnionModel</h1><div class="highlight"><pre>
52<span class="c">##############################################################################</span>
53<span class="c"># This software was developed by the University of Tennessee as part of the</span>
54<span class="c"># Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
55<span class="c"># project funded by the US National Science Foundation.</span>
56<span class="c">#</span>
57<span class="c"># If you use DANSE applications to do scientific research that leads to</span>
58<span class="c"># publication, we ask that you acknowledge the use of the software with the</span>
59<span class="c"># following sentence:</span>
60<span class="c">#</span>
61<span class="c"># This work benefited from DANSE software developed under NSF award DMR-0520547</span>
62<span class="c">#</span>
63<span class="c"># Copyright 2008-2011, University of Tennessee</span>
64<span class="c">##############################################################################</span>
65
66<span class="sd">&quot;&quot;&quot; </span>
67<span class="sd">Provide functionality for a C extension model</span>
68
69<span class="sd">.. WARNING::</span>
70
71<span class="sd">   THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY</span>
72<span class="sd">   DO NOT MODIFY THIS FILE, MODIFY</span>
73<span class="sd">   src/sas/models/include/onion.h</span>
74<span class="sd">   AND RE-RUN THE GENERATOR SCRIPT</span>
75<span class="sd">&quot;&quot;&quot;</span>
76
77<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
78<span class="kn">from</span> <span class="nn">sas.models.sas_extension.c_models</span> <span class="kn">import</span> <span class="n">COnionModel</span>
79
80<div class="viewcode-block" id="create_OnionModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.create_OnionModel">[docs]</a><span class="k">def</span> <span class="nf">create_OnionModel</span><span class="p">():</span>
81    <span class="sd">&quot;&quot;&quot;</span>
82<span class="sd">       Create a model instance</span>
83<span class="sd">    &quot;&quot;&quot;</span>
84    <span class="n">obj</span> <span class="o">=</span> <span class="n">OnionModel</span><span class="p">()</span>
85    <span class="c"># COnionModel.__init__(obj) is called by</span>
86    <span class="c"># the OnionModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="OnionModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel">[docs]</a><span class="k">class</span> <span class="nc">OnionModel</span><span class="p">(</span><span class="n">COnionModel</span><span class="p">,</span> <span class="n">BaseComponent</span><span class="p">):</span>
90    <span class="sd">&quot;&quot;&quot; </span>
91<span class="sd">    Class that evaluates a OnionModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/onion.h.</span>
93<span class="sd">    Refer to that file and the structure it contains</span>
94<span class="sd">    for details of the model.</span>
95<span class="sd">    </span>
96<span class="sd">    List of default parameters:</span>
97
98<span class="sd">    * n_shells        = 1.0 </span>
99<span class="sd">    * scale           = 1.0 </span>
100<span class="sd">    * rad_core0       = 200.0 [A]</span>
101<span class="sd">    * sld_core0       = 1e-06 [1/A^(2)]</span>
102<span class="sd">    * sld_solv        = 6.4e-06 [1/A^(2)]</span>
103<span class="sd">    * background      = 0.0 [1/cm]</span>
104<span class="sd">    * sld_out_shell1  = 2e-06 [1/A^(2)]</span>
105<span class="sd">    * sld_out_shell2  = 2.5e-06 [1/A^(2)]</span>
106<span class="sd">    * sld_out_shell3  = 3e-06 [1/A^(2)]</span>
107<span class="sd">    * sld_out_shell4  = 3.5e-06 [1/A^(2)]</span>
108<span class="sd">    * sld_out_shell5  = 4e-06 [1/A^(2)]</span>
109<span class="sd">    * sld_out_shell6  = 4.5e-06 [1/A^(2)]</span>
110<span class="sd">    * sld_out_shell7  = 5e-06 [1/A^(2)]</span>
111<span class="sd">    * sld_out_shell8  = 5.5e-06 [1/A^(2)]</span>
112<span class="sd">    * sld_out_shell9  = 6e-06 [1/A^(2)]</span>
113<span class="sd">    * sld_out_shell10 = 6.2e-06 [1/A^(2)]</span>
114<span class="sd">    * sld_in_shell1   = 1.7e-06 [1/A^(2)]</span>
115<span class="sd">    * sld_in_shell2   = 2.2e-06 [1/A^(2)]</span>
116<span class="sd">    * sld_in_shell3   = 2.7e-06 [1/A^(2)]</span>
117<span class="sd">    * sld_in_shell4   = 3.2e-06 [1/A^(2)]</span>
118<span class="sd">    * sld_in_shell5   = 3.7e-06 [1/A^(2)]</span>
119<span class="sd">    * sld_in_shell6   = 4.2e-06 [1/A^(2)]</span>
120<span class="sd">    * sld_in_shell7   = 4.7e-06 [1/A^(2)]</span>
121<span class="sd">    * sld_in_shell8   = 5.2e-06 [1/A^(2)]</span>
122<span class="sd">    * sld_in_shell9   = 5.7e-06 [1/A^(2)]</span>
123<span class="sd">    * sld_in_shell10  = 6e-06 [1/A^(2)]</span>
124<span class="sd">    * A_shell1        = 1.0 </span>
125<span class="sd">    * A_shell2        = 1.0 </span>
126<span class="sd">    * A_shell3        = 1.0 </span>
127<span class="sd">    * A_shell4        = 1.0 </span>
128<span class="sd">    * A_shell5        = 1.0 </span>
129<span class="sd">    * A_shell6        = 1.0 </span>
130<span class="sd">    * A_shell7        = 1.0 </span>
131<span class="sd">    * A_shell8        = 1.0 </span>
132<span class="sd">    * A_shell9        = 1.0 </span>
133<span class="sd">    * A_shell10       = 1.0 </span>
134<span class="sd">    * thick_shell1    = 50.0 [A]</span>
135<span class="sd">    * thick_shell2    = 50.0 [A]</span>
136<span class="sd">    * thick_shell3    = 50.0 [A]</span>
137<span class="sd">    * thick_shell4    = 50.0 [A]</span>
138<span class="sd">    * thick_shell5    = 50.0 [A]</span>
139<span class="sd">    * thick_shell6    = 50.0 [A]</span>
140<span class="sd">    * thick_shell7    = 50.0 [A]</span>
141<span class="sd">    * thick_shell8    = 50.0 [A]</span>
142<span class="sd">    * thick_shell9    = 50.0 [A]</span>
143<span class="sd">    * thick_shell10   = 50.0 [A]</span>
144<span class="sd">    * func_shell1     = 2.0 </span>
145<span class="sd">    * func_shell2     = 2.0 </span>
146<span class="sd">    * func_shell3     = 2.0 </span>
147<span class="sd">    * func_shell4     = 2.0 </span>
148<span class="sd">    * func_shell5     = 2.0 </span>
149<span class="sd">    * func_shell6     = 2.0 </span>
150<span class="sd">    * func_shell7     = 2.0 </span>
151<span class="sd">    * func_shell8     = 2.0 </span>
152<span class="sd">    * func_shell9     = 2.0 </span>
153<span class="sd">    * func_shell10    = 2.0 </span>
154
155<span class="sd">    &quot;&quot;&quot;</span>
156       
157    <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">multfactor</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
158        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
159        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
160       
161        <span class="c"># Initialize BaseComponent first, then sphere</span>
162        <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>
163        <span class="c">#apply(COnionModel.__init__, (self,)) </span>
164
165        <span class="n">COnionModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
166        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
167                       
168        <span class="c">## Name of the model</span>
169        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;OnionModel&quot;</span>
170        <span class="c">## Model description</span>
171        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;</span>
172<span class="s">        Form factor of mutishells normalized by the volume. Here each shell is described</span>
173<span class="s">                by an exponential function;</span>
174<span class="s">                I)</span>
175<span class="s">                For A_shell != 0,</span>
176<span class="s">                f(r) = B*exp(A_shell*(r-r_in)/thick_shell)+C</span>
177<span class="s">                where</span>
178<span class="s">                B=(sld_out-sld_in)/(exp(A_shell)-1)</span>
179<span class="s">                C=sld_in-B.</span>
180<span class="s">                Note that in the above case,</span>
181<span class="s">                the function becomes a linear function</span>
182<span class="s">                as A_shell --&gt; 0+ or 0-.</span>
183<span class="s">                II)</span>
184<span class="s">                For the exact point of A_shell == 0,</span>
185<span class="s">                f(r) = sld_in ,i.e., it crosses over flat function</span>
186<span class="s">                Note that the &#39;sld_out&#39; becaomes NULL in this case.</span>
187<span class="s">                </span>
188<span class="s">                background:background,</span>
189<span class="s">                rad_core0: radius of sphere(core)</span>
190<span class="s">                thick_shell#:the thickness of the shell#</span>
191<span class="s">                sld_core0: the SLD of the sphere</span>
192<span class="s">                sld_solv: the SLD of the solvent</span>
193<span class="s">                sld_shell: the SLD of the shell#</span>
194<span class="s">                A_shell#: the coefficient in the exponential function</span>
195<span class="s">        &quot;&quot;&quot;</span>
196       
197        <span class="c">## Parameter details [units, min, max]</span>
198        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
199        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;n_shells&#39;</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>
200        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;scale&#39;</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>
201        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;rad_core0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
202        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_core0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
203        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_solv&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
204        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;background&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/cm]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
205        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
206        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
207        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
208        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
209        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
210        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
211        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
212        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
213        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
214        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_out_shell10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
215        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
216        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
217        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
218        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
219        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
220        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
221        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
222        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
223        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
224        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_in_shell10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
225        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell1&#39;</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>
226        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell2&#39;</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>
227        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell3&#39;</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>
228        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell4&#39;</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>
229        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell5&#39;</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>
230        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell6&#39;</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>
231        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell7&#39;</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>
232        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell8&#39;</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>
233        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell9&#39;</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>
234        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;A_shell10&#39;</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>
235        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
236        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
237        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
238        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
239        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
240        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
241        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
242        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
243        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
244        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_shell10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
245        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell1&#39;</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>
246        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell2&#39;</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>
247        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell3&#39;</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>
248        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell4&#39;</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>
249        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell5&#39;</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>
250        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell6&#39;</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>
251        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell7&#39;</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>
252        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell8&#39;</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>
253        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell9&#39;</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>
254        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_shell10&#39;</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>
255
256        <span class="c">## fittable parameters</span>
257        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;rad_core0.width&#39;</span><span class="p">,</span>
258                      <span class="s">&#39;thick_shell1.width&#39;</span><span class="p">,</span>
259                      <span class="s">&#39;thick_shell2.width&#39;</span><span class="p">,</span>
260                      <span class="s">&#39;thick_shell3.width&#39;</span><span class="p">,</span>
261                      <span class="s">&#39;thick_shell4.width&#39;</span><span class="p">,</span>
262                      <span class="s">&#39;thick_shell5.width&#39;</span><span class="p">,</span>
263                      <span class="s">&#39;thick_shell6.width&#39;</span><span class="p">,</span>
264                      <span class="s">&#39;thick_shell7.width&#39;</span><span class="p">,</span>
265                      <span class="s">&#39;thick_shell8.width&#39;</span><span class="p">,</span>
266                      <span class="s">&#39;thick_shell9.width&#39;</span><span class="p">,</span>
267                      <span class="s">&#39;thick_shell10.width&#39;</span><span class="p">]</span>
268       
269        <span class="c">## non-fittable parameters</span>
270        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
271       
272        <span class="c">## parameters with orientation</span>
273        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
274
275        <span class="c">## parameters with magnetism</span>
276        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
277
278        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
279        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
280       
281    <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
282        <span class="sd">&quot;&quot;&quot;</span>
283<span class="sd">        restore the state of a model from pickle</span>
284<span class="sd">        &quot;&quot;&quot;</span>
285        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</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="bp">self</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="n">state</span>
286       
287    <span class="k">def</span> <span class="nf">__reduce_ex__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span>
288        <span class="sd">&quot;&quot;&quot;</span>
289<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
290<span class="sd">        c model.</span>
291<span class="sd">        &quot;&quot;&quot;</span>
292        <span class="n">state</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__dict__</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="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">)</span>
293        <span class="k">return</span> <span class="p">(</span><span class="n">create_OnionModel</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">(),</span> <span class="n">state</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
294       
295<div class="viewcode-block" id="OnionModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.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>
296        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
297        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clone</span><span class="p">(</span><span class="n">OnionModel</span><span class="p">())</span>   
298        </div>
299<div class="viewcode-block" id="OnionModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.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>
300        <span class="sd">&quot;&quot;&quot; </span>
301<span class="sd">        Evaluate the model</span>
302<span class="sd">        </span>
303<span class="sd">        :param x: input q, or [q,phi]</span>
304<span class="sd">        </span>
305<span class="sd">        :return: scattering function P(q)</span>
306<span class="sd">        </span>
307<span class="sd">        &quot;&quot;&quot;</span>
308        <span class="k">return</span> <span class="n">COnionModel</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>
309   </div>
310<div class="viewcode-block" id="OnionModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.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>
311        <span class="sd">&quot;&quot;&quot; </span>
312<span class="sd">        Evaluate the model in cartesian coordinates</span>
313<span class="sd">        </span>
314<span class="sd">        :param x: input q, or [qx, qy]</span>
315<span class="sd">        </span>
316<span class="sd">        :return: scattering function P(q)</span>
317<span class="sd">        </span>
318<span class="sd">        &quot;&quot;&quot;</span>
319        <span class="k">return</span> <span class="n">COnionModel</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>
320        </div>
321<div class="viewcode-block" id="OnionModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.evalDistribution">[docs]</a>    <span class="k">def</span> <span class="nf">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
322        <span class="sd">&quot;&quot;&quot; </span>
323<span class="sd">        Evaluate the model in cartesian coordinates</span>
324<span class="sd">        </span>
325<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
326<span class="sd">        </span>
327<span class="sd">        :return: scattering function P(q[])</span>
328<span class="sd">        </span>
329<span class="sd">        &quot;&quot;&quot;</span>
330        <span class="k">return</span> <span class="n">COnionModel</span><span class="o">.</span><span class="n">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
331        </div>
332<div class="viewcode-block" id="OnionModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.calculate_ER">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
333        <span class="sd">&quot;&quot;&quot; </span>
334<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
335<span class="sd">        </span>
336<span class="sd">        :return: the value of the effective radius</span>
337<span class="sd">        </span>
338<span class="sd">        &quot;&quot;&quot;</span>       
339        <span class="k">return</span> <span class="n">COnionModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
340        </div>
341<div class="viewcode-block" id="OnionModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.calculate_VR">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
342        <span class="sd">&quot;&quot;&quot; </span>
343<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
344<span class="sd">        </span>
345<span class="sd">        :return: the value of the volf ratio</span>
346<span class="sd">        </span>
347<span class="sd">        &quot;&quot;&quot;</span>       
348        <span class="k">return</span> <span class="n">COnionModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
349              </div>
350<div class="viewcode-block" id="OnionModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.OnionModel.OnionModel.set_dispersion">[docs]</a>    <span class="k">def</span> <span class="nf">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="p">):</span>
351        <span class="sd">&quot;&quot;&quot;</span>
352<span class="sd">        Set the dispersion object for a model parameter</span>
353<span class="sd">        </span>
354<span class="sd">        :param parameter: name of the parameter [string]</span>
355<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
356<span class="sd">        </span>
357<span class="sd">        &quot;&quot;&quot;</span>
358        <span class="k">return</span> <span class="n">COnionModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
359               <span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="o">.</span><span class="n">cdisp</span><span class="p">)</span>
360       
361   
362<span class="c"># End of file</span>
363</pre></div></div></div>
364
365          </div>
366        </div>
367      </div>
368      <div class="sphinxsidebar">
369        <div class="sphinxsidebarwrapper">
370<div id="searchbox" style="display: none">
371  <h3>Quick search</h3>
372    <form class="search" action="../../../search.html" method="get">
373      <input type="text" name="q" />
374      <input type="submit" value="Go" />
375      <input type="hidden" name="check_keywords" value="yes" />
376      <input type="hidden" name="area" value="default" />
377    </form>
378    <p class="searchtip" style="font-size: 90%">
379    Enter search terms or a module, class or function name.
380    </p>
381</div>
382<script type="text/javascript">$('#searchbox').show(0);</script>
383        </div>
384      </div>
385      <div class="clearer"></div>
386    </div>
387    <div class="related">
388      <h3>Navigation</h3>
389      <ul>
390        <li class="right" style="margin-right: 10px">
391          <a href="../../../genindex.html" title="General Index"
392             >index</a></li>
393        <li class="right" >
394          <a href="../../../py-modindex.html" title="Python Module Index"
395             >modules</a> |</li>
396        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
397          <li><a href="../../index.html" >Module code</a> &raquo;</li>
398          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
399      </ul>
400    </div>
401    <div class="footer">
402        &copy; Copyright 2013, The SasView Project.
403      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
404    </div>
405  </body>
406</html>
Note: See TracBrowser for help on using the repository browser.