Changeset a4f04f2 in sasview for sanscalculator/docs/sphinx/html/api
- Timestamp:
- Oct 24, 2011 11:50:18 AM (13 years ago)
- Branches:
- master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- 7247844
- Parents:
- 8884996
- Location:
- sanscalculator/docs/sphinx/html/api
- Files:
-
- 5 edited
-
index.html (modified) (8 diffs)
-
instrument.html (modified) (43 diffs)
-
kiessig_calculator.html (modified) (15 diffs)
-
resolution_calculator.html (modified) (34 diffs)
-
slit_length_calculator.html (modified) (14 diffs)
Legend:
- Unmodified
- Added
- Removed
-
sanscalculator/docs/sphinx/html/api/index.html
r771fe98 ra4f04f2 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> 7 8 <head> 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>Reference — calculator v0.1.0 documentation</title> 11 <title>Reference — calculator 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <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="next" title=" Instrument" href="instrument.html" />28 <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" /> 29 <link rel="next" title="instrument" href="instrument.html" /> 27 30 <link rel="prev" title="Calculator" href="../index.html" /> 28 31 </head> … … 38 41 >modules</a> |</li> 39 42 <li class="right" > 40 <a href="instrument.html" title=" Instrument"43 <a href="instrument.html" title="instrument" 41 44 accesskey="N">next</a> |</li> 42 45 <li class="right" > 43 46 <a href="../index.html" title="Calculator" 44 47 accesskey="P">previous</a> |</li> 45 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>48 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 46 49 </ul> 47 50 </div> … … 58 61 <col class="field-body" /> 59 62 <tbody valign="top"> 60 <tr class="field "><th class="field-name">Release:</th><td class="field-body">0.1</td>63 <tr class="field-odd field"><th class="field-name">Release:</th><td class="field-body">0.1</td> 61 64 </tr> 62 <tr class="field "><th class="field-name">Date:</th><td class="field-body">August 12, 2011</td>65 <tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">October 24, 2011</td> 63 66 </tr> 64 67 </tbody> … … 66 69 <div class="toctree-wrapper compound"> 67 70 <ul> 68 <li class="toctree-l1"><a class="reference internal" href="instrument.html"> Instrument</a><ul>69 <li class="toctree-l2"><a class="reference internal" href="instrument.html# module-sans.calculator.instrument"><tt class="docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a></li>71 <li class="toctree-l1"><a class="reference internal" href="instrument.html">instrument</a><ul> 72 <li class="toctree-l2"><a class="reference internal" href="instrument.html#sans-calculator-instrument"><tt class="docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a></li> 70 73 </ul> 71 74 </li> 72 <li class="toctree-l1"><a class="reference internal" href=" slit_length_calculator.html">Slit Length Calculator</a><ul>73 <li class="toctree-l2"><a class="reference internal" href=" slit_length_calculator.html#module-sans.calculator.slit_length_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li>75 <li class="toctree-l1"><a class="reference internal" href="kiessig_calculator.html">kiessig_calculator</a><ul> 76 <li class="toctree-l2"><a class="reference internal" href="kiessig_calculator.html#sans-calculator-kiessig-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li> 74 77 </ul> 75 78 </li> 76 <li class="toctree-l1"><a class="reference internal" href=" kiessig_calculator.html">Kiessig Calculator</a><ul>77 <li class="toctree-l2"><a class="reference internal" href=" kiessig_calculator.html#module-sans.calculator.kiessig_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li>79 <li class="toctree-l1"><a class="reference internal" href="resolution_calculator.html">resolution_calculator</a><ul> 80 <li class="toctree-l2"><a class="reference internal" href="resolution_calculator.html#sans-calculator-resolution-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a></li> 78 81 </ul> 79 82 </li> 80 <li class="toctree-l1"><a class="reference internal" href=" resolution_calculator.html">Resolution Calculator</a><ul>81 <li class="toctree-l2"><a class="reference internal" href=" resolution_calculator.html#module-sans.calculator.resolution_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a></li>83 <li class="toctree-l1"><a class="reference internal" href="slit_length_calculator.html">slit_length_calculator</a><ul> 84 <li class="toctree-l2"><a class="reference internal" href="slit_length_calculator.html#sans-calculator-slit-length-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li> 82 85 </ul> 83 86 </li> … … 97 100 <h4>Next topic</h4> 98 101 <p class="topless"><a href="instrument.html" 99 title="next chapter"> Instrument</a></p>102 title="next chapter">instrument</a></p> 100 103 <h3>This Page</h3> 101 104 <ul class="this-page-menu"> … … 106 109 <h3>Quick search</h3> 107 110 <form class="search" action="../search.html" method="get"> 108 <input type="text" name="q" size="18"/>111 <input type="text" name="q" /> 109 112 <input type="submit" value="Go" /> 110 113 <input type="hidden" name="check_keywords" value="yes" /> … … 130 133 >modules</a> |</li> 131 134 <li class="right" > 132 <a href="instrument.html" title=" Instrument"135 <a href="instrument.html" title="instrument" 133 136 >next</a> |</li> 134 137 <li class="right" > 135 138 <a href="../index.html" title="Calculator" 136 139 >previous</a> |</li> 137 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>140 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 138 141 </ul> 139 142 </div> 140 143 <div class="footer"> 141 144 © Copyright 2010, Gervaise Alina. 142 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.145 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 143 146 </div> 144 147 </body> -
sanscalculator/docs/sphinx/html/api/instrument.html
r771fe98 ra4f04f2 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>Instrument — calculator v0.1.0 documentation</title> 11 <title>instrument — calculator 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 <link rel="next" title=" Slit Length Calculator" href="slit_length_calculator.html" />30 <link rel="next" title="kiessig_calculator" href="kiessig_calculator.html" /> 28 31 <link rel="prev" title="Reference" href="index.html" /> 29 32 </head> … … 39 42 >modules</a> |</li> 40 43 <li class="right" > 41 <a href=" slit_length_calculator.html" title="Slit Length Calculator"44 <a href="kiessig_calculator.html" title="kiessig_calculator" 42 45 accesskey="N">next</a> |</li> 43 46 <li class="right" > 44 47 <a href="index.html" title="Reference" 45 48 accesskey="P">previous</a> |</li> 46 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>49 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 47 50 <li><a href="index.html" accesskey="U">Reference</a> »</li> 48 51 </ul> … … 55 58 56 59 <div class="section" id="instrument"> 57 <h1> Instrument<a class="headerlink" href="#instrument" title="Permalink to this headline">¶</a></h1>58 <div class="section" id=" module-sans.calculator.instrument">59 < span id="sans-calculator-instrument"></span><h2><a class="reference internal" href="#module-sans.calculator.instrument" title="sans.calculator.instrument"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a><a class="headerlink" href="#module-sans.calculator.instrument" title="Permalink to this headline">¶</a></h2>60 < p>This module is a small tool to allow user to60 <h1>instrument<a class="headerlink" href="#instrument" title="Permalink to this headline">¶</a></h1> 61 <div class="section" id="sans-calculator-instrument"> 62 <h2><a class="reference internal" href="#module-sans.calculator.instrument" title="sans.calculator.instrument"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a><a class="headerlink" href="#sans-calculator-instrument" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.calculator.instrument"></span><p>This module is a small tool to allow user to 61 64 control instrumental parameters</p> 62 65 <dl class="class"> … … 65 68 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 66 69 <p>An object class that defines the aperture variables</p> 70 <dl class="attribute"> 71 <dt id="sans.calculator.instrument.Aperture.__class__"> 72 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__class__" title="Permalink to this definition">¶</a></dt> 73 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 74 </dd></dl> 75 76 <dl class="attribute"> 77 <dt id="sans.calculator.instrument.Aperture.__delattr__"> 78 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__delattr__" title="Permalink to this definition">¶</a></dt> 79 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 80 </dd></dl> 81 82 <dl class="attribute"> 83 <dt id="sans.calculator.instrument.Aperture.__dict__"> 84 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01A48250></em><a class="headerlink" href="#sans.calculator.instrument.Aperture.__dict__" title="Permalink to this definition">¶</a></dt> 85 <dd></dd></dl> 86 87 <dl class="attribute"> 88 <dt id="sans.calculator.instrument.Aperture.__getattribute__"> 89 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__getattribute__" title="Permalink to this definition">¶</a></dt> 90 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 91 </dd></dl> 92 93 <dl class="attribute"> 94 <dt id="sans.calculator.instrument.Aperture.__hash__"> 95 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__hash__" title="Permalink to this definition">¶</a></dt> 96 <dd><p>x.__hash__() <==> hash(x)</p> 97 </dd></dl> 98 99 <dl class="method"> 100 <dt id="sans.calculator.instrument.Aperture.__init__"> 101 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.__init__" title="Permalink to this definition">¶</a></dt> 102 <dd></dd></dl> 103 104 <dl class="attribute"> 105 <dt id="sans.calculator.instrument.Aperture.__module__"> 106 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Aperture.__module__" title="Permalink to this definition">¶</a></dt> 107 <dd></dd></dl> 108 109 <dl class="staticmethod"> 110 <dt id="sans.calculator.instrument.Aperture.__new__"> 111 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Aperture.__new__" title="Permalink to this definition">¶</a></dt> 112 <dd></dd></dl> 113 114 <dl class="method"> 115 <dt id="sans.calculator.instrument.Aperture.__reduce__"> 116 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.__reduce__" title="Permalink to this definition">¶</a></dt> 117 <dd><p>helper for pickle</p> 118 </dd></dl> 119 120 <dl class="method"> 121 <dt id="sans.calculator.instrument.Aperture.__reduce_ex__"> 122 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 123 <dd><p>helper for pickle</p> 124 </dd></dl> 125 126 <dl class="attribute"> 127 <dt id="sans.calculator.instrument.Aperture.__repr__"> 128 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__repr__" title="Permalink to this definition">¶</a></dt> 129 <dd><p>x.__repr__() <==> repr(x)</p> 130 </dd></dl> 131 132 <dl class="attribute"> 133 <dt id="sans.calculator.instrument.Aperture.__setattr__"> 134 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__setattr__" title="Permalink to this definition">¶</a></dt> 135 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 136 </dd></dl> 137 138 <dl class="attribute"> 139 <dt id="sans.calculator.instrument.Aperture.__str__"> 140 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__str__" title="Permalink to this definition">¶</a></dt> 141 <dd><p>x.__str__() <==> str(x)</p> 142 </dd></dl> 143 144 <dl class="attribute"> 145 <dt id="sans.calculator.instrument.Aperture.__weakref__"> 146 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__weakref__" title="Permalink to this definition">¶</a></dt> 147 <dd><p>list of weak references to the object (if defined)</p> 148 </dd></dl> 149 67 150 <dl class="method"> 68 151 <dt id="sans.calculator.instrument.Aperture.set_sample_distance"> 69 <tt class="descname">set_sample_distance</tt><big>(</big>< em>distance=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_distance" title="Permalink to this definition">¶</a></dt>152 <tt class="descname">set_sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_distance" title="Permalink to this definition">¶</a></dt> 70 153 <dd><p>Set the sample aperture distance</p> 71 154 </dd></dl> … … 73 156 <dl class="method"> 74 157 <dt id="sans.calculator.instrument.Aperture.set_sample_size"> 75 <tt class="descname">set_sample_size</tt><big>(</big>< em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_size" title="Permalink to this definition">¶</a></dt>158 <tt class="descname">set_sample_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_size" title="Permalink to this definition">¶</a></dt> 76 159 <dd><p>Set the sample aperture size</p> 77 160 </dd></dl> … … 79 162 <dl class="method"> 80 163 <dt id="sans.calculator.instrument.Aperture.set_source_size"> 81 <tt class="descname">set_source_size</tt><big>(</big>< em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_source_size" title="Permalink to this definition">¶</a></dt>164 <tt class="descname">set_source_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_source_size" title="Permalink to this definition">¶</a></dt> 82 165 <dd><p>Set the source aperture size</p> 83 166 </dd></dl> … … 90 173 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 91 174 <p>An object class that defines the detector variables</p> 175 <dl class="attribute"> 176 <dt id="sans.calculator.instrument.Detector.__class__"> 177 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__class__" title="Permalink to this definition">¶</a></dt> 178 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 179 </dd></dl> 180 181 <dl class="attribute"> 182 <dt id="sans.calculator.instrument.Detector.__delattr__"> 183 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__delattr__" title="Permalink to this definition">¶</a></dt> 184 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 185 </dd></dl> 186 187 <dl class="attribute"> 188 <dt id="sans.calculator.instrument.Detector.__dict__"> 189 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01A3DEF0></em><a class="headerlink" href="#sans.calculator.instrument.Detector.__dict__" title="Permalink to this definition">¶</a></dt> 190 <dd></dd></dl> 191 192 <dl class="attribute"> 193 <dt id="sans.calculator.instrument.Detector.__getattribute__"> 194 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__getattribute__" title="Permalink to this definition">¶</a></dt> 195 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 196 </dd></dl> 197 198 <dl class="attribute"> 199 <dt id="sans.calculator.instrument.Detector.__hash__"> 200 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__hash__" title="Permalink to this definition">¶</a></dt> 201 <dd><p>x.__hash__() <==> hash(x)</p> 202 </dd></dl> 203 204 <dl class="method"> 205 <dt id="sans.calculator.instrument.Detector.__init__"> 206 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.__init__" title="Permalink to this definition">¶</a></dt> 207 <dd></dd></dl> 208 209 <dl class="attribute"> 210 <dt id="sans.calculator.instrument.Detector.__module__"> 211 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Detector.__module__" title="Permalink to this definition">¶</a></dt> 212 <dd></dd></dl> 213 214 <dl class="staticmethod"> 215 <dt id="sans.calculator.instrument.Detector.__new__"> 216 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Detector.__new__" title="Permalink to this definition">¶</a></dt> 217 <dd></dd></dl> 218 219 <dl class="method"> 220 <dt id="sans.calculator.instrument.Detector.__reduce__"> 221 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.__reduce__" title="Permalink to this definition">¶</a></dt> 222 <dd><p>helper for pickle</p> 223 </dd></dl> 224 225 <dl class="method"> 226 <dt id="sans.calculator.instrument.Detector.__reduce_ex__"> 227 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 228 <dd><p>helper for pickle</p> 229 </dd></dl> 230 231 <dl class="attribute"> 232 <dt id="sans.calculator.instrument.Detector.__repr__"> 233 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__repr__" title="Permalink to this definition">¶</a></dt> 234 <dd><p>x.__repr__() <==> repr(x)</p> 235 </dd></dl> 236 237 <dl class="attribute"> 238 <dt id="sans.calculator.instrument.Detector.__setattr__"> 239 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__setattr__" title="Permalink to this definition">¶</a></dt> 240 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 241 </dd></dl> 242 243 <dl class="attribute"> 244 <dt id="sans.calculator.instrument.Detector.__str__"> 245 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__str__" title="Permalink to this definition">¶</a></dt> 246 <dd><p>x.__str__() <==> str(x)</p> 247 </dd></dl> 248 249 <dl class="attribute"> 250 <dt id="sans.calculator.instrument.Detector.__weakref__"> 251 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__weakref__" title="Permalink to this definition">¶</a></dt> 252 <dd><p>list of weak references to the object (if defined)</p> 253 </dd></dl> 254 92 255 <dl class="method"> 93 256 <dt id="sans.calculator.instrument.Detector.set_distance"> 94 <tt class="descname">set_distance</tt><big>(</big>< em>distance=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_distance" title="Permalink to this definition">¶</a></dt>257 <tt class="descname">set_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_distance" title="Permalink to this definition">¶</a></dt> 95 258 <dd><p>Set the detector distance</p> 96 259 </dd></dl> … … 98 261 <dl class="method"> 99 262 <dt id="sans.calculator.instrument.Detector.set_pix_size"> 100 <tt class="descname">set_pix_size</tt><big>(</big>< em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_pix_size" title="Permalink to this definition">¶</a></dt>263 <tt class="descname">set_pix_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_pix_size" title="Permalink to this definition">¶</a></dt> 101 264 <dd><p>Set the detector pix_size</p> 102 265 </dd></dl> … … 104 267 <dl class="method"> 105 268 <dt id="sans.calculator.instrument.Detector.set_size"> 106 <tt class="descname">set_size</tt><big>(</big>< em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_size" title="Permalink to this definition">¶</a></dt>269 <tt class="descname">set_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_size" title="Permalink to this definition">¶</a></dt> 107 270 <dd><p>Set the detector size</p> 108 271 </dd></dl> … … 115 278 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 116 279 <p>An object that defines the wavelength variables</p> 280 <dl class="attribute"> 281 <dt id="sans.calculator.instrument.Neutron.__class__"> 282 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__class__" title="Permalink to this definition">¶</a></dt> 283 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 284 </dd></dl> 285 286 <dl class="attribute"> 287 <dt id="sans.calculator.instrument.Neutron.__delattr__"> 288 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__delattr__" title="Permalink to this definition">¶</a></dt> 289 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 290 </dd></dl> 291 292 <dl class="attribute"> 293 <dt id="sans.calculator.instrument.Neutron.__dict__"> 294 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01A4F410></em><a class="headerlink" href="#sans.calculator.instrument.Neutron.__dict__" title="Permalink to this definition">¶</a></dt> 295 <dd></dd></dl> 296 297 <dl class="attribute"> 298 <dt id="sans.calculator.instrument.Neutron.__getattribute__"> 299 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__getattribute__" title="Permalink to this definition">¶</a></dt> 300 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 301 </dd></dl> 302 303 <dl class="attribute"> 304 <dt id="sans.calculator.instrument.Neutron.__hash__"> 305 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__hash__" title="Permalink to this definition">¶</a></dt> 306 <dd><p>x.__hash__() <==> hash(x)</p> 307 </dd></dl> 308 309 <dl class="method"> 310 <dt id="sans.calculator.instrument.Neutron.__init__"> 311 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.__init__" title="Permalink to this definition">¶</a></dt> 312 <dd></dd></dl> 313 314 <dl class="attribute"> 315 <dt id="sans.calculator.instrument.Neutron.__module__"> 316 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Neutron.__module__" title="Permalink to this definition">¶</a></dt> 317 <dd></dd></dl> 318 319 <dl class="staticmethod"> 320 <dt id="sans.calculator.instrument.Neutron.__new__"> 321 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Neutron.__new__" title="Permalink to this definition">¶</a></dt> 322 <dd></dd></dl> 323 324 <dl class="method"> 325 <dt id="sans.calculator.instrument.Neutron.__reduce__"> 326 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.__reduce__" title="Permalink to this definition">¶</a></dt> 327 <dd><p>helper for pickle</p> 328 </dd></dl> 329 330 <dl class="method"> 331 <dt id="sans.calculator.instrument.Neutron.__reduce_ex__"> 332 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 333 <dd><p>helper for pickle</p> 334 </dd></dl> 335 336 <dl class="attribute"> 337 <dt id="sans.calculator.instrument.Neutron.__repr__"> 338 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__repr__" title="Permalink to this definition">¶</a></dt> 339 <dd><p>x.__repr__() <==> repr(x)</p> 340 </dd></dl> 341 342 <dl class="attribute"> 343 <dt id="sans.calculator.instrument.Neutron.__setattr__"> 344 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__setattr__" title="Permalink to this definition">¶</a></dt> 345 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 346 </dd></dl> 347 348 <dl class="attribute"> 349 <dt id="sans.calculator.instrument.Neutron.__str__"> 350 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__str__" title="Permalink to this definition">¶</a></dt> 351 <dd><p>x.__str__() <==> str(x)</p> 352 </dd></dl> 353 354 <dl class="attribute"> 355 <dt id="sans.calculator.instrument.Neutron.__weakref__"> 356 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__weakref__" title="Permalink to this definition">¶</a></dt> 357 <dd><p>list of weak references to the object (if defined)</p> 358 </dd></dl> 359 117 360 <dl class="method"> 118 361 <dt id="sans.calculator.instrument.Neutron.get_band"> … … 172 415 <dl class="method"> 173 416 <dt id="sans.calculator.instrument.Neutron.set_band"> 174 <tt class="descname">set_band</tt><big>(</big>< em>band=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_band" title="Permalink to this definition">¶</a></dt>417 <tt class="descname">set_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_band" title="Permalink to this definition">¶</a></dt> 175 418 <dd><p>To set the wavelength band</p> 176 419 <table class="docutils field-list" frame="void" rules="none"> … … 178 421 <col class="field-body" /> 179 422 <tbody valign="top"> 180 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> – array of [min, max]</td>423 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> – array of [min, max]</td> 181 424 </tr> 182 425 </tbody> … … 192 435 <dl class="method"> 193 436 <dt id="sans.calculator.instrument.Neutron.set_intensity"> 194 <tt class="descname">set_intensity</tt><big>(</big>< em>intensity=368428</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_intensity" title="Permalink to this definition">¶</a></dt>437 <tt class="descname">set_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_intensity" title="Permalink to this definition">¶</a></dt> 195 438 <dd><p>Sets the intensity in counts/sec</p> 196 439 </dd></dl> … … 198 441 <dl class="method"> 199 442 <dt id="sans.calculator.instrument.Neutron.set_mass"> 200 <tt class="descname">set_mass</tt><big>(</big>< em>mass=1.6749272900000001e-024</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_mass" title="Permalink to this definition">¶</a></dt>443 <tt class="descname">set_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_mass" title="Permalink to this definition">¶</a></dt> 201 444 <dd><p>Sets the wavelength</p> 202 445 </dd></dl> … … 204 447 <dl class="method"> 205 448 <dt id="sans.calculator.instrument.Neutron.set_spectrum"> 206 <tt class="descname">set_spectrum</tt><big>(</big>< em>spectrum</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_spectrum" title="Permalink to this definition">¶</a></dt>449 <tt class="descname">set_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_spectrum" title="Permalink to this definition">¶</a></dt> 207 450 <dd><p>Set spectrum</p> 208 451 <table class="docutils field-list" frame="void" rules="none"> … … 210 453 <col class="field-body" /> 211 454 <tbody valign="top"> 212 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> – numpy array</td>455 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> – numpy array</td> 213 456 </tr> 214 457 </tbody> … … 218 461 <dl class="method"> 219 462 <dt id="sans.calculator.instrument.Neutron.set_wavelength"> 220 <tt class="descname">set_wavelength</tt><big>(</big>< em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength" title="Permalink to this definition">¶</a></dt>463 <tt class="descname">set_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength" title="Permalink to this definition">¶</a></dt> 221 464 <dd><p>Sets the wavelength</p> 222 465 </dd></dl> … … 224 467 <dl class="method"> 225 468 <dt id="sans.calculator.instrument.Neutron.set_wavelength_spread"> 226 <tt class="descname">set_wavelength_spread</tt><big>(</big>< em>spread=0.125</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>469 <tt class="descname">set_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength_spread" title="Permalink to this definition">¶</a></dt> 227 470 <dd><p>Sets the wavelength spread</p> 228 471 </dd></dl> … … 242 485 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 243 486 <p>An object class that defines the sample variables</p> 487 <dl class="attribute"> 488 <dt id="sans.calculator.instrument.Sample.__class__"> 489 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__class__" title="Permalink to this definition">¶</a></dt> 490 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 491 </dd></dl> 492 493 <dl class="attribute"> 494 <dt id="sans.calculator.instrument.Sample.__delattr__"> 495 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__delattr__" title="Permalink to this definition">¶</a></dt> 496 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 497 </dd></dl> 498 499 <dl class="attribute"> 500 <dt id="sans.calculator.instrument.Sample.__dict__"> 501 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01A4F530></em><a class="headerlink" href="#sans.calculator.instrument.Sample.__dict__" title="Permalink to this definition">¶</a></dt> 502 <dd></dd></dl> 503 504 <dl class="attribute"> 505 <dt id="sans.calculator.instrument.Sample.__getattribute__"> 506 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__getattribute__" title="Permalink to this definition">¶</a></dt> 507 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 508 </dd></dl> 509 510 <dl class="attribute"> 511 <dt id="sans.calculator.instrument.Sample.__hash__"> 512 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__hash__" title="Permalink to this definition">¶</a></dt> 513 <dd><p>x.__hash__() <==> hash(x)</p> 514 </dd></dl> 515 516 <dl class="method"> 517 <dt id="sans.calculator.instrument.Sample.__init__"> 518 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.__init__" title="Permalink to this definition">¶</a></dt> 519 <dd></dd></dl> 520 521 <dl class="attribute"> 522 <dt id="sans.calculator.instrument.Sample.__module__"> 523 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Sample.__module__" title="Permalink to this definition">¶</a></dt> 524 <dd></dd></dl> 525 526 <dl class="staticmethod"> 527 <dt id="sans.calculator.instrument.Sample.__new__"> 528 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Sample.__new__" title="Permalink to this definition">¶</a></dt> 529 <dd></dd></dl> 530 531 <dl class="method"> 532 <dt id="sans.calculator.instrument.Sample.__reduce__"> 533 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.__reduce__" title="Permalink to this definition">¶</a></dt> 534 <dd><p>helper for pickle</p> 535 </dd></dl> 536 537 <dl class="method"> 538 <dt id="sans.calculator.instrument.Sample.__reduce_ex__"> 539 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 540 <dd><p>helper for pickle</p> 541 </dd></dl> 542 543 <dl class="attribute"> 544 <dt id="sans.calculator.instrument.Sample.__repr__"> 545 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__repr__" title="Permalink to this definition">¶</a></dt> 546 <dd><p>x.__repr__() <==> repr(x)</p> 547 </dd></dl> 548 549 <dl class="attribute"> 550 <dt id="sans.calculator.instrument.Sample.__setattr__"> 551 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__setattr__" title="Permalink to this definition">¶</a></dt> 552 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 553 </dd></dl> 554 555 <dl class="attribute"> 556 <dt id="sans.calculator.instrument.Sample.__str__"> 557 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__str__" title="Permalink to this definition">¶</a></dt> 558 <dd><p>x.__str__() <==> str(x)</p> 559 </dd></dl> 560 561 <dl class="attribute"> 562 <dt id="sans.calculator.instrument.Sample.__weakref__"> 563 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__weakref__" title="Permalink to this definition">¶</a></dt> 564 <dd><p>list of weak references to the object (if defined)</p> 565 </dd></dl> 566 244 567 <dl class="method"> 245 568 <dt id="sans.calculator.instrument.Sample.set_distance"> 246 <tt class="descname">set_distance</tt><big>(</big>< em>distance=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_distance" title="Permalink to this definition">¶</a></dt>569 <tt class="descname">set_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_distance" title="Permalink to this definition">¶</a></dt> 247 570 <dd><p>Set the sample distance</p> 248 571 </dd></dl> … … 250 573 <dl class="method"> 251 574 <dt id="sans.calculator.instrument.Sample.set_size"> 252 <tt class="descname">set_size</tt><big>(</big>< em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_size" title="Permalink to this definition">¶</a></dt>575 <tt class="descname">set_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_size" title="Permalink to this definition">¶</a></dt> 253 576 <dd><p>Set the sample size</p> 254 577 </dd></dl> … … 256 579 <dl class="method"> 257 580 <dt id="sans.calculator.instrument.Sample.set_thickness"> 258 <tt class="descname">set_thickness</tt><big>(</big>< em>thickness=0.0</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_thickness" title="Permalink to this definition">¶</a></dt>581 <tt class="descname">set_thickness</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_thickness" title="Permalink to this definition">¶</a></dt> 259 582 <dd><p>Set the sample thickness</p> 260 583 </dd></dl> … … 267 590 <dd><p>Bases: <a class="reference internal" href="#sans.calculator.instrument.Neutron" title="sans.calculator.instrument.Neutron"><tt class="xref py py-class docutils literal"><span class="pre">sans.calculator.instrument.Neutron</span></tt></a></p> 268 591 <p>TOF: make list of wavelength and wave length spreads</p> 592 <dl class="attribute"> 593 <dt id="sans.calculator.instrument.TOF.__class__"> 594 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__class__" title="Permalink to this definition">¶</a></dt> 595 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 596 </dd></dl> 597 598 <dl class="attribute"> 599 <dt id="sans.calculator.instrument.TOF.__delattr__"> 600 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__delattr__" title="Permalink to this definition">¶</a></dt> 601 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 602 </dd></dl> 603 604 <dl class="attribute"> 605 <dt id="sans.calculator.instrument.TOF.__dict__"> 606 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01A5B830></em><a class="headerlink" href="#sans.calculator.instrument.TOF.__dict__" title="Permalink to this definition">¶</a></dt> 607 <dd></dd></dl> 608 609 <dl class="attribute"> 610 <dt id="sans.calculator.instrument.TOF.__getattribute__"> 611 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__getattribute__" title="Permalink to this definition">¶</a></dt> 612 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 613 </dd></dl> 614 615 <dl class="attribute"> 616 <dt id="sans.calculator.instrument.TOF.__hash__"> 617 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__hash__" title="Permalink to this definition">¶</a></dt> 618 <dd><p>x.__hash__() <==> hash(x)</p> 619 </dd></dl> 620 621 <dl class="method"> 622 <dt id="sans.calculator.instrument.TOF.__init__"> 623 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.__init__" title="Permalink to this definition">¶</a></dt> 624 <dd><p>Init</p> 625 </dd></dl> 626 627 <dl class="attribute"> 628 <dt id="sans.calculator.instrument.TOF.__module__"> 629 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.TOF.__module__" title="Permalink to this definition">¶</a></dt> 630 <dd></dd></dl> 631 632 <dl class="staticmethod"> 633 <dt id="sans.calculator.instrument.TOF.__new__"> 634 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.TOF.__new__" title="Permalink to this definition">¶</a></dt> 635 <dd></dd></dl> 636 637 <dl class="method"> 638 <dt id="sans.calculator.instrument.TOF.__reduce__"> 639 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.__reduce__" title="Permalink to this definition">¶</a></dt> 640 <dd><p>helper for pickle</p> 641 </dd></dl> 642 643 <dl class="method"> 644 <dt id="sans.calculator.instrument.TOF.__reduce_ex__"> 645 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 646 <dd><p>helper for pickle</p> 647 </dd></dl> 648 649 <dl class="attribute"> 650 <dt id="sans.calculator.instrument.TOF.__repr__"> 651 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__repr__" title="Permalink to this definition">¶</a></dt> 652 <dd><p>x.__repr__() <==> repr(x)</p> 653 </dd></dl> 654 655 <dl class="attribute"> 656 <dt id="sans.calculator.instrument.TOF.__setattr__"> 657 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__setattr__" title="Permalink to this definition">¶</a></dt> 658 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 659 </dd></dl> 660 661 <dl class="attribute"> 662 <dt id="sans.calculator.instrument.TOF.__str__"> 663 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__str__" title="Permalink to this definition">¶</a></dt> 664 <dd><p>x.__str__() <==> str(x)</p> 665 </dd></dl> 666 667 <dl class="attribute"> 668 <dt id="sans.calculator.instrument.TOF.__weakref__"> 669 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__weakref__" title="Permalink to this definition">¶</a></dt> 670 <dd><p>list of weak references to the object (if defined)</p> 671 </dd></dl> 672 269 673 <dl class="method"> 270 674 <dt id="sans.calculator.instrument.TOF.get_band"> … … 336 740 <dl class="method"> 337 741 <dt id="sans.calculator.instrument.TOF.set_band"> 338 <tt class="descname">set_band</tt><big>(</big>< em>band=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_band" title="Permalink to this definition">¶</a></dt>742 <tt class="descname">set_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_band" title="Permalink to this definition">¶</a></dt> 339 743 <dd><p>To set the wavelength band</p> 340 744 <table class="docutils field-list" frame="void" rules="none"> … … 342 746 <col class="field-body" /> 343 747 <tbody valign="top"> 344 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> – array of [min, max]</td>748 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> – array of [min, max]</td> 345 749 </tr> 346 750 </tbody> … … 356 760 <dl class="method"> 357 761 <dt id="sans.calculator.instrument.TOF.set_intensity"> 358 <tt class="descname">set_intensity</tt><big>(</big>< em>intensity=368428</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_intensity" title="Permalink to this definition">¶</a></dt>762 <tt class="descname">set_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_intensity" title="Permalink to this definition">¶</a></dt> 359 763 <dd><p>Sets the intensity in counts/sec</p> 360 764 </dd></dl> … … 362 766 <dl class="method"> 363 767 <dt id="sans.calculator.instrument.TOF.set_mass"> 364 <tt class="descname">set_mass</tt><big>(</big>< em>mass=1.6749272900000001e-024</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_mass" title="Permalink to this definition">¶</a></dt>768 <tt class="descname">set_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_mass" title="Permalink to this definition">¶</a></dt> 365 769 <dd><p>Sets the wavelength</p> 366 770 </dd></dl> … … 368 772 <dl class="method"> 369 773 <dt id="sans.calculator.instrument.TOF.set_spectrum"> 370 <tt class="descname">set_spectrum</tt><big>(</big>< em>spectrum</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_spectrum" title="Permalink to this definition">¶</a></dt>774 <tt class="descname">set_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_spectrum" title="Permalink to this definition">¶</a></dt> 371 775 <dd><p>Set spectrum</p> 372 776 <table class="docutils field-list" frame="void" rules="none"> … … 374 778 <col class="field-body" /> 375 779 <tbody valign="top"> 376 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> – numpy array</td>780 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> – numpy array</td> 377 781 </tr> 378 782 </tbody> … … 382 786 <dl class="method"> 383 787 <dt id="sans.calculator.instrument.TOF.set_wave_list"> 384 <tt class="descname">set_wave_list</tt><big>(</big>< em>wavelength=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_list" title="Permalink to this definition">¶</a></dt>788 <tt class="descname">set_wave_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_list" title="Permalink to this definition">¶</a></dt> 385 789 <dd><p>Set wavelength list</p> 386 790 <table class="docutils field-list" frame="void" rules="none"> … … 388 792 <col class="field-body" /> 389 793 <tbody valign="top"> 390 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength</strong> – list of wavelengths</td>794 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength</strong> – list of wavelengths</td> 391 795 </tr> 392 796 </tbody> … … 396 800 <dl class="method"> 397 801 <dt id="sans.calculator.instrument.TOF.set_wave_spread_list"> 398 <tt class="descname">set_wave_spread_list</tt><big>(</big>< em>wavelength_spread=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_spread_list" title="Permalink to this definition">¶</a></dt>802 <tt class="descname">set_wave_spread_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_spread_list" title="Permalink to this definition">¶</a></dt> 399 803 <dd><p>Set wavelength_spread list</p> 400 804 <table class="docutils field-list" frame="void" rules="none"> … … 402 806 <col class="field-body" /> 403 807 <tbody valign="top"> 404 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength_spread</strong> – list of wavelength spreads</td>808 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength_spread</strong> – list of wavelength spreads</td> 405 809 </tr> 406 810 </tbody> … … 410 814 <dl class="method"> 411 815 <dt id="sans.calculator.instrument.TOF.set_wavelength"> 412 <tt class="descname">set_wavelength</tt><big>(</big>< em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength" title="Permalink to this definition">¶</a></dt>816 <tt class="descname">set_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength" title="Permalink to this definition">¶</a></dt> 413 817 <dd><p>Sets the wavelength</p> 414 818 </dd></dl> … … 416 820 <dl class="method"> 417 821 <dt id="sans.calculator.instrument.TOF.set_wavelength_spread"> 418 <tt class="descname">set_wavelength_spread</tt><big>(</big>< em>spread=0.125</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>822 <tt class="descname">set_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength_spread" title="Permalink to this definition">¶</a></dt> 419 823 <dd><p>Sets the wavelength spread</p> 420 824 </dd></dl> … … 431 835 <dl class="function"> 432 836 <dt id="sans.calculator.instrument.validate"> 433 <tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">validate</tt><big>(</big>< em>value=None</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.validate" title="Permalink to this definition">¶</a></dt>837 <tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">validate</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.validate" title="Permalink to this definition">¶</a></dt> 434 838 <dd><p>Check if the value is folat > 0.0</p> 435 839 <table class="docutils field-list" frame="void" rules="none"> … … 437 841 <col class="field-body" /> 438 842 <tbody valign="top"> 439 <tr class="field "><th class="field-name">Return value:</th><td class="field-body">True / False</td>843 <tr class="field-odd field"><th class="field-name">Return value:</th><td class="field-body">True / False</td> 440 844 </tr> 441 845 </tbody> … … 454 858 <h3><a href="../index.html">Table Of Contents</a></h3> 455 859 <ul> 456 <li><a class="reference internal" href="#"> Instrument</a><ul>457 <li><a class="reference internal" href="# module-sans.calculator.instrument"><tt class="docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a></li>860 <li><a class="reference internal" href="#">instrument</a><ul> 861 <li><a class="reference internal" href="#sans-calculator-instrument"><tt class="docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a></li> 458 862 </ul> 459 863 </li> … … 464 868 title="previous chapter">Reference</a></p> 465 869 <h4>Next topic</h4> 466 <p class="topless"><a href=" slit_length_calculator.html"467 title="next chapter"> Slit Length Calculator</a></p>870 <p class="topless"><a href="kiessig_calculator.html" 871 title="next chapter">kiessig_calculator</a></p> 468 872 <h3>This Page</h3> 469 873 <ul class="this-page-menu"> … … 474 878 <h3>Quick search</h3> 475 879 <form class="search" action="../search.html" method="get"> 476 <input type="text" name="q" size="18"/>880 <input type="text" name="q" /> 477 881 <input type="submit" value="Go" /> 478 882 <input type="hidden" name="check_keywords" value="yes" /> … … 498 902 >modules</a> |</li> 499 903 <li class="right" > 500 <a href=" slit_length_calculator.html" title="Slit Length Calculator"904 <a href="kiessig_calculator.html" title="kiessig_calculator" 501 905 >next</a> |</li> 502 906 <li class="right" > 503 907 <a href="index.html" title="Reference" 504 908 >previous</a> |</li> 505 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>909 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 506 910 <li><a href="index.html" >Reference</a> »</li> 507 911 </ul> … … 509 913 <div class="footer"> 510 914 © Copyright 2010, Gervaise Alina. 511 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.915 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 512 916 </div> 513 917 </body> -
sanscalculator/docs/sphinx/html/api/kiessig_calculator.html
r771fe98 ra4f04f2 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>Kiessig Calculator — calculator v0.1.0 documentation</title> 11 <title>kiessig_calculator — calculator 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 <link rel="next" title=" Resolution Calculator" href="resolution_calculator.html" />28 <link rel="prev" title=" Slit Length Calculator" href="slit_length_calculator.html" />30 <link rel="next" title="resolution_calculator" href="resolution_calculator.html" /> 31 <link rel="prev" title="instrument" href="instrument.html" /> 29 32 </head> 30 33 <body> … … 39 42 >modules</a> |</li> 40 43 <li class="right" > 41 <a href="resolution_calculator.html" title=" Resolution Calculator"44 <a href="resolution_calculator.html" title="resolution_calculator" 42 45 accesskey="N">next</a> |</li> 43 46 <li class="right" > 44 <a href=" slit_length_calculator.html" title="Slit Length Calculator"47 <a href="instrument.html" title="instrument" 45 48 accesskey="P">previous</a> |</li> 46 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>49 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 47 50 <li><a href="index.html" accesskey="U">Reference</a> »</li> 48 51 </ul> … … 55 58 56 59 <div class="section" id="kiessig-calculator"> 57 <h1> Kiessig Calculator<a class="headerlink" href="#kiessig-calculator" title="Permalink to this headline">¶</a></h1>58 <div class="section" id=" module-sans.calculator.kiessig_calculator">59 < span id="sans-calculator-kiessig-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.kiessig_calculator" title="sans.calculator.kiessig_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a><a class="headerlink" href="#module-sans.calculator.kiessig_calculator" title="Permalink to this headline">¶</a></h2>60 < p>This module is a small tool to allow user to quickly60 <h1>kiessig_calculator<a class="headerlink" href="#kiessig-calculator" title="Permalink to this headline">¶</a></h1> 61 <div class="section" id="sans-calculator-kiessig-calculator"> 62 <h2><a class="reference internal" href="#module-sans.calculator.kiessig_calculator" title="sans.calculator.kiessig_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-kiessig-calculator" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.calculator.kiessig_calculator"></span><p>This module is a small tool to allow user to quickly 61 64 determine the size value in real space from the 62 65 fringe width in q space.</p> … … 66 69 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 67 70 <p>compute thickness from the fringe width of data</p> 71 <dl class="attribute"> 72 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__class__"> 73 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__class__" title="Permalink to this definition">¶</a></dt> 74 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 75 </dd></dl> 76 77 <dl class="attribute"> 78 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__delattr__"> 79 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__delattr__" title="Permalink to this definition">¶</a></dt> 80 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 81 </dd></dl> 82 83 <dl class="attribute"> 84 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__dict__"> 85 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01C9DBD0></em><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__dict__" title="Permalink to this definition">¶</a></dt> 86 <dd></dd></dl> 87 88 <dl class="attribute"> 89 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__getattribute__"> 90 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt> 91 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 92 </dd></dl> 93 94 <dl class="attribute"> 95 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__hash__"> 96 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__hash__" title="Permalink to this definition">¶</a></dt> 97 <dd><p>x.__hash__() <==> hash(x)</p> 98 </dd></dl> 99 100 <dl class="method"> 101 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__init__"> 102 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__init__" title="Permalink to this definition">¶</a></dt> 103 <dd></dd></dl> 104 105 <dl class="attribute"> 106 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__module__"> 107 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.kiessig_calculator'</em><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__module__" title="Permalink to this definition">¶</a></dt> 108 <dd></dd></dl> 109 110 <dl class="staticmethod"> 111 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__new__"> 112 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__new__" title="Permalink to this definition">¶</a></dt> 113 <dd></dd></dl> 114 115 <dl class="method"> 116 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce__"> 117 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce__" title="Permalink to this definition">¶</a></dt> 118 <dd><p>helper for pickle</p> 119 </dd></dl> 120 121 <dl class="method"> 122 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce_ex__"> 123 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 124 <dd><p>helper for pickle</p> 125 </dd></dl> 126 127 <dl class="attribute"> 128 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__repr__"> 129 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__repr__" title="Permalink to this definition">¶</a></dt> 130 <dd><p>x.__repr__() <==> repr(x)</p> 131 </dd></dl> 132 133 <dl class="attribute"> 134 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__setattr__"> 135 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__setattr__" title="Permalink to this definition">¶</a></dt> 136 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 137 </dd></dl> 138 139 <dl class="attribute"> 140 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__str__"> 141 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__str__" title="Permalink to this definition">¶</a></dt> 142 <dd><p>x.__str__() <==> str(x)</p> 143 </dd></dl> 144 145 <dl class="attribute"> 146 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__weakref__"> 147 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.__weakref__" title="Permalink to this definition">¶</a></dt> 148 <dd><p>list of weak references to the object (if defined)</p> 149 </dd></dl> 150 68 151 <dl class="method"> 69 152 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.compute_thickness"> … … 74 157 <col class="field-body" /> 75 158 <tbody valign="top"> 76 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">the thickness.</td>159 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness.</td> 77 160 </tr> 78 161 </tbody> … … 93 176 <col class="field-body" /> 94 177 <tbody valign="top"> 95 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">the thickness unit.</td>178 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness unit.</td> 96 179 </tr> 97 180 </tbody> … … 101 184 <dl class="method"> 102 185 <dt id="sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq"> 103 <tt class="descname">set_deltaq</tt><big>(</big>< em>dq=None</em><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq" title="Permalink to this definition">¶</a></dt>186 <tt class="descname">set_deltaq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq" title="Permalink to this definition">¶</a></dt> 104 187 <dd><p>Receive deltaQ value</p> 105 188 <table class="docutils field-list" frame="void" rules="none"> … … 107 190 <col class="field-body" /> 108 191 <tbody valign="top"> 109 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>dq</strong> – q fringe width in 1/A unit</td>192 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dq</strong> – q fringe width in 1/A unit</td> 110 193 </tr> 111 194 </tbody> … … 126 209 <h3><a href="../index.html">Table Of Contents</a></h3> 127 210 <ul> 128 <li><a class="reference internal" href="#"> Kiessig Calculator</a><ul>129 <li><a class="reference internal" href="# module-sans.calculator.kiessig_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li>211 <li><a class="reference internal" href="#">kiessig_calculator</a><ul> 212 <li><a class="reference internal" href="#sans-calculator-kiessig-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.kiessig_calculator</span></tt></a></li> 130 213 </ul> 131 214 </li> … … 133 216 134 217 <h4>Previous topic</h4> 135 <p class="topless"><a href=" slit_length_calculator.html"136 title="previous chapter"> Slit Length Calculator</a></p>218 <p class="topless"><a href="instrument.html" 219 title="previous chapter">instrument</a></p> 137 220 <h4>Next topic</h4> 138 221 <p class="topless"><a href="resolution_calculator.html" 139 title="next chapter"> Resolution Calculator</a></p>222 title="next chapter">resolution_calculator</a></p> 140 223 <h3>This Page</h3> 141 224 <ul class="this-page-menu"> … … 146 229 <h3>Quick search</h3> 147 230 <form class="search" action="../search.html" method="get"> 148 <input type="text" name="q" size="18"/>231 <input type="text" name="q" /> 149 232 <input type="submit" value="Go" /> 150 233 <input type="hidden" name="check_keywords" value="yes" /> … … 170 253 >modules</a> |</li> 171 254 <li class="right" > 172 <a href="resolution_calculator.html" title=" Resolution Calculator"255 <a href="resolution_calculator.html" title="resolution_calculator" 173 256 >next</a> |</li> 174 257 <li class="right" > 175 <a href=" slit_length_calculator.html" title="Slit Length Calculator"258 <a href="instrument.html" title="instrument" 176 259 >previous</a> |</li> 177 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>260 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 178 261 <li><a href="index.html" >Reference</a> »</li> 179 262 </ul> … … 181 264 <div class="footer"> 182 265 © Copyright 2010, Gervaise Alina. 183 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.266 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 184 267 </div> 185 268 </body> -
sanscalculator/docs/sphinx/html/api/resolution_calculator.html
r771fe98 ra4f04f2 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>Resolution Calculator — calculator v0.1.0 documentation</title> 11 <title>resolution_calculator — calculator 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 <link rel="prev" title="Kiessig Calculator" href="kiessig_calculator.html" /> 30 <link rel="next" title="slit_length_calculator" href="slit_length_calculator.html" /> 31 <link rel="prev" title="kiessig_calculator" href="kiessig_calculator.html" /> 28 32 </head> 29 33 <body> … … 38 42 >modules</a> |</li> 39 43 <li class="right" > 40 <a href="kiessig_calculator.html" title="Kiessig Calculator" 44 <a href="slit_length_calculator.html" title="slit_length_calculator" 45 accesskey="N">next</a> |</li> 46 <li class="right" > 47 <a href="kiessig_calculator.html" title="kiessig_calculator" 41 48 accesskey="P">previous</a> |</li> 42 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>49 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 43 50 <li><a href="index.html" accesskey="U">Reference</a> »</li> 44 51 </ul> … … 51 58 52 59 <div class="section" id="resolution-calculator"> 53 <h1> Resolution Calculator<a class="headerlink" href="#resolution-calculator" title="Permalink to this headline">¶</a></h1>54 <div class="section" id=" module-sans.calculator.resolution_calculator">55 < span id="sans-calculator-resolution-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.resolution_calculator" title="sans.calculator.resolution_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a><a class="headerlink" href="#module-sans.calculator.resolution_calculator" title="Permalink to this headline">¶</a></h2>56 < p>This object is a small tool to allow user to quickly60 <h1>resolution_calculator<a class="headerlink" href="#resolution-calculator" title="Permalink to this headline">¶</a></h1> 61 <div class="section" id="sans-calculator-resolution-calculator"> 62 <h2><a class="reference internal" href="#module-sans.calculator.resolution_calculator" title="sans.calculator.resolution_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-resolution-calculator" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.calculator.resolution_calculator"></span><p>This object is a small tool to allow user to quickly 57 64 determine the variance in q from the 58 65 instrumental parameters.</p> … … 62 69 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 63 70 <p>compute resolution in 2D</p> 71 <dl class="attribute"> 72 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__class__"> 73 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__class__" title="Permalink to this definition">¶</a></dt> 74 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 75 </dd></dl> 76 77 <dl class="attribute"> 78 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__delattr__"> 79 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__delattr__" title="Permalink to this definition">¶</a></dt> 80 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 81 </dd></dl> 82 83 <dl class="attribute"> 84 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__dict__"> 85 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x0205AC50></em><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__dict__" title="Permalink to this definition">¶</a></dt> 86 <dd></dd></dl> 87 88 <dl class="attribute"> 89 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__getattribute__"> 90 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt> 91 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 92 </dd></dl> 93 94 <dl class="attribute"> 95 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__hash__"> 96 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__hash__" title="Permalink to this definition">¶</a></dt> 97 <dd><p>x.__hash__() <==> hash(x)</p> 98 </dd></dl> 99 100 <dl class="method"> 101 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__init__"> 102 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__init__" title="Permalink to this definition">¶</a></dt> 103 <dd></dd></dl> 104 105 <dl class="attribute"> 106 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__module__"> 107 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.resolution_calculator'</em><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__module__" title="Permalink to this definition">¶</a></dt> 108 <dd></dd></dl> 109 110 <dl class="staticmethod"> 111 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__new__"> 112 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__new__" title="Permalink to this definition">¶</a></dt> 113 <dd></dd></dl> 114 115 <dl class="method"> 116 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__reduce__"> 117 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__reduce__" title="Permalink to this definition">¶</a></dt> 118 <dd><p>helper for pickle</p> 119 </dd></dl> 120 121 <dl class="method"> 122 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__reduce_ex__"> 123 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 124 <dd><p>helper for pickle</p> 125 </dd></dl> 126 127 <dl class="attribute"> 128 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__repr__"> 129 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__repr__" title="Permalink to this definition">¶</a></dt> 130 <dd><p>x.__repr__() <==> repr(x)</p> 131 </dd></dl> 132 133 <dl class="attribute"> 134 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__setattr__"> 135 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__setattr__" title="Permalink to this definition">¶</a></dt> 136 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 137 </dd></dl> 138 139 <dl class="attribute"> 140 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__str__"> 141 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__str__" title="Permalink to this definition">¶</a></dt> 142 <dd><p>x.__str__() <==> str(x)</p> 143 </dd></dl> 144 145 <dl class="attribute"> 146 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__weakref__"> 147 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__weakref__" title="Permalink to this definition">¶</a></dt> 148 <dd><p>list of weak references to the object (if defined)</p> 149 </dd></dl> 150 151 <dl class="method"> 152 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._atan_phi"> 153 <tt class="descname">_atan_phi</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._atan_phi" title="Permalink to this definition">¶</a></dt> 154 <dd><p>Find the angle phi of q on the detector plane for qx_value, qy_value given 155 : qx_value: x component of q 156 : qy_value: y component of q</p> 157 <p>: return phi: the azimuthal angle of q on x-y plane</p> 158 </dd></dl> 159 160 <dl class="method"> 161 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._cal_A_value"> 162 <tt class="descname">_cal_A_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._cal_A_value" title="Permalink to this definition">¶</a></dt> 163 <dd><p>Calculate A value for gravity</p> 164 <p>: s_distance: source to sample distance 165 : d_distance: sample to detector distance</p> 166 </dd></dl> 167 168 <dl class="method"> 169 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._gaussian1d"> 170 <tt class="descname">_gaussian1d</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._gaussian1d" title="Permalink to this definition">¶</a></dt> 171 <dd><p>Calculate 1D Gaussian distribution 172 : value: value 173 : mean: mean value 174 : sigma: variance</p> 175 <p>: return: gaussian (value)</p> 176 </dd></dl> 177 178 <dl class="method"> 179 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d"> 180 <tt class="descname">_gaussian2d</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d" title="Permalink to this definition">¶</a></dt> 181 <dd><p>Calculate 2D Gaussian distribution 182 : x_val: x value 183 : y_val: y value 184 : x0_val: mean value in x-axis 185 : y0_val: mean value in y-axis 186 : sigma_x: variance in x-direction 187 : sigma_y: variance in y-direction</p> 188 <p>: return: gaussian (value)</p> 189 </dd></dl> 190 191 <dl class="method"> 192 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d_polar"> 193 <tt class="descname">_gaussian2d_polar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d_polar" title="Permalink to this definition">¶</a></dt> 194 <dd><p>Calculate 2D Gaussian distribution for polar coodinate 195 : x_val: x value 196 : y_val: y value 197 : x0_val: mean value in x-axis 198 : y0_val: mean value in y-axis 199 : sigma_x: variance in r-direction 200 : sigma_y: variance in phi-direction 201 : sigma_r: wavelength variance in r-direction</p> 202 <p>: return: gaussian (value)</p> 203 </dd></dl> 204 205 <dl class="method"> 206 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_drop"> 207 <tt class="descname">_get_beamcenter_drop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_drop" title="Permalink to this definition">¶</a></dt> 208 <dd><p>Get the beam center drop (delta y) in y diection due to gravity</p> 209 <table class="docutils field-list" frame="void" rules="none"> 210 <col class="field-name" /> 211 <col class="field-body" /> 212 <tbody valign="top"> 213 <tr class="field-odd field"><th class="field-name">Return delta y:</th><td class="field-body">the beam center drop in cm</td> 214 </tr> 215 </tbody> 216 </table> 217 </dd></dl> 218 219 <dl class="method"> 220 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_position"> 221 <tt class="descname">_get_beamcenter_position</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_position" title="Permalink to this definition">¶</a></dt> 222 <dd><table class="docutils field-list" frame="void" rules="none"> 223 <col class="field-name" /> 224 <col class="field-body" /> 225 <tbody valign="top"> 226 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 227 <li><strong>num_x</strong> – number of pixel in x-direction</li> 228 <li><strong>num_y</strong> – number of pixel in y-direction</li> 229 <li><strong>offset</strong> – detector offset in x-direction in pix number</li> 230 </ul> 231 </td> 232 </tr> 233 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pix number; pos_x, pos_y in pix index</p> 234 </td> 235 </tr> 236 </tbody> 237 </table> 238 </dd></dl> 239 240 <dl class="method"> 241 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_detector_qxqy_pixels"> 242 <tt class="descname">_get_detector_qxqy_pixels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_detector_qxqy_pixels" title="Permalink to this definition">¶</a></dt> 243 <dd><p>Get the pixel positions of the detector in the qx_value-qy_value space</p> 244 </dd></dl> 245 246 <dl class="method"> 247 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_polar_value"> 248 <tt class="descname">_get_polar_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_polar_value" title="Permalink to this definition">¶</a></dt> 249 <dd><p>Find qr_value and phi from qx_value and qy_value values</p> 250 <p>: return qr_value, phi</p> 251 </dd></dl> 252 253 <dl class="method"> 254 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_qx"> 255 <tt class="descname">_get_qx</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_qx" title="Permalink to this definition">¶</a></dt> 256 <dd><table class="docutils field-list" frame="void" rules="none"> 257 <col class="field-name" /> 258 <col class="field-body" /> 259 <tbody valign="top"> 260 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 261 <li><strong>dx_size</strong> – x-distance from beam center [cm]</li> 262 <li><strong>det_dist</strong> – sample to detector distance [cm]</li> 263 </ul> 264 </td> 265 </tr> 266 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">q-value at the given position</p> 267 </td> 268 </tr> 269 </tbody> 270 </table> 271 </dd></dl> 272 273 <dl class="method"> 274 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._rotate_z"> 275 <tt class="descname">_rotate_z</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._rotate_z" title="Permalink to this definition">¶</a></dt> 276 <dd><p>Rotate x-y cordinate around z-axis by theta 277 : x_value: numpy array of x values 278 : y_value: numpy array of y values 279 : theta: angle to rotate by in rad</p> 280 <table class="docutils field-list" frame="void" rules="none"> 281 <col class="field-name" /> 282 <col class="field-body" /> 283 <tbody valign="top"> 284 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">x_prime, y-prime</td> 285 </tr> 286 </tbody> 287 </table> 288 </dd></dl> 289 290 <dl class="method"> 291 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator._within_detector_range"> 292 <tt class="descname">_within_detector_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._within_detector_range" title="Permalink to this definition">¶</a></dt> 293 <dd><p>check if qvalues are within detector range</p> 294 </dd></dl> 295 64 296 <dl class="method"> 65 297 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.compute"> 66 <tt class="descname">compute</tt><big>(</big>< em>wavelength</em>, <em>wavelength_spread</em>, <em>qx_value</em>, <em>qy_value</em>, <em>coord='cartesian'</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.compute" title="Permalink to this definition">¶</a></dt>298 <tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.compute" title="Permalink to this definition">¶</a></dt> 67 299 <dd><p>Compute the Q resoltuion in || and + direction of 2D 68 300 : qx_value: x component of q … … 72 304 <dl class="method"> 73 305 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.compute_and_plot"> 74 <tt class="descname">compute_and_plot</tt><big>(</big>< em>qx_value</em>, <em>qy_value</em>, <em>qx_min</em>, <em>qx_max</em>, <em>qy_min</em>, <em>qy_max</em>, <em>coord='cartesian'</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.compute_and_plot" title="Permalink to this definition">¶</a></dt>306 <tt class="descname">compute_and_plot</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.compute_and_plot" title="Permalink to this definition">¶</a></dt> 75 307 <dd><p>Compute the resolution 76 308 : qx_value: x component of q … … 111 343 <dl class="method"> 112 344 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_image"> 113 <tt class="descname">get_image</tt><big>(</big>< em>qx_value</em>, <em>qy_value</em>, <em>sigma_1</em>, <em>sigma_2</em>, <em>sigma_r</em>, <em>qx_min</em>, <em>qx_max</em>, <em>qy_min</em>, <em>qy_max</em>, <em>coord='cartesian'</em>, <em>full_cal=True</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_image" title="Permalink to this definition">¶</a></dt>345 <tt class="descname">get_image</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_image" title="Permalink to this definition">¶</a></dt> 114 346 <dd><p>Get the resolution in polar coordinate ready to plot 115 347 : qx_value: qx_value value … … 176 408 <dl class="method"> 177 409 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_variance"> 178 <tt class="descname">get_variance</tt><big>(</big>< em>size=</em><span class="optional">[</span><span class="optional">]</span>, <em>distance=0</em>, <em>phi=0</em>, <em>comp='radial'</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance" title="Permalink to this definition">¶</a></dt>410 <tt class="descname">get_variance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance" title="Permalink to this definition">¶</a></dt> 179 411 <dd><p>Get the variance when the slit/pinhole size is given 180 412 : size: list that can be one(diameter for circular)</p> … … 188 420 <dl class="method"> 189 421 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_gravity"> 190 <tt class="descname">get_variance_gravity</tt><big>(</big>< em>s_distance</em>, <em>d_distance</em>, <em>wavelength</em>, <em>spread</em>, <em>phi</em>, <em>comp='radial'</em>, <em>switch='on'</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_gravity" title="Permalink to this definition">¶</a></dt>422 <tt class="descname">get_variance_gravity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_gravity" title="Permalink to this definition">¶</a></dt> 191 423 <dd><p>Get the variance from gravity when the wavelength spread is given</p> 192 424 <p>: s_distance: source to sample distance … … 200 432 <dl class="method"> 201 433 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_wave"> 202 <tt class="descname">get_variance_wave</tt><big>(</big>< em>radius</em>, <em>distance</em>, <em>spread</em>, <em>phi</em>, <em>comp='radial'</em>, <em>switch='on'</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_wave" title="Permalink to this definition">¶</a></dt>434 <tt class="descname">get_variance_wave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_wave" title="Permalink to this definition">¶</a></dt> 203 435 <dd><p>Get the variance when the wavelength spread is given</p> 204 436 <p>: radius: the radial distance from the beam center to the pix of q … … 206 438 : spread: wavelength spread (ratio) 207 439 : comp: direction of the sigma; can be ‘phi’, ‘y’, ‘x’, and ‘radial’</p> 208 <p>: return variance: sigma^2 </p>440 <p>: return variance: sigma^2 for 2d, sigma^2 for 1d [tuple]</p> 209 441 </dd></dl> 210 442 … … 229 461 <dl class="method"> 230 462 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.plot_image"> 231 <tt class="descname">plot_image</tt><big>(</big>< em>image</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.plot_image" title="Permalink to this definition">¶</a></dt>463 <tt class="descname">plot_image</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.plot_image" title="Permalink to this definition">¶</a></dt> 232 464 <dd><p>Plot image using pyplot 233 465 : image: 2d resolution image</p> … … 243 475 <dl class="method"> 244 476 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_pix_size"> 245 <tt class="descname">set_detector_pix_size</tt><big>(</big>< em>size</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_pix_size" title="Permalink to this definition">¶</a></dt>477 <tt class="descname">set_detector_pix_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_pix_size" title="Permalink to this definition">¶</a></dt> 246 478 <dd><p>Set detector pixel size</p> 247 479 </dd></dl> … … 249 481 <dl class="method"> 250 482 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_size"> 251 <tt class="descname">set_detector_size</tt><big>(</big>< em>size</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_size" title="Permalink to this definition">¶</a></dt>483 <tt class="descname">set_detector_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_size" title="Permalink to this definition">¶</a></dt> 252 484 <dd><p>Set detector size in number of pixels 253 485 : param size: [pixel_nums] or [x_pix_num, yx_pix_num]</p> … … 256 488 <dl class="method"> 257 489 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_intensity"> 258 <tt class="descname">set_intensity</tt><big>(</big>< em>intensity</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_intensity" title="Permalink to this definition">¶</a></dt>490 <tt class="descname">set_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_intensity" title="Permalink to this definition">¶</a></dt> 259 491 <dd><p>Set intensity</p> 260 492 </dd></dl> … … 262 494 <dl class="method"> 263 495 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_neutron_mass"> 264 <tt class="descname">set_neutron_mass</tt><big>(</big>< em>mass</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_neutron_mass" title="Permalink to this definition">¶</a></dt>496 <tt class="descname">set_neutron_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_neutron_mass" title="Permalink to this definition">¶</a></dt> 265 497 <dd><p>Set Neutron mass</p> 266 498 </dd></dl> … … 268 500 <dl class="method"> 269 501 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2detector_distance"> 270 <tt class="descname">set_sample2detector_distance</tt><big>(</big>< em>distance</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2detector_distance" title="Permalink to this definition">¶</a></dt>502 <tt class="descname">set_sample2detector_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2detector_distance" title="Permalink to this definition">¶</a></dt> 271 503 <dd><p>Set detector sample2detector_distance</p> 272 504 <p>: param distance: [distance, x_offset]</p> … … 275 507 <dl class="method"> 276 508 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2sample_distance"> 277 <tt class="descname">set_sample2sample_distance</tt><big>(</big>< em>distance</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2sample_distance" title="Permalink to this definition">¶</a></dt>509 <tt class="descname">set_sample2sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2sample_distance" title="Permalink to this definition">¶</a></dt> 278 510 <dd><p>Set detector sample_slit2sample_distance</p> 279 511 <p>: param distance: [distance, x_offset]</p> … … 282 514 <dl class="method"> 283 515 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_sample_aperture_size"> 284 <tt class="descname">set_sample_aperture_size</tt><big>(</big>< em>size</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample_aperture_size" title="Permalink to this definition">¶</a></dt>516 <tt class="descname">set_sample_aperture_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample_aperture_size" title="Permalink to this definition">¶</a></dt> 285 517 <dd><p>Set sample aperture size</p> 286 518 <p>: param size: [dia_value] or [xheight_value, yheight_value]</p> … … 289 521 <dl class="method"> 290 522 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_source2sample_distance"> 291 <tt class="descname">set_source2sample_distance</tt><big>(</big>< em>distance</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_source2sample_distance" title="Permalink to this definition">¶</a></dt>523 <tt class="descname">set_source2sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_source2sample_distance" title="Permalink to this definition">¶</a></dt> 292 524 <dd><p>Set detector source2sample_distance</p> 293 525 <p>: param distance: [distance, x_offset]</p> … … 296 528 <dl class="method"> 297 529 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_source_aperture_size"> 298 <tt class="descname">set_source_aperture_size</tt><big>(</big>< em>size</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_source_aperture_size" title="Permalink to this definition">¶</a></dt>530 <tt class="descname">set_source_aperture_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_source_aperture_size" title="Permalink to this definition">¶</a></dt> 299 531 <dd><p>Set source aperture size</p> 300 532 <p>: param size: [dia_value] or [x_value, y_value]</p> … … 303 535 <dl class="method"> 304 536 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_spectrum"> 305 <tt class="descname">set_spectrum</tt><big>(</big>< em>spectrum</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_spectrum" title="Permalink to this definition">¶</a></dt>537 <tt class="descname">set_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_spectrum" title="Permalink to this definition">¶</a></dt> 306 538 <dd><p>Set spectrum</p> 307 539 </dd></dl> … … 309 541 <dl class="method"> 310 542 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wave"> 311 <tt class="descname">set_wave</tt><big>(</big>< em>wavelength</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave" title="Permalink to this definition">¶</a></dt>543 <tt class="descname">set_wave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave" title="Permalink to this definition">¶</a></dt> 312 544 <dd><p>Set wavelength list or wavelength</p> 313 545 </dd></dl> … … 315 547 <dl class="method"> 316 548 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_list"> 317 <tt class="descname">set_wave_list</tt><big>(</big>< em>wavelength_list</em>, <em>wavelengthspread_list</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_list" title="Permalink to this definition">¶</a></dt>549 <tt class="descname">set_wave_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_list" title="Permalink to this definition">¶</a></dt> 318 550 <dd><p>Set wavelength and its spread list</p> 319 551 </dd></dl> … … 321 553 <dl class="method"> 322 554 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_spread"> 323 <tt class="descname">set_wave_spread</tt><big>(</big>< em>wavelength_spread</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_spread" title="Permalink to this definition">¶</a></dt>555 <tt class="descname">set_wave_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_spread" title="Permalink to this definition">¶</a></dt> 324 556 <dd><p>Set wavelength spread or wavelength spread</p> 325 557 </dd></dl> … … 327 559 <dl class="method"> 328 560 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength"> 329 <tt class="descname">set_wavelength</tt><big>(</big>< em>wavelength</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength" title="Permalink to this definition">¶</a></dt>561 <tt class="descname">set_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength" title="Permalink to this definition">¶</a></dt> 330 562 <dd><p>Set wavelength</p> 331 563 </dd></dl> … … 333 565 <dl class="method"> 334 566 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength_spread"> 335 <tt class="descname">set_wavelength_spread</tt><big>(</big>< em>wavelength_spread</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>567 <tt class="descname">set_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength_spread" title="Permalink to this definition">¶</a></dt> 336 568 <dd><p>Set wavelength spread</p> 337 569 </dd></dl> … … 339 571 <dl class="method"> 340 572 <dt id="sans.calculator.resolution_calculator.ResolutionCalculator.setup_tof"> 341 <tt class="descname">setup_tof</tt><big>(</big>< em>wavelength</em>, <em>wavelength_spread</em><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.setup_tof" title="Permalink to this definition">¶</a></dt>573 <tt class="descname">setup_tof</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.setup_tof" title="Permalink to this definition">¶</a></dt> 342 574 <dd><p>Setup all parameters in instrument</p> 343 575 <p>: param ind: index of lambda, etc</p> … … 357 589 <h3><a href="../index.html">Table Of Contents</a></h3> 358 590 <ul> 359 <li><a class="reference internal" href="#"> Resolution Calculator</a><ul>360 <li><a class="reference internal" href="# module-sans.calculator.resolution_calculator"><tt class="docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a></li>591 <li><a class="reference internal" href="#">resolution_calculator</a><ul> 592 <li><a class="reference internal" href="#sans-calculator-resolution-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a></li> 361 593 </ul> 362 594 </li> … … 365 597 <h4>Previous topic</h4> 366 598 <p class="topless"><a href="kiessig_calculator.html" 367 title="previous chapter">Kiessig Calculator</a></p> 599 title="previous chapter">kiessig_calculator</a></p> 600 <h4>Next topic</h4> 601 <p class="topless"><a href="slit_length_calculator.html" 602 title="next chapter">slit_length_calculator</a></p> 368 603 <h3>This Page</h3> 369 604 <ul class="this-page-menu"> … … 374 609 <h3>Quick search</h3> 375 610 <form class="search" action="../search.html" method="get"> 376 <input type="text" name="q" size="18"/>611 <input type="text" name="q" /> 377 612 <input type="submit" value="Go" /> 378 613 <input type="hidden" name="check_keywords" value="yes" /> … … 398 633 >modules</a> |</li> 399 634 <li class="right" > 400 <a href="kiessig_calculator.html" title="Kiessig Calculator" 635 <a href="slit_length_calculator.html" title="slit_length_calculator" 636 >next</a> |</li> 637 <li class="right" > 638 <a href="kiessig_calculator.html" title="kiessig_calculator" 401 639 >previous</a> |</li> 402 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>640 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 403 641 <li><a href="index.html" >Reference</a> »</li> 404 642 </ul> … … 406 644 <div class="footer"> 407 645 © Copyright 2010, Gervaise Alina. 408 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.646 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 409 647 </div> 410 648 </body> -
sanscalculator/docs/sphinx/html/api/slit_length_calculator.html
r771fe98 ra4f04f2 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>Slit Length Calculator — calculator v0.1.0 documentation</title> 11 <title>slit_length_calculator — calculator 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 <link rel="next" title="Kiessig Calculator" href="kiessig_calculator.html" /> 28 <link rel="prev" title="Instrument" href="instrument.html" /> 30 <link rel="prev" title="resolution_calculator" href="resolution_calculator.html" /> 29 31 </head> 30 32 <body> … … 39 41 >modules</a> |</li> 40 42 <li class="right" > 41 <a href="kiessig_calculator.html" title="Kiessig Calculator" 42 accesskey="N">next</a> |</li> 43 <li class="right" > 44 <a href="instrument.html" title="Instrument" 43 <a href="resolution_calculator.html" title="resolution_calculator" 45 44 accesskey="P">previous</a> |</li> 46 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>45 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 47 46 <li><a href="index.html" accesskey="U">Reference</a> »</li> 48 47 </ul> … … 55 54 56 55 <div class="section" id="slit-length-calculator"> 57 <h1> Slit Length Calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1>58 <div class="section" id=" module-sans.calculator.slit_length_calculator">59 < span id="sans-calculator-slit-length-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.slit_length_calculator" title="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>60 < p>This module is a small tool to allow user to quickly56 <h1>slit_length_calculator<a class="headerlink" href="#slit-length-calculator" title="Permalink to this headline">¶</a></h1> 57 <div class="section" id="sans-calculator-slit-length-calculator"> 58 <h2><a class="reference internal" href="#module-sans.calculator.slit_length_calculator" title="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="#sans-calculator-slit-length-calculator" title="Permalink to this headline">¶</a></h2> 59 <span class="target" id="module-sans.calculator.slit_length_calculator"></span><p>This module is a small tool to allow user to quickly 61 60 determine the slit length value of data.</p> 62 61 <dl class="class"> … … 66 65 <p>compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I , 67 66 and 3rd col. dI.: don’t need the 3rd)</p> 67 <dl class="attribute"> 68 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__class__"> 69 <tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__class__" title="Permalink to this definition">¶</a></dt> 70 <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 71 </dd></dl> 72 73 <dl class="attribute"> 74 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__delattr__"> 75 <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__delattr__" title="Permalink to this definition">¶</a></dt> 76 <dd><p>x.__delattr__(‘name’) <==> del x.name</p> 77 </dd></dl> 78 79 <dl class="attribute"> 80 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__dict__"> 81 <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x0226C6F0></em><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__dict__" title="Permalink to this definition">¶</a></dt> 82 <dd></dd></dl> 83 84 <dl class="attribute"> 85 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__getattribute__"> 86 <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt> 87 <dd><p>x.__getattribute__(‘name’) <==> x.name</p> 88 </dd></dl> 89 90 <dl class="attribute"> 91 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__hash__"> 92 <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__hash__" title="Permalink to this definition">¶</a></dt> 93 <dd><p>x.__hash__() <==> hash(x)</p> 94 </dd></dl> 95 96 <dl class="method"> 97 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__init__"> 98 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__init__" title="Permalink to this definition">¶</a></dt> 99 <dd></dd></dl> 100 101 <dl class="attribute"> 102 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__module__"> 103 <tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.slit_length_calculator'</em><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__module__" title="Permalink to this definition">¶</a></dt> 104 <dd></dd></dl> 105 106 <dl class="staticmethod"> 107 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__new__"> 108 <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__new__" title="Permalink to this definition">¶</a></dt> 109 <dd></dd></dl> 110 111 <dl class="method"> 112 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce__"> 113 <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce__" title="Permalink to this definition">¶</a></dt> 114 <dd><p>helper for pickle</p> 115 </dd></dl> 116 117 <dl class="method"> 118 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce_ex__"> 119 <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 120 <dd><p>helper for pickle</p> 121 </dd></dl> 122 123 <dl class="attribute"> 124 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__repr__"> 125 <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__repr__" title="Permalink to this definition">¶</a></dt> 126 <dd><p>x.__repr__() <==> repr(x)</p> 127 </dd></dl> 128 129 <dl class="attribute"> 130 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__setattr__"> 131 <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__setattr__" title="Permalink to this definition">¶</a></dt> 132 <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> 133 </dd></dl> 134 135 <dl class="attribute"> 136 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__str__"> 137 <tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__str__" title="Permalink to this definition">¶</a></dt> 138 <dd><p>x.__str__() <==> str(x)</p> 139 </dd></dl> 140 141 <dl class="attribute"> 142 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.__weakref__"> 143 <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.__weakref__" title="Permalink to this definition">¶</a></dt> 144 <dd><p>list of weak references to the object (if defined)</p> 145 </dd></dl> 146 68 147 <dl class="method"> 69 148 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length"> … … 74 153 <col class="field-body" /> 75 154 <tbody valign="top"> 76 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td>155 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td> 77 156 </tr> 78 157 </tbody> … … 87 166 <col class="field-body" /> 88 167 <tbody valign="top"> 89 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td>168 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td> 90 169 </tr> 91 170 </tbody> … … 95 174 <dl class="method"> 96 175 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data"> 97 <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> 98 <dd><blockquote> 99 <div>Receive two vector x, y and prepare the slit calculator for 100 computation.</div></blockquote> 176 <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt> 177 <dd><dl class="docutils"> 178 <dt>Receive two vector x, y and prepare the slit calculator for </dt> 179 <dd>computation.</dd> 180 </dl> 101 181 <table class="docutils field-list" frame="void" rules="none"> 102 182 <col class="field-name" /> 103 183 <col class="field-body" /> 104 184 <tbody valign="top"> 105 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">185 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 106 186 <li><strong>x</strong> – array</li> 107 187 <li><strong>y</strong> – array</li> … … 126 206 <h3><a href="../index.html">Table Of Contents</a></h3> 127 207 <ul> 128 <li><a class="reference internal" href="#"> Slit Length Calculator</a><ul>129 <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>208 <li><a class="reference internal" href="#">slit_length_calculator</a><ul> 209 <li><a class="reference internal" href="#sans-calculator-slit-length-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.slit_length_calculator</span></tt></a></li> 130 210 </ul> 131 211 </li> … … 133 213 134 214 <h4>Previous topic</h4> 135 <p class="topless"><a href="instrument.html" 136 title="previous chapter">Instrument</a></p> 137 <h4>Next topic</h4> 138 <p class="topless"><a href="kiessig_calculator.html" 139 title="next chapter">Kiessig Calculator</a></p> 215 <p class="topless"><a href="resolution_calculator.html" 216 title="previous chapter">resolution_calculator</a></p> 140 217 <h3>This Page</h3> 141 218 <ul class="this-page-menu"> … … 146 223 <h3>Quick search</h3> 147 224 <form class="search" action="../search.html" method="get"> 148 <input type="text" name="q" size="18"/>225 <input type="text" name="q" /> 149 226 <input type="submit" value="Go" /> 150 227 <input type="hidden" name="check_keywords" value="yes" /> … … 170 247 >modules</a> |</li> 171 248 <li class="right" > 172 <a href="kiessig_calculator.html" title="Kiessig Calculator" 173 >next</a> |</li> 174 <li class="right" > 175 <a href="instrument.html" title="Instrument" 249 <a href="resolution_calculator.html" title="resolution_calculator" 176 250 >previous</a> |</li> 177 <li><a href="../index.html">calculator v0.1.0 documentation</a> »</li>251 <li><a href="../index.html">calculator 0.1.0 documentation</a> »</li> 178 252 <li><a href="index.html" >Reference</a> »</li> 179 253 </ul> … … 181 255 <div class="footer"> 182 256 © Copyright 2010, Gervaise Alina. 183 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.257 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 184 258 </div> 185 259 </body>
Note: See TracChangeset
for help on using the changeset viewer.
