Ignore:
Timestamp:
Oct 24, 2011 1:37:36 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:
f696e2a
Parents:
89b7858
Message:

edit doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • inversionview/docs/sphinx/html/api/perspectives/pr/inversion_state.html

    r242eba5 r40299ce  
    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>inversion_state &mdash; prview v0.1.0 documentation</title> 
     11    <title>inversion_state &mdash; prview 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="prview v0.1.0 documentation" href="../../../index.html" /> 
     28    <link rel="top" title="prview 0.1.0 documentation" href="../../../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    27     <link rel="next" title="pr_thread" href="pr_thread.html" /> 
     30    <link rel="next" title="pr" href="pr.html" /> 
    2831    <link rel="prev" title="inversion_panel" href="inversion_panel.html" />  
    2932  </head> 
    … …  
    3639             accesskey="I">index</a></li> 
    3740        <li class="right" > 
    38           <a href="pr_thread.html" title="pr_thread" 
     41          <a href="../../../py-modindex.html" title="Python Module Index" 
     42             >modules</a> |</li> 
     43        <li class="right" > 
     44          <a href="pr.html" title="pr" 
    3945             accesskey="N">next</a> |</li> 
    4046        <li class="right" > 
    4147          <a href="inversion_panel.html" title="inversion_panel" 
    4248             accesskey="P">previous</a> |</li> 
    43         <li><a href="../../../index.html">prview v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../../../index.html">prview 0.1.0 documentation</a> &raquo;</li> 
    4450          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4551      </ul> 
    … …  
    5460<h1>inversion_state<a class="headerlink" href="#inversion-state" title="Permalink to this headline">¶</a></h1> 
    5561<div class="section" id="sans-perspectives-pr-inversion-state"> 
    56 <h2><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.pr.inversion_state</span></tt><a class="headerlink" href="#sans-perspectives-pr-inversion-state" title="Permalink to this headline">¶</a></h2> 
     62<h2><a class="reference internal" href="#module-sans.perspectives.pr.inversion_state" title="sans.perspectives.pr.inversion_state"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.pr.inversion_state</span></tt></a><a class="headerlink" href="#sans-perspectives-pr-inversion-state" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.perspectives.pr.inversion_state"></span><dl class="class"> 
     64<dt id="sans.perspectives.pr.inversion_state.InversionState"> 
     65<em class="property">class </em><tt class="descclassname">sans.perspectives.pr.inversion_state.</tt><tt class="descname">InversionState</tt><a class="headerlink" href="#sans.perspectives.pr.inversion_state.InversionState" title="Permalink to this definition">¶</a></dt> 
     66<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
     67<p>Class to hold the state information of the InversionControl panel.</p> 
     68<dl class="method"> 
     69<dt id="sans.perspectives.pr.inversion_state.InversionState.fromXML"> 
     70<tt class="descname">fromXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.inversion_state.InversionState.fromXML" title="Permalink to this definition">¶</a></dt> 
     71<dd><p>Load a P(r) inversion state from a file</p> 
     72<table class="docutils field-list" frame="void" rules="none"> 
     73<col class="field-name" /> 
     74<col class="field-body" /> 
     75<tbody valign="top"> 
     76<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     77<li><strong>file</strong> &#8211; .prv file</li> 
     78<li><strong>node</strong> &#8211; node of a XML document to read from</li> 
     79</ul> 
     80</td> 
     81</tr> 
     82</tbody> 
     83</table> 
     84</dd></dl> 
     85 
     86<dl class="method"> 
     87<dt id="sans.perspectives.pr.inversion_state.InversionState.toXML"> 
     88<tt class="descname">toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.inversion_state.InversionState.toXML" title="Permalink to this definition">¶</a></dt> 
     89<dd><p>Writes the state of the InversionControl panel to file, as XML.</p> 
     90<p>Compatible with standalone writing, or appending to an 
     91already existing XML document. In that case, the XML document 
     92is required. An optional entry node in the XML document  
     93may also be given.</p> 
     94<table class="docutils field-list" frame="void" rules="none"> 
     95<col class="field-name" /> 
     96<col class="field-body" /> 
     97<tbody valign="top"> 
     98<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     99<li><strong>file</strong> &#8211; file to write to</li> 
     100<li><strong>doc</strong> &#8211; XML document object [optional]</li> 
     101<li><strong>entry_node</strong> &#8211; XML node within the XML document at which  
     102we will append the data [optional]</li> 
     103</ul> 
     104</td> 
     105</tr> 
     106</tbody> 
     107</table> 
     108</dd></dl> 
     109 
     110</dd></dl> 
     111 
     112<dl class="class"> 
     113<dt id="sans.perspectives.pr.inversion_state.Reader"> 
     114<em class="property">class </em><tt class="descclassname">sans.perspectives.pr.inversion_state.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader" title="Permalink to this definition">¶</a></dt> 
     115<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader.Reader</span></tt></p> 
     116<p>Class to load a .prv P(r) inversion file</p> 
     117<dl class="attribute"> 
     118<dt id="sans.perspectives.pr.inversion_state.Reader.ext"> 
     119<tt class="descname">ext</tt><em class="property"> = ['.prv', '.PRV', '.svs', '.SVS']</em><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     120<dd></dd></dl> 
     121 
     122<dl class="method"> 
     123<dt id="sans.perspectives.pr.inversion_state.Reader.read"> 
     124<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.read" title="Permalink to this definition">¶</a></dt> 
     125<dd><p>Load a new P(r) inversion state from file</p> 
     126<table class="docutils field-list" frame="void" rules="none"> 
     127<col class="field-name" /> 
     128<col class="field-body" /> 
     129<tbody valign="top"> 
     130<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; file path</td> 
     131</tr> 
     132<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td> 
     133</tr> 
     134</tbody> 
     135</table> 
     136</dd></dl> 
     137 
     138<dl class="attribute"> 
     139<dt id="sans.perspectives.pr.inversion_state.Reader.type"> 
     140<tt class="descname">type</tt><em class="property"> = ['P(r) files (*.prv)|*.prv', 'SANSView files (*.svs)|*.svs']</em><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.type" title="Permalink to this definition">¶</a></dt> 
     141<dd></dd></dl> 
     142 
     143<dl class="attribute"> 
     144<dt id="sans.perspectives.pr.inversion_state.Reader.type_name"> 
     145<tt class="descname">type_name</tt><em class="property"> = 'P(r)'</em><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     146<dd></dd></dl> 
     147 
     148<dl class="attribute"> 
     149<dt id="sans.perspectives.pr.inversion_state.Reader.version"> 
     150<tt class="descname">version</tt><em class="property"> = '1.0'</em><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.version" title="Permalink to this definition">¶</a></dt> 
     151<dd></dd></dl> 
     152 
     153<dl class="method"> 
     154<dt id="sans.perspectives.pr.inversion_state.Reader.write"> 
     155<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.write" title="Permalink to this definition">¶</a></dt> 
     156<dd><p>Write the content of a Data1D as a CanSAS XML file</p> 
     157<table class="docutils field-list" frame="void" rules="none"> 
     158<col class="field-name" /> 
     159<col class="field-body" /> 
     160<tbody valign="top"> 
     161<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     162<li><strong>filename</strong> &#8211; name of the file to write</li> 
     163<li><strong>datainfo</strong> &#8211; Data1D object</li> 
     164<li><strong>prstate</strong> &#8211; InversionState object</li> 
     165</ul> 
     166</td> 
     167</tr> 
     168</tbody> 
     169</table> 
     170</dd></dl> 
     171 
     172<dl class="method"> 
     173<dt id="sans.perspectives.pr.inversion_state.Reader.write_toXML"> 
     174<tt class="descname">write_toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.inversion_state.Reader.write_toXML" title="Permalink to this definition">¶</a></dt> 
     175<dd><p>Write toXML, a helper for write()</p> 
     176<p>: return: xml doc</p> 
     177</dd></dl> 
     178 
     179</dd></dl> 
     180 
    57181</div> 
    58182</div> 
    … …  
    76200                        title="previous chapter">inversion_panel</a></p> 
    77201  <h4>Next topic</h4> 
    78   <p class="topless"><a href="pr_thread.html" 
    79                         title="next chapter">pr_thread</a></p> 
     202  <p class="topless"><a href="pr.html" 
     203                        title="next chapter">pr</a></p> 
    80204  <h3>This Page</h3> 
    81205  <ul class="this-page-menu"> 
    … …  
    86210  <h3>Quick search</h3> 
    87211    <form class="search" action="../../../search.html" method="get"> 
    88       <input type="text" name="q" size="18" /> 
     212      <input type="text" name="q" /> 
    89213      <input type="submit" value="Go" /> 
    90214      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    107231             >index</a></li> 
    108232        <li class="right" > 
    109           <a href="pr_thread.html" title="pr_thread" 
     233          <a href="../../../py-modindex.html" title="Python Module Index" 
     234             >modules</a> |</li> 
     235        <li class="right" > 
     236          <a href="pr.html" title="pr" 
    110237             >next</a> |</li> 
    111238        <li class="right" > 
    112239          <a href="inversion_panel.html" title="inversion_panel" 
    113240             >previous</a> |</li> 
    114         <li><a href="../../../index.html">prview v0.1.0 documentation</a> &raquo;</li> 
     241        <li><a href="../../../index.html">prview 0.1.0 documentation</a> &raquo;</li> 
    115242          <li><a href="index.html" >Reference</a> &raquo;</li>  
    116243      </ul> 
    … …  
    118245    <div class="footer"> 
    119246        &copy; Copyright 2010, sans group. 
    120       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     247      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    121248    </div> 
    122249  </body> 
Note: See TracChangeset for help on using the changeset viewer.