source: sasview/_modules/sas/models/ReflModel.html @ a462c6a

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

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 41.3 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.models.ReflModel &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../../index.html" />
28    <link rel="up" title="sas.models" href="../models.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../index.html" >Module code</a> &raquo;</li>
42          <li><a href="../models.html" accesskey="U">sas.models</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.models.ReflModel</h1><div class="highlight"><pre>
52<span class="c">##############################################################################</span>
53<span class="c"># This software was developed by the University of Tennessee as part of the</span>
54<span class="c"># Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
55<span class="c"># project funded by the US National Science Foundation.</span>
56<span class="c">#</span>
57<span class="c"># If you use DANSE applications to do scientific research that leads to</span>
58<span class="c"># publication, we ask that you acknowledge the use of the software with the</span>
59<span class="c"># following sentence:</span>
60<span class="c">#</span>
61<span class="c"># This work benefited from DANSE software developed under NSF award DMR-0520547</span>
62<span class="c">#</span>
63<span class="c"># Copyright 2008-2011, University of Tennessee</span>
64<span class="c">##############################################################################</span>
65
66<span class="sd">&quot;&quot;&quot; </span>
67<span class="sd">Provide functionality for a C extension model</span>
68
69<span class="sd">.. WARNING::</span>
70
71<span class="sd">   THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY</span>
72<span class="sd">   DO NOT MODIFY THIS FILE, MODIFY</span>
73<span class="sd">   src/sas/models/include/refl.h</span>
74<span class="sd">   AND RE-RUN THE GENERATOR SCRIPT</span>
75<span class="sd">&quot;&quot;&quot;</span>
76
77<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
78<span class="kn">from</span> <span class="nn">sas.models.sas_extension.c_models</span> <span class="kn">import</span> <span class="n">CReflModel</span>
79
80<div class="viewcode-block" id="create_ReflModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.create_ReflModel">[docs]</a><span class="k">def</span> <span class="nf">create_ReflModel</span><span class="p">():</span>
81    <span class="sd">&quot;&quot;&quot;</span>
82<span class="sd">       Create a model instance</span>
83<span class="sd">    &quot;&quot;&quot;</span>
84    <span class="n">obj</span> <span class="o">=</span> <span class="n">ReflModel</span><span class="p">()</span>
85    <span class="c"># CReflModel.__init__(obj) is called by</span>
86    <span class="c"># the ReflModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="ReflModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel">[docs]</a><span class="k">class</span> <span class="nc">ReflModel</span><span class="p">(</span><span class="n">CReflModel</span><span class="p">,</span> <span class="n">BaseComponent</span><span class="p">):</span>
90    <span class="sd">&quot;&quot;&quot; </span>
91<span class="sd">    Class that evaluates a ReflModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/refl.h.</span>
93<span class="sd">    Refer to that file and the structure it contains</span>
94<span class="sd">    for details of the model.</span>
95<span class="sd">    </span>
96<span class="sd">    List of default parameters:</span>
97
98<span class="sd">    * n_layers        = 1.0 </span>
99<span class="sd">    * scale           = 1.0 </span>
100<span class="sd">    * thick_inter0    = 1.0 [A]</span>
101<span class="sd">    * func_inter0     = 0.0 </span>
102<span class="sd">    * sld_bottom0     = 2.07e-06 [1/A^(2)]</span>
103<span class="sd">    * sld_medium      = 1e-06 [1/A^(2)]</span>
104<span class="sd">    * background      = 0.0 </span>
105<span class="sd">    * sld_flat1       = 4e-06 [1/A^(2)]</span>
106<span class="sd">    * sld_flat2       = 3.5e-06 [1/A^(2)]</span>
107<span class="sd">    * sld_flat3       = 4e-06 [1/A^(2)]</span>
108<span class="sd">    * sld_flat4       = 3.5e-06 [1/A^(2)]</span>
109<span class="sd">    * sld_flat5       = 4e-06 [1/A^(2)]</span>
110<span class="sd">    * sld_flat6       = 3.5e-06 [1/A^(2)]</span>
111<span class="sd">    * sld_flat7       = 4e-06 [1/A^(2)]</span>
112<span class="sd">    * sld_flat8       = 3.5e-06 [1/A^(2)]</span>
113<span class="sd">    * sld_flat9       = 4e-06 [1/A^(2)]</span>
114<span class="sd">    * sld_flat10      = 3.5e-06 [1/A^(2)]</span>
115<span class="sd">    * thick_inter1    = 1.0 [A]</span>
116<span class="sd">    * thick_inter2    = 1.0 [A]</span>
117<span class="sd">    * thick_inter3    = 1.0 [A]</span>
118<span class="sd">    * thick_inter4    = 1.0 [A]</span>
119<span class="sd">    * thick_inter5    = 1.0 [A]</span>
120<span class="sd">    * thick_inter6    = 1.0 [A]</span>
121<span class="sd">    * thick_inter7    = 1.0 [A]</span>
122<span class="sd">    * thick_inter8    = 1.0 [A]</span>
123<span class="sd">    * thick_inter9    = 1.0 [A]</span>
124<span class="sd">    * thick_inter10   = 1.0 [A]</span>
125<span class="sd">    * thick_flat1     = 10.0 [A]</span>
126<span class="sd">    * thick_flat2     = 100.0 [A]</span>
127<span class="sd">    * thick_flat3     = 100.0 [A]</span>
128<span class="sd">    * thick_flat4     = 100.0 [A]</span>
129<span class="sd">    * thick_flat5     = 100.0 [A]</span>
130<span class="sd">    * thick_flat6     = 100.0 [A]</span>
131<span class="sd">    * thick_flat7     = 100.0 [A]</span>
132<span class="sd">    * thick_flat8     = 100.0 [A]</span>
133<span class="sd">    * thick_flat9     = 100.0 [A]</span>
134<span class="sd">    * thick_flat10    = 100.0 [A]</span>
135<span class="sd">    * func_inter1     = 0.0 </span>
136<span class="sd">    * func_inter2     = 0.0 </span>
137<span class="sd">    * func_inter3     = 0.0 </span>
138<span class="sd">    * func_inter4     = 0.0 </span>
139<span class="sd">    * func_inter5     = 0.0 </span>
140<span class="sd">    * func_inter6     = 0.0 </span>
141<span class="sd">    * func_inter7     = 0.0 </span>
142<span class="sd">    * func_inter8     = 0.0 </span>
143<span class="sd">    * func_inter9     = 0.0 </span>
144<span class="sd">    * func_inter10    = 0.0 </span>
145
146<span class="sd">    &quot;&quot;&quot;</span>
147       
148    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">multfactor</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
149        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
150        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
151       
152        <span class="c"># Initialize BaseComponent first, then sphere</span>
153        <span class="n">BaseComponent</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
154        <span class="c">#apply(CReflModel.__init__, (self,)) </span>
155
156        <span class="n">CReflModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
157        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
158                       
159        <span class="c">## Name of the model</span>
160        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;ReflModel&quot;</span>
161        <span class="c">## Model description</span>
162        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;</span>
163<span class="s">        Calculate neutron reflectivity using the Parratt iterative formula</span>
164<span class="s">                Parameters:</span>
165<span class="s">                background:background</span>
166<span class="s">                scale: scale factor</span>
167<span class="s">                sld_bottom0: the SLD of the substrate</span>
168<span class="s">                sld_medium: the SLD of the incident medium</span>
169<span class="s">                or superstrate</span>
170<span class="s">                sld_flatN: the SLD of the flat region of</span>
171<span class="s">                the N&#39;th layer</span>
172<span class="s">                thick_flatN: the thickness of the flat</span>
173<span class="s">                region of the N&#39;th layer</span>
174<span class="s">                func_interN: the function used to describe</span>
175<span class="s">                the interface of the N&#39;th layer</span>
176<span class="s">                thick_interN: the thickness of the interface</span>
177<span class="s">                of the N&#39;th layer</span>
178<span class="s">                Note: the layer number starts to increase</span>
179<span class="s">                from the bottom (substrate) to the top.</span>
180<span class="s">        &quot;&quot;&quot;</span>
181       
182        <span class="c">## Parameter details [units, min, max]</span>
183        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
184        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;n_layers&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
185        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;scale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
186        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
187        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
188        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_bottom0&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
189        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_medium&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
190        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;background&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
191        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
192        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
193        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
194        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
195        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
196        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
197        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
198        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
199        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
200        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sld_flat10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[1/A^(2)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
201        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
202        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
203        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
204        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
205        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
206        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
207        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
208        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
209        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
210        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_inter10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
211        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
212        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
213        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
214        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
215        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
216        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
217        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
218        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
219        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
220        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;thick_flat10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[A]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
221        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter1&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
222        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter2&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
223        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter3&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
224        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter4&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
225        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter5&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
226        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter6&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
227        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter7&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
228        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter8&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
229        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter9&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
230        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;func_inter10&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
231
232        <span class="c">## fittable parameters</span>
233        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[]</span>
234       
235        <span class="c">## non-fittable parameters</span>
236        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;n_layers&#39;</span><span class="p">,</span>
237                             <span class="s">&#39;func_inter0&#39;</span><span class="p">,</span>
238                             <span class="s">&#39;func_inter1&#39;</span><span class="p">,</span>
239                             <span class="s">&#39;func_inter2&#39;</span><span class="p">,</span>
240                             <span class="s">&#39;func_inter3&#39;</span><span class="p">,</span>
241                             <span class="s">&#39;func_inter4&#39;</span><span class="p">,</span>
242                             <span class="s">&#39;func_inter5&#39;</span><span class="p">,</span>
243                             <span class="s">&#39;func_inter5&#39;</span><span class="p">,</span>
244                             <span class="s">&#39;func_inter7&#39;</span><span class="p">,</span>
245                             <span class="s">&#39;func_inter8&#39;</span><span class="p">,</span>
246                             <span class="s">&#39;func_inter9&#39;</span><span class="p">,</span>
247                             <span class="s">&#39;func_inter10&#39;</span><span class="p">]</span>
248       
249        <span class="c">## parameters with orientation</span>
250        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
251
252        <span class="c">## parameters with magnetism</span>
253        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
254
255        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
256        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
257       
258    <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
259        <span class="sd">&quot;&quot;&quot;</span>
260<span class="sd">        restore the state of a model from pickle</span>
261<span class="sd">        &quot;&quot;&quot;</span>
262        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="n">state</span>
263       
264    <span class="k">def</span> <span class="nf">__reduce_ex__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span>
265        <span class="sd">&quot;&quot;&quot;</span>
266<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
267<span class="sd">        c model.</span>
268<span class="sd">        &quot;&quot;&quot;</span>
269        <span class="n">state</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">)</span>
270        <span class="k">return</span> <span class="p">(</span><span class="n">create_ReflModel</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">(),</span> <span class="n">state</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
271       
272<div class="viewcode-block" id="ReflModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.clone">[docs]</a>    <span class="k">def</span> <span class="nf">clone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
273        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
274        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clone</span><span class="p">(</span><span class="n">ReflModel</span><span class="p">())</span>   
275        </div>
276<div class="viewcode-block" id="ReflModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.run">[docs]</a>    <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mf">0.0</span><span class="p">):</span>
277        <span class="sd">&quot;&quot;&quot; </span>
278<span class="sd">        Evaluate the model</span>
279<span class="sd">        </span>
280<span class="sd">        :param x: input q, or [q,phi]</span>
281<span class="sd">        </span>
282<span class="sd">        :return: scattering function P(q)</span>
283<span class="sd">        </span>
284<span class="sd">        &quot;&quot;&quot;</span>
285        <span class="k">return</span> <span class="n">CReflModel</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
286   </div>
287<div class="viewcode-block" id="ReflModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.runXY">[docs]</a>    <span class="k">def</span> <span class="nf">runXY</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mf">0.0</span><span class="p">):</span>
288        <span class="sd">&quot;&quot;&quot; </span>
289<span class="sd">        Evaluate the model in cartesian coordinates</span>
290<span class="sd">        </span>
291<span class="sd">        :param x: input q, or [qx, qy]</span>
292<span class="sd">        </span>
293<span class="sd">        :return: scattering function P(q)</span>
294<span class="sd">        </span>
295<span class="sd">        &quot;&quot;&quot;</span>
296        <span class="k">return</span> <span class="n">CReflModel</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
297        </div>
298<div class="viewcode-block" id="ReflModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.evalDistribution">[docs]</a>    <span class="k">def</span> <span class="nf">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
299        <span class="sd">&quot;&quot;&quot; </span>
300<span class="sd">        Evaluate the model in cartesian coordinates</span>
301<span class="sd">        </span>
302<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
303<span class="sd">        </span>
304<span class="sd">        :return: scattering function P(q[])</span>
305<span class="sd">        </span>
306<span class="sd">        &quot;&quot;&quot;</span>
307        <span class="k">return</span> <span class="n">CReflModel</span><span class="o">.</span><span class="n">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
308        </div>
309<div class="viewcode-block" id="ReflModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.calculate_ER">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
310        <span class="sd">&quot;&quot;&quot; </span>
311<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
312<span class="sd">        </span>
313<span class="sd">        :return: the value of the effective radius</span>
314<span class="sd">        </span>
315<span class="sd">        &quot;&quot;&quot;</span>       
316        <span class="k">return</span> <span class="n">CReflModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
317        </div>
318<div class="viewcode-block" id="ReflModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.calculate_VR">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
319        <span class="sd">&quot;&quot;&quot; </span>
320<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
321<span class="sd">        </span>
322<span class="sd">        :return: the value of the volf ratio</span>
323<span class="sd">        </span>
324<span class="sd">        &quot;&quot;&quot;</span>       
325        <span class="k">return</span> <span class="n">CReflModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
326              </div>
327<div class="viewcode-block" id="ReflModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ReflModel.ReflModel.set_dispersion">[docs]</a>    <span class="k">def</span> <span class="nf">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="p">):</span>
328        <span class="sd">&quot;&quot;&quot;</span>
329<span class="sd">        Set the dispersion object for a model parameter</span>
330<span class="sd">        </span>
331<span class="sd">        :param parameter: name of the parameter [string]</span>
332<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
333<span class="sd">        </span>
334<span class="sd">        &quot;&quot;&quot;</span>
335        <span class="k">return</span> <span class="n">CReflModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
336               <span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="o">.</span><span class="n">cdisp</span><span class="p">)</span>
337       
338   
339<span class="c"># End of file</span>
340</pre></div></div></div>
341
342          </div>
343        </div>
344      </div>
345      <div class="sphinxsidebar">
346        <div class="sphinxsidebarwrapper">
347<div id="searchbox" style="display: none">
348  <h3>Quick search</h3>
349    <form class="search" action="../../../search.html" method="get">
350      <input type="text" name="q" />
351      <input type="submit" value="Go" />
352      <input type="hidden" name="check_keywords" value="yes" />
353      <input type="hidden" name="area" value="default" />
354    </form>
355    <p class="searchtip" style="font-size: 90%">
356    Enter search terms or a module, class or function name.
357    </p>
358</div>
359<script type="text/javascript">$('#searchbox').show(0);</script>
360        </div>
361      </div>
362      <div class="clearer"></div>
363    </div>
364    <div class="related">
365      <h3>Navigation</h3>
366      <ul>
367        <li class="right" style="margin-right: 10px">
368          <a href="../../../genindex.html" title="General Index"
369             >index</a></li>
370        <li class="right" >
371          <a href="../../../py-modindex.html" title="Python Module Index"
372             >modules</a> |</li>
373        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
374          <li><a href="../../index.html" >Module code</a> &raquo;</li>
375          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
376      </ul>
377    </div>
378    <div class="footer">
379        &copy; Copyright 2013, The SasView Project.
380      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
381    </div>
382  </body>
383</html>
Note: See TracBrowser for help on using the repository browser.