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/distance_explorer.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>distance_explorer &mdash; pr_inversion v0.1.0 documentation</title> 
     11    <title>distance_explorer &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="invertor" href="invertor.html" /> 
     
    4447          <a href="index.html" title="Reference" 
    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="distance-explorer"> 
    5760<h1>distance_explorer<a class="headerlink" href="#distance-explorer" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.pr.distance_explorer"> 
    59 <span id="sans-pr-distance-explorer"></span><h2><a class="reference internal" href="#module-sans.pr.distance_explorer" title="sans.pr.distance_explorer"><tt class="xref py py-mod docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a><a class="headerlink" href="#module-sans.pr.distance_explorer" title="Permalink to this headline">¶</a></h2> 
    60 <p>Module to explore the P(r) inversion results for a range 
     61<div class="section" id="sans-pr-distance-explorer"> 
     62<h2><a class="reference internal" href="#module-sans.pr.distance_explorer" title="sans.pr.distance_explorer"><tt class="xref py py-mod docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a><a class="headerlink" href="#sans-pr-distance-explorer" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.pr.distance_explorer"></span><p>Module to explore the P(r) inversion results for a range 
    6164of D_max value. User picks a number of points and a range of 
    6265distances, then get a series of outputs as a function of D_max 
     
    6467<dl class="class"> 
    6568<dt id="sans.pr.distance_explorer.DistExplorer"> 
    66 <em class="property">class </em><tt class="descclassname">sans.pr.distance_explorer.</tt><tt class="descname">DistExplorer</tt><big>(</big><em>pr_state</em><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer" title="Permalink to this definition">¶</a></dt> 
     69<em class="property">class </em><tt class="descclassname">sans.pr.distance_explorer.</tt><tt class="descname">DistExplorer</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer" title="Permalink to this definition">¶</a></dt> 
    6770<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
    6871<p>The explorer class</p> 
     72<dl class="method"> 
     73<dt id="sans.pr.distance_explorer.DistExplorer.__call__"> 
     74<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__call__" title="Permalink to this definition">¶</a></dt> 
     75<dd><p>Compute the outputs as a function of D_max.</p> 
     76<table class="docutils field-list" frame="void" rules="none"> 
     77<col class="field-name" /> 
     78<col class="field-body" /> 
     79<tbody valign="top"> 
     80<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     81<li><strong>dmin</strong> &#8211; minimum value for D_max</li> 
     82<li><strong>dmax</strong> &#8211; maximum value for D_max</li> 
     83<li><strong>npts</strong> &#8211; number of points for D_max</li> 
     84</ul> 
     85</td> 
     86</tr> 
     87</tbody> 
     88</table> 
     89</dd></dl> 
     90 
     91<dl class="attribute"> 
     92<dt id="sans.pr.distance_explorer.DistExplorer.__class__"> 
     93<tt class="descname">__class__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__class__" title="Permalink to this definition">¶</a></dt> 
     94<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     95</dd></dl> 
     96 
     97<dl class="attribute"> 
     98<dt id="sans.pr.distance_explorer.DistExplorer.__delattr__"> 
     99<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__delattr__" title="Permalink to this definition">¶</a></dt> 
     100<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     101</dd></dl> 
     102 
     103<dl class="attribute"> 
     104<dt id="sans.pr.distance_explorer.DistExplorer.__dict__"> 
     105<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x018F9B90&gt;</em><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__dict__" title="Permalink to this definition">¶</a></dt> 
     106<dd></dd></dl> 
     107 
     108<dl class="attribute"> 
     109<dt id="sans.pr.distance_explorer.DistExplorer.__getattribute__"> 
     110<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     111<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     112</dd></dl> 
     113 
     114<dl class="attribute"> 
     115<dt id="sans.pr.distance_explorer.DistExplorer.__hash__"> 
     116<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__hash__" title="Permalink to this definition">¶</a></dt> 
     117<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     118</dd></dl> 
     119 
     120<dl class="method"> 
     121<dt id="sans.pr.distance_explorer.DistExplorer.__init__"> 
     122<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__init__" title="Permalink to this definition">¶</a></dt> 
     123<dd><p>Initialization.</p> 
     124<table class="docutils field-list" frame="void" rules="none"> 
     125<col class="field-name" /> 
     126<col class="field-body" /> 
     127<tbody valign="top"> 
     128<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pr_state</strong> &#8211; sans.pr.invertor.Invertor object</td> 
     129</tr> 
     130</tbody> 
     131</table> 
     132</dd></dl> 
     133 
     134<dl class="attribute"> 
     135<dt id="sans.pr.distance_explorer.DistExplorer.__module__"> 
     136<tt class="descname">__module__</tt><em class="property"> = 'sans.pr.distance_explorer'</em><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__module__" title="Permalink to this definition">¶</a></dt> 
     137<dd></dd></dl> 
     138 
     139<dl class="staticmethod"> 
     140<dt id="sans.pr.distance_explorer.DistExplorer.__new__"> 
     141<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.distance_explorer.DistExplorer.__new__" title="Permalink to this definition">¶</a></dt> 
     142<dd></dd></dl> 
     143 
     144<dl class="method"> 
     145<dt id="sans.pr.distance_explorer.DistExplorer.__reduce__"> 
     146<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__reduce__" title="Permalink to this definition">¶</a></dt> 
     147<dd><p>helper for pickle</p> 
     148</dd></dl> 
     149 
     150<dl class="method"> 
     151<dt id="sans.pr.distance_explorer.DistExplorer.__reduce_ex__"> 
     152<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     153<dd><p>helper for pickle</p> 
     154</dd></dl> 
     155 
     156<dl class="attribute"> 
     157<dt id="sans.pr.distance_explorer.DistExplorer.__repr__"> 
     158<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__repr__" title="Permalink to this definition">¶</a></dt> 
     159<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     160</dd></dl> 
     161 
     162<dl class="attribute"> 
     163<dt id="sans.pr.distance_explorer.DistExplorer.__setattr__"> 
     164<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__setattr__" title="Permalink to this definition">¶</a></dt> 
     165<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     166</dd></dl> 
     167 
     168<dl class="attribute"> 
     169<dt id="sans.pr.distance_explorer.DistExplorer.__str__"> 
     170<tt class="descname">__str__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__str__" title="Permalink to this definition">¶</a></dt> 
     171<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     172</dd></dl> 
     173 
     174<dl class="attribute"> 
     175<dt id="sans.pr.distance_explorer.DistExplorer.__weakref__"> 
     176<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.pr.distance_explorer.DistExplorer.__weakref__" title="Permalink to this definition">¶</a></dt> 
     177<dd><p>list of weak references to the object (if defined)</p> 
     178</dd></dl> 
     179 
    69180</dd></dl> 
    70181 
     
    74185<dd><p>Class to hold the inversion output parameters 
    75186as a function of D_max</p> 
     187<dl class="method"> 
     188<dt id="sans.pr.distance_explorer.Results.__init__"> 
     189<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.pr.distance_explorer.Results.__init__" title="Permalink to this definition">¶</a></dt> 
     190<dd><p>Initialization. Create empty arrays 
     191and dictionary of labels.</p> 
     192</dd></dl> 
     193 
     194<dl class="attribute"> 
     195<dt id="sans.pr.distance_explorer.Results.__module__"> 
     196<tt class="descname">__module__</tt><em class="property"> = 'sans.pr.distance_explorer'</em><a class="headerlink" href="#sans.pr.distance_explorer.Results.__module__" title="Permalink to this definition">¶</a></dt> 
     197<dd></dd></dl> 
     198 
    76199</dd></dl> 
    77200 
     
    88211  <ul> 
    89212<li><a class="reference internal" href="#">distance_explorer</a><ul> 
    90 <li><a class="reference internal" href="#module-sans.pr.distance_explorer"><tt class="docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a></li> 
     213<li><a class="reference internal" href="#sans-pr-distance-explorer"><tt class="docutils literal"><span class="pre">sans.pr.distance_explorer</span></tt></a></li> 
    91214</ul> 
    92215</li> 
     
    107230  <h3>Quick search</h3> 
    108231    <form class="search" action="../search.html" method="get"> 
    109       <input type="text" name="q" size="18" /> 
     232      <input type="text" name="q" /> 
    110233      <input type="submit" value="Go" /> 
    111234      <input type="hidden" name="check_keywords" value="yes" /> 
     
    136259          <a href="index.html" title="Reference" 
    137260             >previous</a> |</li> 
    138         <li><a href="../index.html">pr_inversion v0.1.0 documentation</a> &raquo;</li> 
     261        <li><a href="../index.html">pr_inversion 0.1.0 documentation</a> &raquo;</li> 
    139262          <li><a href="index.html" >Reference</a> &raquo;</li>  
    140263      </ul> 
     
    142265    <div class="footer"> 
    143266        &copy; Copyright 2010, sans group. 
    144       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     267      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    145268    </div> 
    146269  </body> 
Note: See TracChangeset for help on using the changeset viewer.