Ignore:
Timestamp:
Oct 24, 2011 11:50:18 AM (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/kiessig_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>Kiessig Calculator &mdash; calculator v0.1.0 documentation</title> 
     11    <title>kiessig_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="Resolution Calculator" href="resolution_calculator.html" /> 
    28     <link rel="prev" title="Slit Length Calculator" href="slit_length_calculator.html" />  
     30    <link rel="next" title="resolution_calculator" href="resolution_calculator.html" /> 
     31    <link rel="prev" title="instrument" href="instrument.html" />  
    2932  </head> 
    3033  <body> 
    … …  
    3942             >modules</a> |</li> 
    4043        <li class="right" > 
    41           <a href="resolution_calculator.html" title="Resolution Calculator" 
     44          <a href="resolution_calculator.html" title="resolution_calculator" 
    4245             accesskey="N">next</a> |</li> 
    4346        <li class="right" > 
    44           <a href="slit_length_calculator.html" title="Slit Length Calculator" 
     47          <a href="instrument.html" title="instrument" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5558             
    5659  <div class="section" id="kiessig-calculator"> 
    57 <h1>Kiessig Calculator<a class="headerlink" href="#kiessig-calculator" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.calculator.kiessig_calculator"> 
    59 <span id="sans-calculator-kiessig-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.kiessig_calculator" title="sans.calculator.kiessig_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a><a class="headerlink" href="#module-sans.calculator.kiessig_calculator" title="Permalink to this headline">¶</a></h2> 
    60 <p>This module is a small tool to allow user to quickly 
     60<h1>kiessig_calculator<a class="headerlink" href="#kiessig-calculator" title="Permalink to this headline">¶</a></h1> 
     61<div class="section" id="sans-calculator-kiessig-calculator"> 
     62<h2><a class="reference internal" href="#module-sans.calculator.kiessig_calculator" title="sans.calculator.kiessig_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-kiessig-calculator" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.calculator.kiessig_calculator"></span><p>This module is a small tool to allow user to quickly 
    6164determine the size value in real space  from the  
    6265fringe width in q space.</p> 
    … …  
    6669<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
    6770<p>compute thickness from the fringe width of data</p> 
     71<dl class="attribute"> 
     72<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__class__"> 
     73<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__class__" title="Permalink to this definition">¶</a></dt> 
     74<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     75</dd></dl> 
     76 
     77<dl class="attribute"> 
     78<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__delattr__"> 
     79<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__delattr__" title="Permalink to this definition">¶</a></dt> 
     80<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     81</dd></dl> 
     82 
     83<dl class="attribute"> 
     84<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__dict__"> 
     85<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01C9DBD0&gt;</em><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__dict__" title="Permalink to this definition">¶</a></dt> 
     86<dd></dd></dl> 
     87 
     88<dl class="attribute"> 
     89<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__getattribute__"> 
     90<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     91<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     92</dd></dl> 
     93 
     94<dl class="attribute"> 
     95<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__hash__"> 
     96<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__hash__" title="Permalink to this definition">¶</a></dt> 
     97<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     98</dd></dl> 
     99 
     100<dl class="method"> 
     101<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__init__"> 
     102<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__init__" title="Permalink to this definition">¶</a></dt> 
     103<dd></dd></dl> 
     104 
     105<dl class="attribute"> 
     106<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__module__"> 
     107<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.kiessig_calculator'</em><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__module__" title="Permalink to this definition">¶</a></dt> 
     108<dd></dd></dl> 
     109 
     110<dl class="staticmethod"> 
     111<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__new__"> 
     112<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.kiessig_calculator.KiessigThicknessCalculator.__new__" title="Permalink to this definition">¶</a></dt> 
     113<dd></dd></dl> 
     114 
     115<dl class="method"> 
     116<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce__"> 
     117<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce__" title="Permalink to this definition">¶</a></dt> 
     118<dd><p>helper for pickle</p> 
     119</dd></dl> 
     120 
     121<dl class="method"> 
     122<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce_ex__"> 
     123<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>helper for pickle</p> 
     125</dd></dl> 
     126 
     127<dl class="attribute"> 
     128<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__repr__"> 
     129<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__repr__" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     131</dd></dl> 
     132 
     133<dl class="attribute"> 
     134<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__setattr__"> 
     135<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__setattr__" title="Permalink to this definition">¶</a></dt> 
     136<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     137</dd></dl> 
     138 
     139<dl class="attribute"> 
     140<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__str__"> 
     141<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__str__" title="Permalink to this definition">¶</a></dt> 
     142<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     143</dd></dl> 
     144 
     145<dl class="attribute"> 
     146<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__weakref__"> 
     147<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__weakref__" title="Permalink to this definition">¶</a></dt> 
     148<dd><p>list of weak references to the object (if defined)</p> 
     149</dd></dl> 
     150 
    68151<dl class="method"> 
    69152<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.compute_thickness"> 
    … …  
    74157<col class="field-body" /> 
    75158<tbody valign="top"> 
    76 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the thickness.</td> 
     159<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness.</td> 
    77160</tr> 
    78161</tbody> 
    … …  
    93176<col class="field-body" /> 
    94177<tbody valign="top"> 
    95 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the thickness unit.</td> 
     178<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness unit.</td> 
    96179</tr> 
    97180</tbody> 
    … …  
    101184<dl class="method"> 
    102185<dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq"> 
    103 <tt class="descname">set_deltaq</tt><big>(</big><em>dq=None</em><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq" title="Permalink to this definition">¶</a></dt> 
     186<tt class="descname">set_deltaq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq" title="Permalink to this definition">¶</a></dt> 
    104187<dd><p>Receive deltaQ value</p> 
    105188<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    107190<col class="field-body" /> 
    108191<tbody valign="top"> 
    109 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dq</strong> &#8211; q fringe width in 1/A unit</td> 
     192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dq</strong> &#8211; q fringe width in 1/A unit</td> 
    110193</tr> 
    111194</tbody> 
    … …  
    126209  <h3><a href="../index.html">Table Of Contents</a></h3> 
    127210  <ul> 
    128 <li><a class="reference internal" href="#">Kiessig Calculator</a><ul> 
    129 <li><a class="reference internal" href="#module-sans.calculator.kiessig_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li> 
     211<li><a class="reference internal" href="#">kiessig_calculator</a><ul> 
     212<li><a class="reference internal" href="#sans-calculator-kiessig-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li> 
    130213</ul> 
    131214</li> 
    … …  
    133216 
    134217  <h4>Previous topic</h4> 
    135   <p class="topless"><a href="slit_length_calculator.html" 
    136                         title="previous chapter">Slit Length Calculator</a></p> 
     218  <p class="topless"><a href="instrument.html" 
     219                        title="previous chapter">instrument</a></p> 
    137220  <h4>Next topic</h4> 
    138221  <p class="topless"><a href="resolution_calculator.html" 
    139                         title="next chapter">Resolution Calculator</a></p> 
     222                        title="next chapter">resolution_calculator</a></p> 
    140223  <h3>This Page</h3> 
    141224  <ul class="this-page-menu"> 
    … …  
    146229  <h3>Quick search</h3> 
    147230    <form class="search" action="../search.html" method="get"> 
    148       <input type="text" name="q" size="18" /> 
     231      <input type="text" name="q" /> 
    149232      <input type="submit" value="Go" /> 
    150233      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    170253             >modules</a> |</li> 
    171254        <li class="right" > 
    172           <a href="resolution_calculator.html" title="Resolution Calculator" 
     255          <a href="resolution_calculator.html" title="resolution_calculator" 
    173256             >next</a> |</li> 
    174257        <li class="right" > 
    175           <a href="slit_length_calculator.html" title="Slit Length Calculator" 
     258          <a href="instrument.html" title="instrument" 
    176259             >previous</a> |</li> 
    177         <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li> 
     260        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li> 
    178261          <li><a href="index.html" >Reference</a> &raquo;</li>  
    179262      </ul> 
    … …  
    181264    <div class="footer"> 
    182265        &copy; Copyright 2010, Gervaise Alina. 
    183       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     266      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    184267    </div> 
    185268  </body> 
Note: See TracChangeset for help on using the changeset viewer.