source: sasview/_modules/sas/models/CoreFourShellModel.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: 38.6 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.CoreFourShellModel &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.CoreFourShellModel</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/corefourshell.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">CCoreFourShellModel</span>
79
80<div class="viewcode-block" id="create_CoreFourShellModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.create_CoreFourShellModel">[docs]</a><span class="k">def</span> <span class="nf">create_CoreFourShellModel</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">CoreFourShellModel</span><span class="p">()</span>
85    <span class="c"># CCoreFourShellModel.__init__(obj) is called by</span>
86    <span class="c"># the CoreFourShellModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="CoreFourShellModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel">[docs]</a><span class="k">class</span> <span class="nc">CoreFourShellModel</span><span class="p">(</span><span class="n">CCoreFourShellModel</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 CoreFourShellModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/corefourshell.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">    * scale           = 1.0 </span>
99<span class="sd">    * rad_core0       = 60.0 [A]</span>
100<span class="sd">    * sld_core0       = 6.4e-06 [1/A^(2)]</span>
101<span class="sd">    * thick_shell1    = 10.0 [A]</span>
102<span class="sd">    * sld_shell1      = 1e-06 [1/A^(2)]</span>
103<span class="sd">    * thick_shell2    = 10.0 [A]</span>
104<span class="sd">    * sld_shell2      = 2e-06 [1/A^(2)]</span>
105<span class="sd">    * thick_shell3    = 10.0 [A]</span>
106<span class="sd">    * sld_shell3      = 3e-06 [1/A^(2)]</span>
107<span class="sd">    * thick_shell4    = 10.0 [A]</span>
108<span class="sd">    * sld_shell4      = 4e-06 [1/A^(2)]</span>
109<span class="sd">    * sld_solv        = 6.4e-06 [1/A^(2)]</span>
110<span class="sd">    * background      = 0.001 [1/cm]</span>
111<span class="sd">    * M0_sld_shell1   = 0.0 [1/A^(2)]</span>
112<span class="sd">    * M_theta_shell1  = 0.0 [deg]</span>
113<span class="sd">    * M_phi_shell1    = 0.0 [deg]</span>
114<span class="sd">    * M0_sld_shell2   = 0.0 [1/A^(2)]</span>
115<span class="sd">    * M_theta_shell2  = 0.0 [deg]</span>
116<span class="sd">    * M_phi_shell2    = 0.0 [deg]</span>
117<span class="sd">    * M0_sld_shell3   = 0.0 [1/A^(2)]</span>
118<span class="sd">    * M_theta_shell3  = 0.0 [deg]</span>
119<span class="sd">    * M_phi_shell3    = 0.0 [deg]</span>
120<span class="sd">    * M0_sld_shell4   = 0.0 [1/A^(2)]</span>
121<span class="sd">    * M_theta_shell4  = 0.0 [deg]</span>
122<span class="sd">    * M_phi_shell4    = 0.0 [deg]</span>
123<span class="sd">    * M0_sld_core0    = 0.0 [1/A^(2)]</span>
124<span class="sd">    * M_theta_core0   = 0.0 [deg]</span>
125<span class="sd">    * M_phi_core0     = 0.0 [deg]</span>
126<span class="sd">    * M0_sld_solv     = 0.0 [1/A^(2)]</span>
127<span class="sd">    * M_theta_solv    = 0.0 [deg]</span>
128<span class="sd">    * M_phi_solv      = 0.0 [deg]</span>
129<span class="sd">    * Up_frac_i       = 0.5 [u/(u+d)]</span>
130<span class="sd">    * Up_frac_f       = 0.5 [u/(u+d)]</span>
131<span class="sd">    * Up_theta        = 0.0 [deg]</span>
132
133<span class="sd">    &quot;&quot;&quot;</span>
134       
135    <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>
136        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
137        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
138       
139        <span class="c"># Initialize BaseComponent first, then sphere</span>
140        <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>
141        <span class="c">#apply(CCoreFourShellModel.__init__, (self,)) </span>
142
143        <span class="n">CCoreFourShellModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
144        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
145                       
146        <span class="c">## Name of the model</span>
147        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;CoreFourShellModel&quot;</span>
148        <span class="c">## Model description</span>
149        <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>
150<span class="s">         Calculates the scattering intensity from a core-4 shell structure.</span>
151<span class="s">                scale = scale factor * volume fraction</span>
152<span class="s">                rad_core0: the radius of the core</span>
153<span class="s">                sld_core0: the SLD of the core</span>
154<span class="s">                thick_shelli: the thickness of the i&#39;th shell from the core</span>
155<span class="s">                sld_shelli: the SLD of the i&#39;th shell from the core</span>
156<span class="s">                sld_solv: the SLD of the solvent</span>
157<span class="s">                background: incoherent background</span>
158<span class="s">        &quot;&quot;&quot;</span>
159       
160        <span class="c">## Parameter details [units, min, max]</span>
161        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
162        <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>
163        <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>
164        <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>
165        <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>
166        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_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>
167        <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>
168        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_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>
169        <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>
170        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_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>
171        <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>
172        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_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>
173        <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>
174        <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>
175        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_sld_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>
176        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_shell1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
177        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_shell1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
178        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_sld_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>
179        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_shell2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
180        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_shell2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
181        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_sld_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>
182        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_shell3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
183        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_shell3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
184        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_sld_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>
185        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_shell4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
186        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_shell4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
187        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_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>
188        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_core0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
189        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_core0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
190        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_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>
191        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_solv&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
192        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_solv&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
193        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Up_frac_i&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[u/(u+d)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
194        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Up_frac_f&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[u/(u+d)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
195        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Up_theta&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
196
197        <span class="c">## fittable parameters</span>
198        <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;thick_shell4.width&#39;</span><span class="p">,</span>
199                      <span class="s">&#39;thick_shell1.width&#39;</span><span class="p">,</span>
200                      <span class="s">&#39;thick_shell2.width&#39;</span><span class="p">,</span>
201                      <span class="s">&#39;thick_shell3.width&#39;</span><span class="p">,</span>
202                      <span class="s">&#39;rad_core0.width&#39;</span><span class="p">]</span>
203       
204        <span class="c">## non-fittable parameters</span>
205        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
206       
207        <span class="c">## parameters with orientation</span>
208        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;M0_sld_shell4&#39;</span><span class="p">,</span>
209                                   <span class="s">&#39;M_theta_shell4&#39;</span><span class="p">,</span>
210                                   <span class="s">&#39;M_phi_shell4&#39;</span><span class="p">,</span>
211                                   <span class="s">&#39;M0_sld_shell3&#39;</span><span class="p">,</span>
212                                   <span class="s">&#39;M_theta_shell3&#39;</span><span class="p">,</span>
213                                   <span class="s">&#39;M_phi_shell3&#39;</span><span class="p">,</span>
214                                   <span class="s">&#39;M0_sld_shell2&#39;</span><span class="p">,</span>
215                                   <span class="s">&#39;M_theta_shell2&#39;</span><span class="p">,</span>
216                                   <span class="s">&#39;M_phi_shell2&#39;</span><span class="p">,</span>
217                                   <span class="s">&#39;M0_sld_shell1&#39;</span><span class="p">,</span>
218                                   <span class="s">&#39;M_theta_shell1&#39;</span><span class="p">,</span>
219                                   <span class="s">&#39;M_phi_shell1&#39;</span><span class="p">,</span>
220                                   <span class="s">&#39;M0_sld_core0&#39;</span><span class="p">,</span>
221                                   <span class="s">&#39;M_theta_core0&#39;</span><span class="p">,</span>
222                                   <span class="s">&#39;M_phi_core0&#39;</span><span class="p">,</span>
223                                   <span class="s">&#39;M0_sld_solv&#39;</span><span class="p">,</span>
224                                   <span class="s">&#39;M_theta_solv&#39;</span><span class="p">,</span>
225                                   <span class="s">&#39;M_phi_solv&#39;</span><span class="p">,</span>
226                                   <span class="s">&#39;Up_frac_i&#39;</span><span class="p">,</span>
227                                   <span class="s">&#39;Up_frac_f&#39;</span><span class="p">,</span>
228                                   <span class="s">&#39;Up_theta&#39;</span><span class="p">]</span>
229
230        <span class="c">## parameters with magnetism</span>
231        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;M0_sld_shell4&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_shell4&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_shell4&#39;</span><span class="p">,</span> <span class="s">&#39;M0_sld_shell3&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_shell3&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_shell3&#39;</span><span class="p">,</span> <span class="s">&#39;M0_sld_shell2&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_shell2&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_shell2&#39;</span><span class="p">,</span> <span class="s">&#39;M0_sld_shell1&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_shell1&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_shell1&#39;</span><span class="p">,</span> <span class="s">&#39;M0_sld_core0&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_core0&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_core0&#39;</span><span class="p">,</span> <span class="s">&#39;M0_sld_solv&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_solv&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_solv&#39;</span><span class="p">,</span> <span class="s">&#39;Up_frac_i&#39;</span><span class="p">,</span> <span class="s">&#39;Up_frac_f&#39;</span><span class="p">,</span> <span class="s">&#39;Up_theta&#39;</span><span class="p">]</span>
232
233        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
234        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
235       
236    <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>
237        <span class="sd">&quot;&quot;&quot;</span>
238<span class="sd">        restore the state of a model from pickle</span>
239<span class="sd">        &quot;&quot;&quot;</span>
240        <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>
241       
242    <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>
243        <span class="sd">&quot;&quot;&quot;</span>
244<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
245<span class="sd">        c model.</span>
246<span class="sd">        &quot;&quot;&quot;</span>
247        <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>
248        <span class="k">return</span> <span class="p">(</span><span class="n">create_CoreFourShellModel</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>
249       
250<div class="viewcode-block" id="CoreFourShellModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
251        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
252        <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">CoreFourShellModel</span><span class="p">())</span>   
253        </div>
254<div class="viewcode-block" id="CoreFourShellModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
255        <span class="sd">&quot;&quot;&quot; </span>
256<span class="sd">        Evaluate the model</span>
257<span class="sd">        </span>
258<span class="sd">        :param x: input q, or [q,phi]</span>
259<span class="sd">        </span>
260<span class="sd">        :return: scattering function P(q)</span>
261<span class="sd">        </span>
262<span class="sd">        &quot;&quot;&quot;</span>
263        <span class="k">return</span> <span class="n">CCoreFourShellModel</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>
264   </div>
265<div class="viewcode-block" id="CoreFourShellModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
266        <span class="sd">&quot;&quot;&quot; </span>
267<span class="sd">        Evaluate the model in cartesian coordinates</span>
268<span class="sd">        </span>
269<span class="sd">        :param x: input q, or [qx, qy]</span>
270<span class="sd">        </span>
271<span class="sd">        :return: scattering function P(q)</span>
272<span class="sd">        </span>
273<span class="sd">        &quot;&quot;&quot;</span>
274        <span class="k">return</span> <span class="n">CCoreFourShellModel</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>
275        </div>
276<div class="viewcode-block" id="CoreFourShellModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
277        <span class="sd">&quot;&quot;&quot; </span>
278<span class="sd">        Evaluate the model in cartesian coordinates</span>
279<span class="sd">        </span>
280<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
281<span class="sd">        </span>
282<span class="sd">        :return: scattering function P(q[])</span>
283<span class="sd">        </span>
284<span class="sd">        &quot;&quot;&quot;</span>
285        <span class="k">return</span> <span class="n">CCoreFourShellModel</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>
286        </div>
287<div class="viewcode-block" id="CoreFourShellModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
288        <span class="sd">&quot;&quot;&quot; </span>
289<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
290<span class="sd">        </span>
291<span class="sd">        :return: the value of the effective radius</span>
292<span class="sd">        </span>
293<span class="sd">        &quot;&quot;&quot;</span>       
294        <span class="k">return</span> <span class="n">CCoreFourShellModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
295        </div>
296<div class="viewcode-block" id="CoreFourShellModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
297        <span class="sd">&quot;&quot;&quot; </span>
298<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
299<span class="sd">        </span>
300<span class="sd">        :return: the value of the volf ratio</span>
301<span class="sd">        </span>
302<span class="sd">        &quot;&quot;&quot;</span>       
303        <span class="k">return</span> <span class="n">CCoreFourShellModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
304              </div>
305<div class="viewcode-block" id="CoreFourShellModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.CoreFourShellModel.CoreFourShellModel.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>
306        <span class="sd">&quot;&quot;&quot;</span>
307<span class="sd">        Set the dispersion object for a model parameter</span>
308<span class="sd">        </span>
309<span class="sd">        :param parameter: name of the parameter [string]</span>
310<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
311<span class="sd">        </span>
312<span class="sd">        &quot;&quot;&quot;</span>
313        <span class="k">return</span> <span class="n">CCoreFourShellModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
314               <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>
315       
316   
317<span class="c"># End of file</span>
318</pre></div></div></div>
319
320          </div>
321        </div>
322      </div>
323      <div class="sphinxsidebar">
324        <div class="sphinxsidebarwrapper">
325<div id="searchbox" style="display: none">
326  <h3>Quick search</h3>
327    <form class="search" action="../../../search.html" method="get">
328      <input type="text" name="q" />
329      <input type="submit" value="Go" />
330      <input type="hidden" name="check_keywords" value="yes" />
331      <input type="hidden" name="area" value="default" />
332    </form>
333    <p class="searchtip" style="font-size: 90%">
334    Enter search terms or a module, class or function name.
335    </p>
336</div>
337<script type="text/javascript">$('#searchbox').show(0);</script>
338        </div>
339      </div>
340      <div class="clearer"></div>
341    </div>
342    <div class="related">
343      <h3>Navigation</h3>
344      <ul>
345        <li class="right" style="margin-right: 10px">
346          <a href="../../../genindex.html" title="General Index"
347             >index</a></li>
348        <li class="right" >
349          <a href="../../../py-modindex.html" title="Python Module Index"
350             >modules</a> |</li>
351        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
352          <li><a href="../../index.html" >Module code</a> &raquo;</li>
353          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
354      </ul>
355    </div>
356    <div class="footer">
357        &copy; Copyright 2013, The SasView Project.
358      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
359    </div>
360  </body>
361</html>
Note: See TracBrowser for help on using the repository browser.