Ignore:
Timestamp:
Oct 24, 2011 1:50:18 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:
7247844
Parents:
8884996
Message:

edit doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sanscalculator/docs/sphinx/html/api/slit_length_calculator.html

    r771fe98 ra4f04f2  
    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>Slit Length Calculator &mdash; calculator v0.1.0 documentation</title> 
     11    <title>slit_length_calculator &mdash; calculator 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="calculator v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    27     <link rel="next" title="Kiessig Calculator" href="kiessig_calculator.html" /> 
    28     <link rel="prev" title="Instrument" href="instrument.html" />  
     30    <link rel="prev" title="resolution_calculator" href="resolution_calculator.html" />  
    2931  </head> 
    3032  <body> 
    … …  
    3941             >modules</a> |</li> 
    4042        <li class="right" > 
    41           <a href="kiessig_calculator.html" title="Kiessig Calculator" 
    42              accesskey="N">next</a> |</li> 
    43         <li class="right" > 
    44           <a href="instrument.html" title="Instrument" 
     43          <a href="resolution_calculator.html" title="resolution_calculator" 
    4544             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li> 
     45        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li> 
    4746          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4847      </ul> 
    … …  
    5554             
    5655  <div class="section" id="slit-length-calculator"> 
    57 <h1>Slit Length Calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.calculator.slit_length_calculator"> 
    59 <span id="sans-calculator-slit-length-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.slit_length_calculator" title="sans.calculator.slit_length_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a><a class="headerlink" href="#module-sans.calculator.slit_length_calculator" title="Permalink to this headline">¶</a></h2> 
    60 <p>This module is a small tool to allow user to quickly 
     56<h1>slit_length_calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1> 
     57<div class="section" id="sans-calculator-slit-length-calculator"> 
     58<h2><a class="reference internal" href="#module-sans.calculator.slit_length_calculator" title="sans.calculator.slit_length_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-slit-length-calculator" title="Permalink to this headline">¶</a></h2> 
     59<span class="target" id="module-sans.calculator.slit_length_calculator"></span><p>This module is a small tool to allow user to quickly 
    6160determine the slit length value of data.</p> 
    6261<dl class="class"> 
    … …  
    6665<p>compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I , 
    6766and 3rd col. dI.: don&#8217;t need the 3rd)</p> 
     67<dl class="attribute"> 
     68<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__class__"> 
     69<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__class__" title="Permalink to this definition">¶</a></dt> 
     70<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     71</dd></dl> 
     72 
     73<dl class="attribute"> 
     74<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__delattr__"> 
     75<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__delattr__" title="Permalink to this definition">¶</a></dt> 
     76<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     77</dd></dl> 
     78 
     79<dl class="attribute"> 
     80<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__dict__"> 
     81<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0226C6F0&gt;</em><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__dict__" title="Permalink to this definition">¶</a></dt> 
     82<dd></dd></dl> 
     83 
     84<dl class="attribute"> 
     85<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__getattribute__"> 
     86<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     87<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     88</dd></dl> 
     89 
     90<dl class="attribute"> 
     91<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__hash__"> 
     92<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__hash__" title="Permalink to this definition">¶</a></dt> 
     93<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     94</dd></dl> 
     95 
     96<dl class="method"> 
     97<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__init__"> 
     98<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__init__" title="Permalink to this definition">¶</a></dt> 
     99<dd></dd></dl> 
     100 
     101<dl class="attribute"> 
     102<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__module__"> 
     103<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.slit_length_calculator'</em><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__module__" title="Permalink to this definition">¶</a></dt> 
     104<dd></dd></dl> 
     105 
     106<dl class="staticmethod"> 
     107<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__new__"> 
     108<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.calculator.slit_length_calculator.SlitlengthCalculator.__new__" title="Permalink to this definition">¶</a></dt> 
     109<dd></dd></dl> 
     110 
     111<dl class="method"> 
     112<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce__"> 
     113<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce__" title="Permalink to this definition">¶</a></dt> 
     114<dd><p>helper for pickle</p> 
     115</dd></dl> 
     116 
     117<dl class="method"> 
     118<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce_ex__"> 
     119<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     120<dd><p>helper for pickle</p> 
     121</dd></dl> 
     122 
     123<dl class="attribute"> 
     124<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__repr__"> 
     125<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__repr__" title="Permalink to this definition">¶</a></dt> 
     126<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     127</dd></dl> 
     128 
     129<dl class="attribute"> 
     130<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__setattr__"> 
     131<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__setattr__" title="Permalink to this definition">¶</a></dt> 
     132<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     133</dd></dl> 
     134 
     135<dl class="attribute"> 
     136<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__str__"> 
     137<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__str__" title="Permalink to this definition">¶</a></dt> 
     138<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     139</dd></dl> 
     140 
     141<dl class="attribute"> 
     142<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__weakref__"> 
     143<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__weakref__" title="Permalink to this definition">¶</a></dt> 
     144<dd><p>list of weak references to the object (if defined)</p> 
     145</dd></dl> 
     146 
    68147<dl class="method"> 
    69148<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length"> 
    … …  
    74153<col class="field-body" /> 
    75154<tbody valign="top"> 
    76 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td> 
     155<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td> 
    77156</tr> 
    78157</tbody> 
    … …  
    87166<col class="field-body" /> 
    88167<tbody valign="top"> 
    89 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td> 
     168<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td> 
    90169</tr> 
    91170</tbody> 
    … …  
    95174<dl class="method"> 
    96175<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data"> 
    97 <tt class="descname">set_data</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt> 
    98 <dd><blockquote> 
    99 <div>Receive two vector x, y and prepare the slit calculator for  
    100 computation.</div></blockquote> 
     176<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt> 
     177<dd><dl class="docutils"> 
     178<dt>Receive two vector x, y and prepare the slit calculator for </dt> 
     179<dd>computation.</dd> 
     180</dl> 
    101181<table class="docutils field-list" frame="void" rules="none"> 
    102182<col class="field-name" /> 
    103183<col class="field-body" /> 
    104184<tbody valign="top"> 
    105 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    106186<li><strong>x</strong> &#8211; array</li> 
    107187<li><strong>y</strong> &#8211; array</li> 
    … …  
    126206  <h3><a href="../index.html">Table Of Contents</a></h3> 
    127207  <ul> 
    128 <li><a class="reference internal" href="#">Slit Length Calculator</a><ul> 
    129 <li><a class="reference internal" href="#module-sans.calculator.slit_length_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li> 
     208<li><a class="reference internal" href="#">slit_length_calculator</a><ul> 
     209<li><a class="reference internal" href="#sans-calculator-slit-length-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li> 
    130210</ul> 
    131211</li> 
    … …  
    133213 
    134214  <h4>Previous topic</h4> 
    135   <p class="topless"><a href="instrument.html" 
    136                         title="previous chapter">Instrument</a></p> 
    137   <h4>Next topic</h4> 
    138   <p class="topless"><a href="kiessig_calculator.html" 
    139                         title="next chapter">Kiessig Calculator</a></p> 
     215  <p class="topless"><a href="resolution_calculator.html" 
     216                        title="previous chapter">resolution_calculator</a></p> 
    140217  <h3>This Page</h3> 
    141218  <ul class="this-page-menu"> 
    … …  
    146223  <h3>Quick search</h3> 
    147224    <form class="search" action="../search.html" method="get"> 
    148       <input type="text" name="q" size="18" /> 
     225      <input type="text" name="q" /> 
    149226      <input type="submit" value="Go" /> 
    150227      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    170247             >modules</a> |</li> 
    171248        <li class="right" > 
    172           <a href="kiessig_calculator.html" title="Kiessig Calculator" 
    173              >next</a> |</li> 
    174         <li class="right" > 
    175           <a href="instrument.html" title="Instrument" 
     249          <a href="resolution_calculator.html" title="resolution_calculator" 
    176250             >previous</a> |</li> 
    177         <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li> 
     251        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li> 
    178252          <li><a href="index.html" >Reference</a> &raquo;</li>  
    179253      </ul> 
    … …  
    181255    <div class="footer"> 
    182256        &copy; Copyright 2010, Gervaise Alina. 
    183       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     257      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    184258    </div> 
    185259  </body> 
Note: See TracChangeset for help on using the changeset viewer.