source: sasview/calculator/docs/sphinx/_build/html/api/slit_length_calculator.html @ 25a2ee3

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 25a2ee3 was 14e9eb3, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 6.6 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>Slit Length Calculator &mdash; calculator v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="prev" title="Sld Calculator" href="sld_calculator.html" /> 
28  </head>
29  <body>
30    <div class="related">
31      <h3>Navigation</h3>
32      <ul>
33        <li class="right" style="margin-right: 10px">
34          <a href="../genindex.html" title="General Index"
35             accesskey="I">index</a></li>
36        <li class="right" >
37          <a href="../py-modindex.html" title="Python Module Index"
38             >modules</a> |</li>
39        <li class="right" >
40          <a href="sld_calculator.html" title="Sld Calculator"
41             accesskey="P">previous</a> |</li>
42        <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li>
43          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
44      </ul>
45    </div> 
46
47    <div class="document">
48      <div class="documentwrapper">
49        <div class="bodywrapper">
50          <div class="body">
51           
52  <div class="section" id="slit-length-calculator">
53<h1>Slit Length Calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1>
54<div class="section" id="module-sans.calculator.slit_length_calculator">
55<span id="sans-calculator-slit-length-calculator"></span><h2><a class="reference internal" href="#module-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>
56<p>This module is a small tool to allow user to quickly
57determine the slit length value of data.</p>
58<dl class="class">
59<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator">
60<em class="property">class </em><tt class="descclassname">sans.calculator.slit_length_calculator.</tt><tt class="descname">SlitlengthCalculator</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator" title="Permalink to this definition">¶</a></dt>
61<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
62<p>compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I ,
63and 3rd col. dI.: don&#8217;t need the 3rd)</p>
64<dl class="method">
65<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">
66<tt class="descname">calculate_slit_length</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length" title="Permalink to this definition">¶</a></dt>
67<dd>Calculate slit length.</dd></dl>
68
69<dl class="method">
70<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">
71<tt class="descname">get_slit_length_unit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit" title="Permalink to this definition">¶</a></dt>
72<dd>return the slit length unit.</dd></dl>
73
74<dl class="method">
75<dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data">
76<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>
77<dd>set data
78:param x, y: x array and y array</dd></dl>
79
80</dd></dl>
81
82</div>
83</div>
84
85
86          </div>
87        </div>
88      </div>
89      <div class="sphinxsidebar">
90        <div class="sphinxsidebarwrapper">
91  <h3><a href="../index.html">Table Of Contents</a></h3>
92  <ul>
93<li><a class="reference internal" href="#">Slit Length Calculator</a><ul>
94<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>
95</ul>
96</li>
97</ul>
98
99  <h4>Previous topic</h4>
100  <p class="topless"><a href="sld_calculator.html"
101                        title="previous chapter">Sld Calculator</a></p>
102  <h3>This Page</h3>
103  <ul class="this-page-menu">
104    <li><a href="../_sources/api/slit_length_calculator.txt"
105           rel="nofollow">Show Source</a></li>
106  </ul>
107<div id="searchbox" style="display: none">
108  <h3>Quick search</h3>
109    <form class="search" action="../search.html" method="get">
110      <input type="text" name="q" size="18" />
111      <input type="submit" value="Go" />
112      <input type="hidden" name="check_keywords" value="yes" />
113      <input type="hidden" name="area" value="default" />
114    </form>
115    <p class="searchtip" style="font-size: 90%">
116    Enter search terms or a module, class or function name.
117    </p>
118</div>
119<script type="text/javascript">$('#searchbox').show(0);</script>
120        </div>
121      </div>
122      <div class="clearer"></div>
123    </div>
124    <div class="related">
125      <h3>Navigation</h3>
126      <ul>
127        <li class="right" style="margin-right: 10px">
128          <a href="../genindex.html" title="General Index"
129             >index</a></li>
130        <li class="right" >
131          <a href="../py-modindex.html" title="Python Module Index"
132             >modules</a> |</li>
133        <li class="right" >
134          <a href="sld_calculator.html" title="Sld Calculator"
135             >previous</a> |</li>
136        <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li>
137          <li><a href="index.html" >Reference</a> &raquo;</li> 
138      </ul>
139    </div>
140    <div class="footer">
141        &copy; Copyright 2010, Gervaise Alina.
142      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
143    </div>
144  </body>
145</html>
Note: See TracBrowser for help on using the repository browser.