Ignore:
Timestamp:
Oct 24, 2011 1:46:34 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
a4f04f2
Parents:
f696e2a
Message:

edit doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pr_inversion/docs/sphinx/html/api/invertor.html

    ra7c772e r8884996  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
     
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>invertor &mdash; pr_inversion v0.1.0 documentation</title> 
     11    <title>invertor &mdash; pr_inversion 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
     
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="pr_inversion v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="pr_inversion 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="next" title="num_term" href="num_term.html" /> 
     
    4447          <a href="distance_explorer.html" title="distance_explorer" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">pr_inversion v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">pr_inversion 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
     
    5659  <div class="section" id="invertor"> 
    5760<h1>invertor<a class="headerlink" href="#invertor" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.pr.invertor"> 
    59 <span id="sans-pr-invertor"></span><h2><a class="reference internal" href="#module-sans.pr.invertor" title="sans.pr.invertor"><tt class="xref py py-mod docutils literal"><span class="pre">sans.pr.invertor</span></tt></a><a class="headerlink" href="#module-sans.pr.invertor" title="Permalink to this headline">¶</a></h2> 
    60 <p>Module to perform P(r) inversion. 
     61<div class="section" id="sans-pr-invertor"> 
     62<h2><a class="reference internal" href="#module-sans.pr.invertor" title="sans.pr.invertor"><tt class="xref py py-mod docutils literal"><span class="pre">sans.pr.invertor</span></tt></a><a class="headerlink" href="#sans-pr-invertor" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.pr.invertor"></span><p>Module to perform P(r) inversion. 
    6164The module contains the Invertor class.</p> 
    6265<dl class="class"> 
     
    9194- get_pos_err(pars): returns the fraction of P(r) that is 1-sigma above zero</p> 
    9295<dl class="attribute"> 
     96<dt id="sans.pr.invertor.Invertor.__class__"> 
     97<tt class="descname">__class__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__class__" title="Permalink to this definition">¶</a></dt> 
     98<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     99</dd></dl> 
     100 
     101<dl class="attribute"> 
     102<dt id="sans.pr.invertor.Invertor.__delattr__"> 
     103<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__delattr__" title="Permalink to this definition">¶</a></dt> 
     104<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     105</dd></dl> 
     106 
     107<dl class="attribute"> 
     108<dt id="sans.pr.invertor.Invertor.__dict__"> 
     109<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01CA22F0&gt;</em><a class="headerlink" href="#sans.pr.invertor.Invertor.__dict__" title="Permalink to this definition">¶</a></dt> 
     110<dd></dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.pr.invertor.Invertor.__getattr__"> 
     114<tt class="descname">__getattr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.__getattr__" title="Permalink to this definition">¶</a></dt> 
     115<dd><p>Return the value of an attribute</p> 
     116</dd></dl> 
     117 
     118<dl class="attribute"> 
     119<dt id="sans.pr.invertor.Invertor.__getattribute__"> 
     120<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     121<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     122</dd></dl> 
     123 
     124<dl class="attribute"> 
     125<dt id="sans.pr.invertor.Invertor.__hash__"> 
     126<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__hash__" title="Permalink to this definition">¶</a></dt> 
     127<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     128</dd></dl> 
     129 
     130<dl class="method"> 
     131<dt id="sans.pr.invertor.Invertor.__init__"> 
     132<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.__init__" title="Permalink to this definition">¶</a></dt> 
     133<dd></dd></dl> 
     134 
     135<dl class="attribute"> 
     136<dt id="sans.pr.invertor.Invertor.__module__"> 
     137<tt class="descname">__module__</tt><em class="property"> = 'sans.pr.invertor'</em><a class="headerlink" href="#sans.pr.invertor.Invertor.__module__" title="Permalink to this definition">¶</a></dt> 
     138<dd></dd></dl> 
     139 
     140<dl class="staticmethod"> 
     141<dt id="sans.pr.invertor.Invertor.__new__"> 
     142<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.pr.invertor.Invertor.__new__" title="Permalink to this definition">¶</a></dt> 
     143<dd></dd></dl> 
     144 
     145<dl class="method"> 
     146<dt id="sans.pr.invertor.Invertor.__reduce__"> 
     147<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.__reduce__" title="Permalink to this definition">¶</a></dt> 
     148<dd><p>helper for pickle</p> 
     149</dd></dl> 
     150 
     151<dl class="method"> 
     152<dt id="sans.pr.invertor.Invertor.__reduce_ex__"> 
     153<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     154<dd><p>Overwrite the __reduce_ex__</p> 
     155</dd></dl> 
     156 
     157<dl class="attribute"> 
     158<dt id="sans.pr.invertor.Invertor.__repr__"> 
     159<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__repr__" title="Permalink to this definition">¶</a></dt> 
     160<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     161</dd></dl> 
     162 
     163<dl class="method"> 
     164<dt id="sans.pr.invertor.Invertor.__setattr__"> 
     165<tt class="descname">__setattr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.__setattr__" title="Permalink to this definition">¶</a></dt> 
     166<dd><p>Set the value of an attribute. 
     167Access the parent class methods for 
     168x, y, err, d_max, q_min, q_max and alpha</p> 
     169</dd></dl> 
     170 
     171<dl class="method"> 
     172<dt id="sans.pr.invertor.Invertor.__setstate__"> 
     173<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.__setstate__" title="Permalink to this definition">¶</a></dt> 
     174<dd><p>restore the state of invertor for pickle</p> 
     175</dd></dl> 
     176 
     177<dl class="attribute"> 
     178<dt id="sans.pr.invertor.Invertor.__str__"> 
     179<tt class="descname">__str__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__str__" title="Permalink to this definition">¶</a></dt> 
     180<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     181</dd></dl> 
     182 
     183<dl class="attribute"> 
     184<dt id="sans.pr.invertor.Invertor.__weakref__"> 
     185<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.__weakref__" title="Permalink to this definition">¶</a></dt> 
     186<dd><p>list of weak references to the object (if defined)</p> 
     187</dd></dl> 
     188 
     189<dl class="method"> 
     190<dt id="sans.pr.invertor.Invertor._accept_q"> 
     191<tt class="descname">_accept_q</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor._accept_q" title="Permalink to this definition">¶</a></dt> 
     192<dd><p>Check q-value against user-defined range</p> 
     193</dd></dl> 
     194 
     195<dl class="method"> 
     196<dt id="sans.pr.invertor.Invertor._get_invcov_matrix"> 
     197<tt class="descname">_get_invcov_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor._get_invcov_matrix" title="Permalink to this definition">¶</a></dt> 
     198<dd><p>Compute the inverse covariance matrix, defined as inv_cov = a_transposed x a. 
     199&#64;param nfunc: number of base functions 
     200&#64;param nr: number of r-points used when evaluating reg term. 
     201&#64;param a: A array to fill 
     202&#64;param inv_cov: inverse covariance array to be filled 
     203&#64;return: 0</p> 
     204</dd></dl> 
     205 
     206<dl class="method"> 
     207<dt id="sans.pr.invertor.Invertor._get_matrix"> 
     208<tt class="descname">_get_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor._get_matrix" title="Permalink to this definition">¶</a></dt> 
     209<dd><p>Returns A matrix and b vector for least square problem. 
     210&#64;param nfunc: number of base functions 
     211&#64;param nr: number of r-points used when evaluating reg term. 
     212&#64;param a: A array to fill 
     213&#64;param b: b vector to fill 
     214&#64;return: 0</p> 
     215</dd></dl> 
     216 
     217<dl class="method"> 
     218<dt id="sans.pr.invertor.Invertor._get_reg_size"> 
     219<tt class="descname">_get_reg_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor._get_reg_size" title="Permalink to this definition">¶</a></dt> 
     220<dd><p>Compute the covariance matrix, defined as inv_cov = a_transposed x a. 
     221&#64;param nfunc: number of base functions 
     222&#64;param nr: number of r-points used when evaluating reg term. 
     223&#64;param a: A array to fill 
     224&#64;param inv_cov: inverse covariance array to be filled 
     225&#64;return: 0</p> 
     226</dd></dl> 
     227 
     228<dl class="attribute"> 
     229<dt id="sans.pr.invertor.Invertor.background"> 
     230<tt class="descname">background</tt><em class="property"> = 0</em><a class="headerlink" href="#sans.pr.invertor.Invertor.background" title="Permalink to this definition">¶</a></dt> 
     231<dd></dd></dl> 
     232 
     233<dl class="method"> 
    93234<dt id="sans.pr.invertor.Invertor.basefunc_ft"> 
    94 <tt class="descname">basefunc_ft</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.basefunc_ft" title="Permalink to this definition">¶</a></dt> 
     235<tt class="descname">basefunc_ft</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.basefunc_ft" title="Permalink to this definition">¶</a></dt> 
    95236<dd><p>Returns the value of the nth Fourier transofrmed base function 
    96237&#64;param args: c-parameters, n and q 
     
    98239</dd></dl> 
    99240 
     241<dl class="attribute"> 
     242<dt id="sans.pr.invertor.Invertor.chi2"> 
     243<tt class="descname">chi2</tt><em class="property"> = 0</em><a class="headerlink" href="#sans.pr.invertor.Invertor.chi2" title="Permalink to this definition">¶</a></dt> 
     244<dd></dd></dl> 
     245 
    100246<dl class="method"> 
    101247<dt id="sans.pr.invertor.Invertor.clone"> 
     
    104250</dd></dl> 
    105251 
     252<dl class="attribute"> 
     253<dt id="sans.pr.invertor.Invertor.cov"> 
     254<tt class="descname">cov</tt><em class="property"> = None</em><a class="headerlink" href="#sans.pr.invertor.Invertor.cov" title="Permalink to this definition">¶</a></dt> 
     255<dd></dd></dl> 
     256 
     257<dl class="attribute"> 
     258<dt id="sans.pr.invertor.Invertor.elapsed"> 
     259<tt class="descname">elapsed</tt><em class="property"> = 0</em><a class="headerlink" href="#sans.pr.invertor.Invertor.elapsed" title="Permalink to this definition">¶</a></dt> 
     260<dd></dd></dl> 
     261 
    106262<dl class="method"> 
    107263<dt id="sans.pr.invertor.Invertor.estimate_alpha"> 
    108 <tt class="descname">estimate_alpha</tt><big>(</big><em>nfunc</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.estimate_alpha" title="Permalink to this definition">¶</a></dt> 
     264<tt class="descname">estimate_alpha</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.estimate_alpha" title="Permalink to this definition">¶</a></dt> 
    109265<dd><p>Returns a reasonable guess for the 
    110266regularization constant alpha</p> 
     
    113269<col class="field-body" /> 
    114270<tbody valign="top"> 
    115 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nfunc</strong> &#8211; number of terms to use in the expansion.</td> 
    116 </tr> 
    117 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">alpha, message, elapsed</td> 
     271<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>nfunc</strong> &#8211; number of terms to use in the expansion.</td> 
     272</tr> 
     273<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">alpha, message, elapsed</td> 
    118274</tr> 
    119275</tbody> 
     
    126282<dl class="method"> 
    127283<dt id="sans.pr.invertor.Invertor.estimate_numterms"> 
    128 <tt class="descname">estimate_numterms</tt><big>(</big><em>isquit_func=None</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.estimate_numterms" title="Permalink to this definition">¶</a></dt> 
     284<tt class="descname">estimate_numterms</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.estimate_numterms" title="Permalink to this definition">¶</a></dt> 
    129285<dd><p>Returns a reasonable guess for the 
    130286number of terms</p> 
     
    133289<col class="field-body" /> 
    134290<tbody valign="top"> 
    135 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>isquit_func</strong> &#8211; reference to thread function to call to  
     291<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>isquit_func</strong> &#8211; reference to thread function to call to  
    136292check whether the computation needs to 
    137293be stopped.</td> 
    138294</tr> 
    139 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">number of terms, alpha, message</td> 
     295<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of terms, alpha, message</td> 
    140296</tr> 
    141297</tbody> 
     
    145301<dl class="method"> 
    146302<dt id="sans.pr.invertor.Invertor.from_file"> 
    147 <tt class="descname">from_file</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.from_file" title="Permalink to this definition">¶</a></dt> 
     303<tt class="descname">from_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.from_file" title="Permalink to this definition">¶</a></dt> 
    148304<dd><p>Load the state of the Invertor from a file, 
    149305to be able to generate P(r) from a set of 
     
    153309<col class="field-body" /> 
    154310<tbody valign="top"> 
    155 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; path of the file to load</td> 
     311<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; path of the file to load</td> 
    156312</tr> 
    157313</tbody> 
     
    159315</dd></dl> 
    160316 
    161 <dl class="attribute"> 
     317<dl class="method"> 
    162318<dt id="sans.pr.invertor.Invertor.get_alpha"> 
    163 <tt class="descname">get_alpha</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_alpha" title="Permalink to this definition">¶</a></dt> 
     319<tt class="descname">get_alpha</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_alpha" title="Permalink to this definition">¶</a></dt> 
    164320<dd><p>Gets the alpha parameter</p> 
    165321</dd></dl> 
    166322 
    167 <dl class="attribute"> 
     323<dl class="method"> 
    168324<dt id="sans.pr.invertor.Invertor.get_dmax"> 
    169 <tt class="descname">get_dmax</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_dmax" title="Permalink to this definition">¶</a></dt> 
     325<tt class="descname">get_dmax</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_dmax" title="Permalink to this definition">¶</a></dt> 
    170326<dd><p>Gets the maximum distance</p> 
    171327</dd></dl> 
    172328 
    173 <dl class="attribute"> 
     329<dl class="method"> 
    174330<dt id="sans.pr.invertor.Invertor.get_err"> 
    175 <tt class="descname">get_err</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_err" title="Permalink to this definition">¶</a></dt> 
     331<tt class="descname">get_err</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_err" title="Permalink to this definition">¶</a></dt> 
    176332<dd><p>Function to get the err data 
    177 Takes an array of doubles as input.</p> 
    178 <blockquote> 
    179 <div>&#64;return: number of entries found</div></blockquote> 
    180 </dd></dl> 
    181  
    182 <dl class="attribute"> 
     333Takes an array of doubles as input. 
     334&#64;return: number of entries found</p> 
     335</dd></dl> 
     336 
     337<dl class="method"> 
    183338<dt id="sans.pr.invertor.Invertor.get_has_bck"> 
    184 <tt class="descname">get_has_bck</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_has_bck" title="Permalink to this definition">¶</a></dt> 
     339<tt class="descname">get_has_bck</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_has_bck" title="Permalink to this definition">¶</a></dt> 
    185340<dd><p>Gets background flag</p> 
    186341</dd></dl> 
    187342 
    188 <dl class="attribute"> 
     343<dl class="method"> 
    189344<dt id="sans.pr.invertor.Invertor.get_nerr"> 
    190 <tt class="descname">get_nerr</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_nerr" title="Permalink to this definition">¶</a></dt> 
     345<tt class="descname">get_nerr</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_nerr" title="Permalink to this definition">¶</a></dt> 
    191346<dd><p>Gets the number of err points</p> 
    192347</dd></dl> 
    193348 
    194 <dl class="attribute"> 
     349<dl class="method"> 
    195350<dt id="sans.pr.invertor.Invertor.get_nx"> 
    196 <tt class="descname">get_nx</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_nx" title="Permalink to this definition">¶</a></dt> 
     351<tt class="descname">get_nx</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_nx" title="Permalink to this definition">¶</a></dt> 
    197352<dd><p>Gets the number of x points</p> 
    198353</dd></dl> 
    199354 
    200 <dl class="attribute"> 
     355<dl class="method"> 
    201356<dt id="sans.pr.invertor.Invertor.get_ny"> 
    202 <tt class="descname">get_ny</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_ny" title="Permalink to this definition">¶</a></dt> 
     357<tt class="descname">get_ny</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_ny" title="Permalink to this definition">¶</a></dt> 
    203358<dd><p>Gets the number of y points</p> 
    204359</dd></dl> 
    205360 
    206 <dl class="attribute"> 
     361<dl class="method"> 
    207362<dt id="sans.pr.invertor.Invertor.get_peaks"> 
    208 <tt class="descname">get_peaks</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_peaks" title="Permalink to this definition">¶</a></dt> 
     363<tt class="descname">get_peaks</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_peaks" title="Permalink to this definition">¶</a></dt> 
    209364<dd><p>Returns the number of peaks in the output P(r) distrubution 
    210 for the given set of coefficients.</p> 
    211 <blockquote> 
    212 <div>&#64;param args: c-parameters 
    213 &#64;return: number of P(r) peaks</div></blockquote> 
    214 </dd></dl> 
    215  
    216 <dl class="attribute"> 
     365for the given set of coefficients. 
     366&#64;param args: c-parameters 
     367&#64;return: number of P(r) peaks</p> 
     368</dd></dl> 
     369 
     370<dl class="method"> 
    217371<dt id="sans.pr.invertor.Invertor.get_pos_err"> 
    218 <tt class="descname">get_pos_err</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_pos_err" title="Permalink to this definition">¶</a></dt> 
     372<tt class="descname">get_pos_err</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_pos_err" title="Permalink to this definition">¶</a></dt> 
    219373<dd><p>Returns the fraction of P(r) that is 1 standard deviation 
    220 above zero over the full range of r for the given set of coefficients.</p> 
    221 <blockquote> 
    222 <div>&#64;param args: c-parameters 
    223 &#64;return: fraction of P(r) that is positive</div></blockquote> 
    224 </dd></dl> 
    225  
    226 <dl class="attribute"> 
     374above zero over the full range of r for the given set of coefficients. 
     375&#64;param args: c-parameters 
     376&#64;return: fraction of P(r) that is positive</p> 
     377</dd></dl> 
     378 
     379<dl class="method"> 
    227380<dt id="sans.pr.invertor.Invertor.get_positive"> 
    228 <tt class="descname">get_positive</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_positive" title="Permalink to this definition">¶</a></dt> 
     381<tt class="descname">get_positive</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_positive" title="Permalink to this definition">¶</a></dt> 
    229382<dd><p>Returns the fraction of P(r) that is positive over 
    230 the full range of r for the given set of coefficients.</p> 
    231 <blockquote> 
    232 <div>&#64;param args: c-parameters 
    233 &#64;return: fraction of P(r) that is positive</div></blockquote> 
    234 </dd></dl> 
    235  
    236 <dl class="attribute"> 
     383the full range of r for the given set of coefficients. 
     384&#64;param args: c-parameters 
     385&#64;return: fraction of P(r) that is positive</p> 
     386</dd></dl> 
     387 
     388<dl class="method"> 
    237389<dt id="sans.pr.invertor.Invertor.get_pr_err"> 
    238 <tt class="descname">get_pr_err</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_pr_err" title="Permalink to this definition">¶</a></dt> 
     390<tt class="descname">get_pr_err</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_pr_err" title="Permalink to this definition">¶</a></dt> 
    239391<dd><p>Function to call to evaluate P(r) with errors 
    240392&#64;param args: c-parameters and r 
     
    242394</dd></dl> 
    243395 
    244 <dl class="attribute"> 
     396<dl class="method"> 
    245397<dt id="sans.pr.invertor.Invertor.get_qmax"> 
    246 <tt class="descname">get_qmax</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_qmax" title="Permalink to this definition">¶</a></dt> 
     398<tt class="descname">get_qmax</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_qmax" title="Permalink to this definition">¶</a></dt> 
    247399<dd><p>Gets the maximum q</p> 
    248400</dd></dl> 
    249401 
    250 <dl class="attribute"> 
     402<dl class="method"> 
    251403<dt id="sans.pr.invertor.Invertor.get_qmin"> 
    252 <tt class="descname">get_qmin</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_qmin" title="Permalink to this definition">¶</a></dt> 
     404<tt class="descname">get_qmin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_qmin" title="Permalink to this definition">¶</a></dt> 
    253405<dd><p>Gets the minimum q</p> 
    254406</dd></dl> 
    255407 
    256 <dl class="attribute"> 
     408<dl class="method"> 
    257409<dt id="sans.pr.invertor.Invertor.get_slit_height"> 
    258 <tt class="descname">get_slit_height</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_slit_height" title="Permalink to this definition">¶</a></dt> 
     410<tt class="descname">get_slit_height</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_slit_height" title="Permalink to this definition">¶</a></dt> 
    259411<dd><p>Gets the slit height</p> 
    260412</dd></dl> 
    261413 
    262 <dl class="attribute"> 
     414<dl class="method"> 
    263415<dt id="sans.pr.invertor.Invertor.get_slit_width"> 
    264 <tt class="descname">get_slit_width</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_slit_width" title="Permalink to this definition">¶</a></dt> 
     416<tt class="descname">get_slit_width</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_slit_width" title="Permalink to this definition">¶</a></dt> 
    265417<dd><p>Gets the slit width</p> 
    266418</dd></dl> 
    267419 
    268 <dl class="attribute"> 
     420<dl class="method"> 
    269421<dt id="sans.pr.invertor.Invertor.get_x"> 
    270 <tt class="descname">get_x</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_x" title="Permalink to this definition">¶</a></dt> 
     422<tt class="descname">get_x</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_x" title="Permalink to this definition">¶</a></dt> 
    271423<dd><p>Function to get the x data 
    272 Takes an array of doubles as input.</p> 
    273 <blockquote> 
    274 <div>&#64;return: number of entries found</div></blockquote> 
    275 </dd></dl> 
    276  
    277 <dl class="attribute"> 
     424Takes an array of doubles as input. 
     425&#64;return: number of entries found</p> 
     426</dd></dl> 
     427 
     428<dl class="method"> 
    278429<dt id="sans.pr.invertor.Invertor.get_y"> 
    279 <tt class="descname">get_y</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.get_y" title="Permalink to this definition">¶</a></dt> 
     430<tt class="descname">get_y</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.get_y" title="Permalink to this definition">¶</a></dt> 
    280431<dd><p>Function to get the y data 
    281 Takes an array of doubles as input.</p> 
    282 <blockquote> 
    283 <div>&#64;return: number of entries found</div></blockquote> 
    284 </dd></dl> 
     432Takes an array of doubles as input. 
     433&#64;return: number of entries found</p> 
     434</dd></dl> 
     435 
     436<dl class="attribute"> 
     437<dt id="sans.pr.invertor.Invertor.info"> 
     438<tt class="descname">info</tt><em class="property"> = {}</em><a class="headerlink" href="#sans.pr.invertor.Invertor.info" title="Permalink to this definition">¶</a></dt> 
     439<dd></dd></dl> 
    285440 
    286441<dl class="method"> 
    287442<dt id="sans.pr.invertor.Invertor.invert"> 
    288 <tt class="descname">invert</tt><big>(</big><em>nfunc=10</em>, <em>nr=20</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.invert" title="Permalink to this definition">¶</a></dt> 
     443<tt class="descname">invert</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.invert" title="Permalink to this definition">¶</a></dt> 
    289444<dd><p>Perform inversion to P(r)</p> 
    290445<p>The problem is solved by posing the problem as  Ax = b, 
     
    311466<col class="field-body" /> 
    312467<tbody valign="top"> 
    313 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     468<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    314469<li><strong>nfunc</strong> &#8211; number of base functions to use.</li> 
    315470<li><strong>nr</strong> &#8211; number of r points to evaluate the 2nd derivative at for the reg. term.</li> 
     
    317472</td> 
    318473</tr> 
    319 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">c_out, c_cov - the coefficients with covariance matrix</p> 
     474<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">c_out, c_cov - the coefficients with covariance matrix</p> 
    320475</td> 
    321476</tr> 
     
    326481<dl class="method"> 
    327482<dt id="sans.pr.invertor.Invertor.invert_optimize"> 
    328 <tt class="descname">invert_optimize</tt><big>(</big><em>nfunc=10</em>, <em>nr=20</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.invert_optimize" title="Permalink to this definition">¶</a></dt> 
     483<tt class="descname">invert_optimize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.invert_optimize" title="Permalink to this definition">¶</a></dt> 
    329484<dd><p>Slower version of the P(r) inversion that uses scipy.optimize.leastsq.</p> 
    330485<p>This probably produce more reliable results, but is much slower. 
     
    338493<col class="field-body" /> 
    339494<tbody valign="top"> 
    340 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     495<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    341496<li><strong>nfunc</strong> &#8211; number of base functions to use.</li> 
    342497<li><strong>nr</strong> &#8211; number of r points to evaluate the 2nd derivative at  
     
    345500</td> 
    346501</tr> 
    347 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">c_out, c_cov - the coefficients with covariance matrix</p> 
     502<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">c_out, c_cov - the coefficients with covariance matrix</p> 
    348503</td> 
    349504</tr> 
     
    354509<dl class="method"> 
    355510<dt id="sans.pr.invertor.Invertor.iq"> 
    356 <tt class="descname">iq</tt><big>(</big><em>out</em>, <em>q</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.iq" title="Permalink to this definition">¶</a></dt> 
     511<tt class="descname">iq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.iq" title="Permalink to this definition">¶</a></dt> 
    357512<dd><p>Function to call to evaluate the scattering intensity</p> 
    358513<table class="docutils field-list" frame="void" rules="none"> 
     
    360515<col class="field-body" /> 
    361516<tbody valign="top"> 
    362 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> &#8211; c-parameters, and q</td> 
    363 </tr> 
    364 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">I(q)</td> 
     517<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> &#8211; c-parameters, and q</td> 
     518</tr> 
     519<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">I(q)</td> 
    365520</tr> 
    366521</tbody> 
     
    368523</dd></dl> 
    369524 
    370 <dl class="attribute"> 
     525<dl class="method"> 
    371526<dt id="sans.pr.invertor.Invertor.iq0"> 
    372 <tt class="descname">iq0</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.iq0" title="Permalink to this definition">¶</a></dt> 
     527<tt class="descname">iq0</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.iq0" title="Permalink to this definition">¶</a></dt> 
    373528<dd><p>Returns the value of I(q=0). 
    374529&#64;param args: c-parameters 
     
    376531</dd></dl> 
    377532 
    378 <dl class="attribute"> 
     533<dl class="method"> 
    379534<dt id="sans.pr.invertor.Invertor.iq_smeared"> 
    380 <tt class="descname">iq_smeared</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.iq_smeared" title="Permalink to this definition">¶</a></dt> 
     535<tt class="descname">iq_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.iq_smeared" title="Permalink to this definition">¶</a></dt> 
    381536<dd><p>Function to call to evaluate the scattering intensity. 
    382 The scattering intensity is slit-smeared. &#64;param args: c-parameters, and q</p> 
    383 <blockquote> 
    384 <div>&#64;return: I(q)</div></blockquote> 
    385 </dd></dl> 
    386  
    387 <dl class="attribute"> 
     537The scattering intensity is slit-smeared. &#64;param args: c-parameters, and q 
     538&#64;return: I(q)</p> 
     539</dd></dl> 
     540 
     541<dl class="method"> 
    388542<dt id="sans.pr.invertor.Invertor.is_valid"> 
    389 <tt class="descname">is_valid</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.is_valid" title="Permalink to this definition">¶</a></dt> 
     543<tt class="descname">is_valid</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.is_valid" title="Permalink to this definition">¶</a></dt> 
    390544<dd><p>Check the validity of the stored data 
    391545&#64;return: Returns the number of points if it&#8217;s all good, -1 otherwise</p> 
     
    394548<dl class="method"> 
    395549<dt id="sans.pr.invertor.Invertor.lstsq"> 
    396 <tt class="descname">lstsq</tt><big>(</big><em>nfunc=5</em>, <em>nr=20</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.lstsq" title="Permalink to this definition">¶</a></dt> 
     550<tt class="descname">lstsq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.lstsq" title="Permalink to this definition">¶</a></dt> 
    397551<dd><p>The problem is solved by posing the problem as  Ax = b, 
    398552where x is the set of coefficients we are looking for.</p> 
     
    419573<col class="field-body" /> 
    420574<tbody valign="top"> 
    421 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     575<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    422576<li><strong>nfunc</strong> &#8211; number of base functions to use.</li> 
    423577<li><strong>nr</strong> &#8211; number of r points to evaluate the 2nd derivative at 
     
    433587 
    434588<dl class="attribute"> 
     589<dt id="sans.pr.invertor.Invertor.nfunc"> 
     590<tt class="descname">nfunc</tt><em class="property"> = 10</em><a class="headerlink" href="#sans.pr.invertor.Invertor.nfunc" title="Permalink to this definition">¶</a></dt> 
     591<dd></dd></dl> 
     592 
     593<dl class="method"> 
    435594<dt id="sans.pr.invertor.Invertor.oscillations"> 
    436 <tt class="descname">oscillations</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.oscillations" title="Permalink to this definition">¶</a></dt> 
     595<tt class="descname">oscillations</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.oscillations" title="Permalink to this definition">¶</a></dt> 
    437596<dd><p>Returns the value of the oscillation figure of merit for 
    438597the given set of coefficients. For a sphere, the oscillation 
     
    444603 
    445604<dl class="attribute"> 
     605<dt id="sans.pr.invertor.Invertor.out"> 
     606<tt class="descname">out</tt><em class="property"> = None</em><a class="headerlink" href="#sans.pr.invertor.Invertor.out" title="Permalink to this definition">¶</a></dt> 
     607<dd></dd></dl> 
     608 
     609<dl class="method"> 
    446610<dt id="sans.pr.invertor.Invertor.pr"> 
    447 <tt class="descname">pr</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.pr" title="Permalink to this definition">¶</a></dt> 
     611<tt class="descname">pr</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.pr" title="Permalink to this definition">¶</a></dt> 
    448612<dd><p>Function to call to evaluate P(r) 
    449613&#64;param args: c-parameters and r 
     
    453617<dl class="method"> 
    454618<dt id="sans.pr.invertor.Invertor.pr_err"> 
    455 <tt class="descname">pr_err</tt><big>(</big><em>c</em>, <em>c_cov</em>, <em>r</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.pr_err" title="Permalink to this definition">¶</a></dt> 
     619<tt class="descname">pr_err</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.pr_err" title="Permalink to this definition">¶</a></dt> 
    456620<dd><p>Returns the value of P(r) for a given r, and base function 
    457621coefficients, with error.</p> 
     
    460624<col class="field-body" /> 
    461625<tbody valign="top"> 
    462 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     626<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    463627<li><strong>c</strong> &#8211; base function coefficients</li> 
    464628<li><strong>c_cov</strong> &#8211; covariance matrice of the base function coefficients</li> 
     
    467631</td> 
    468632</tr> 
    469 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">P(r)</p> 
     633<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">P(r)</p> 
    470634</td> 
    471635</tr> 
     
    476640<dl class="method"> 
    477641<dt id="sans.pr.invertor.Invertor.pr_fit"> 
    478 <tt class="descname">pr_fit</tt><big>(</big><em>nfunc=5</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.pr_fit" title="Permalink to this definition">¶</a></dt> 
     642<tt class="descname">pr_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.pr_fit" title="Permalink to this definition">¶</a></dt> 
    479643<dd><p>This is a direct fit to a given P(r). It assumes that the y data 
    480644is set to some P(r) distribution that we are trying to reproduce 
     
    483647</dd></dl> 
    484648 
    485 <dl class="attribute"> 
     649<dl class="method"> 
    486650<dt id="sans.pr.invertor.Invertor.pr_residuals"> 
    487 <tt class="descname">pr_residuals</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.pr_residuals" title="Permalink to this definition">¶</a></dt> 
     651<tt class="descname">pr_residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.pr_residuals" title="Permalink to this definition">¶</a></dt> 
    488652<dd><p>Function to call to evaluate the residuals 
    489 for P(r) minimization (for testing purposes)</p> 
    490 <blockquote> 
    491 <div>&#64;param args: input parameters 
    492 &#64;return: list of residuals</div></blockquote> 
    493 </dd></dl> 
    494  
    495 <dl class="attribute"> 
     653for P(r) minimization (for testing purposes) 
     654&#64;param args: input parameters 
     655&#64;return: list of residuals</p> 
     656</dd></dl> 
     657 
     658<dl class="method"> 
    496659<dt id="sans.pr.invertor.Invertor.residuals"> 
    497 <tt class="descname">residuals</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.residuals" title="Permalink to this definition">¶</a></dt> 
     660<tt class="descname">residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.residuals" title="Permalink to this definition">¶</a></dt> 
    498661<dd><p>Function to call to evaluate the residuals 
    499 for P(r) inversion</p> 
    500 <blockquote> 
    501 <div>&#64;param args: input parameters 
    502 &#64;return: list of residuals</div></blockquote> 
    503 </dd></dl> 
    504  
    505 <dl class="attribute"> 
     662for P(r) inversion 
     663&#64;param args: input parameters 
     664&#64;return: list of residuals</p> 
     665</dd></dl> 
     666 
     667<dl class="method"> 
    506668<dt id="sans.pr.invertor.Invertor.rg"> 
    507 <tt class="descname">rg</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.rg" title="Permalink to this definition">¶</a></dt> 
     669<tt class="descname">rg</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.rg" title="Permalink to this definition">¶</a></dt> 
    508670<dd><p>Returns the value of the radius of gyration Rg. 
    509671&#64;param args: c-parameters 
     
    511673</dd></dl> 
    512674 
    513 <dl class="attribute"> 
     675<dl class="method"> 
    514676<dt id="sans.pr.invertor.Invertor.set_alpha"> 
    515 <tt class="descname">set_alpha</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_alpha" title="Permalink to this definition">¶</a></dt> 
     677<tt class="descname">set_alpha</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_alpha" title="Permalink to this definition">¶</a></dt> 
    516678<dd><p>Sets the alpha parameter</p> 
    517679</dd></dl> 
    518680 
    519 <dl class="attribute"> 
     681<dl class="method"> 
    520682<dt id="sans.pr.invertor.Invertor.set_dmax"> 
    521 <tt class="descname">set_dmax</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_dmax" title="Permalink to this definition">¶</a></dt> 
     683<tt class="descname">set_dmax</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_dmax" title="Permalink to this definition">¶</a></dt> 
    522684<dd><p>Sets the maximum distance</p> 
    523685</dd></dl> 
    524686 
    525 <dl class="attribute"> 
     687<dl class="method"> 
    526688<dt id="sans.pr.invertor.Invertor.set_err"> 
    527 <tt class="descname">set_err</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_err" title="Permalink to this definition">¶</a></dt> 
     689<tt class="descname">set_err</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_err" title="Permalink to this definition">¶</a></dt> 
    528690<dd><p>Function to set the err data 
    529 Takes an array of doubles as input.</p> 
    530 <blockquote> 
    531 <div>&#64;return: number of entries found</div></blockquote> 
    532 </dd></dl> 
    533  
    534 <dl class="attribute"> 
     691Takes an array of doubles as input. 
     692&#64;return: number of entries found</p> 
     693</dd></dl> 
     694 
     695<dl class="method"> 
    535696<dt id="sans.pr.invertor.Invertor.set_has_bck"> 
    536 <tt class="descname">set_has_bck</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_has_bck" title="Permalink to this definition">¶</a></dt> 
     697<tt class="descname">set_has_bck</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_has_bck" title="Permalink to this definition">¶</a></dt> 
    537698<dd><p>Sets background flag</p> 
    538699</dd></dl> 
    539700 
    540 <dl class="attribute"> 
     701<dl class="method"> 
    541702<dt id="sans.pr.invertor.Invertor.set_qmax"> 
    542 <tt class="descname">set_qmax</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_qmax" title="Permalink to this definition">¶</a></dt> 
     703<tt class="descname">set_qmax</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_qmax" title="Permalink to this definition">¶</a></dt> 
    543704<dd><p>Sets the maximum q</p> 
    544705</dd></dl> 
    545706 
    546 <dl class="attribute"> 
     707<dl class="method"> 
    547708<dt id="sans.pr.invertor.Invertor.set_qmin"> 
    548 <tt class="descname">set_qmin</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_qmin" title="Permalink to this definition">¶</a></dt> 
     709<tt class="descname">set_qmin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_qmin" title="Permalink to this definition">¶</a></dt> 
    549710<dd><p>Sets the minimum q</p> 
    550711</dd></dl> 
    551712 
    552 <dl class="attribute"> 
     713<dl class="method"> 
    553714<dt id="sans.pr.invertor.Invertor.set_slit_height"> 
    554 <tt class="descname">set_slit_height</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_slit_height" title="Permalink to this definition">¶</a></dt> 
     715<tt class="descname">set_slit_height</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_slit_height" title="Permalink to this definition">¶</a></dt> 
    555716<dd><p>Sets the slit height in units of q [A-1]</p> 
    556717</dd></dl> 
    557718 
    558 <dl class="attribute"> 
     719<dl class="method"> 
    559720<dt id="sans.pr.invertor.Invertor.set_slit_width"> 
    560 <tt class="descname">set_slit_width</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_slit_width" title="Permalink to this definition">¶</a></dt> 
     721<tt class="descname">set_slit_width</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_slit_width" title="Permalink to this definition">¶</a></dt> 
    561722<dd><p>Sets the slit width in units of q [A-1]</p> 
    562723</dd></dl> 
    563724 
    564 <dl class="attribute"> 
     725<dl class="method"> 
    565726<dt id="sans.pr.invertor.Invertor.set_x"> 
    566 <tt class="descname">set_x</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_x" title="Permalink to this definition">¶</a></dt> 
     727<tt class="descname">set_x</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_x" title="Permalink to this definition">¶</a></dt> 
    567728<dd><p>Function to set the x data 
    568 Takes an array of doubles as input.</p> 
    569 <blockquote> 
    570 <div>&#64;return: number of entries found</div></blockquote> 
    571 </dd></dl> 
    572  
    573 <dl class="attribute"> 
     729Takes an array of doubles as input. 
     730&#64;return: number of entries found</p> 
     731</dd></dl> 
     732 
     733<dl class="method"> 
    574734<dt id="sans.pr.invertor.Invertor.set_y"> 
    575 <tt class="descname">set_y</tt><a class="headerlink" href="#sans.pr.invertor.Invertor.set_y" title="Permalink to this definition">¶</a></dt> 
     735<tt class="descname">set_y</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.set_y" title="Permalink to this definition">¶</a></dt> 
    576736<dd><p>Function to set the y data 
    577 Takes an array of doubles as input.</p> 
    578 <blockquote> 
    579 <div>&#64;return: number of entries found</div></blockquote> 
    580 </dd></dl> 
     737Takes an array of doubles as input. 
     738&#64;return: number of entries found</p> 
     739</dd></dl> 
     740 
     741<dl class="attribute"> 
     742<dt id="sans.pr.invertor.Invertor.suggested_alpha"> 
     743<tt class="descname">suggested_alpha</tt><em class="property"> = 0</em><a class="headerlink" href="#sans.pr.invertor.Invertor.suggested_alpha" title="Permalink to this definition">¶</a></dt> 
     744<dd></dd></dl> 
    581745 
    582746<dl class="method"> 
    583747<dt id="sans.pr.invertor.Invertor.to_file"> 
    584 <tt class="descname">to_file</tt><big>(</big><em>path</em>, <em>npts=100</em><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.to_file" title="Permalink to this definition">¶</a></dt> 
     748<tt class="descname">to_file</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.invertor.Invertor.to_file" title="Permalink to this definition">¶</a></dt> 
    585749<dd><p>Save the state to a file that will be readable 
    586750by SliceView.</p> 
     
    589753<col class="field-body" /> 
    590754<tbody valign="top"> 
    591 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     755<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    592756<li><strong>path</strong> &#8211; path of the file to write</li> 
    593757<li><strong>npts</strong> &#8211; number of P(r) points to be written</li> 
     
    620784  <ul> 
    621785<li><a class="reference internal" href="#">invertor</a><ul> 
    622 <li><a class="reference internal" href="#module-sans.pr.invertor"><tt class="docutils literal"><span class="pre">sans.pr.invertor</span></tt></a></li> 
     786<li><a class="reference internal" href="#sans-pr-invertor"><tt class="docutils literal"><span class="pre">sans.pr.invertor</span></tt></a></li> 
    623787</ul> 
    624788</li> 
     
    639803  <h3>Quick search</h3> 
    640804    <form class="search" action="../search.html" method="get"> 
    641       <input type="text" name="q" size="18" /> 
     805      <input type="text" name="q" /> 
    642806      <input type="submit" value="Go" /> 
    643807      <input type="hidden" name="check_keywords" value="yes" /> 
     
    668832          <a href="distance_explorer.html" title="distance_explorer" 
    669833             >previous</a> |</li> 
    670         <li><a href="../index.html">pr_inversion v0.1.0 documentation</a> &raquo;</li> 
     834        <li><a href="../index.html">pr_inversion 0.1.0 documentation</a> &raquo;</li> 
    671835          <li><a href="index.html" >Reference</a> &raquo;</li>  
    672836      </ul> 
     
    674838    <div class="footer"> 
    675839        &copy; Copyright 2010, sans group. 
    676       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     840      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    677841    </div> 
    678842  </body> 
Note: See TracChangeset for help on using the changeset viewer.