source: sasview/_modules/sas/models/MultiplicationModel.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 45.2 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.MultiplicationModel &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.MultiplicationModel</h1><div class="highlight"><pre>
52<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
53<span class="c">#import numpy, math</span>
54<span class="kn">import</span> <span class="nn">copy</span>
55<span class="c">#from sas.models.pluginmodel import Model1DPlugin</span>
56<span class="k">class</span> <span class="nc">MultiplicationModel</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
57<div class="viewcode-block" id="MultiplicationModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel">[docs]</a>    <span class="sd">&quot;&quot;&quot;</span>
58<span class="sd">        Use for P(Q)*S(Q); function call must be in the order of P(Q) and then S(Q):</span>
59<span class="sd">        The model parameters are combined from both models, P(Q) and S(Q), except 1) &#39;effect_radius&#39; of S(Q)</span>
60<span class="sd">        which will be calculated from P(Q) via calculate_ER(), </span>
61<span class="sd">        and 2) &#39;scale&#39; in P model which is synchronized w/ volfraction in S </span>
62<span class="sd">        then P*S is multiplied by a new param, &#39;scale_factor&#39;.</span>
63<span class="sd">        The polydispersion is applicable only to P(Q), not to S(Q).</span>
64<span class="sd">        Note: P(Q) refers to &#39;form factor&#39; model while S(Q) does to &#39;structure factor&#39;.</span>
65<span class="sd">    &quot;&quot;&quot;</span>
66    <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">p_model</span><span class="p">,</span> <span class="n">s_model</span> <span class="p">):</span>
67        <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>
68        <span class="sd">&quot;&quot;&quot;</span>
69<span class="sd">        :param p_model: form factor, P(Q)</span>
70<span class="sd">        :param s_model: structure factor, S(Q)</span>
71<span class="sd">        &quot;&quot;&quot;</span>
72
73        <span class="c">## Setting  model name model description</span>
74        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
75        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">p_model</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span><span class="s">&quot; * &quot;</span><span class="o">+</span> <span class="n">s_model</span><span class="o">.</span><span class="n">name</span>
76        <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span>
77        <span class="bp">self</span><span class="o">.</span><span class="n">fill_description</span><span class="p">(</span><span class="n">p_model</span><span class="p">,</span> <span class="n">s_model</span><span class="p">)</span>
78
79        <span class="c">## Define parameters</span>
80        <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="p">{}</span>
81
82        <span class="c">## Parameter details [units, min, max]</span>
83        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
84       
85        <span class="c">##models </span>
86        <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span> <span class="o">=</span> <span class="n">p_model</span>
87        <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span> <span class="o">=</span> <span class="n">s_model</span>       
88        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
89        <span class="c">## dispersion</span>
90        <span class="bp">self</span><span class="o">.</span><span class="n">_set_dispersion</span><span class="p">()</span>
91        <span class="c">## Define parameters</span>
92        <span class="bp">self</span><span class="o">.</span><span class="n">_set_params</span><span class="p">()</span>
93        <span class="c">## New parameter:Scaling factor</span>
94        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;scale_factor&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>
95       
96        <span class="c">## Parameter details [units, min, max]</span>
97        <span class="bp">self</span><span class="o">.</span><span class="n">_set_details</span><span class="p">()</span>
98        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;scale_factor&#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>
99       
100        <span class="c">#list of parameter that can be fitted</span>
101        <span class="bp">self</span><span class="o">.</span><span class="n">_set_fixed_params</span><span class="p">()</span> 
102        <span class="c">## parameters with orientation</span>
103        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">orientation_params</span><span class="p">:</span>
104            <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
105        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">magnetic_params</span><span class="p">:</span> 
106            <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span> 
107        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">orientation_params</span><span class="p">:</span>
108            <span class="k">if</span> <span class="ow">not</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span><span class="p">:</span>
109                <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
110        <span class="c"># get multiplicity if model provide it, else 1.</span>
111        <span class="k">try</span><span class="p">:</span>
112            <span class="n">multiplicity</span> <span class="o">=</span> <span class="n">p_model</span><span class="o">.</span><span class="n">multiplicity</span>
113        <span class="k">except</span><span class="p">:</span>
114            <span class="n">multiplicity</span> <span class="o">=</span> <span class="mi">1</span>
115        <span class="c">## functional multiplicity of the model</span>
116        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity</span> <span class="o">=</span> <span class="n">multiplicity</span>   
117         
118        <span class="c"># non-fittable parameters</span>
119        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="n">p_model</span><span class="o">.</span><span class="n">non_fittable</span> 
120        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="p">[]</span> 
121        <span class="bp">self</span><span class="o">.</span><span class="n">fun_list</span> <span class="o">=</span> <span class="p">{}</span>
122        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
123            <span class="k">try</span><span class="p">:</span>
124                <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="n">p_model</span><span class="o">.</span><span class="n">multiplicity_info</span> 
125                <span class="bp">self</span><span class="o">.</span><span class="n">fun_list</span> <span class="o">=</span> <span class="n">p_model</span><span class="o">.</span><span class="n">fun_list</span>
126            <span class="k">except</span><span class="p">:</span>
127                <span class="k">pass</span>
128        <span class="k">else</span><span class="p">:</span>
129            <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="p">[]</span>
130           
131    <span class="k">def</span> <span class="nf">_clone</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
132        <span class="sd">&quot;&quot;&quot;</span>
133<span class="sd">            Internal utility function to copy the internal</span>
134<span class="sd">            data members to a fresh copy.</span>
135<span class="sd">        &quot;&quot;&quot;</span>
136        <span class="n">obj</span><span class="o">.</span><span class="n">params</span>     <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">)</span>
137        <span class="n">obj</span><span class="o">.</span><span class="n">description</span>     <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">)</span>
138        <span class="n">obj</span><span class="o">.</span><span class="n">details</span>    <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">)</span>
139        <span class="n">obj</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">)</span>
140        <span class="n">obj</span><span class="o">.</span><span class="n">p_model</span>  <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">clone</span><span class="p">()</span>
141        <span class="n">obj</span><span class="o">.</span><span class="n">s_model</span>  <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">clone</span><span class="p">()</span>
142        <span class="c">#obj = copy.deepcopy(self)</span>
143        <span class="k">return</span> <span class="n">obj</span>
144   
145   
146    <span class="k">def</span> <span class="nf">_set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
147        <span class="sd">&quot;&quot;&quot;</span>
148<span class="sd">           combined the two models dispersions</span>
149<span class="sd">           Polydispersion should not be applied to s_model</span>
150<span class="sd">        &quot;&quot;&quot;</span>
151        <span class="c">##set dispersion only from p_model </span>
152        <span class="k">for</span> <span class="n">name</span> <span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">dispersion</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
153            <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> 
154                                     
155    <span class="k">def</span> <span class="nf">getProfile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
156<div class="viewcode-block" id="MultiplicationModel.getProfile"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.getProfile">[docs]</a>        <span class="sd">&quot;&quot;&quot;</span>
157<span class="sd">        Get SLD profile of p_model if exists</span>
158<span class="sd">        </span>
159<span class="sd">        : return: (r, beta) where r is a list of radius of the transition points</span>
160<span class="sd">                beta is a list of the corresponding SLD values </span>
161<span class="sd">        : Note: This works only for func_shell# = 2 (exp function).</span>
162<span class="sd">        &quot;&quot;&quot;</span>
163        <span class="k">try</span><span class="p">:</span>
164            <span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">getProfile</span><span class="p">()</span>
165        <span class="k">except</span><span class="p">:</span>
166            <span class="n">x</span> <span class="o">=</span> <span class="bp">None</span>
167            <span class="n">y</span> <span class="o">=</span> <span class="bp">None</span>
168           
169        <span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
170   
171    <span class="k">def</span> <span class="nf">_set_params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span></div>
172        <span class="sd">&quot;&quot;&quot;</span>
173<span class="sd">            Concatenate the parameters of the two models to create</span>
174<span class="sd">            this model parameters </span>
175<span class="sd">        &quot;&quot;&quot;</span>
176
177        <span class="k">for</span> <span class="n">name</span> <span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
178            <span class="k">if</span> <span class="ow">not</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">and</span> <span class="n">name</span> <span class="o">!=</span> <span class="s">&#39;scale&#39;</span><span class="p">:</span>
179                <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
180           
181        <span class="k">for</span> <span class="n">name</span> <span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
182            <span class="c">#Remove the effect_radius from the (P*S) model parameters.</span>
183            <span class="k">if</span> <span class="ow">not</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">and</span> <span class="n">name</span> <span class="o">!=</span> <span class="s">&#39;effect_radius&#39;</span><span class="p">:</span>
184                <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
185               
186        <span class="c"># Set &quot;scale and effec_radius to P and S model as initializing</span>
187        <span class="c"># since run P*S comes from P and S separately.</span>
188        <span class="bp">self</span><span class="o">.</span><span class="n">_set_scale_factor</span><span class="p">()</span>
189        <span class="bp">self</span><span class="o">.</span><span class="n">_set_effect_radius</span><span class="p">()</span>       
190           
191    <span class="k">def</span> <span class="nf">_set_details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
192        <span class="sd">&quot;&quot;&quot;</span>
193<span class="sd">            Concatenate details of the two models to create</span>
194<span class="sd">            this model details </span>
195<span class="sd">        &quot;&quot;&quot;</span>
196        <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">detail</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">details</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
197            <span class="k">if</span> <span class="n">name</span> <span class="o">!=</span> <span class="s">&#39;scale&#39;</span><span class="p">:</span>
198                <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">detail</span>
199           
200        <span class="k">for</span> <span class="n">name</span> <span class="p">,</span> <span class="n">detail</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">details</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
201            <span class="k">if</span> <span class="ow">not</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">or</span> <span class="n">name</span> <span class="o">!=</span> <span class="s">&#39;effect_radius&#39;</span><span class="p">:</span>
202                <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">detail</span>
203   
204    <span class="k">def</span> <span class="nf">_set_scale_factor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
205        <span class="sd">&quot;&quot;&quot;</span>
206<span class="sd">            Set scale=volfraction to P model</span>
207<span class="sd">        &quot;&quot;&quot;</span>
208        <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;volfraction&#39;</span><span class="p">]</span>
209        <span class="k">if</span> <span class="n">value</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">:</span> 
210            <span class="n">factor</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">()</span>
211            <span class="k">if</span> <span class="n">factor</span> <span class="o">==</span> <span class="bp">None</span> <span class="ow">or</span> <span class="n">factor</span> <span class="o">==</span> <span class="bp">NotImplemented</span> <span class="ow">or</span> <span class="n">factor</span> <span class="o">==</span> <span class="mf">0.0</span><span class="p">:</span>
212                <span class="n">val</span> <span class="o">=</span> <span class="n">value</span>
213            <span class="k">else</span><span class="p">:</span>
214                <span class="n">val</span> <span class="o">=</span> <span class="n">value</span> <span class="o">/</span> <span class="n">factor</span>
215            <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span><span class="s">&#39;scale&#39;</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
216            <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span><span class="s">&#39;volfraction&#39;</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
217           
218    <span class="k">def</span> <span class="nf">_set_effect_radius</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
219        <span class="sd">&quot;&quot;&quot;</span>
220<span class="sd">            Set effective radius to S(Q) model</span>
221<span class="sd">        &quot;&quot;&quot;</span>
222        <span class="k">if</span> <span class="ow">not</span> <span class="s">&#39;effect_radius&#39;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
223            <span class="k">return</span>
224        <span class="n">effective_radius</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">()</span>
225        <span class="c">#Reset the effective_radius of s_model just before the run</span>
226        <span class="k">if</span> <span class="n">effective_radius</span> <span class="o">!=</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">effective_radius</span> <span class="o">!=</span> <span class="bp">NotImplemented</span><span class="p">:</span>
227            <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span><span class="s">&#39;effect_radius&#39;</span><span class="p">,</span> <span class="n">effective_radius</span><span class="p">)</span>
228               
229    <span class="k">def</span> <span class="nf">setParam</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
230<div class="viewcode-block" id="MultiplicationModel.setParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.setParam">[docs]</a>        <span class="sd">&quot;&quot;&quot; </span>
231<span class="sd">        Set the value of a model parameter</span>
232<span class="sd">        </span>
233<span class="sd">        :param name: name of the parameter</span>
234<span class="sd">        :param value: value of the parameter</span>
235<span class="sd">        &quot;&quot;&quot;</span>
236        <span class="c"># set param to P*S model</span>
237        <span class="bp">self</span><span class="o">.</span><span class="n">_setParamHelper</span><span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
238       
239        <span class="c">## setParam to p model </span>
240        <span class="c"># set &#39;scale&#39; in P(Q) equal to volfraction </span>
241        <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s">&#39;volfraction&#39;</span><span class="p">:</span>
242            <span class="bp">self</span><span class="o">.</span><span class="n">_set_scale_factor</span><span class="p">()</span>
243        <span class="k">elif</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">getParamList</span><span class="p">():</span>
244            <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
245       
246        <span class="c">## setParam to s model </span>
247        <span class="c"># This is a little bit abundant: Todo: find better way         </span>
248        <span class="bp">self</span><span class="o">.</span><span class="n">_set_effect_radius</span><span class="p">()</span>
249        <span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">getParamList</span><span class="p">():</span>
250            <span class="k">if</span> <span class="n">name</span> <span class="o">!=</span> <span class="s">&#39;volfraction&#39;</span><span class="p">:</span>
251                <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
252           
253
254        <span class="c">#self._setParamHelper( name, value)</span>
255       
256    <span class="k">def</span> <span class="nf">_setParamHelper</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span></div>
257        <span class="sd">&quot;&quot;&quot;</span>
258<span class="sd">            Helper function to setparam</span>
259<span class="sd">        &quot;&quot;&quot;</span>
260        <span class="c"># Look for dispersion parameters</span>
261        <span class="n">toks</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)</span>
262        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">toks</span><span class="p">)</span><span class="o">==</span><span class="mi">2</span><span class="p">:</span>
263            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
264                <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">==</span><span class="n">toks</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
265                    <span class="k">for</span> <span class="n">par</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">[</span><span class="n">item</span><span class="p">]:</span>
266                        <span class="k">if</span> <span class="n">par</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">toks</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
267                            <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">[</span><span class="n">item</span><span class="p">][</span><span class="n">par</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
268                            <span class="k">return</span>
269        <span class="k">else</span><span class="p">:</span>
270            <span class="c"># Look for standard parameter</span>
271            <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
272                <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
273                    <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="n">item</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
274                    <span class="k">return</span>
275           
276        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Model does not contain parameter </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">name</span>
277             
278   
279    <span class="k">def</span> <span class="nf">_set_fixed_params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
280        <span class="sd">&quot;&quot;&quot;</span>
281<span class="sd">             fill the self.fixed list with the p_model fixed list</span>
282<span class="sd">        &quot;&quot;&quot;</span>
283        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">fixed</span><span class="p">:</span>
284            <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
285
286        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
287               
288               
289    <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>
290<div class="viewcode-block" id="MultiplicationModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.run">[docs]</a>        <span class="sd">&quot;&quot;&quot; </span>
291<span class="sd">        Evaluate the model</span>
292<span class="sd">        :param x: input q-value (float or [float, float] as [r, theta])</span>
293<span class="sd">        :return: (scattering function value)</span>
294<span class="sd">        &quot;&quot;&quot;</span>
295        <span class="c"># set effective radius and scaling factor before run</span>
296        <span class="bp">self</span><span class="o">.</span><span class="n">_set_effect_radius</span><span class="p">()</span>
297        <span class="bp">self</span><span class="o">.</span><span class="n">_set_scale_factor</span><span class="p">()</span>
298        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;scale_factor&#39;</span><span class="p">]</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">*</span> \
299                            <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
300
301    <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></div>
302<div class="viewcode-block" id="MultiplicationModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.runXY">[docs]</a>        <span class="sd">&quot;&quot;&quot; Evaluate the model</span>
303<span class="sd">            @param x: input q-value (float or [float, float] as [qx, qy])</span>
304<span class="sd">            @return: scattering function value</span>
305<span class="sd">        &quot;&quot;&quot;</span> 
306        <span class="c"># set effective radius and scaling factor before run</span>
307        <span class="bp">self</span><span class="o">.</span><span class="n">_set_effect_radius</span><span class="p">()</span>
308        <span class="bp">self</span><span class="o">.</span><span class="n">_set_scale_factor</span><span class="p">()</span>
309        <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;scale_factor&#39;</span><span class="p">]</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">*</span> \
310                        <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
311        <span class="k">return</span> <span class="n">out</span>
312   
313    <span class="c">## Now (May27,10) directly uses the model eval function </span>
314    <span class="c">## instead of the for-loop in Base Component.</span>
315    <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="o">=</span> <span class="p">[]):</span></div>
316<div class="viewcode-block" id="MultiplicationModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.evalDistribution">[docs]</a>        <span class="sd">&quot;&quot;&quot; </span>
317<span class="sd">        Evaluate the model in cartesian coordinates</span>
318<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
319<span class="sd">        :return: scattering function P(q[])</span>
320<span class="sd">        &quot;&quot;&quot;</span>
321        <span class="c"># set effective radius and scaling factor before run</span>
322        <span class="bp">self</span><span class="o">.</span><span class="n">_set_effect_radius</span><span class="p">()</span>
323        <span class="bp">self</span><span class="o">.</span><span class="n">_set_scale_factor</span><span class="p">()</span>
324        <span class="n">out</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;scale_factor&#39;</span><span class="p">]</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">evalDistribution</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">*</span> \
325                        <span class="bp">self</span><span class="o">.</span><span class="n">s_model</span><span class="o">.</span><span class="n">evalDistribution</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
326        <span class="k">return</span> <span class="n">out</span>
327
328    <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></div>
329<div class="viewcode-block" id="MultiplicationModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.set_dispersion">[docs]</a>        <span class="sd">&quot;&quot;&quot;</span>
330<span class="sd">        Set the dispersion object for a model parameter</span>
331<span class="sd">        :param parameter: name of the parameter [string]</span>
332<span class="sd">        :dispersion: dispersion object of type DispersionModel</span>
333<span class="sd">        &quot;&quot;&quot;</span>
334        <span class="n">value</span> <span class="o">=</span> <span class="bp">None</span>
335        <span class="k">try</span><span class="p">:</span>
336            <span class="k">if</span> <span class="n">parameter</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">dispersion</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
337                <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">p_model</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="p">)</span>
338            <span class="bp">self</span><span class="o">.</span><span class="n">_set_dispersion</span><span class="p">()</span>
339            <span class="k">return</span> <span class="n">value</span>
340        <span class="k">except</span><span class="p">:</span>
341            <span class="k">raise</span> 
342
343    <span class="k">def</span> <span class="nf">fill_description</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p_model</span><span class="p">,</span> <span class="n">s_model</span><span class="p">):</span></div>
344<div class="viewcode-block" id="MultiplicationModel.fill_description"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.MultiplicationModel.MultiplicationModel.fill_description">[docs]</a>        <span class="sd">&quot;&quot;&quot;</span>
345<span class="sd">            Fill the description for P(Q)*S(Q)</span>
346<span class="sd">        &quot;&quot;&quot;</span>
347        <span class="n">description</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
348        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;Note:1) The effect_radius (effective radius) of </span><span class="si">%s</span><span class="s"> </span><span class="se">\n</span><span class="s">&quot;</span><span class="o">%</span>\
349                                                                <span class="p">(</span><span class="n">s_model</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
350        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;             is automatically calculated &quot;</span>
351        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;from size parameters (radius...).</span><span class="se">\n</span><span class="s">&quot;</span>
352        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;         2) For non-spherical shape, &quot;</span>
353        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;this approximation is valid </span><span class="se">\n</span><span class="s">&quot;</span>
354        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;            only for limited systems. &quot;</span>
355        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;Thus, use it at your own risk.</span><span class="se">\n</span><span class="s">&quot;</span>
356        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;See </span><span class="si">%s</span><span class="s"> description and </span><span class="si">%s</span><span class="s"> description </span><span class="se">\n</span><span class="s">&quot;</span><span class="o">%</span> \
357                                                <span class="p">(</span> <span class="n">p_model</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">s_model</span><span class="o">.</span><span class="n">name</span> <span class="p">)</span>
358        <span class="n">description</span> <span class="o">+=</span> <span class="s">&quot;        for details of individual models.&quot;</span>
359        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">+=</span> <span class="n">description</span>
360   
361</pre></div></div></div>
362
363          </div>
364        </div>
365      </div>
366      <div class="sphinxsidebar">
367        <div class="sphinxsidebarwrapper">
368<div id="searchbox" style="display: none">
369  <h3>Quick search</h3>
370    <form class="search" action="../../../search.html" method="get">
371      <input type="text" name="q" />
372      <input type="submit" value="Go" />
373      <input type="hidden" name="check_keywords" value="yes" />
374      <input type="hidden" name="area" value="default" />
375    </form>
376    <p class="searchtip" style="font-size: 90%">
377    Enter search terms or a module, class or function name.
378    </p>
379</div>
380<script type="text/javascript">$('#searchbox').show(0);</script>
381        </div>
382      </div>
383      <div class="clearer"></div>
384    </div>
385    <div class="related">
386      <h3>Navigation</h3>
387      <ul>
388        <li class="right" style="margin-right: 10px">
389          <a href="../../../genindex.html" title="General Index"
390             >index</a></li>
391        <li class="right" >
392          <a href="../../../py-modindex.html" title="Python Module Index"
393             >modules</a> |</li>
394        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
395          <li><a href="../../index.html" >Module code</a> &raquo;</li>
396          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
397      </ul>
398    </div>
399    <div class="footer">
400        &copy; Copyright 2013, The SasView Project.
401      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
402    </div>
403  </body>
404</html>
Note: See TracBrowser for help on using the repository browser.