source: sasview/_modules/sas/models/RPAModel.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: 33.3 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.RPAModel &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.RPAModel</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/rpa.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">CRPAModel</span>
79
80<div class="viewcode-block" id="create_RPAModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.create_RPAModel">[docs]</a><span class="k">def</span> <span class="nf">create_RPAModel</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">RPAModel</span><span class="p">()</span>
85    <span class="c"># CRPAModel.__init__(obj) is called by</span>
86    <span class="c"># the RPAModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="RPAModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel">[docs]</a><span class="k">class</span> <span class="nc">RPAModel</span><span class="p">(</span><span class="n">CRPAModel</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 RPAModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/rpa.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">    * lcase_n         = 0.0 </span>
99<span class="sd">    * ba              = 5.0 </span>
100<span class="sd">    * bb              = 5.0 </span>
101<span class="sd">    * bc              = 5.0 </span>
102<span class="sd">    * bd              = 5.0 </span>
103<span class="sd">    * Kab             = -0.0004 </span>
104<span class="sd">    * Kac             = -0.0004 </span>
105<span class="sd">    * Kad             = -0.0004 </span>
106<span class="sd">    * Kbc             = -0.0004 </span>
107<span class="sd">    * Kbd             = -0.0004 </span>
108<span class="sd">    * Kcd             = -0.0004 </span>
109<span class="sd">    * scale           = 1.0 </span>
110<span class="sd">    * background      = 0.0 [1/cm]</span>
111<span class="sd">    * Na              = 1000.0 </span>
112<span class="sd">    * Phia            = 0.25 </span>
113<span class="sd">    * va              = 100.0 </span>
114<span class="sd">    * La              = 1e-12 </span>
115<span class="sd">    * Nb              = 1000.0 </span>
116<span class="sd">    * Phib            = 0.25 </span>
117<span class="sd">    * vb              = 100.0 </span>
118<span class="sd">    * Lb              = 1e-12 </span>
119<span class="sd">    * Nc              = 1000.0 </span>
120<span class="sd">    * Phic            = 0.25 </span>
121<span class="sd">    * vc              = 100.0 </span>
122<span class="sd">    * Lc              = 1e-12 </span>
123<span class="sd">    * Nd              = 1000.0 </span>
124<span class="sd">    * Phid            = 0.25 </span>
125<span class="sd">    * vd              = 100.0 </span>
126<span class="sd">    * Ld              = 0.0 </span>
127
128<span class="sd">    &quot;&quot;&quot;</span>
129       
130    <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>
131        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
132        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
133       
134        <span class="c"># Initialize BaseComponent first, then sphere</span>
135        <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>
136        <span class="c">#apply(CRPAModel.__init__, (self,)) </span>
137
138        <span class="n">CRPAModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
139        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
140                       
141        <span class="c">## Name of the model</span>
142        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;RPAModel&quot;</span>
143        <span class="c">## Model description</span>
144        <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>
145<span class="s">          THIS FORMALISM APPLIES TO MULTICOMPONENT POLYMER MIXTURES IN THE</span>
146<span class="s">                HOMOGENEOUS (MIXED) PHASE REGION ONLY.;</span>
147<span class="s">                CASE 0: C/D BINARY MIXTURE OF HOMOPOLYMERS</span>
148<span class="s">                CASE 1: C-D DIBLOCK COPOLYMER</span>
149<span class="s">                CASE 2: B/C/D TERNARY MIXTURE OF HOMOPOLYMERS</span>
150<span class="s">                CASE 3: B/C-D MIXTURE OF HOMOPOLYMER B AND</span>
151<span class="s">                DIBLOCK COPOLYMER C-D</span>
152<span class="s">                CASE 4: B-C-D TRIBLOCK COPOLYMER</span>
153<span class="s">                CASE 5: A/B/C/D QUATERNARY MIXTURE OF HOMOPOLYMERS</span>
154<span class="s">                CASE 6: A/B/C-D MIXTURE OF TWO HOMOPOLYMERS A/B</span>
155<span class="s">                AND A DIBLOCK C-D</span>
156<span class="s">                CASE 7: A/B-C-D MIXTURE OF A HOMOPOLYMER A AND A</span>
157<span class="s">                TRIBLOCK B-C-D</span>
158<span class="s">                CASE 8: A-B/C-D MIXTURE OF TWO DIBLOCK COPOLYMERS</span>
159<span class="s">                A-B AND C-D</span>
160<span class="s">                CASE 9: A-B-C-D FOUR-BLOCK COPOLYMER</span>
161<span class="s">                See details in the model function help</span>
162<span class="s">        &quot;&quot;&quot;</span>
163       
164        <span class="c">## Parameter details [units, min, max]</span>
165        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</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;lcase_n&#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>
167        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;ba&#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        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;bb&#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>
169        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;bc&#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>
170        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;bd&#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>
171        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Kab&#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>
172        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Kac&#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>
173        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Kad&#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>
174        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Kbc&#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>
175        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Kbd&#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>
176        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Kcd&#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>
177        <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>
178        <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>
179        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Na&#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>
180        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Phia&#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>
181        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;va&#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>
182        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;La&#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>
183        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Nb&#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>
184        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Phib&#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>
185        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;vb&#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>
186        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Lb&#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>
187        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Nc&#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>
188        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Phic&#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>
189        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;vc&#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>
190        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Lc&#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>
191        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Nd&#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>
192        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Phid&#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>
193        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;vd&#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>
194        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Ld&#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>
195
196        <span class="c">## fittable parameters</span>
197        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[]</span>
198       
199        <span class="c">## non-fittable parameters</span>
200        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;lcase_n&#39;</span><span class="p">,</span>
201                             <span class="s">&#39;Na&#39;</span><span class="p">,</span>
202                             <span class="s">&#39;Phia&#39;</span><span class="p">,</span>
203                             <span class="s">&#39;va&#39;</span><span class="p">,</span>
204                             <span class="s">&#39;La&#39;</span><span class="p">,</span>
205                             <span class="s">&#39;Nb&#39;</span><span class="p">,</span>
206                             <span class="s">&#39;Phib&#39;</span><span class="p">,</span>
207                             <span class="s">&#39;vb&#39;</span><span class="p">,</span>
208                             <span class="s">&#39;Lb&#39;</span><span class="p">,</span>
209                             <span class="s">&#39;Nc&#39;</span><span class="p">,</span>
210                             <span class="s">&#39;Phic&#39;</span><span class="p">,</span>
211                             <span class="s">&#39;vc&#39;</span><span class="p">,</span>
212                             <span class="s">&#39;Lc&#39;</span><span class="p">,</span>
213                             <span class="s">&#39;Nd&#39;</span><span class="p">,</span>
214                             <span class="s">&#39;Phid&#39;</span><span class="p">,</span>
215                             <span class="s">&#39;vd&#39;</span><span class="p">,</span>
216                             <span class="s">&#39;Ld&#39;</span><span class="p">]</span>
217       
218        <span class="c">## parameters with orientation</span>
219        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
220
221        <span class="c">## parameters with magnetism</span>
222        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
223
224        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
225        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
226       
227    <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>
228        <span class="sd">&quot;&quot;&quot;</span>
229<span class="sd">        restore the state of a model from pickle</span>
230<span class="sd">        &quot;&quot;&quot;</span>
231        <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>
232       
233    <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>
234        <span class="sd">&quot;&quot;&quot;</span>
235<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
236<span class="sd">        c model.</span>
237<span class="sd">        &quot;&quot;&quot;</span>
238        <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>
239        <span class="k">return</span> <span class="p">(</span><span class="n">create_RPAModel</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>
240       
241<div class="viewcode-block" id="RPAModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
242        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
243        <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">RPAModel</span><span class="p">())</span>   
244        </div>
245<div class="viewcode-block" id="RPAModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
246        <span class="sd">&quot;&quot;&quot; </span>
247<span class="sd">        Evaluate the model</span>
248<span class="sd">        </span>
249<span class="sd">        :param x: input q, or [q,phi]</span>
250<span class="sd">        </span>
251<span class="sd">        :return: scattering function P(q)</span>
252<span class="sd">        </span>
253<span class="sd">        &quot;&quot;&quot;</span>
254        <span class="k">return</span> <span class="n">CRPAModel</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>
255   </div>
256<div class="viewcode-block" id="RPAModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
257        <span class="sd">&quot;&quot;&quot; </span>
258<span class="sd">        Evaluate the model in cartesian coordinates</span>
259<span class="sd">        </span>
260<span class="sd">        :param x: input q, or [qx, qy]</span>
261<span class="sd">        </span>
262<span class="sd">        :return: scattering function P(q)</span>
263<span class="sd">        </span>
264<span class="sd">        &quot;&quot;&quot;</span>
265        <span class="k">return</span> <span class="n">CRPAModel</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>
266        </div>
267<div class="viewcode-block" id="RPAModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
268        <span class="sd">&quot;&quot;&quot; </span>
269<span class="sd">        Evaluate the model in cartesian coordinates</span>
270<span class="sd">        </span>
271<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
272<span class="sd">        </span>
273<span class="sd">        :return: scattering function P(q[])</span>
274<span class="sd">        </span>
275<span class="sd">        &quot;&quot;&quot;</span>
276        <span class="k">return</span> <span class="n">CRPAModel</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>
277        </div>
278<div class="viewcode-block" id="RPAModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
279        <span class="sd">&quot;&quot;&quot; </span>
280<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
281<span class="sd">        </span>
282<span class="sd">        :return: the value of the effective radius</span>
283<span class="sd">        </span>
284<span class="sd">        &quot;&quot;&quot;</span>       
285        <span class="k">return</span> <span class="n">CRPAModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
286        </div>
287<div class="viewcode-block" id="RPAModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
288        <span class="sd">&quot;&quot;&quot; </span>
289<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
290<span class="sd">        </span>
291<span class="sd">        :return: the value of the volf ratio</span>
292<span class="sd">        </span>
293<span class="sd">        &quot;&quot;&quot;</span>       
294        <span class="k">return</span> <span class="n">CRPAModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
295              </div>
296<div class="viewcode-block" id="RPAModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.RPAModel.RPAModel.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>
297        <span class="sd">&quot;&quot;&quot;</span>
298<span class="sd">        Set the dispersion object for a model parameter</span>
299<span class="sd">        </span>
300<span class="sd">        :param parameter: name of the parameter [string]</span>
301<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
302<span class="sd">        </span>
303<span class="sd">        &quot;&quot;&quot;</span>
304        <span class="k">return</span> <span class="n">CRPAModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
305               <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>
306       
307   
308<span class="c"># End of file</span>
309</pre></div></div></div>
310
311          </div>
312        </div>
313      </div>
314      <div class="sphinxsidebar">
315        <div class="sphinxsidebarwrapper">
316<div id="searchbox" style="display: none">
317  <h3>Quick search</h3>
318    <form class="search" action="../../../search.html" method="get">
319      <input type="text" name="q" />
320      <input type="submit" value="Go" />
321      <input type="hidden" name="check_keywords" value="yes" />
322      <input type="hidden" name="area" value="default" />
323    </form>
324    <p class="searchtip" style="font-size: 90%">
325    Enter search terms or a module, class or function name.
326    </p>
327</div>
328<script type="text/javascript">$('#searchbox').show(0);</script>
329        </div>
330      </div>
331      <div class="clearer"></div>
332    </div>
333    <div class="related">
334      <h3>Navigation</h3>
335      <ul>
336        <li class="right" style="margin-right: 10px">
337          <a href="../../../genindex.html" title="General Index"
338             >index</a></li>
339        <li class="right" >
340          <a href="../../../py-modindex.html" title="Python Module Index"
341             >modules</a> |</li>
342        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
343          <li><a href="../../index.html" >Module code</a> &raquo;</li>
344          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
345      </ul>
346    </div>
347    <div class="footer">
348        &copy; Copyright 2013, The SasView Project.
349      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
350    </div>
351  </body>
352</html>
Note: See TracBrowser for help on using the repository browser.