source: sasview/theoryview/docs/sphinx/_build/html/api/models.html @ 6c79243

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 6c79243 was 74755ff, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation theory view
  • Property mode set to 100644
File size: 8.3 KB
Line 
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
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>models &mdash; theoryview v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="theoryview v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="pagestate" href="pagestate.html" />
28    <link rel="prev" title="model_thread" href="model_thread.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 class="right" >
41          <a href="pagestate.html" title="pagestate"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="model_thread.html" title="model_thread"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">theoryview v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="models">
57<h1>models<a class="headerlink" href="#models" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.perspectives.theory.models">
59<span id="sans-perspectives-theory-models"></span><h2><a class="reference internal" href="#module-sans.perspectives.theory.models"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.theory.models</span></tt></a><a class="headerlink" href="#module-sans.perspectives.theory.models" title="Permalink to this headline">¶</a></h2>
60<p>This module collects models from sans.models packages and orders theses models
61by categories that GUI application understands and uses.</p>
62<dl class="class">
63<dt id="sans.perspectives.theory.models.ModelList">
64<em class="property">class </em><tt class="descclassname">sans.perspectives.theory.models.</tt><tt class="descname">ModelList</tt><a class="headerlink" href="#sans.perspectives.theory.models.ModelList" title="Permalink to this definition">¶</a></dt>
65<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
66<p>Contains dictionary of model and their type</p>
67<dl class="method">
68<dt id="sans.perspectives.theory.models.ModelList.get_list">
69<tt class="descname">get_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.theory.models.ModelList.get_list" title="Permalink to this definition">¶</a></dt>
70<dd>return all the list stored in a dictionary object</dd></dl>
71
72<dl class="method">
73<dt id="sans.perspectives.theory.models.ModelList.set_list">
74<tt class="descname">set_list</tt><big>(</big><em>name</em>, <em>mylist</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.models.ModelList.set_list" title="Permalink to this definition">¶</a></dt>
75<dd><table class="docutils field-list" frame="void" rules="none">
76<col class="field-name" />
77<col class="field-body" />
78<tbody valign="top">
79<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
80<li><strong>name</strong> &#8211; the type of the list</li>
81<li><strong>mylist</strong> &#8211; the list to add</li>
82</ul>
83</td>
84</tr>
85</tbody>
86</table>
87</dd></dl>
88
89</dd></dl>
90
91<dl class="class">
92<dt id="sans.perspectives.theory.models.ModelManager">
93<em class="property">class </em><tt class="descclassname">sans.perspectives.theory.models.</tt><tt class="descname">ModelManager</tt><a class="headerlink" href="#sans.perspectives.theory.models.ModelManager" title="Permalink to this definition">¶</a></dt>
94<dd><p>ModelManager collected model classes object of available into a
95dictionary of models&#8217; names and models&#8217; classes.</p>
96<dl class="method">
97<dt id="sans.perspectives.theory.models.ModelManager.get_model_list">
98<tt class="descname">get_model_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.theory.models.ModelManager.get_model_list" title="Permalink to this definition">¶</a></dt>
99<dd><table class="docutils field-list" frame="void" rules="none">
100<col class="field-name" />
101<col class="field-body" />
102<tbody valign="top">
103<tr class="field"><th class="field-name">Returns:</th><td class="field-body">dictionary of models for fitpanel use</td>
104</tr>
105</tbody>
106</table>
107</dd></dl>
108
109</dd></dl>
110
111<dl class="function">
112<dt id="sans.perspectives.theory.models.findModels">
113<tt class="descclassname">sans.perspectives.theory.models.</tt><tt class="descname">findModels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.theory.models.findModels" title="Permalink to this definition">¶</a></dt>
114<dd></dd></dl>
115
116<dl class="function">
117<dt id="sans.perspectives.theory.models.log">
118<tt class="descclassname">sans.perspectives.theory.models.</tt><tt class="descname">log</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#sans.perspectives.theory.models.log" title="Permalink to this definition">¶</a></dt>
119<dd></dd></dl>
120
121</div>
122</div>
123
124
125          </div>
126        </div>
127      </div>
128      <div class="sphinxsidebar">
129        <div class="sphinxsidebarwrapper">
130  <h3><a href="../index.html">Table Of Contents</a></h3>
131  <ul>
132<li><a class="reference internal" href="#">models</a><ul>
133<li><a class="reference internal" href="#module-sans.perspectives.theory.models"><tt class="docutils literal"><span class="pre">sans.perspectives.theory.models</span></tt></a></li>
134</ul>
135</li>
136</ul>
137
138  <h4>Previous topic</h4>
139  <p class="topless"><a href="model_thread.html"
140                        title="previous chapter">model_thread</a></p>
141  <h4>Next topic</h4>
142  <p class="topless"><a href="pagestate.html"
143                        title="next chapter">pagestate</a></p>
144  <h3>This Page</h3>
145  <ul class="this-page-menu">
146    <li><a href="../_sources/api/models.txt"
147           rel="nofollow">Show Source</a></li>
148  </ul>
149<div id="searchbox" style="display: none">
150  <h3>Quick search</h3>
151    <form class="search" action="../search.html" method="get">
152      <input type="text" name="q" size="18" />
153      <input type="submit" value="Go" />
154      <input type="hidden" name="check_keywords" value="yes" />
155      <input type="hidden" name="area" value="default" />
156    </form>
157    <p class="searchtip" style="font-size: 90%">
158    Enter search terms or a module, class or function name.
159    </p>
160</div>
161<script type="text/javascript">$('#searchbox').show(0);</script>
162        </div>
163      </div>
164      <div class="clearer"></div>
165    </div>
166    <div class="related">
167      <h3>Navigation</h3>
168      <ul>
169        <li class="right" style="margin-right: 10px">
170          <a href="../genindex.html" title="General Index"
171             >index</a></li>
172        <li class="right" >
173          <a href="../py-modindex.html" title="Python Module Index"
174             >modules</a> |</li>
175        <li class="right" >
176          <a href="pagestate.html" title="pagestate"
177             >next</a> |</li>
178        <li class="right" >
179          <a href="model_thread.html" title="model_thread"
180             >previous</a> |</li>
181        <li><a href="../index.html">theoryview v0.1.0 documentation</a> &raquo;</li>
182          <li><a href="index.html" >Reference</a> &raquo;</li> 
183      </ul>
184    </div>
185    <div class="footer">
186        &copy; Copyright 2010, sans group.
187      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
188    </div>
189  </body>
190</html>
Note: See TracBrowser for help on using the repository browser.