source: sasview/_modules/sas/models/UnifiedPowerRgModel.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: 36.1 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.UnifiedPowerRgModel &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.UnifiedPowerRgModel</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="kn">from</span> <span class="nn">math</span> <span class="kn">import</span> <span class="n">exp</span><span class="p">,</span> <span class="n">sqrt</span>
54<span class="kn">from</span> <span class="nn">numpy</span> <span class="kn">import</span> <span class="n">power</span>
55<span class="kn">from</span> <span class="nn">scipy.special</span> <span class="kn">import</span> <span class="n">erf</span>
56<span class="n">max_level_n</span> <span class="o">=</span> <span class="mi">7</span>
57<div class="viewcode-block" id="UnifiedPowerRgModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel">[docs]</a><span class="k">class</span> <span class="nc">UnifiedPowerRgModel</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
58    <span class="sd">&quot;&quot;&quot;</span>
59<span class="sd">    This model is based on Exponential/Power-law fit method developed </span>
60<span class="sd">    by G. Beaucage</span>
61<span class="sd">    &quot;&quot;&quot;</span>
62    <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>
63        <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>
64        <span class="sd">&quot;&quot;&quot;</span>
65<span class="sd">        :param multfactor: number of levels in the model, </span>
66<span class="sd">            assumes 0&lt;= level# &lt;=5.</span>
67<span class="sd">        &quot;&quot;&quot;</span>
68
69        <span class="c">## Setting  model name model description</span>
70        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;UnifiedPowerRg&quot;</span>
71        <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>
72<span class="s">        Multiple Levels of Unified Exponential/Power-law Method.</span>
73<span class="s">        Up to Level 6 is provided.</span>
74<span class="s">        Note; the additional Level 0 is an inverse linear function, </span>
75<span class="s">        i.e., y = scale/x + background.</span>
76<span class="s">        The Level N is defined as</span>
77<span class="s">        y = background + scale * Sum(1..N)[G_i*exp(-x^2*Rg_i^2/3)</span>
78<span class="s">        + B_i/x^(power_i)*(erf(x*Rg_i/sqrt(6))^(3*power_i))].</span>
79<span class="s">        Ref:</span>
80<span class="s">        G. Beaucage (1995).  J. Appl. Cryst., vol. 28, p717-728.</span>
81<span class="s">        G. Beaucage (1996).  J. Appl. Cryst., vol. 29, p134-146.</span>
82<span class="s">        &quot;&quot;&quot;</span>
83        <span class="bp">self</span><span class="o">.</span><span class="n">level_num</span> <span class="o">=</span> <span class="n">multfactor</span>
84        <span class="c">## Define parameters</span>
85        <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="p">{}</span>
86
87        <span class="c">## Parameter details [units, min, max]</span>
88        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
89       
90        <span class="c"># non-fittable parameters</span>
91        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
92
93        <span class="c"># list of function in order of the function number </span>
94        <span class="bp">self</span><span class="o">.</span><span class="n">fun_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_func_list</span><span class="p">()</span>
95        <span class="c">## dispersion</span>
96        <span class="bp">self</span><span class="o">.</span><span class="n">_set_dispersion</span><span class="p">()</span>
97        <span class="c">## Define parameters</span>
98        <span class="bp">self</span><span class="o">.</span><span class="n">_set_params</span><span class="p">()</span>
99       
100        <span class="c">## Parameter details [units, min, max]</span>
101        <span class="bp">self</span><span class="o">.</span><span class="n">_set_details</span><span class="p">()</span>
102       
103        <span class="c">#list of parameter that can be fitted</span>
104        <span class="bp">self</span><span class="o">.</span><span class="n">_set_fixed_params</span><span class="p">()</span> 
105       
106        <span class="c">## functional multiplicity of the model</span>
107        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="p">[</span><span class="n">max_level_n</span><span class="p">,</span> <span class="s">&quot;Level No.:&quot;</span><span class="p">,</span> <span class="p">[],</span> <span class="p">[]]</span>
108   
109    <span class="k">def</span> <span class="nf">_unifiedpowerrg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
110        <span class="sd">&quot;&quot;&quot;</span>
111<span class="sd">        Scattering function</span>
112<span class="sd">        </span>
113<span class="sd">        :param x: q value(s)</span>
114<span class="sd">        :return answer: output of the function</span>
115<span class="sd">        &quot;&quot;&quot;</span>
116        <span class="c"># common parameters for the model functions</span>
117        <span class="n">bkg</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;background&#39;</span><span class="p">]</span> 
118        <span class="n">scale</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&#39;</span><span class="p">]</span>
119        <span class="n">l_num</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">level_num</span>
120        <span class="c"># set default output</span>
121        <span class="n">answer</span> <span class="o">=</span> <span class="mf">0.0</span>
122        <span class="c"># Set constant on lebel zero (special case)</span>
123        <span class="k">if</span> <span class="n">l_num</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
124            <span class="n">answer</span> <span class="o">=</span> <span class="n">scale</span> <span class="o">/</span> <span class="n">x</span> <span class="o">+</span> <span class="n">bkg</span>
125            <span class="k">return</span> <span class="n">answer</span>
126        <span class="c"># rearrange the parameters for the given label no.</span>
127        <span class="k">for</span> <span class="n">ind</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">l_num</span><span class="o">+</span><span class="mi">1</span><span class="p">):</span>
128            <span class="c"># get exp term</span>
129            <span class="n">exp_now</span> <span class="o">=</span> <span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="n">power</span><span class="p">(</span><span class="n">x</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;Rg</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">],</span> <span class="mi">2</span><span class="p">)</span><span class="o">/</span><span class="mf">3.0</span><span class="p">)</span>
130            <span class="c"># get erf term</span>
131            <span class="n">erf_now</span> <span class="o">=</span> <span class="n">erf</span><span class="p">(</span><span class="n">x</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;Rg</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span><span class="o">/</span><span class="n">sqrt</span><span class="p">(</span><span class="mf">6.0</span><span class="p">))</span>
132            <span class="c"># get power term</span>
133            <span class="n">pow_now</span> <span class="o">=</span> <span class="n">power</span><span class="p">((</span><span class="n">erf_now</span><span class="o">*</span><span class="n">erf_now</span><span class="o">*</span><span class="n">erf_now</span><span class="o">/</span><span class="n">x</span><span class="p">),</span> 
134                            <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;power</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">])</span>
135            <span class="c"># get next exp term only if it exists</span>
136            <span class="k">try</span><span class="p">:</span>
137                <span class="n">exp_next</span> <span class="o">=</span> <span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="n">power</span><span class="p">(</span><span class="n">x</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;Rg</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="p">(</span><span class="n">ind</span><span class="o">+</span><span class="mi">1</span><span class="p">)],</span> <span class="mi">2</span><span class="p">)</span><span class="o">/</span><span class="mf">3.0</span><span class="p">)</span>
138            <span class="k">except</span><span class="p">:</span>
139                <span class="n">exp_next</span> <span class="o">=</span> <span class="mf">1.0</span>
140            <span class="c"># get to the calculation</span>
141            <span class="n">answer</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;G</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span><span class="o">*</span><span class="n">exp_now</span> <span class="o">+</span> \
142                            <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;B</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">*</span> <span class="n">exp_next</span> <span class="o">*</span> <span class="n">pow_now</span>
143        <span class="c"># take care of the singular point</span>
144        <span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="mf">0.0</span><span class="p">:</span>
145            <span class="n">answer</span> <span class="o">=</span> <span class="mf">0.0</span>
146            <span class="k">for</span> <span class="n">ind</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">l_num</span><span class="o">+</span><span class="mi">1</span><span class="p">):</span>
147                <span class="n">answer</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;G</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span>
148        <span class="c"># get scaled</span>
149        <span class="n">answer</span> <span class="o">*=</span> <span class="n">scale</span>
150        <span class="c"># add background</span>
151        <span class="n">answer</span> <span class="o">+=</span> <span class="n">bkg</span>
152        <span class="k">return</span> <span class="n">answer</span>
153       
154    <span class="k">def</span> <span class="nf">_set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
155        <span class="sd">&quot;&quot;&quot;</span>
156<span class="sd">        model dispersions</span>
157<span class="sd">        &quot;&quot;&quot;</span> 
158        <span class="c">##set dispersion from model </span>
159        <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="p">{}</span>
160                   
161
162    <span class="k">def</span> <span class="nf">_set_params</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
163        <span class="sd">&quot;&quot;&quot;</span>
164<span class="sd">        Concatenate the parameters of the model to create</span>
165<span class="sd">        this model parameters </span>
166<span class="sd">        &quot;&quot;&quot;</span>
167        <span class="c"># common parameters for the model functions</span>
168        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;background&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>
169        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;scale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span>
170        <span class="n">l_num</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">level_num</span>
171        <span class="c"># rearrange the parameters for the given label no.</span>
172        <span class="k">for</span> <span class="n">ind</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">l_num</span><span class="o">+</span><span class="mi">1</span><span class="p">):</span>
173            <span class="k">if</span> <span class="n">ind</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
174                <span class="k">continue</span>
175            <span class="c"># multiple factor for higher labels</span>
176            <span class="n">mult</span> <span class="o">=</span> <span class="mf">1.0</span>
177            <span class="n">mul_pow</span> <span class="o">=</span> <span class="mf">1.0</span>
178            <span class="k">if</span> <span class="n">ind</span> <span class="o">!=</span> <span class="n">l_num</span><span class="p">:</span>
179                <span class="n">mult</span> <span class="o">=</span> <span class="mf">10.0</span> <span class="o">*</span> <span class="mf">4.0</span><span class="o">/</span><span class="mf">3.0</span>
180                <span class="n">mul_pow</span> <span class="o">=</span> <span class="mf">2.0</span>
181            <span class="c"># Set reasonably define default values that consistent </span>
182            <span class="c"># w/NIST for label #1</span>
183            <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;G</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.3</span> <span class="o">*</span> <span class="n">mult</span> <span class="o">*</span> <span class="nb">pow</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> \
184                            <span class="p">(</span><span class="n">l_num</span><span class="o">+</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">)))</span>
185            <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;Rg</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">=</span> <span class="mf">21.0</span> <span class="o">/</span> <span class="n">mult</span> <span class="o">*</span> <span class="nb">pow</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> \
186                              <span class="p">(</span><span class="n">l_num</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">)))</span>
187            <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;B</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">=</span> <span class="mf">6e-03</span><span class="o">/</span><span class="n">mult</span> <span class="o">*</span> <span class="nb">pow</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> \
188                           <span class="o">-</span><span class="p">(</span><span class="n">l_num</span><span class="o">+</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">)))</span>
189            <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;power</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">=</span> <span class="mf">2.0</span> <span class="o">*</span> <span class="n">mul_pow</span>
190           
191
192    <span class="k">def</span> <span class="nf">_set_details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
193        <span class="sd">&quot;&quot;&quot;</span>
194<span class="sd">        Concatenate details of the original model to create</span>
195<span class="sd">        this model details </span>
196<span class="sd">        &quot;&quot;&quot;</span>
197        <span class="c"># common parameters for the model functions</span>
198        <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>
199        <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>
200        <span class="c"># rearrange the parameters for the given label no.</span>
201        <span class="k">for</span> <span class="n">ind</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">level_num</span><span class="o">+</span><span class="mi">1</span><span class="p">):</span>
202            <span class="k">if</span> <span class="n">ind</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
203                <span class="k">continue</span>
204            <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;G</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/(cm.sr)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
205            <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Rg</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</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>
206            <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;B</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/(cm.sr)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
207            <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;power</span><span class="si">%s</span><span class="s">&#39;</span><span class="o">%</span> <span class="n">ind</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>
208
209   
210    <span class="k">def</span> <span class="nf">_get_func_list</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
211        <span class="sd">&quot;&quot;&quot;</span>
212<span class="sd">        Get the list of functions in each cases </span>
213<span class="sd">        &quot;&quot;&quot;</span>
214        <span class="n">func_list</span> <span class="o">=</span> <span class="p">{}</span>
215        <span class="k">return</span> <span class="n">func_list</span>
216       
217<div class="viewcode-block" id="UnifiedPowerRgModel.getProfile"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getProfile">[docs]</a>    <span class="k">def</span> <span class="nf">getProfile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
218        <span class="sd">&quot;&quot;&quot;</span>
219<span class="sd">        Get SLD profile </span>
220<span class="sd">        </span>
221<span class="sd">        : return: None, No SLD profile supporting for this model</span>
222<span class="sd">        &quot;&quot;&quot;</span>
223        <span class="k">return</span> <span class="bp">None</span>
224        </div>
225<div class="viewcode-block" id="UnifiedPowerRgModel.setParam"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam">[docs]</a>    <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>
226        <span class="sd">&quot;&quot;&quot; </span>
227<span class="sd">        Set the value of a model parameter</span>
228<span class="sd">    </span>
229<span class="sd">        : param name: name of the parameter</span>
230<span class="sd">        : param value: value of the parameter</span>
231<span class="sd">        &quot;&quot;&quot;</span>
232        <span class="c"># set param to new model</span>
233        <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>
234</div>
235    <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>
236        <span class="sd">&quot;&quot;&quot;</span>
237<span class="sd">        Helper function to setParam</span>
238<span class="sd">        &quot;&quot;&quot;</span>
239
240        <span class="c"># Look for standard parameter</span>
241        <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>
242            <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>
243                <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>
244                <span class="k">return</span>
245       
246        <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>
247             
248   
249    <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>
250        <span class="sd">&quot;&quot;&quot;</span>
251<span class="sd">        Fill the self.fixed list with the model fixed list</span>
252<span class="sd">        &quot;&quot;&quot;</span>
253        <span class="k">pass</span>         
254
255               
256<div class="viewcode-block" id="UnifiedPowerRgModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel.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>
257        <span class="sd">&quot;&quot;&quot; </span>
258<span class="sd">        Evaluate the model</span>
259<span class="sd">        </span>
260<span class="sd">        : param x: input q-value (float or [float, float] as [r, theta])</span>
261<span class="sd">        : return: (DAB value)</span>
262<span class="sd">        &quot;&quot;&quot;</span>
263        <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;list&#39;</span><span class="p">:</span>
264            <span class="c"># Take absolute value of Q, since this model is really meant to</span>
265            <span class="c"># be defined in 1D for a given length of Q</span>
266            <span class="c">#qx = math.fabs(x[0]*math.cos(x[1]))</span>
267            <span class="c">#qy = math.fabs(x[0]*math.sin(x[1]))</span>
268            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unifiedpowerrg</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
269        <span class="k">elif</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;tuple&#39;</span><span class="p">:</span>
270            <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Tuples are not allowed as input to BaseComponent models&quot;</span>
271            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="n">msg</span>
272        <span class="k">else</span><span class="p">:</span>
273            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unifiedpowerrg</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
274
275
276        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unifiedpowerrg</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
277</div>
278<div class="viewcode-block" id="UnifiedPowerRgModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel.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>
279        <span class="sd">&quot;&quot;&quot; </span>
280<span class="sd">        Evaluate the model</span>
281<span class="sd">        </span>
282<span class="sd">        : param x: input q-value (float or [float, float] as [qx, qy])</span>
283<span class="sd">        : return: DAB value</span>
284<span class="sd">        &quot;&quot;&quot;</span> 
285        <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;list&#39;</span><span class="p">:</span>
286            <span class="n">q</span> <span class="o">=</span> <span class="n">sqrt</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span>
287            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unifiedpowerrg</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
288        <span class="k">elif</span> <span class="n">x</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;tuple&#39;</span><span class="p">:</span>
289            <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Tuples are not allowed as input to BaseComponent models&quot;</span>
290            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="n">msg</span>
291        <span class="k">else</span><span class="p">:</span>
292            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_unifiedpowerrg</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
293</div>
294<div class="viewcode-block" id="UnifiedPowerRgModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel.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>
295        <span class="sd">&quot;&quot;&quot;</span>
296<span class="sd">        &quot;&quot;&quot;</span>
297        <span class="c"># Not implemented!!!</span>
298        <span class="k">pass</span>
299    </div>
300<div class="viewcode-block" id="UnifiedPowerRgModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.UnifiedPowerRgModel.UnifiedPowerRgModel.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>
301        <span class="sd">&quot;&quot;&quot;</span>
302<span class="sd">        Set the dispersion object for a model parameter</span>
303<span class="sd">        </span>
304<span class="sd">        : param parameter: name of the parameter [string]</span>
305<span class="sd">        :dispersion: dispersion object of type DispersionModel</span>
306<span class="sd">        &quot;&quot;&quot;</span>
307        <span class="k">pass</span></div></div>
308</pre></div>
309
310          </div>
311        </div>
312      </div>
313      <div class="sphinxsidebar">
314        <div class="sphinxsidebarwrapper">
315<div id="searchbox" style="display: none">
316  <h3>Quick search</h3>
317    <form class="search" action="../../../search.html" method="get">
318      <input type="text" name="q" />
319      <input type="submit" value="Go" />
320      <input type="hidden" name="check_keywords" value="yes" />
321      <input type="hidden" name="area" value="default" />
322    </form>
323    <p class="searchtip" style="font-size: 90%">
324    Enter search terms or a module, class or function name.
325    </p>
326</div>
327<script type="text/javascript">$('#searchbox').show(0);</script>
328        </div>
329      </div>
330      <div class="clearer"></div>
331    </div>
332    <div class="related">
333      <h3>Navigation</h3>
334      <ul>
335        <li class="right" style="margin-right: 10px">
336          <a href="../../../genindex.html" title="General Index"
337             >index</a></li>
338        <li class="right" >
339          <a href="../../../py-modindex.html" title="Python Module Index"
340             >modules</a> |</li>
341        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
342          <li><a href="../../index.html" >Module code</a> &raquo;</li>
343          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
344      </ul>
345    </div>
346    <div class="footer">
347        &copy; Copyright 2013, The SasView Project.
348      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
349    </div>
350  </body>
351</html>
Note: See TracBrowser for help on using the repository browser.