Changeset 14e9eb3 in sasview for calculator/docs/sphinx/_build/html/api/sld_calculator.html

Timestamp:

May 28, 2010 1:24:47 PM (15 years ago)

Author:

Gervaise Alina <gervyh@…>

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:

25a2ee3

Parents:

2882fb5

Message:

working on documentation

File:

• calculator/docs/sphinx/_build/html/api/sld_calculator.html (modified) (7 diffs)

calculator/docs/sphinx/_build/html/api/sld_calculator.html

@@ -25 +25 @@
     <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />
     <link rel="up" title="Reference" href="index.html" />
+    <link rel="next" title="Slit Length Calculator" href="slit_length_calculator.html" />
     <link rel="prev" title="Reference" href="index.html" /> 
   </head>
@@ -37 +38 @@
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="slit_length_calculator.html" title="Slit Length Calculator"
+             accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="index.html" title="Reference"
@@ -54 +58 @@
 <div class="section" id="module-sans.calculator.sld_calculator">
 <span id="sans-calculator-sld-calculator"></span><h2><a class="reference internal" href="#module-sans.calculator.sld_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.sld_calculator</span></tt></a><a class="headerlink" href="#module-sans.calculator.sld_calculator" title="Permalink to this headline">¶</a></h2>
-<p>This module intends to compute the neutron scattering length density of molecule
-&#64;author: Gervaise B. Alina</p>
+<p>This module intends to compute the neutron scattering length density 
+of a molecule.It uses methods of the periodictable package to provide 
+easy user interface for  Sld calculator applications.</p>
 <dl class="class">
 <dt id="sans.calculator.sld_calculator.SldCalculator">
 <em class="property">class </em><tt class="descclassname">sans.calculator.sld_calculator.</tt><tt class="descname">SldCalculator</tt><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
-<p>compute neutron SLD and related parameters</p>
-<dl class="method">
-<dt id="sans.calculator.sld_calculator.SldCalculator.calculate_coherence_im">
-<tt class="descname">calculate_coherence_im</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.calculate_coherence_im" title="Permalink to this definition">¶</a></dt>
-<dd>Compute imaginary part of the absorption</dd></dl>
-
+<p>Given a molecule, a density and a wavelength, this class 
+determine scattering length density.</p>
+<p>Example: To get the sld value and the length 1/e the following 
+methods need to be called in this later order:</p>
+<div class="highlight-python"><pre>formula = "H2O"
+density = 1.0
+wavelength = 6.0
+sld_calculator = SldCalculator()
+sld_calculator.set_value(formula, density, wavelength) 
+sld_real, sld_im, _ = sld_calculator.calculate_neutron_sld()
+result : sld = sld_real +i sld_im</pre>
+</div>
+<p>Note: <strong>set_value()</strong> and <strong>calculate_neutron_sld()</strong> methods must
+be called in this order prior calling <strong>calculate_length()</strong> to get 
+the proper result.</p>
 <dl class="method">
 <dt id="sans.calculator.sld_calculator.SldCalculator.calculate_length">
@@ -75 +89 @@
 <tt class="descname">calculate_neutron_sld</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.calculate_neutron_sld" title="Permalink to this definition">¶</a></dt>
 <dd>Compute the neutron SLD for a given molecule
-&#64;return absorp: absorption
-&#64;return coh: coherence cross section
+&#64;return sld_real : real part of the sld value
+&#64;return sld_im: imaginary part of the sld value
 &#64;return inc: incoherence cross section</dd></dl>
 
@@ -87 +101 @@
 <dl class="method">
 <dt id="sans.calculator.sld_calculator.SldCalculator.set_value">
-<tt class="descname">set_value</tt><big>(</big><em>user_formula</em>, <em>density</em>, <em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.set_value" title="Permalink to this definition">¶</a></dt>
-<dd>Store values of density and wavelength into the calculator 
-and compute the volume</dd></dl>
+<tt class="descname">set_value</tt><big>(</big><em>formula</em>, <em>density</em>, <em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.sld_calculator.SldCalculator.set_value" title="Permalink to this definition">¶</a></dt>
+<dd>Store values into the sld calculator and compute the corresponding
+volume.</dd></dl>
 
 </dd></dl>
@@ -113 +127 @@
   <p class="topless"><a href="index.html"
                         title="previous chapter">Reference</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="slit_length_calculator.html"
+                        title="next chapter">Slit Length Calculator</a></p>
   <h3>This Page</h3>
   <ul class="this-page-menu">
@@ -145 +162 @@
              >modules</a> |</li>
         <li class="right" >
+          <a href="slit_length_calculator.html" title="Slit Length Calculator"
+             >next</a> |</li>
+        <li class="right" >
           <a href="index.html" title="Reference"
              >previous</a> |</li>