Index: _modules/sas/models/Gaussian.html
===================================================================
--- _modules/sas/models/Gaussian.html	(revision a462c6a6616628a6536b55fc2886d9ab1224149a)
+++ _modules/sas/models/Gaussian.html	(revision a462c6a6616628a6536b55fc2886d9ab1224149a)
@@ -0,0 +1,268 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>sas.models.Gaussian &mdash; SasView 3.0.0 documentation</title>
+    
+    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../../',
+        VERSION:     '3.0.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../../_static/doctools.js"></script>
+    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    <link rel="top" title="SasView 3.0.0 documentation" href="../../../index.html" />
+    <link rel="up" title="sas.models" href="../models.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" >Module code</a> &raquo;</li>
+          <li><a href="../models.html" accesskey="U">sas.models</a> &raquo;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <h1>Source code for sas.models.Gaussian</h1><div class="highlight"><pre>
+<span class="c">##############################################################################</span>
+<span class="c"># This software was developed by the University of Tennessee as part of the</span>
+<span class="c"># Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
+<span class="c"># project funded by the US National Science Foundation.</span>
+<span class="c">#</span>
+<span class="c"># If you use DANSE applications to do scientific research that leads to</span>
+<span class="c"># publication, we ask that you acknowledge the use of the software with the</span>
+<span class="c"># following sentence:</span>
+<span class="c">#</span>
+<span class="c"># This work benefited from DANSE software developed under NSF award DMR-0520547</span>
+<span class="c">#</span>
+<span class="c"># Copyright 2008-2011, University of Tennessee</span>
+<span class="c">##############################################################################</span>
+
+<span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">Provide functionality for a C extension model</span>
+
+<span class="sd">.. WARNING::</span>
+
+<span class="sd">   THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY</span>
+<span class="sd">   DO NOT MODIFY THIS FILE, MODIFY</span>
+<span class="sd">   src/sas/models/include/gaussian.h</span>
+<span class="sd">   AND RE-RUN THE GENERATOR SCRIPT</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
+<span class="kn">from</span> <span class="nn">sas.models.sas_extension.c_models</span> <span class="kn">import</span> <span class="n">CGaussian</span>
+
+<div class="viewcode-block" id="create_Gaussian"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.create_Gaussian">[docs]</a><span class="k">def</span> <span class="nf">create_Gaussian</span><span class="p">():</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">       Create a model instance</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">obj</span> <span class="o">=</span> <span class="n">Gaussian</span><span class="p">()</span>
+    <span class="c"># CGaussian.__init__(obj) is called by</span>
+    <span class="c"># the Gaussian constructor</span>
+    <span class="k">return</span> <span class="n">obj</span>
+</div>
+<div class="viewcode-block" id="Gaussian"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian">[docs]</a><span class="k">class</span> <span class="nc">Gaussian</span><span class="p">(</span><span class="n">CGaussian</span><span class="p">,</span> <span class="n">BaseComponent</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">    Class that evaluates a Gaussian model. </span>
+<span class="sd">    This file was auto-generated from src/sas/models/include/gaussian.h.</span>
+<span class="sd">    Refer to that file and the structure it contains</span>
+<span class="sd">    for details of the model.</span>
+<span class="sd">    </span>
+<span class="sd">    List of default parameters:</span>
+
+<span class="sd">    * scale           = 1.0 </span>
+<span class="sd">    * sigma           = 1.0 </span>
+<span class="sd">    * center          = 0.0 </span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
+        
+    <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>
+        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
+        
+        <span class="c"># Initialize BaseComponent first, then sphere</span>
+        <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>
+        <span class="c">#apply(CGaussian.__init__, (self,)) </span>
+
+        <span class="n">CGaussian</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
+		        
+        <span class="c">## Name of the model</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;Gaussian&quot;</span>
+        <span class="c">## Model description</span>
+        <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>
+<span class="s">        f(x)=scale * 1/(sigma^2*2pi)e^(-(x-mu)^2/2sigma^2)</span>
+<span class="s">        &quot;&quot;&quot;</span>
+       
+        <span class="c">## Parameter details [units, min, max]</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
+        <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>
+        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sigma&#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>
+        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;center&#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>
+
+        <span class="c">## fittable parameters</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[]</span>
+        
+        <span class="c">## non-fittable parameters</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
+        
+        <span class="c">## parameters with orientation</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
+
+        <span class="c">## parameters with magnetism</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
+        
+    <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        restore the state of a model from pickle</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="n">state</span>
+        
+    <span class="k">def</span> <span class="nf">__reduce_ex__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
+<span class="sd">        c model.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">state</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">)</span>
+        <span class="k">return</span> <span class="p">(</span><span class="n">create_Gaussian</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">(),</span> <span class="n">state</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
+        
+<div class="viewcode-block" id="Gaussian.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.clone">[docs]</a>    <span class="k">def</span> <span class="nf">clone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clone</span><span class="p">(</span><span class="n">Gaussian</span><span class="p">())</span>   
+       	</div>
+<div class="viewcode-block" id="Gaussian.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.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>
+        <span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">        Evaluate the model</span>
+<span class="sd">        </span>
+<span class="sd">        :param x: input q, or [q,phi]</span>
+<span class="sd">        </span>
+<span class="sd">        :return: scattering function P(q)</span>
+<span class="sd">        </span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="n">CGaussian</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
+   </div>
+<div class="viewcode-block" id="Gaussian.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.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>
+        <span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">        Evaluate the model in cartesian coordinates</span>
+<span class="sd">        </span>
+<span class="sd">        :param x: input q, or [qx, qy]</span>
+<span class="sd">        </span>
+<span class="sd">        :return: scattering function P(q)</span>
+<span class="sd">        </span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="n">CGaussian</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
+        </div>
+<div class="viewcode-block" id="Gaussian.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.evalDistribution">[docs]</a>    <span class="k">def</span> <span class="nf">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">        Evaluate the model in cartesian coordinates</span>
+<span class="sd">        </span>
+<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
+<span class="sd">        </span>
+<span class="sd">        :return: scattering function P(q[])</span>
+<span class="sd">        </span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="n">CGaussian</span><span class="o">.</span><span class="n">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
+        </div>
+<div class="viewcode-block" id="Gaussian.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.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>
+        <span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
+<span class="sd">        </span>
+<span class="sd">        :return: the value of the effective radius</span>
+<span class="sd">        </span>
+<span class="sd">        &quot;&quot;&quot;</span>       
+        <span class="k">return</span> <span class="n">CGaussian</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+        </div>
+<div class="viewcode-block" id="Gaussian.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.calculate_VR">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; </span>
+<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
+<span class="sd">        </span>
+<span class="sd">        :return: the value of the volf ratio</span>
+<span class="sd">        </span>
+<span class="sd">        &quot;&quot;&quot;</span>       
+        <span class="k">return</span> <span class="n">CGaussian</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
+              </div>
+<div class="viewcode-block" id="Gaussian.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.Gaussian.Gaussian.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>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Set the dispersion object for a model parameter</span>
+<span class="sd">        </span>
+<span class="sd">        :param parameter: name of the parameter [string]</span>
+<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
+<span class="sd">        </span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="n">CGaussian</span><span class="o">.</span><span class="n">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="o">.</span><span class="n">cdisp</span><span class="p">)</span>
+        
+   
+<span class="c"># End of file</span>
+</pre></div></div></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" >Module code</a> &raquo;</li>
+          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2013, The SasView Project.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
