source: sasview/_modules/sas/models/ParallelepipedModel.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: 30.4 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.ParallelepipedModel &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.ParallelepipedModel</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/parallelepiped.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">CParallelepipedModel</span>
79
80<div class="viewcode-block" id="create_ParallelepipedModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.create_ParallelepipedModel">[docs]</a><span class="k">def</span> <span class="nf">create_ParallelepipedModel</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">ParallelepipedModel</span><span class="p">()</span>
85    <span class="c"># CParallelepipedModel.__init__(obj) is called by</span>
86    <span class="c"># the ParallelepipedModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="ParallelepipedModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel">[docs]</a><span class="k">class</span> <span class="nc">ParallelepipedModel</span><span class="p">(</span><span class="n">CParallelepipedModel</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 ParallelepipedModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/parallelepiped.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">    * scale           = 1.0 </span>
99<span class="sd">    * short_a         = 35.0 [A]</span>
100<span class="sd">    * short_b         = 75.0 [A]</span>
101<span class="sd">    * long_c          = 400.0 [A]</span>
102<span class="sd">    * sldPipe         = 6.3e-06 [1/A^(2)]</span>
103<span class="sd">    * sldSolv         = 1e-06 [1/A^(2)]</span>
104<span class="sd">    * background      = 0.0 [1/cm]</span>
105<span class="sd">    * parallel_theta  = 0.0 [deg]</span>
106<span class="sd">    * parallel_phi    = 0.0 [deg]</span>
107<span class="sd">    * parallel_psi    = 0.0 [deg]</span>
108<span class="sd">    * M0_sld_pipe     = 0.0 [1/A^(2)]</span>
109<span class="sd">    * M_theta_pipe    = 0.0 [deg]</span>
110<span class="sd">    * M_phi_pipe      = 0.0 [deg]</span>
111<span class="sd">    * M0_sld_solv     = 0.0 [1/A^(2)]</span>
112<span class="sd">    * M_theta_solv    = 0.0 [deg]</span>
113<span class="sd">    * M_phi_solv      = 0.0 [deg]</span>
114<span class="sd">    * Up_frac_i       = 0.5 [u/(u+d)]</span>
115<span class="sd">    * Up_frac_f       = 0.5 [u/(u+d)]</span>
116<span class="sd">    * Up_theta        = 0.0 [deg]</span>
117
118<span class="sd">    &quot;&quot;&quot;</span>
119       
120    <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>
121        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
122        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
123       
124        <span class="c"># Initialize BaseComponent first, then sphere</span>
125        <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>
126        <span class="c">#apply(CParallelepipedModel.__init__, (self,)) </span>
127
128        <span class="n">CParallelepipedModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
129        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
130                       
131        <span class="c">## Name of the model</span>
132        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;ParallelepipedModel&quot;</span>
133        <span class="c">## Model description</span>
134        <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>
135<span class="s">         Form factor for a rectangular solid with uniform scattering length density.</span>
136<span class="s">                </span>
137<span class="s">                scale:Scale factor</span>
138<span class="s">                short_a: length of short edge  [A]</span>
139<span class="s">                short_b: length of another short edge [A]</span>
140<span class="s">                long_c: length of long edge  of the parallelepiped [A]</span>
141<span class="s">                sldPipe: Pipe_sld</span>
142<span class="s">                sldSolv: solvent_sld</span>
143<span class="s">                background:Incoherent Background [1/cm]</span>
144<span class="s">        &quot;&quot;&quot;</span>
145       
146        <span class="c">## Parameter details [units, min, max]</span>
147        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
148        <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>
149        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;short_a&#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>
150        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;short_b&#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>
151        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;long_c&#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>
152        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sldPipe&#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>
153        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;sldSolv&#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>
154        <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;[1/cm]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
155        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;parallel_theta&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
156        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;parallel_phi&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
157        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;parallel_psi&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
158        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_sld_pipe&#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>
159        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_pipe&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
160        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_pipe&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
161        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M0_sld_solv&#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>
162        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_theta_solv&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
163        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;M_phi_solv&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
164        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Up_frac_i&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[u/(u+d)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
165        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Up_frac_f&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[u/(u+d)]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
166        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;Up_theta&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;[deg]&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
167
168        <span class="c">## fittable parameters</span>
169        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;short_a.width&#39;</span><span class="p">,</span>
170                      <span class="s">&#39;short_b.width&#39;</span><span class="p">,</span>
171                      <span class="s">&#39;long_c.width&#39;</span><span class="p">,</span>
172                      <span class="s">&#39;parallel_phi.width&#39;</span><span class="p">,</span>
173                      <span class="s">&#39;parallel_psi.width&#39;</span><span class="p">,</span>
174                      <span class="s">&#39;parallel_theta.width&#39;</span><span class="p">]</span>
175       
176        <span class="c">## non-fittable parameters</span>
177        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
178       
179        <span class="c">## parameters with orientation</span>
180        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;parallel_phi&#39;</span><span class="p">,</span>
181                                   <span class="s">&#39;parallel_psi&#39;</span><span class="p">,</span>
182                                   <span class="s">&#39;parallel_theta&#39;</span><span class="p">,</span>
183                                   <span class="s">&#39;parallel_phi.width&#39;</span><span class="p">,</span>
184                                   <span class="s">&#39;parallel_psi.width&#39;</span><span class="p">,</span>
185                                   <span class="s">&#39;parallel_theta.width&#39;</span><span class="p">,</span>
186                                   <span class="s">&#39;M0_sld_pipe&#39;</span><span class="p">,</span>
187                                   <span class="s">&#39;M_theta_pipe&#39;</span><span class="p">,</span>
188                                   <span class="s">&#39;M_phi_pipe&#39;</span><span class="p">,</span>
189                                   <span class="s">&#39;M0_sld_solv&#39;</span><span class="p">,</span>
190                                   <span class="s">&#39;M_theta_solv&#39;</span><span class="p">,</span>
191                                   <span class="s">&#39;M_phi_solv&#39;</span><span class="p">,</span>
192                                   <span class="s">&#39;Up_frac_i&#39;</span><span class="p">,</span>
193                                   <span class="s">&#39;Up_frac_f&#39;</span><span class="p">,</span>
194                                   <span class="s">&#39;Up_theta&#39;</span><span class="p">]</span>
195
196        <span class="c">## parameters with magnetism</span>
197        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;M0_sld_pipe&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_pipe&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_pipe&#39;</span><span class="p">,</span> <span class="s">&#39;M0_sld_solv&#39;</span><span class="p">,</span> <span class="s">&#39;M_theta_solv&#39;</span><span class="p">,</span> <span class="s">&#39;M_phi_solv&#39;</span><span class="p">,</span> <span class="s">&#39;Up_frac_i&#39;</span><span class="p">,</span> <span class="s">&#39;Up_frac_f&#39;</span><span class="p">,</span> <span class="s">&#39;Up_theta&#39;</span><span class="p">]</span>
198
199        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
200        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
201       
202    <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>
203        <span class="sd">&quot;&quot;&quot;</span>
204<span class="sd">        restore the state of a model from pickle</span>
205<span class="sd">        &quot;&quot;&quot;</span>
206        <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>
207       
208    <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>
209        <span class="sd">&quot;&quot;&quot;</span>
210<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
211<span class="sd">        c model.</span>
212<span class="sd">        &quot;&quot;&quot;</span>
213        <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>
214        <span class="k">return</span> <span class="p">(</span><span class="n">create_ParallelepipedModel</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>
215       
216<div class="viewcode-block" id="ParallelepipedModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
217        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
218        <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">ParallelepipedModel</span><span class="p">())</span>   
219        </div>
220<div class="viewcode-block" id="ParallelepipedModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
221        <span class="sd">&quot;&quot;&quot; </span>
222<span class="sd">        Evaluate the model</span>
223<span class="sd">        </span>
224<span class="sd">        :param x: input q, or [q,phi]</span>
225<span class="sd">        </span>
226<span class="sd">        :return: scattering function P(q)</span>
227<span class="sd">        </span>
228<span class="sd">        &quot;&quot;&quot;</span>
229        <span class="k">return</span> <span class="n">CParallelepipedModel</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>
230   </div>
231<div class="viewcode-block" id="ParallelepipedModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
232        <span class="sd">&quot;&quot;&quot; </span>
233<span class="sd">        Evaluate the model in cartesian coordinates</span>
234<span class="sd">        </span>
235<span class="sd">        :param x: input q, or [qx, qy]</span>
236<span class="sd">        </span>
237<span class="sd">        :return: scattering function P(q)</span>
238<span class="sd">        </span>
239<span class="sd">        &quot;&quot;&quot;</span>
240        <span class="k">return</span> <span class="n">CParallelepipedModel</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>
241        </div>
242<div class="viewcode-block" id="ParallelepipedModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
243        <span class="sd">&quot;&quot;&quot; </span>
244<span class="sd">        Evaluate the model in cartesian coordinates</span>
245<span class="sd">        </span>
246<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
247<span class="sd">        </span>
248<span class="sd">        :return: scattering function P(q[])</span>
249<span class="sd">        </span>
250<span class="sd">        &quot;&quot;&quot;</span>
251        <span class="k">return</span> <span class="n">CParallelepipedModel</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>
252        </div>
253<div class="viewcode-block" id="ParallelepipedModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
254        <span class="sd">&quot;&quot;&quot; </span>
255<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
256<span class="sd">        </span>
257<span class="sd">        :return: the value of the effective radius</span>
258<span class="sd">        </span>
259<span class="sd">        &quot;&quot;&quot;</span>       
260        <span class="k">return</span> <span class="n">CParallelepipedModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
261        </div>
262<div class="viewcode-block" id="ParallelepipedModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
263        <span class="sd">&quot;&quot;&quot; </span>
264<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
265<span class="sd">        </span>
266<span class="sd">        :return: the value of the volf ratio</span>
267<span class="sd">        </span>
268<span class="sd">        &quot;&quot;&quot;</span>       
269        <span class="k">return</span> <span class="n">CParallelepipedModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
270              </div>
271<div class="viewcode-block" id="ParallelepipedModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.ParallelepipedModel.ParallelepipedModel.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>
272        <span class="sd">&quot;&quot;&quot;</span>
273<span class="sd">        Set the dispersion object for a model parameter</span>
274<span class="sd">        </span>
275<span class="sd">        :param parameter: name of the parameter [string]</span>
276<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
277<span class="sd">        </span>
278<span class="sd">        &quot;&quot;&quot;</span>
279        <span class="k">return</span> <span class="n">CParallelepipedModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
280               <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>
281       
282   
283<span class="c"># End of file</span>
284</pre></div></div></div>
285
286          </div>
287        </div>
288      </div>
289      <div class="sphinxsidebar">
290        <div class="sphinxsidebarwrapper">
291<div id="searchbox" style="display: none">
292  <h3>Quick search</h3>
293    <form class="search" action="../../../search.html" method="get">
294      <input type="text" name="q" />
295      <input type="submit" value="Go" />
296      <input type="hidden" name="check_keywords" value="yes" />
297      <input type="hidden" name="area" value="default" />
298    </form>
299    <p class="searchtip" style="font-size: 90%">
300    Enter search terms or a module, class or function name.
301    </p>
302</div>
303<script type="text/javascript">$('#searchbox').show(0);</script>
304        </div>
305      </div>
306      <div class="clearer"></div>
307    </div>
308    <div class="related">
309      <h3>Navigation</h3>
310      <ul>
311        <li class="right" style="margin-right: 10px">
312          <a href="../../../genindex.html" title="General Index"
313             >index</a></li>
314        <li class="right" >
315          <a href="../../../py-modindex.html" title="Python Module Index"
316             >modules</a> |</li>
317        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
318          <li><a href="../../index.html" >Module code</a> &raquo;</li>
319          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
320      </ul>
321    </div>
322    <div class="footer">
323        &copy; Copyright 2013, The SasView Project.
324      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
325    </div>
326  </body>
327</html>
Note: See TracBrowser for help on using the repository browser.