source: sasview/_modules/sas/models/LamellarPSModel.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: 23.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.LamellarPSModel &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.LamellarPSModel</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/lamellarPS.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">CLamellarPSModel</span>
79
80<div class="viewcode-block" id="create_LamellarPSModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.create_LamellarPSModel">[docs]</a><span class="k">def</span> <span class="nf">create_LamellarPSModel</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">LamellarPSModel</span><span class="p">()</span>
85    <span class="c"># CLamellarPSModel.__init__(obj) is called by</span>
86    <span class="c"># the LamellarPSModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="LamellarPSModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel">[docs]</a><span class="k">class</span> <span class="nc">LamellarPSModel</span><span class="p">(</span><span class="n">CLamellarPSModel</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 LamellarPSModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/lamellarPS.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">    * spacing         = 400.0 [A]</span>
100<span class="sd">    * delta           = 30.0 [A]</span>
101<span class="sd">    * sld_bi          = 6.3e-06 [1/A^(2)]</span>
102<span class="sd">    * sld_sol         = 1e-06 [1/A^(2)]</span>
103<span class="sd">    * n_plates        = 20.0 </span>
104<span class="sd">    * caille          = 0.1 </span>
105<span class="sd">    * background      = 0.0 [1/cm]</span>
106
107<span class="sd">    &quot;&quot;&quot;</span>
108       
109    <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>
110        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
111        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
112       
113        <span class="c"># Initialize BaseComponent first, then sphere</span>
114        <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>
115        <span class="c">#apply(CLamellarPSModel.__init__, (self,)) </span>
116
117        <span class="n">CLamellarPSModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
118        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
119                       
120        <span class="c">## Name of the model</span>
121        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;LamellarPSModel&quot;</span>
122        <span class="c">## Model description</span>
123        <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>
124<span class="s">        [Concentrated Lamellar Form Factor] Calculates the scattered</span>
125<span class="s">                intensity from a lyotropic lamellar phase.</span>
126<span class="s">                The intensity (form factor and structure</span>
127<span class="s">                factor)calculated is for lamellae of</span>
128<span class="s">                uniform scattering length density that</span>
129<span class="s">                are randomly distributed in solution</span>
130<span class="s">                (a powder average). The lamellae thickness</span>
131<span class="s">                is polydisperse. The model can also</span>
132<span class="s">                be applied to large, multi-lamellar vesicles.</span>
133<span class="s">                No resolution smeared version is included</span>
134<span class="s">                in the structure factor of this model.</span>
135<span class="s">                *Parameters: spacing = repeat spacing,</span>
136<span class="s">                delta = bilayer thickness,</span>
137<span class="s">                sld_bi = SLD_bilayer</span>
138<span class="s">                sld_sol = SLD_solvent</span>
139<span class="s">                n_plate = # of Lamellar plates</span>
140<span class="s">                caille = Caille parameter (&lt;0.8 or &lt;1)</span>
141<span class="s">                background = incoherent bgd</span>
142<span class="s">                scale = scale factor</span>
143<span class="s">        &quot;&quot;&quot;</span>
144       
145        <span class="c">## Parameter details [units, min, max]</span>
146        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
147        <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>
148        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;spacing&#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>
149        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;delta&#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>
150        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_bi&#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>
151        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_sol&#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>
152        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;n_plates&#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>
153        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;caille&#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>
154        <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>
155
156        <span class="c">## fittable parameters</span>
157        <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;delta.width&#39;</span><span class="p">,</span>
158                      <span class="s">&#39;spacing.width&#39;</span><span class="p">]</span>
159       
160        <span class="c">## non-fittable parameters</span>
161        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
162       
163        <span class="c">## parameters with orientation</span>
164        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
165
166        <span class="c">## parameters with magnetism</span>
167        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
168
169        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
170        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
171       
172    <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>
173        <span class="sd">&quot;&quot;&quot;</span>
174<span class="sd">        restore the state of a model from pickle</span>
175<span class="sd">        &quot;&quot;&quot;</span>
176        <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>
177       
178    <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>
179        <span class="sd">&quot;&quot;&quot;</span>
180<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
181<span class="sd">        c model.</span>
182<span class="sd">        &quot;&quot;&quot;</span>
183        <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>
184        <span class="k">return</span> <span class="p">(</span><span class="n">create_LamellarPSModel</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>
185       
186<div class="viewcode-block" id="LamellarPSModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
187        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
188        <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">LamellarPSModel</span><span class="p">())</span>   
189        </div>
190<div class="viewcode-block" id="LamellarPSModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
191        <span class="sd">&quot;&quot;&quot; </span>
192<span class="sd">        Evaluate the model</span>
193<span class="sd">        </span>
194<span class="sd">        :param x: input q, or [q,phi]</span>
195<span class="sd">        </span>
196<span class="sd">        :return: scattering function P(q)</span>
197<span class="sd">        </span>
198<span class="sd">        &quot;&quot;&quot;</span>
199        <span class="k">return</span> <span class="n">CLamellarPSModel</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>
200   </div>
201<div class="viewcode-block" id="LamellarPSModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
202        <span class="sd">&quot;&quot;&quot; </span>
203<span class="sd">        Evaluate the model in cartesian coordinates</span>
204<span class="sd">        </span>
205<span class="sd">        :param x: input q, or [qx, qy]</span>
206<span class="sd">        </span>
207<span class="sd">        :return: scattering function P(q)</span>
208<span class="sd">        </span>
209<span class="sd">        &quot;&quot;&quot;</span>
210        <span class="k">return</span> <span class="n">CLamellarPSModel</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>
211        </div>
212<div class="viewcode-block" id="LamellarPSModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
213        <span class="sd">&quot;&quot;&quot; </span>
214<span class="sd">        Evaluate the model in cartesian coordinates</span>
215<span class="sd">        </span>
216<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
217<span class="sd">        </span>
218<span class="sd">        :return: scattering function P(q[])</span>
219<span class="sd">        </span>
220<span class="sd">        &quot;&quot;&quot;</span>
221        <span class="k">return</span> <span class="n">CLamellarPSModel</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>
222        </div>
223<div class="viewcode-block" id="LamellarPSModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
224        <span class="sd">&quot;&quot;&quot; </span>
225<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
226<span class="sd">        </span>
227<span class="sd">        :return: the value of the effective radius</span>
228<span class="sd">        </span>
229<span class="sd">        &quot;&quot;&quot;</span>       
230        <span class="k">return</span> <span class="n">CLamellarPSModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
231        </div>
232<div class="viewcode-block" id="LamellarPSModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
233        <span class="sd">&quot;&quot;&quot; </span>
234<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
235<span class="sd">        </span>
236<span class="sd">        :return: the value of the volf ratio</span>
237<span class="sd">        </span>
238<span class="sd">        &quot;&quot;&quot;</span>       
239        <span class="k">return</span> <span class="n">CLamellarPSModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
240              </div>
241<div class="viewcode-block" id="LamellarPSModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.LamellarPSModel.LamellarPSModel.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>
242        <span class="sd">&quot;&quot;&quot;</span>
243<span class="sd">        Set the dispersion object for a model parameter</span>
244<span class="sd">        </span>
245<span class="sd">        :param parameter: name of the parameter [string]</span>
246<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
247<span class="sd">        </span>
248<span class="sd">        &quot;&quot;&quot;</span>
249        <span class="k">return</span> <span class="n">CLamellarPSModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
250               <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>
251       
252   
253<span class="c"># End of file</span>
254</pre></div></div></div>
255
256          </div>
257        </div>
258      </div>
259      <div class="sphinxsidebar">
260        <div class="sphinxsidebarwrapper">
261<div id="searchbox" style="display: none">
262  <h3>Quick search</h3>
263    <form class="search" action="../../../search.html" method="get">
264      <input type="text" name="q" />
265      <input type="submit" value="Go" />
266      <input type="hidden" name="check_keywords" value="yes" />
267      <input type="hidden" name="area" value="default" />
268    </form>
269    <p class="searchtip" style="font-size: 90%">
270    Enter search terms or a module, class or function name.
271    </p>
272</div>
273<script type="text/javascript">$('#searchbox').show(0);</script>
274        </div>
275      </div>
276      <div class="clearer"></div>
277    </div>
278    <div class="related">
279      <h3>Navigation</h3>
280      <ul>
281        <li class="right" style="margin-right: 10px">
282          <a href="../../../genindex.html" title="General Index"
283             >index</a></li>
284        <li class="right" >
285          <a href="../../../py-modindex.html" title="Python Module Index"
286             >modules</a> |</li>
287        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
288          <li><a href="../../index.html" >Module code</a> &raquo;</li>
289          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
290      </ul>
291    </div>
292    <div class="footer">
293        &copy; Copyright 2013, The SasView Project.
294      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
295    </div>
296  </body>
297</html>
Note: See TracBrowser for help on using the repository browser.