source: sasview/_modules/sas/calculator/kiessig_calculator.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 9.5 KB
Line 
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.calculator.kiessig_calculator &mdash; 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> &raquo;</li>
41          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</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.calculator.kiessig_calculator</h1><div class="highlight"><pre>
51<span class="sd">&quot;&quot;&quot;</span>
52<span class="sd">This module is a small tool to allow user to quickly</span>
53<span class="sd">determine the size value in real space  from the</span>
54<span class="sd">fringe width in q space.</span>
55<span class="sd">&quot;&quot;&quot;</span>
56<span class="kn">from</span> <span class="nn">math</span> <span class="kn">import</span> <span class="n">pi</span><span class="p">,</span> <span class="n">fabs</span>
57<span class="n">_DQ_DEFAULT</span> <span class="o">=</span> <span class="mf">0.05</span>
58
59
60<div class="viewcode-block" id="KiessigThicknessCalculator"><a class="viewcode-back" href="../../../dev/api/sas.calculator.html#sas.calculator.kiessig_calculator.KiessigThicknessCalculator">[docs]</a><span class="k">class</span> <span class="nc">KiessigThicknessCalculator</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
61    <span class="sd">&quot;&quot;&quot;</span>
62<span class="sd">    compute thickness from the fringe width of data</span>
63<span class="sd">    &quot;&quot;&quot;</span>
64    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
65       
66        <span class="c"># dq value</span>
67        <span class="bp">self</span><span class="o">.</span><span class="n">deltaq</span> <span class="o">=</span> <span class="n">_DQ_DEFAULT</span>
68        <span class="c"># thickenss value</span>
69        <span class="bp">self</span><span class="o">.</span><span class="n">thickness</span> <span class="o">=</span> <span class="bp">None</span>
70        <span class="c"># unit of the thickness</span>
71        <span class="bp">self</span><span class="o">.</span><span class="n">thickness_unit</span> <span class="o">=</span> <span class="s">&#39;A&#39;</span>
72       
73<div class="viewcode-block" id="KiessigThicknessCalculator.set_deltaq"><a class="viewcode-back" href="../../../dev/api/sas.calculator.html#sas.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq">[docs]</a>    <span class="k">def</span> <span class="nf">set_deltaq</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dq</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
74        <span class="sd">&quot;&quot;&quot;</span>
75<span class="sd">        Receive deltaQ value</span>
76<span class="sd">        </span>
77<span class="sd">        :param dq: q fringe width in 1/A unit</span>
78<span class="sd">        &quot;&quot;&quot;</span>
79        <span class="c"># set dq</span>
80        <span class="bp">self</span><span class="o">.</span><span class="n">deltaq</span> <span class="o">=</span> <span class="n">dq</span>
81        </div>
82<div class="viewcode-block" id="KiessigThicknessCalculator.get_deltaq"><a class="viewcode-back" href="../../../dev/api/sas.calculator.html#sas.calculator.kiessig_calculator.KiessigThicknessCalculator.get_deltaq">[docs]</a>    <span class="k">def</span> <span class="nf">get_deltaq</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
83        <span class="sd">&quot;&quot;&quot;</span>
84<span class="sd">        return deltaQ value in 1/A unit</span>
85<span class="sd">        &quot;&quot;&quot;</span>
86        <span class="c"># return dq</span>
87        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">deltaq</span>
88</div>
89<div class="viewcode-block" id="KiessigThicknessCalculator.compute_thickness"><a class="viewcode-back" href="../../../dev/api/sas.calculator.html#sas.calculator.kiessig_calculator.KiessigThicknessCalculator.compute_thickness">[docs]</a>    <span class="k">def</span> <span class="nf">compute_thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
90        <span class="sd">&quot;&quot;&quot;</span>
91<span class="sd">        Calculate thickness.</span>
92<span class="sd">        </span>
93<span class="sd">        :return: the thickness.</span>
94<span class="sd">        &quot;&quot;&quot;</span>
95        <span class="c"># check if it is float</span>
96        <span class="k">try</span><span class="p">:</span>
97            <span class="n">dq</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">deltaq</span><span class="p">)</span>
98        <span class="k">except</span><span class="p">:</span>
99            <span class="k">return</span> <span class="bp">None</span>
100        <span class="c"># check if delta_q is zero</span>
101        <span class="k">if</span> <span class="n">dq</span> <span class="o">==</span> <span class="mf">0.0</span> <span class="ow">or</span> <span class="n">dq</span> <span class="o">==</span> <span class="bp">None</span><span class="p">:</span>
102            <span class="k">return</span> <span class="bp">None</span>
103        <span class="k">else</span><span class="p">:</span>
104            <span class="c"># calculate thickness</span>
105            <span class="n">thickness</span> <span class="o">=</span> <span class="mi">2</span><span class="o">*</span><span class="n">pi</span><span class="o">/</span><span class="n">fabs</span><span class="p">(</span><span class="n">dq</span><span class="p">)</span>
106            <span class="c"># return thickness value</span>
107            <span class="k">return</span> <span class="n">thickness</span>
108  </div>
109<div class="viewcode-block" id="KiessigThicknessCalculator.get_thickness_unit"><a class="viewcode-back" href="../../../dev/api/sas.calculator.html#sas.calculator.kiessig_calculator.KiessigThicknessCalculator.get_thickness_unit">[docs]</a>    <span class="k">def</span> <span class="nf">get_thickness_unit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
110        <span class="sd">&quot;&quot;&quot;</span>
111<span class="sd">        :return: the thickness unit.</span>
112<span class="sd">        &quot;&quot;&quot;</span>
113        <span class="c"># unit of thickness</span>
114        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">thickness_unit</span></div></div>
115</pre></div>
116
117          </div>
118        </div>
119      </div>
120      <div class="sphinxsidebar">
121        <div class="sphinxsidebarwrapper">
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><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
149          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
150      </ul>
151    </div>
152    <div class="footer">
153        &copy; Copyright 2013, The SasView Project.
154      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
155    </div>
156  </body>
157</html>
Note: See TracBrowser for help on using the repository browser.