source: sasview/sansinvariant/docs/sphinx/_build/html/api/invariant_mapper.html @ 73088f5

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 73088f5 was 1679f2f, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

new html files for sphinx docs
  • Property mode set to 100644
File size: 7.5 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>invariant_mapper &mdash; invariant 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="invariant v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="prev" title="invariant" href="invariant.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="invariant.html" title="invariant"
41             accesskey="P">previous</a> |</li>
42        <li><a href="../index.html">invariant 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="invariant-mapper">
53<h1>invariant_mapper<a class="headerlink" href="#invariant-mapper" title="Permalink to this headline">¶</a></h1>
54<div class="section" id="module-sans.invariant.invariant_mapper">
55<span id="sans-invariant-invariant-mapper"></span><h2><a class="reference internal" href="#module-sans.invariant.invariant_mapper" title="sans.invariant.invariant_mapper"><tt class="xref py py-mod docutils literal"><span class="pre">sans.invariant.invariant_mapper</span></tt></a><a class="headerlink" href="#module-sans.invariant.invariant_mapper" title="Permalink to this headline">¶</a></h2>
56<p>This module is a wrapper to a map function. It allows to loop through
57different invariant objects to call the same function</p>
58<dl class="function">
59<dt id="sans.invariant.invariant_mapper.get_qstar">
60<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_qstar</tt><big>(</big><em>inv</em>, <em>extrapolation=None</em><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_qstar" title="Permalink to this definition">¶</a></dt>
61<dd><p>Get invariant value (Q*)</p>
62</dd></dl>
63
64<dl class="function">
65<dt id="sans.invariant.invariant_mapper.get_qstar_with_error">
66<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_qstar_with_error</tt><big>(</big><em>inv</em>, <em>extrapolation=None</em><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_qstar_with_error" title="Permalink to this definition">¶</a></dt>
67<dd><p>Get invariant value with uncertainty</p>
68</dd></dl>
69
70<dl class="function">
71<dt id="sans.invariant.invariant_mapper.get_surface">
72<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_surface</tt><big>(</big><em>inv</em>, <em>contrast</em>, <em>porod_const</em>, <em>extrapolation=None</em><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_surface" title="Permalink to this definition">¶</a></dt>
73<dd><p>Get surface with uncertainty</p>
74</dd></dl>
75
76<dl class="function">
77<dt id="sans.invariant.invariant_mapper.get_surface_with_error">
78<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_surface_with_error</tt><big>(</big><em>inv</em>, <em>contrast</em>, <em>porod_const</em>, <em>extrapolation=None</em><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_surface_with_error" title="Permalink to this definition">¶</a></dt>
79<dd><p>Get surface with uncertainty</p>
80</dd></dl>
81
82<dl class="function">
83<dt id="sans.invariant.invariant_mapper.get_volume_fraction">
84<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_volume_fraction</tt><big>(</big><em>inv</em>, <em>contrast</em>, <em>extrapolation=None</em><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_volume_fraction" title="Permalink to this definition">¶</a></dt>
85<dd><p>Get volume fraction</p>
86</dd></dl>
87
88<dl class="function">
89<dt id="sans.invariant.invariant_mapper.get_volume_fraction_with_error">
90<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_volume_fraction_with_error</tt><big>(</big><em>inv</em>, <em>contrast</em>, <em>extrapolation=None</em><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_volume_fraction_with_error" title="Permalink to this definition">¶</a></dt>
91<dd><p>Get volume fraction with uncertainty</p>
92</dd></dl>
93
94</div>
95</div>
96
97
98          </div>
99        </div>
100      </div>
101      <div class="sphinxsidebar">
102        <div class="sphinxsidebarwrapper">
103  <h3><a href="../index.html">Table Of Contents</a></h3>
104  <ul>
105<li><a class="reference internal" href="#">invariant_mapper</a><ul>
106<li><a class="reference internal" href="#module-sans.invariant.invariant_mapper"><tt class="docutils literal"><span class="pre">sans.invariant.invariant_mapper</span></tt></a></li>
107</ul>
108</li>
109</ul>
110
111  <h4>Previous topic</h4>
112  <p class="topless"><a href="invariant.html"
113                        title="previous chapter">invariant</a></p>
114  <h3>This Page</h3>
115  <ul class="this-page-menu">
116    <li><a href="../_sources/api/invariant_mapper.txt"
117           rel="nofollow">Show Source</a></li>
118  </ul>
119<div id="searchbox" style="display: none">
120  <h3>Quick search</h3>
121    <form class="search" action="../search.html" method="get">
122      <input type="text" name="q" size="18" />
123      <input type="submit" value="Go" />
124      <input type="hidden" name="check_keywords" value="yes" />
125      <input type="hidden" name="area" value="default" />
126    </form>
127    <p class="searchtip" style="font-size: 90%">
128    Enter search terms or a module, class or function name.
129    </p>
130</div>
131<script type="text/javascript">$('#searchbox').show(0);</script>
132        </div>
133      </div>
134      <div class="clearer"></div>
135    </div>
136    <div class="related">
137      <h3>Navigation</h3>
138      <ul>
139        <li class="right" style="margin-right: 10px">
140          <a href="../genindex.html" title="General Index"
141             >index</a></li>
142        <li class="right" >
143          <a href="../py-modindex.html" title="Python Module Index"
144             >modules</a> |</li>
145        <li class="right" >
146          <a href="invariant.html" title="invariant"
147             >previous</a> |</li>
148        <li><a href="../index.html">invariant v0.1.0 documentation</a> &raquo;</li>
149          <li><a href="index.html" >Reference</a> &raquo;</li> 
150      </ul>
151    </div>
152    <div class="footer">
153        &copy; Copyright 2010, sans group.
154      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
155    </div>
156  </body>
157</html>
Note: See TracBrowser for help on using the repository browser.