source: sasview/sansmodels/docs/sphinx/html/api/StickyHSStructure.html @ 6232a6f

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 6232a6f was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 22.6 KB
RevLine 
[512573a]1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
[c0d873f]6
[512573a]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[c0d873f]11    <title>StickyHSStructure &mdash; sansmodels 0.1.0 documentation</title>
12   
[512573a]13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
[c0d873f]15   
[512573a]16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
[c0d873f]28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
[512573a]29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="SubComponent" href="SubComponent.html" />
31    <link rel="prev" title="StackedDisksModel" href="StackedDisksModel.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="SubComponent.html" title="SubComponent"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="StackedDisksModel.html" title="StackedDisksModel"
48             accesskey="P">previous</a> |</li>
[c0d873f]49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="stickyhsstructure">
60<h1>StickyHSStructure<a class="headerlink" href="#stickyhsstructure" title="Permalink to this headline">¶</a></h1>
[c0d873f]61<div class="section" id="sans-models-stickyhsstructure">
62<h2><a class="reference internal" href="#module-sans.models.StickyHSStructure" title="sans.models.StickyHSStructure"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.StickyHSStructure</span></tt></a><a class="headerlink" href="#sans-models-stickyhsstructure" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.StickyHSStructure"></span><p>Provide functionality for a C extension model</p>
[512573a]64<table class="docutils field-list" frame="void" rules="none">
65<col class="field-name" />
66<col class="field-body" />
67<tbody valign="top">
[c0d873f]68<tr class="field-odd field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
[512573a]69DO NOT MODIFY THIS FILE, MODIFY ..c_extensionsStickyHS.h
70AND RE-RUN THE GENERATOR SCRIPT</td>
71</tr>
72</tbody>
73</table>
74<dl class="class">
75<dt id="sans.models.StickyHSStructure.StickyHSStructure">
76<em class="property">class </em><tt class="descclassname">sans.models.StickyHSStructure.</tt><tt class="descname">StickyHSStructure</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure" title="Permalink to this definition">¶</a></dt>
77<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CStickyHSStructure</span></tt>, <a class="reference internal" href="BaseComponent.html#sans.models.BaseComponent.BaseComponent" title="sans.models.BaseComponent.BaseComponent"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.BaseComponent.BaseComponent</span></tt></a></p>
78<p>Class that evaluates a StickyHSStructure model.
79This file was auto-generated from ..c_extensionsStickyHS.h.
80Refer to that file and the structure it contains
81for details of the model.
82List of default parameters:</p>
83<blockquote>
84<div>effect_radius   = 50.0 [A]
85volfraction     = 0.1
86perturb         = 0.05
87stickiness      = 0.2</div></blockquote>
88<dl class="method">
[c0d873f]89<dt id="sans.models.StickyHSStructure.StickyHSStructure.__add__">
90<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__add__" title="Permalink to this definition">¶</a></dt>
91<dd></dd></dl>
92
93<dl class="attribute">
94<dt id="sans.models.StickyHSStructure.StickyHSStructure.__class__">
95<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__class__" title="Permalink to this definition">¶</a></dt>
96<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
97</dd></dl>
98
99<dl class="attribute">
100<dt id="sans.models.StickyHSStructure.StickyHSStructure.__delattr__">
101<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__delattr__" title="Permalink to this definition">¶</a></dt>
102<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
103</dd></dl>
104
105<dl class="attribute">
106<dt id="sans.models.StickyHSStructure.StickyHSStructure.__dict__">
107<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01B61690&gt;</em><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__dict__" title="Permalink to this definition">¶</a></dt>
108<dd></dd></dl>
109
110<dl class="method">
111<dt id="sans.models.StickyHSStructure.StickyHSStructure.__div__">
112<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__div__" title="Permalink to this definition">¶</a></dt>
113<dd></dd></dl>
114
115<dl class="attribute">
116<dt id="sans.models.StickyHSStructure.StickyHSStructure.__getattribute__">
117<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__getattribute__" title="Permalink to this definition">¶</a></dt>
118<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
119</dd></dl>
120
121<dl class="attribute">
122<dt id="sans.models.StickyHSStructure.StickyHSStructure.__hash__">
123<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__hash__" title="Permalink to this definition">¶</a></dt>
124<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
125</dd></dl>
126
127<dl class="method">
128<dt id="sans.models.StickyHSStructure.StickyHSStructure.__init__">
129<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__init__" title="Permalink to this definition">¶</a></dt>
130<dd><p>Initialization</p>
131</dd></dl>
132
133<dl class="attribute">
134<dt id="sans.models.StickyHSStructure.StickyHSStructure.__module__">
135<tt class="descname">__module__</tt><em class="property"> = 'sans.models.StickyHSStructure'</em><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__module__" title="Permalink to this definition">¶</a></dt>
136<dd></dd></dl>
137
138<dl class="method">
139<dt id="sans.models.StickyHSStructure.StickyHSStructure.__mul__">
140<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__mul__" title="Permalink to this definition">¶</a></dt>
141<dd></dd></dl>
142
143<dl class="staticmethod">
144<dt id="sans.models.StickyHSStructure.StickyHSStructure.__new__">
145<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__new__" title="Permalink to this definition">¶</a></dt>
146<dd></dd></dl>
147
148<dl class="method">
149<dt id="sans.models.StickyHSStructure.StickyHSStructure.__reduce__">
150<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__reduce__" title="Permalink to this definition">¶</a></dt>
151<dd><p>helper for pickle</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.models.StickyHSStructure.StickyHSStructure.__reduce_ex__">
156<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
157<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of
158c model.</p>
159</dd></dl>
160
161<dl class="attribute">
162<dt id="sans.models.StickyHSStructure.StickyHSStructure.__repr__">
163<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__repr__" title="Permalink to this definition">¶</a></dt>
164<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
165</dd></dl>
166
167<dl class="attribute">
168<dt id="sans.models.StickyHSStructure.StickyHSStructure.__setattr__">
169<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__setattr__" title="Permalink to this definition">¶</a></dt>
170<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
171</dd></dl>
172
173<dl class="method">
174<dt id="sans.models.StickyHSStructure.StickyHSStructure.__setstate__">
175<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__setstate__" title="Permalink to this definition">¶</a></dt>
176<dd><p>restore the state of a model from pickle</p>
177</dd></dl>
178
179<dl class="attribute">
180<dt id="sans.models.StickyHSStructure.StickyHSStructure.__str__">
181<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__str__" title="Permalink to this definition">¶</a></dt>
182<dd><p>x.__str__() &lt;==&gt; str(x)</p>
183</dd></dl>
184
185<dl class="method">
186<dt id="sans.models.StickyHSStructure.StickyHSStructure.__sub__">
187<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__sub__" title="Permalink to this definition">¶</a></dt>
188<dd></dd></dl>
189
190<dl class="attribute">
191<dt id="sans.models.StickyHSStructure.StickyHSStructure.__weakref__">
192<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.__weakref__" title="Permalink to this definition">¶</a></dt>
193<dd><p>list of weak references to the object (if defined)</p>
194</dd></dl>
195
196<dl class="method">
197<dt id="sans.models.StickyHSStructure.StickyHSStructure._clone">
198<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure._clone" title="Permalink to this definition">¶</a></dt>
199<dd><p>Internal utility function to copy the internal
200data members to a fresh copy.</p>
201</dd></dl>
202
203<dl class="method">
[512573a]204<dt id="sans.models.StickyHSStructure.StickyHSStructure.calculate_ER">
205<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.calculate_ER" title="Permalink to this definition">¶</a></dt>
206<dd><p>Calculate the effective radius for P(q)*S(q)</p>
207<table class="docutils field-list" frame="void" rules="none">
208<col class="field-name" />
209<col class="field-body" />
210<tbody valign="top">
[c0d873f]211<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
[512573a]212</tr>
213</tbody>
214</table>
215</dd></dl>
216
217<dl class="method">
218<dt id="sans.models.StickyHSStructure.StickyHSStructure.clone">
219<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.clone" title="Permalink to this definition">¶</a></dt>
220<dd><p>Return a identical copy of self</p>
221</dd></dl>
222
223<dl class="attribute">
224<dt id="sans.models.StickyHSStructure.StickyHSStructure.dispersion">
225<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.dispersion" title="Permalink to this definition">¶</a></dt>
226<dd><p>Dispersion parameters</p>
227</dd></dl>
228
229<dl class="method">
230<dt id="sans.models.StickyHSStructure.StickyHSStructure.evalDistribution">
[c0d873f]231<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.evalDistribution" title="Permalink to this definition">¶</a></dt>
[512573a]232<dd><p>Evaluate the model in cartesian coordinates</p>
233<table class="docutils field-list" frame="void" rules="none">
234<col class="field-name" />
235<col class="field-body" />
236<tbody valign="top">
[c0d873f]237<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
[512573a]238</tr>
[c0d873f]239<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
[512573a]240</tr>
241</tbody>
242</table>
243</dd></dl>
244
245<dl class="method">
246<dt id="sans.models.StickyHSStructure.StickyHSStructure.getDispParamList">
247<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.getDispParamList" title="Permalink to this definition">¶</a></dt>
248<dd><p>Return a list of all available parameters for the model</p>
249</dd></dl>
250
251<dl class="method">
252<dt id="sans.models.StickyHSStructure.StickyHSStructure.getParam">
[c0d873f]253<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.getParam" title="Permalink to this definition">¶</a></dt>
[512573a]254<dd><p>Set the value of a model parameter</p>
255<table class="docutils field-list" frame="void" rules="none">
256<col class="field-name" />
257<col class="field-body" />
258<tbody valign="top">
[c0d873f]259<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
[512573a]260</tr>
261</tbody>
262</table>
263</dd></dl>
264
265<dl class="method">
266<dt id="sans.models.StickyHSStructure.StickyHSStructure.getParamList">
267<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.getParamList" title="Permalink to this definition">¶</a></dt>
268<dd><p>Return a list of all available parameters for the model</p>
269</dd></dl>
270
271<dl class="method">
272<dt id="sans.models.StickyHSStructure.StickyHSStructure.getParamListWithToken">
[c0d873f]273<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]274<dd></dd></dl>
275
276<dl class="method">
277<dt id="sans.models.StickyHSStructure.StickyHSStructure.getParamWithToken">
[c0d873f]278<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.getParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]279<dd></dd></dl>
280
281<dl class="method">
282<dt id="sans.models.StickyHSStructure.StickyHSStructure.is_fittable">
[c0d873f]283<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.is_fittable" title="Permalink to this definition">¶</a></dt>
[512573a]284<dd><p>Check if a given parameter is fittable or not</p>
285<table class="docutils field-list" frame="void" rules="none">
286<col class="field-name" />
287<col class="field-body" />
288<tbody valign="top">
[c0d873f]289<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
[512573a]290</tr>
291</tbody>
292</table>
293</dd></dl>
294
295<dl class="attribute">
296<dt id="sans.models.StickyHSStructure.StickyHSStructure.log">
297<tt class="descname">log</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.log" title="Permalink to this definition">¶</a></dt>
298<dd><p>Log</p>
299</dd></dl>
300
301<dl class="attribute">
302<dt id="sans.models.StickyHSStructure.StickyHSStructure.params">
303<tt class="descname">params</tt><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.params" title="Permalink to this definition">¶</a></dt>
304<dd><p>Parameters</p>
305</dd></dl>
306
[c0d873f]307<dl class="method">
[512573a]308<dt id="sans.models.StickyHSStructure.StickyHSStructure.reset">
[c0d873f]309<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.reset" title="Permalink to this definition">¶</a></dt>
[512573a]310<dd><p>Reset pair correlation</p>
311</dd></dl>
312
313<dl class="method">
314<dt id="sans.models.StickyHSStructure.StickyHSStructure.run">
[c0d873f]315<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.run" title="Permalink to this definition">¶</a></dt>
[512573a]316<dd><p>Evaluate the model</p>
317<table class="docutils field-list" frame="void" rules="none">
318<col class="field-name" />
319<col class="field-body" />
320<tbody valign="top">
[c0d873f]321<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
[512573a]322</tr>
[c0d873f]323<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]324</tr>
325</tbody>
326</table>
327</dd></dl>
328
329<dl class="method">
330<dt id="sans.models.StickyHSStructure.StickyHSStructure.runXY">
[c0d873f]331<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.runXY" title="Permalink to this definition">¶</a></dt>
[512573a]332<dd><p>Evaluate the model in cartesian coordinates</p>
333<table class="docutils field-list" frame="void" rules="none">
334<col class="field-name" />
335<col class="field-body" />
336<tbody valign="top">
[c0d873f]337<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
[512573a]338</tr>
[c0d873f]339<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]340</tr>
341</tbody>
342</table>
343</dd></dl>
344
345<dl class="method">
346<dt id="sans.models.StickyHSStructure.StickyHSStructure.setParam">
[c0d873f]347<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.setParam" title="Permalink to this definition">¶</a></dt>
[512573a]348<dd><p>Set the value of a model parameter</p>
349<table class="docutils field-list" frame="void" rules="none">
350<col class="field-name" />
351<col class="field-body" />
352<tbody valign="top">
[c0d873f]353<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]354<li><strong>name</strong> &#8211; name of the parameter</li>
355<li><strong>value</strong> &#8211; value of the parameter</li>
356</ul>
357</td>
358</tr>
359</tbody>
360</table>
361</dd></dl>
362
363<dl class="method">
364<dt id="sans.models.StickyHSStructure.StickyHSStructure.setParamWithToken">
[c0d873f]365<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.setParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]366<dd></dd></dl>
367
368<dl class="method">
369<dt id="sans.models.StickyHSStructure.StickyHSStructure.set_dispersion">
[c0d873f]370<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.StickyHSStructure.set_dispersion" title="Permalink to this definition">¶</a></dt>
[512573a]371<dd><p>Set the dispersion object for a model parameter</p>
372<table class="docutils field-list" frame="void" rules="none">
373<col class="field-name" />
374<col class="field-body" />
375<tbody valign="top">
[c0d873f]376<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]377<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
378<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
379</ul>
380</td>
381</tr>
382</tbody>
383</table>
384</dd></dl>
385
386</dd></dl>
387
388<dl class="function">
389<dt id="sans.models.StickyHSStructure.create_StickyHSStructure">
390<tt class="descclassname">sans.models.StickyHSStructure.</tt><tt class="descname">create_StickyHSStructure</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StickyHSStructure.create_StickyHSStructure" title="Permalink to this definition">¶</a></dt>
391<dd></dd></dl>
392
393</div>
394</div>
395
396
397          </div>
398        </div>
399      </div>
400      <div class="sphinxsidebar">
401        <div class="sphinxsidebarwrapper">
402  <h3><a href="../index.html">Table Of Contents</a></h3>
403  <ul>
404<li><a class="reference internal" href="#">StickyHSStructure</a><ul>
[c0d873f]405<li><a class="reference internal" href="#sans-models-stickyhsstructure"><tt class="docutils literal"><span class="pre">sans.models.StickyHSStructure</span></tt></a></li>
[512573a]406</ul>
407</li>
408</ul>
409
410  <h4>Previous topic</h4>
411  <p class="topless"><a href="StackedDisksModel.html"
412                        title="previous chapter">StackedDisksModel</a></p>
413  <h4>Next topic</h4>
414  <p class="topless"><a href="SubComponent.html"
415                        title="next chapter">SubComponent</a></p>
416  <h3>This Page</h3>
417  <ul class="this-page-menu">
418    <li><a href="../_sources/api/StickyHSStructure.txt"
419           rel="nofollow">Show Source</a></li>
420  </ul>
421<div id="searchbox" style="display: none">
422  <h3>Quick search</h3>
423    <form class="search" action="../search.html" method="get">
[c0d873f]424      <input type="text" name="q" />
[512573a]425      <input type="submit" value="Go" />
426      <input type="hidden" name="check_keywords" value="yes" />
427      <input type="hidden" name="area" value="default" />
428    </form>
429    <p class="searchtip" style="font-size: 90%">
430    Enter search terms or a module, class or function name.
431    </p>
432</div>
433<script type="text/javascript">$('#searchbox').show(0);</script>
434        </div>
435      </div>
436      <div class="clearer"></div>
437    </div>
438    <div class="related">
439      <h3>Navigation</h3>
440      <ul>
441        <li class="right" style="margin-right: 10px">
442          <a href="../genindex.html" title="General Index"
443             >index</a></li>
444        <li class="right" >
445          <a href="../py-modindex.html" title="Python Module Index"
446             >modules</a> |</li>
447        <li class="right" >
448          <a href="SubComponent.html" title="SubComponent"
449             >next</a> |</li>
450        <li class="right" >
451          <a href="StackedDisksModel.html" title="StackedDisksModel"
452             >previous</a> |</li>
[c0d873f]453        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]454          <li><a href="index.html" >Reference</a> &raquo;</li> 
455      </ul>
456    </div>
457    <div class="footer">
458        &copy; Copyright 2010, sans group.
[c0d873f]459      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[512573a]460    </div>
461  </body>
462</html>
Note: See TracBrowser for help on using the repository browser.