source: sasview/sansmodels/docs/sphinx/html/api/ModelFactory.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: 6.7 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>ModelFactory &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
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>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="ModelIO" href="ModelIO.html" />
31    <link rel="prev" title="ModelAdaptor" href="ModelAdaptor.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="ModelIO.html" title="ModelIO"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="ModelAdaptor.html" title="ModelAdaptor"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
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="modelfactory">
60<h1>ModelFactory<a class="headerlink" href="#modelfactory" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-modelfactory">
62<h2><a class="reference internal" href="#module-sans.models.ModelFactory" title="sans.models.ModelFactory"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ModelFactory</span></tt></a><a class="headerlink" href="#sans-models-modelfactory" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.ModelFactory"></span><p>Model factory
64Class that creates models by looking up the name of a model
65in the models directory</p>
66<p>&#64;author: Mathieu Doucet / UTK
67&#64;contact: <a class="reference external" href="mailto:mathieu&#46;doucet&#37;&#52;&#48;nist&#46;gov">mathieu<span>&#46;</span>doucet<span>&#64;</span>nist<span>&#46;</span>gov</a></p>
68<dl class="class">
69<dt id="sans.models.ModelFactory.ModelFactory">
70<em class="property">class </em><tt class="descclassname">sans.models.ModelFactory.</tt><tt class="descname">ModelFactory</tt><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory" title="Permalink to this definition">¶</a></dt>
71<dd><p>Class to create available models</p>
72<dl class="attribute">
73<dt id="sans.models.ModelFactory.ModelFactory.__module__">
74<tt class="descname">__module__</tt><em class="property"> = 'sans.models.ModelFactory'</em><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory.__module__" title="Permalink to this definition">¶</a></dt>
75<dd></dd></dl>
76
77<dl class="method">
78<dt id="sans.models.ModelFactory.ModelFactory.getAllModels">
79<tt class="descname">getAllModels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory.getAllModels" title="Permalink to this definition">¶</a></dt>
80<dd><p>Returns a list of all available models
81&#64;return: python list object</p>
82</dd></dl>
83
84<dl class="method">
85<dt id="sans.models.ModelFactory.ModelFactory.getModel">
86<tt class="descname">getModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelFactory.ModelFactory.getModel" title="Permalink to this definition">¶</a></dt>
87<dd><p>Returns the model if found
88&#64;param name: name of the model to look for
89&#64;return: the model object</p>
90</dd></dl>
91
92</dd></dl>
93
94</div>
95</div>
96
97
98          </div>
99        </div>
100      </div>
101      <div class="sphinxsidebar">
102        <div class="sphinxsidebarwrapper">
103  <h3><a href="../index.html">Table Of Contents</a></h3>
104  <ul>
105<li><a class="reference internal" href="#">ModelFactory</a><ul>
106<li><a class="reference internal" href="#sans-models-modelfactory"><tt class="docutils literal"><span class="pre">sans.models.ModelFactory</span></tt></a></li>
107</ul>
108</li>
109</ul>
110
111  <h4>Previous topic</h4>
112  <p class="topless"><a href="ModelAdaptor.html"
113                        title="previous chapter">ModelAdaptor</a></p>
114  <h4>Next topic</h4>
115  <p class="topless"><a href="ModelIO.html"
116                        title="next chapter">ModelIO</a></p>
117  <h3>This Page</h3>
118  <ul class="this-page-menu">
119    <li><a href="../_sources/api/ModelFactory.txt"
120           rel="nofollow">Show Source</a></li>
121  </ul>
122<div id="searchbox" style="display: none">
123  <h3>Quick search</h3>
124    <form class="search" action="../search.html" method="get">
125      <input type="text" name="q" />
126      <input type="submit" value="Go" />
127      <input type="hidden" name="check_keywords" value="yes" />
128      <input type="hidden" name="area" value="default" />
129    </form>
130    <p class="searchtip" style="font-size: 90%">
131    Enter search terms or a module, class or function name.
132    </p>
133</div>
134<script type="text/javascript">$('#searchbox').show(0);</script>
135        </div>
136      </div>
137      <div class="clearer"></div>
138    </div>
139    <div class="related">
140      <h3>Navigation</h3>
141      <ul>
142        <li class="right" style="margin-right: 10px">
143          <a href="../genindex.html" title="General Index"
144             >index</a></li>
145        <li class="right" >
146          <a href="../py-modindex.html" title="Python Module Index"
147             >modules</a> |</li>
148        <li class="right" >
149          <a href="ModelIO.html" title="ModelIO"
150             >next</a> |</li>
151        <li class="right" >
152          <a href="ModelAdaptor.html" title="ModelAdaptor"
153             >previous</a> |</li>
154        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
155          <li><a href="index.html" >Reference</a> &raquo;</li> 
156      </ul>
157    </div>
158    <div class="footer">
159        &copy; Copyright 2010, sans group.
160      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
161    </div>
162  </body>
163</html>
Note: See TracBrowser for help on using the repository browser.