source: sasview/sansinvariant/docs/sphinx/html/api/invariant_mapper.html @ 37d58372

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 37d58372 was 67cd7c0, checked in by Gervaise Alina <gervyh@…>, 13 years ago

add invariant docs
  • Property mode set to 100644
File size: 7.1 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>invariant_mapper &mdash; invariant 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="invariant 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="prev" title="invariant" href="invariant.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="invariant.html" title="invariant"
44             accesskey="P">previous</a> |</li>
45        <li><a href="../index.html">invariant 0.1.0 documentation</a> &raquo;</li>
46          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
47      </ul>
48    </div> 
49
50    <div class="document">
51      <div class="documentwrapper">
52        <div class="bodywrapper">
53          <div class="body">
54           
55  <div class="section" id="invariant-mapper">
56<h1>invariant_mapper<a class="headerlink" href="#invariant-mapper" title="Permalink to this headline">¶</a></h1>
57<div class="section" id="sans-invariant-invariant-mapper">
58<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="#sans-invariant-invariant-mapper" title="Permalink to this headline">¶</a></h2>
59<span class="target" id="module-sans.invariant.invariant_mapper"></span><p>This module is a wrapper to a map function. It allows to loop through
60different invariant objects to call the same function</p>
61<dl class="function">
62<dt id="sans.invariant.invariant_mapper.get_qstar">
63<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_qstar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_qstar" title="Permalink to this definition">¶</a></dt>
64<dd><p>Get invariant value (Q*)</p>
65</dd></dl>
66
67<dl class="function">
68<dt id="sans.invariant.invariant_mapper.get_qstar_with_error">
69<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_qstar_with_error</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_qstar_with_error" title="Permalink to this definition">¶</a></dt>
70<dd><p>Get invariant value with uncertainty</p>
71</dd></dl>
72
73<dl class="function">
74<dt id="sans.invariant.invariant_mapper.get_surface">
75<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_surface</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_surface" title="Permalink to this definition">¶</a></dt>
76<dd><p>Get surface with uncertainty</p>
77</dd></dl>
78
79<dl class="function">
80<dt id="sans.invariant.invariant_mapper.get_surface_with_error">
81<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_surface_with_error</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_surface_with_error" title="Permalink to this definition">¶</a></dt>
82<dd><p>Get surface with uncertainty</p>
83</dd></dl>
84
85<dl class="function">
86<dt id="sans.invariant.invariant_mapper.get_volume_fraction">
87<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_volume_fraction</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_volume_fraction" title="Permalink to this definition">¶</a></dt>
88<dd><p>Get volume fraction</p>
89</dd></dl>
90
91<dl class="function">
92<dt id="sans.invariant.invariant_mapper.get_volume_fraction_with_error">
93<tt class="descclassname">sans.invariant.invariant_mapper.</tt><tt class="descname">get_volume_fraction_with_error</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.invariant.invariant_mapper.get_volume_fraction_with_error" title="Permalink to this definition">¶</a></dt>
94<dd><p>Get volume fraction with uncertainty</p>
95</dd></dl>
96
97</div>
98</div>
99
100
101          </div>
102        </div>
103      </div>
104      <div class="sphinxsidebar">
105        <div class="sphinxsidebarwrapper">
106  <h3><a href="../index.html">Table Of Contents</a></h3>
107  <ul>
108<li><a class="reference internal" href="#">invariant_mapper</a><ul>
109<li><a class="reference internal" href="#sans-invariant-invariant-mapper"><tt class="docutils literal"><span class="pre">sans.invariant.invariant_mapper</span></tt></a></li>
110</ul>
111</li>
112</ul>
113
114  <h4>Previous topic</h4>
115  <p class="topless"><a href="invariant.html"
116                        title="previous chapter">invariant</a></p>
117  <h3>This Page</h3>
118  <ul class="this-page-menu">
119    <li><a href="../_sources/api/invariant_mapper.txt"
120           rel="nofollow">Show Source</a></li>
121  </ul>
122<div id="searchbox" style="display: none">
123  <h3>Quick search</h3>
124    <form class="search" action="../search.html" method="get">
125      <input type="text" name="q" />
126      <input type="submit" value="Go" />
127      <input type="hidden" name="check_keywords" value="yes" />
128      <input type="hidden" name="area" value="default" />
129    </form>
130    <p class="searchtip" style="font-size: 90%">
131    Enter search terms or a module, class or function name.
132    </p>
133</div>
134<script type="text/javascript">$('#searchbox').show(0);</script>
135        </div>
136      </div>
137      <div class="clearer"></div>
138    </div>
139    <div class="related">
140      <h3>Navigation</h3>
141      <ul>
142        <li class="right" style="margin-right: 10px">
143          <a href="../genindex.html" title="General Index"
144             >index</a></li>
145        <li class="right" >
146          <a href="../py-modindex.html" title="Python Module Index"
147             >modules</a> |</li>
148        <li class="right" >
149          <a href="invariant.html" title="invariant"
150             >previous</a> |</li>
151        <li><a href="../index.html">invariant 0.1.0 documentation</a> &raquo;</li>
152          <li><a href="index.html" >Reference</a> &raquo;</li> 
153      </ul>
154    </div>
155    <div class="footer">
156        &copy; Copyright 2010, sans group.
157      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
158    </div>
159  </body>
160</html>
Note: See TracBrowser for help on using the repository browser.