source: sasview/_modules/sas/models/PearlNecklaceModel.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: 27.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.PearlNecklaceModel &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.PearlNecklaceModel</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/pearlnecklace.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">CPearlNecklaceModel</span>
79
80<div class="viewcode-block" id="create_PearlNecklaceModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.create_PearlNecklaceModel">[docs]</a><span class="k">def</span> <span class="nf">create_PearlNecklaceModel</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">PearlNecklaceModel</span><span class="p">()</span>
85    <span class="c"># CPearlNecklaceModel.__init__(obj) is called by</span>
86    <span class="c"># the PearlNecklaceModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="PearlNecklaceModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel">[docs]</a><span class="k">class</span> <span class="nc">PearlNecklaceModel</span><span class="p">(</span><span class="n">CPearlNecklaceModel</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 PearlNecklaceModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/pearlnecklace.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">    * radius          = 80.0 [A]</span>
100<span class="sd">    * edge_separation = 350.0 [A]</span>
101<span class="sd">    * thick_string    = 2.5 [A]</span>
102<span class="sd">    * num_pearls      = 3.0 </span>
103<span class="sd">    * sld_pearl       = 1e-06 [1/A^(2)]</span>
104<span class="sd">    * sld_string      = 1e-06 [1/A^(2)]</span>
105<span class="sd">    * sld_solv        = 6.3e-06 [1/A^(2)]</span>
106<span class="sd">    * background      = 0.0 </span>
107<span class="sd">    * scale           = 1.0 </span>
108<span class="sd">    * radius          = 80.0 [A]</span>
109<span class="sd">    * edge_separation = 350.0 [A]</span>
110<span class="sd">    * thick_string    = 2.5 [A]</span>
111<span class="sd">    * num_pearls      = 3.0 </span>
112<span class="sd">    * sld_pearl       = 1e-06 [1/A^(2)]</span>
113<span class="sd">    * sld_string      = 1e-06 [1/A^(2)]</span>
114<span class="sd">    * sld_solv        = 6.3e-06 [1/A^(2)]</span>
115<span class="sd">    * background      = 0.0 </span>
116
117<span class="sd">    &quot;&quot;&quot;</span>
118       
119    <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>
120        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
121        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
122       
123        <span class="c"># Initialize BaseComponent first, then sphere</span>
124        <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>
125        <span class="c">#apply(CPearlNecklaceModel.__init__, (self,)) </span>
126
127        <span class="n">CPearlNecklaceModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
128        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
129                       
130        <span class="c">## Name of the model</span>
131        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;PearlNecklaceModel&quot;</span>
132        <span class="c">## Model description</span>
133        <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>
134<span class="s">        Calculate form factor for Pearl Necklace Model</span>
135<span class="s">                [Macromol. Symp. 2004, 211, 25-42]</span>
136<span class="s">                Parameters:</span>
137<span class="s">                background:background</span>
138<span class="s">                scale: scale factor</span>
139<span class="s">                sld_pearl: the SLD of the pearl spheres</span>
140<span class="s">                sld_string: the SLD of the strings</span>
141<span class="s">                sld_solv: the SLD of the solvent</span>
142<span class="s">                num_pearls: number of the pearls</span>
143<span class="s">                radius: the radius of a pearl</span>
144<span class="s">                edge_separation: the length of string segment; surface to surface</span>
145<span class="s">                thick_string: thickness (ie, diameter) of the string</span>
146<span class="s">        &quot;&quot;&quot;</span>
147       
148        <span class="c">## Parameter details [units, min, max]</span>
149        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</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;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>
151        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;radius&#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>
152        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;edge_separation&#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>
153        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_string&#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>
154        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;num_pearls&#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>
155        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_pearl&#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>
156        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_string&#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>
157        <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>
158        <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;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
159        <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>
160        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;radius&#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>
161        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;edge_separation&#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>
162        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_string&#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>
163        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;num_pearls&#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>
164        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_pearl&#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;sld_string&#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>
166        <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>
167        <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;&#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
169        <span class="c">## fittable parameters</span>
170        <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;radius.width&#39;</span><span class="p">,</span>
171                      <span class="s">&#39;edge_separation.width&#39;</span><span class="p">]</span>
172       
173        <span class="c">## non-fittable parameters</span>
174        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
175       
176        <span class="c">## parameters with orientation</span>
177        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
178
179        <span class="c">## parameters with magnetism</span>
180        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
181
182        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
183        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
184       
185    <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>
186        <span class="sd">&quot;&quot;&quot;</span>
187<span class="sd">        restore the state of a model from pickle</span>
188<span class="sd">        &quot;&quot;&quot;</span>
189        <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>
190       
191    <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>
192        <span class="sd">&quot;&quot;&quot;</span>
193<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
194<span class="sd">        c model.</span>
195<span class="sd">        &quot;&quot;&quot;</span>
196        <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>
197        <span class="k">return</span> <span class="p">(</span><span class="n">create_PearlNecklaceModel</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>
198       
199<div class="viewcode-block" id="PearlNecklaceModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
200        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
201        <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">PearlNecklaceModel</span><span class="p">())</span>   
202        </div>
203<div class="viewcode-block" id="PearlNecklaceModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
204        <span class="sd">&quot;&quot;&quot; </span>
205<span class="sd">        Evaluate the model</span>
206<span class="sd">        </span>
207<span class="sd">        :param x: input q, or [q,phi]</span>
208<span class="sd">        </span>
209<span class="sd">        :return: scattering function P(q)</span>
210<span class="sd">        </span>
211<span class="sd">        &quot;&quot;&quot;</span>
212        <span class="k">return</span> <span class="n">CPearlNecklaceModel</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>
213   </div>
214<div class="viewcode-block" id="PearlNecklaceModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
215        <span class="sd">&quot;&quot;&quot; </span>
216<span class="sd">        Evaluate the model in cartesian coordinates</span>
217<span class="sd">        </span>
218<span class="sd">        :param x: input q, or [qx, qy]</span>
219<span class="sd">        </span>
220<span class="sd">        :return: scattering function P(q)</span>
221<span class="sd">        </span>
222<span class="sd">        &quot;&quot;&quot;</span>
223        <span class="k">return</span> <span class="n">CPearlNecklaceModel</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>
224        </div>
225<div class="viewcode-block" id="PearlNecklaceModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
226        <span class="sd">&quot;&quot;&quot; </span>
227<span class="sd">        Evaluate the model in cartesian coordinates</span>
228<span class="sd">        </span>
229<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
230<span class="sd">        </span>
231<span class="sd">        :return: scattering function P(q[])</span>
232<span class="sd">        </span>
233<span class="sd">        &quot;&quot;&quot;</span>
234        <span class="k">return</span> <span class="n">CPearlNecklaceModel</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>
235        </div>
236<div class="viewcode-block" id="PearlNecklaceModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
237        <span class="sd">&quot;&quot;&quot; </span>
238<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
239<span class="sd">        </span>
240<span class="sd">        :return: the value of the effective radius</span>
241<span class="sd">        </span>
242<span class="sd">        &quot;&quot;&quot;</span>       
243        <span class="k">return</span> <span class="n">CPearlNecklaceModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
244        </div>
245<div class="viewcode-block" id="PearlNecklaceModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
246        <span class="sd">&quot;&quot;&quot; </span>
247<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
248<span class="sd">        </span>
249<span class="sd">        :return: the value of the volf ratio</span>
250<span class="sd">        </span>
251<span class="sd">        &quot;&quot;&quot;</span>       
252        <span class="k">return</span> <span class="n">CPearlNecklaceModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
253              </div>
254<div class="viewcode-block" id="PearlNecklaceModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.PearlNecklaceModel.PearlNecklaceModel.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>
255        <span class="sd">&quot;&quot;&quot;</span>
256<span class="sd">        Set the dispersion object for a model parameter</span>
257<span class="sd">        </span>
258<span class="sd">        :param parameter: name of the parameter [string]</span>
259<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
260<span class="sd">        </span>
261<span class="sd">        &quot;&quot;&quot;</span>
262        <span class="k">return</span> <span class="n">CPearlNecklaceModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
263               <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>
264       
265   
266<span class="c"># End of file</span>
267</pre></div></div></div>
268
269          </div>
270        </div>
271      </div>
272      <div class="sphinxsidebar">
273        <div class="sphinxsidebarwrapper">
274<div id="searchbox" style="display: none">
275  <h3>Quick search</h3>
276    <form class="search" action="../../../search.html" method="get">
277      <input type="text" name="q" />
278      <input type="submit" value="Go" />
279      <input type="hidden" name="check_keywords" value="yes" />
280      <input type="hidden" name="area" value="default" />
281    </form>
282    <p class="searchtip" style="font-size: 90%">
283    Enter search terms or a module, class or function name.
284    </p>
285</div>
286<script type="text/javascript">$('#searchbox').show(0);</script>
287        </div>
288      </div>
289      <div class="clearer"></div>
290    </div>
291    <div class="related">
292      <h3>Navigation</h3>
293      <ul>
294        <li class="right" style="margin-right: 10px">
295          <a href="../../../genindex.html" title="General Index"
296             >index</a></li>
297        <li class="right" >
298          <a href="../../../py-modindex.html" title="Python Module Index"
299             >modules</a> |</li>
300        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
301          <li><a href="../../index.html" >Module code</a> &raquo;</li>
302          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
303      </ul>
304    </div>
305    <div class="footer">
306        &copy; Copyright 2013, The SasView Project.
307      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
308    </div>
309  </body>
310</html>
Note: See TracBrowser for help on using the repository browser.