source: sasview/_modules/sas/models/GaussLorentzGelModel.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: 16.8 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.GaussLorentzGelModel &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.GaussLorentzGelModel</h1><div class="highlight"><pre>
52<span class="sd">&quot;&quot;&quot; </span>
53<span class="sd">    Provide I(q) = I_0 exp ( - R_g^2 q^2 / 3.0)</span>
54<span class="sd">    GaussLorentzGel function as a BaseComponent model</span>
55<span class="sd">&quot;&quot;&quot;</span>
56<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
57<span class="kn">import</span> <span class="nn">math</span>
58
59<div class="viewcode-block" id="GaussLorentzGelModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GaussLorentzGelModel.GaussLorentzGelModel">[docs]</a><span class="k">class</span> <span class="nc">GaussLorentzGelModel</span><span class="p">(</span><span class="n">BaseComponent</span><span class="p">):</span>
60    <span class="sd">&quot;&quot;&quot; </span>
61<span class="sd">    Class that evaluates a GaussLorentzGel model.</span>
62
63<span class="sd">    I(q) = scale_g*exp(- q^2*Z^2 / 2)+scale_l/(1+q^2*z^2)</span>
64<span class="sd">            + background</span>
65<span class="sd">    List of default parameters:</span>
66<span class="sd">     scale_g = Gauss scale factor</span>
67<span class="sd">     Z = Static correlation length</span>
68<span class="sd">     scale_l = Lorentzian scale factor</span>
69<span class="sd">     z = Dynamic correlation length</span>
70<span class="sd">     background = Incoherent background</span>
71<span class="sd">    &quot;&quot;&quot;</span>
72       
73    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
74        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
75       
76        <span class="c"># Initialize BaseComponent first, then sphere</span>
77        <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>
78       
79        <span class="c">## Name of the model</span>
80        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;GaussLorentzGel&quot;</span>
81        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;I(q)=scale_g*exp(-q^2*Z^2/2)+scale_l/(1+q^2*z^2)</span>
82<span class="s">            + background</span>
83<span class="s">            List of default parameters:</span>
84<span class="s">             scale_g = Gauss scale factor</span>
85<span class="s">             stat_colength = Static correlation length</span>
86<span class="s">             scale_l = Lorentzian scale factor</span>
87<span class="s">             dyn_colength = Dynamic correlation length</span>
88<span class="s">             background = Incoherent background</span>
89<span class="s">&quot;&quot;&quot;</span>
90        <span class="c">## Define parameters</span>
91        <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="p">{}</span>
92        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;scale_g&#39;</span><span class="p">]</span>  <span class="o">=</span> <span class="mf">100.0</span>
93        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;stat_colength&#39;</span><span class="p">]</span>     <span class="o">=</span> <span class="mf">100.0</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_l&#39;</span><span class="p">]</span>  <span class="o">=</span> <span class="mf">50.0</span>
95        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;dyn_colength&#39;</span><span class="p">]</span>     <span class="o">=</span> <span class="mf">20.0</span>
96        <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>
97        <span class="c">## Parameter details [units, min, max]</span>
98        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
99        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;scale_g&#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>
100        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;stat_colength&#39;</span><span class="p">]</span> <span class="o">=</span>  <span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
101        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;scale_l&#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>
102        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;dyn_colength&#39;</span><span class="p">]</span>  <span class="o">=</span>   <span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
103        <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>
104
105        <span class="c">#list of parameter that cannot be fitted</span>
106        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[]</span> 
107       
108    <span class="k">def</span> <span class="nf">_gausslorentzgel</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
109        <span class="sd">&quot;&quot;&quot;</span>
110<span class="sd">        Model definition</span>
111<span class="sd">        &quot;&quot;&quot;</span>
112        <span class="n">inten</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_g&#39;</span><span class="p">]</span> \
113                <span class="o">*</span><span class="n">math</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">1.0</span><span class="o">*</span><span class="n">x</span><span class="o">*</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;stat_colength&#39;</span><span class="p">]</span><span class="o">*</span> \
114                <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;stat_colength&#39;</span><span class="p">]</span><span class="o">/</span><span class="mf">2.0</span><span class="p">)</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_l&#39;</span><span class="p">]</span><span class="o">/</span> \
115                <span class="p">(</span><span class="mf">1.0</span> <span class="o">+</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;dyn_colength&#39;</span><span class="p">])</span><span class="o">*</span> \
116                 <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;dyn_colength&#39;</span><span class="p">]))</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>
117        <span class="k">return</span> <span class="n">inten</span> 
118   
119<div class="viewcode-block" id="GaussLorentzGelModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GaussLorentzGelModel.GaussLorentzGelModel.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>
120        <span class="sd">&quot;&quot;&quot; Evaluate the model</span>
121<span class="sd">            @param x: input q-value (float or [float, float] as [r, theta])</span>
122<span class="sd">            @return: (guinier value)</span>
123<span class="sd">        &quot;&quot;&quot;</span>
124        <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>
125            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gausslorentzgel</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
126        <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>
127            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Tuples are not allowed as input to models&quot;</span>
128        <span class="k">else</span><span class="p">:</span>
129            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gausslorentzgel</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
130   </div>
131<div class="viewcode-block" id="GaussLorentzGelModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GaussLorentzGelModel.GaussLorentzGelModel.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>
132        <span class="sd">&quot;&quot;&quot; Evaluate the model</span>
133<span class="sd">            @param x: input q-value (float or [float, float] as [qx, qy])</span>
134<span class="sd">            @return: guinier value</span>
135<span class="sd">        &quot;&quot;&quot;</span>
136        <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>
137            <span class="n">q</span> <span class="o">=</span> <span class="n">math</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>
138            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gausslorentzgel</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
139        <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>
140            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Tuples are not allowed as input to models&quot;</span>
141        <span class="k">else</span><span class="p">:</span>
142            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gausslorentzgel</span><span class="p">(</span><span class="n">x</span><span class="p">)</span></div></div>
143</pre></div>
144
145          </div>
146        </div>
147      </div>
148      <div class="sphinxsidebar">
149        <div class="sphinxsidebarwrapper">
150<div id="searchbox" style="display: none">
151  <h3>Quick search</h3>
152    <form class="search" action="../../../search.html" method="get">
153      <input type="text" name="q" />
154      <input type="submit" value="Go" />
155      <input type="hidden" name="check_keywords" value="yes" />
156      <input type="hidden" name="area" value="default" />
157    </form>
158    <p class="searchtip" style="font-size: 90%">
159    Enter search terms or a module, class or function name.
160    </p>
161</div>
162<script type="text/javascript">$('#searchbox').show(0);</script>
163        </div>
164      </div>
165      <div class="clearer"></div>
166    </div>
167    <div class="related">
168      <h3>Navigation</h3>
169      <ul>
170        <li class="right" style="margin-right: 10px">
171          <a href="../../../genindex.html" title="General Index"
172             >index</a></li>
173        <li class="right" >
174          <a href="../../../py-modindex.html" title="Python Module Index"
175             >modules</a> |</li>
176        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
177          <li><a href="../../index.html" >Module code</a> &raquo;</li>
178          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
179      </ul>
180    </div>
181    <div class="footer">
182        &copy; Copyright 2013, The SasView Project.
183      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
184    </div>
185  </body>
186</html>
Note: See TracBrowser for help on using the repository browser.