[a462c6a] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 3 | |
---|
| 4 | |
---|
| 5 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 6 | <head> |
---|
| 7 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 8 | |
---|
| 9 | <title>sas.invariant.invariant_mapper — SasView 3.0.0 documentation</title> |
---|
| 10 | |
---|
| 11 | <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> |
---|
| 12 | <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
---|
| 13 | |
---|
| 14 | <script type="text/javascript"> |
---|
| 15 | var DOCUMENTATION_OPTIONS = { |
---|
| 16 | URL_ROOT: '../../../', |
---|
| 17 | VERSION: '3.0.0', |
---|
| 18 | COLLAPSE_INDEX: false, |
---|
| 19 | FILE_SUFFIX: '.html', |
---|
| 20 | HAS_SOURCE: true |
---|
| 21 | }; |
---|
| 22 | </script> |
---|
| 23 | <script type="text/javascript" src="../../../_static/jquery.js"></script> |
---|
| 24 | <script type="text/javascript" src="../../../_static/underscore.js"></script> |
---|
| 25 | <script type="text/javascript" src="../../../_static/doctools.js"></script> |
---|
| 26 | <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
| 27 | <link rel="top" title="SasView 3.0.0 documentation" href="../../../index.html" /> |
---|
| 28 | <link rel="up" title="Module code" href="../../index.html" /> |
---|
| 29 | </head> |
---|
| 30 | <body> |
---|
| 31 | <div class="related"> |
---|
| 32 | <h3>Navigation</h3> |
---|
| 33 | <ul> |
---|
| 34 | <li class="right" style="margin-right: 10px"> |
---|
| 35 | <a href="../../../genindex.html" title="General Index" |
---|
| 36 | accesskey="I">index</a></li> |
---|
| 37 | <li class="right" > |
---|
| 38 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 39 | >modules</a> |</li> |
---|
| 40 | <li><a href="../../../index.html">SasView 3.0.0 documentation</a> »</li> |
---|
| 41 | <li><a href="../../index.html" accesskey="U">Module code</a> »</li> |
---|
| 42 | </ul> |
---|
| 43 | </div> |
---|
| 44 | |
---|
| 45 | <div class="document"> |
---|
| 46 | <div class="documentwrapper"> |
---|
| 47 | <div class="bodywrapper"> |
---|
| 48 | <div class="body"> |
---|
| 49 | |
---|
| 50 | <h1>Source code for sas.invariant.invariant_mapper</h1><div class="highlight"><pre> |
---|
| 51 | <span class="sd">"""</span> |
---|
| 52 | <span class="sd">This module is a wrapper to a map function. It allows to loop through </span> |
---|
| 53 | <span class="sd">different invariant objects to call the same function</span> |
---|
| 54 | <span class="sd">"""</span> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | <div class="viewcode-block" id="get_qstar"><a class="viewcode-back" href="../../../dev/api/sas.invariant.html#sas.invariant.invariant_mapper.get_qstar">[docs]</a><span class="k">def</span> <span class="nf">get_qstar</span><span class="p">(</span><span class="n">inv</span><span class="p">,</span> <span class="n">extrapolation</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> |
---|
| 58 | <span class="sd">"""</span> |
---|
| 59 | <span class="sd"> Get invariant value (Q*)</span> |
---|
| 60 | <span class="sd"> """</span> |
---|
| 61 | <span class="k">return</span> <span class="n">inv</span><span class="o">.</span><span class="n">get_qstar</span><span class="p">(</span><span class="n">extrapolation</span><span class="p">)</span> |
---|
| 62 | </div> |
---|
| 63 | <div class="viewcode-block" id="get_qstar_with_error"><a class="viewcode-back" href="../../../dev/api/sas.invariant.html#sas.invariant.invariant_mapper.get_qstar_with_error">[docs]</a><span class="k">def</span> <span class="nf">get_qstar_with_error</span><span class="p">(</span><span class="n">inv</span><span class="p">,</span> <span class="n">extrapolation</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> |
---|
| 64 | <span class="sd">"""</span> |
---|
| 65 | <span class="sd"> Get invariant value with uncertainty</span> |
---|
| 66 | <span class="sd"> """</span> |
---|
| 67 | <span class="k">return</span> <span class="n">inv</span><span class="o">.</span><span class="n">get_qstar_with_error</span><span class="p">(</span><span class="n">extrapolation</span><span class="p">)</span> |
---|
| 68 | </div> |
---|
| 69 | <div class="viewcode-block" id="get_volume_fraction"><a class="viewcode-back" href="../../../dev/api/sas.invariant.html#sas.invariant.invariant_mapper.get_volume_fraction">[docs]</a><span class="k">def</span> <span class="nf">get_volume_fraction</span><span class="p">(</span><span class="n">inv</span><span class="p">,</span> <span class="n">contrast</span><span class="p">,</span> <span class="n">extrapolation</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> |
---|
| 70 | <span class="sd">"""</span> |
---|
| 71 | <span class="sd"> Get volume fraction</span> |
---|
| 72 | <span class="sd"> """</span> |
---|
| 73 | <span class="k">return</span> <span class="n">inv</span><span class="o">.</span><span class="n">get_volume_fraction</span><span class="p">(</span><span class="n">contrast</span><span class="p">,</span> <span class="n">extrapolation</span><span class="p">)</span> |
---|
| 74 | </div> |
---|
| 75 | <div class="viewcode-block" id="get_volume_fraction_with_error"><a class="viewcode-back" href="../../../dev/api/sas.invariant.html#sas.invariant.invariant_mapper.get_volume_fraction_with_error">[docs]</a><span class="k">def</span> <span class="nf">get_volume_fraction_with_error</span><span class="p">(</span><span class="n">inv</span><span class="p">,</span> <span class="n">contrast</span><span class="p">,</span> <span class="n">extrapolation</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> |
---|
| 76 | <span class="sd">"""</span> |
---|
| 77 | <span class="sd"> Get volume fraction with uncertainty</span> |
---|
| 78 | <span class="sd"> """</span> |
---|
| 79 | <span class="k">return</span> <span class="n">inv</span><span class="o">.</span><span class="n">get_volume_fraction_with_error</span><span class="p">(</span><span class="n">contrast</span><span class="p">,</span> |
---|
| 80 | <span class="n">extrapolation</span><span class="p">)</span> |
---|
| 81 | </div> |
---|
| 82 | <div class="viewcode-block" id="get_surface"><a class="viewcode-back" href="../../../dev/api/sas.invariant.html#sas.invariant.invariant_mapper.get_surface">[docs]</a><span class="k">def</span> <span class="nf">get_surface</span><span class="p">(</span><span class="n">inv</span><span class="p">,</span> <span class="n">contrast</span><span class="p">,</span> <span class="n">porod_const</span><span class="p">,</span> <span class="n">extrapolation</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> |
---|
| 83 | <span class="sd">"""</span> |
---|
| 84 | <span class="sd"> Get surface with uncertainty</span> |
---|
| 85 | <span class="sd"> """</span> |
---|
| 86 | <span class="k">return</span> <span class="n">inv</span><span class="o">.</span><span class="n">get_surface</span><span class="p">(</span><span class="n">contrast</span><span class="o">=</span><span class="n">contrast</span><span class="p">,</span> |
---|
| 87 | <span class="n">porod_const</span><span class="o">=</span><span class="n">porod_const</span><span class="p">,</span> |
---|
| 88 | <span class="n">extrapolation</span><span class="o">=</span><span class="n">extrapolation</span><span class="p">)</span> |
---|
| 89 | </div> |
---|
| 90 | <div class="viewcode-block" id="get_surface_with_error"><a class="viewcode-back" href="../../../dev/api/sas.invariant.html#sas.invariant.invariant_mapper.get_surface_with_error">[docs]</a><span class="k">def</span> <span class="nf">get_surface_with_error</span><span class="p">(</span><span class="n">inv</span><span class="p">,</span> <span class="n">contrast</span><span class="p">,</span> |
---|
| 91 | <span class="n">porod_const</span><span class="p">,</span> <span class="n">extrapolation</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> |
---|
| 92 | <span class="sd">"""</span> |
---|
| 93 | <span class="sd"> Get surface with uncertainty</span> |
---|
| 94 | <span class="sd"> """</span> |
---|
| 95 | <span class="k">return</span> <span class="n">inv</span><span class="o">.</span><span class="n">get_surface_with_error</span><span class="p">(</span><span class="n">contrast</span><span class="o">=</span><span class="n">contrast</span><span class="p">,</span> |
---|
| 96 | <span class="n">porod_const</span><span class="o">=</span><span class="n">porod_const</span><span class="p">,</span> |
---|
| 97 | <span class="n">extrapolation</span><span class="o">=</span><span class="n">extrapolation</span><span class="p">)</span> |
---|
| 98 | </pre></div></div> |
---|
| 99 | |
---|
| 100 | </div> |
---|
| 101 | </div> |
---|
| 102 | </div> |
---|
| 103 | <div class="sphinxsidebar"> |
---|
| 104 | <div class="sphinxsidebarwrapper"> |
---|
| 105 | <div id="searchbox" style="display: none"> |
---|
| 106 | <h3>Quick search</h3> |
---|
| 107 | <form class="search" action="../../../search.html" method="get"> |
---|
| 108 | <input type="text" name="q" /> |
---|
| 109 | <input type="submit" value="Go" /> |
---|
| 110 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 111 | <input type="hidden" name="area" value="default" /> |
---|
| 112 | </form> |
---|
| 113 | <p class="searchtip" style="font-size: 90%"> |
---|
| 114 | Enter search terms or a module, class or function name. |
---|
| 115 | </p> |
---|
| 116 | </div> |
---|
| 117 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 118 | </div> |
---|
| 119 | </div> |
---|
| 120 | <div class="clearer"></div> |
---|
| 121 | </div> |
---|
| 122 | <div class="related"> |
---|
| 123 | <h3>Navigation</h3> |
---|
| 124 | <ul> |
---|
| 125 | <li class="right" style="margin-right: 10px"> |
---|
| 126 | <a href="../../../genindex.html" title="General Index" |
---|
| 127 | >index</a></li> |
---|
| 128 | <li class="right" > |
---|
| 129 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 130 | >modules</a> |</li> |
---|
| 131 | <li><a href="../../../index.html">SasView 3.0.0 documentation</a> »</li> |
---|
| 132 | <li><a href="../../index.html" >Module code</a> »</li> |
---|
| 133 | </ul> |
---|
| 134 | </div> |
---|
| 135 | <div class="footer"> |
---|
| 136 | © Copyright 2013, The SasView Project. |
---|
| 137 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. |
---|
| 138 | </div> |
---|
| 139 | </body> |
---|
| 140 | </html> |
---|