[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 | |
---|
| 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>BaseModel — sansmodels 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="sansmodels v0.1.0 documentation" href="../index.html" /> |
---|
| 26 | <link rel="up" title="Reference" href="index.html" /> |
---|
| 27 | <link rel="next" title="BCCrystalModel" href="BCCrystalModel.html" /> |
---|
| 28 | <link rel="prev" title="BaseComponent" href="BaseComponent.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="BCCrystalModel.html" title="BCCrystalModel" |
---|
| 42 | accesskey="N">next</a> |</li> |
---|
| 43 | <li class="right" > |
---|
| 44 | <a href="BaseComponent.html" title="BaseComponent" |
---|
| 45 | accesskey="P">previous</a> |</li> |
---|
| 46 | <li><a href="../index.html">sansmodels v0.1.0 documentation</a> »</li> |
---|
| 47 | <li><a href="index.html" accesskey="U">Reference</a> »</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="basemodel"> |
---|
| 57 | <h1>BaseModel<a class="headerlink" href="#basemodel" title="Permalink to this headline">¶</a></h1> |
---|
| 58 | <div class="section" id="module-sans.models.BaseModel"> |
---|
| 59 | <span id="sans-models-basemodel"></span><h2><a class="reference internal" href="#module-sans.models.BaseModel" title="sans.models.BaseModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BaseModel</span></tt></a><a class="headerlink" href="#module-sans.models.BaseModel" title="Permalink to this headline">¶</a></h2> |
---|
| 60 | <p>Provide base functionality for all model components</p> |
---|
| 61 | <p>The following has changed since going from BaseComponent to BaseModel:</p> |
---|
| 62 | <blockquote> |
---|
| 63 | <div><ul class="simple"> |
---|
| 64 | <li>Arithmetic operation between models is no longer supported. |
---|
| 65 | It was found to be of little use and not very flexible.</li> |
---|
| 66 | <li>Parameters are now stored as Parameter object to provide |
---|
| 67 | the necessary extra information like limits, units, etc...</li> |
---|
| 68 | </ul> |
---|
| 69 | </div></blockquote> |
---|
| 70 | <dl class="class"> |
---|
| 71 | <dt id="sans.models.BaseModel.BaseModel"> |
---|
| 72 | <em class="property">class </em><tt class="descclassname">sans.models.BaseModel.</tt><tt class="descname">BaseModel</tt><a class="headerlink" href="#sans.models.BaseModel.BaseModel" title="Permalink to this definition">¶</a></dt> |
---|
| 73 | <dd><p>Bases: <a class="reference internal" href="ModelAdaptor.html#sans.models.ModelAdaptor.ModelAdaptor" title="sans.models.ModelAdaptor.ModelAdaptor"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.ModelAdaptor.ModelAdaptor</span></tt></a></p> |
---|
| 74 | <p>Basic model component</p> |
---|
| 75 | <dl class="method"> |
---|
| 76 | <dt id="sans.models.BaseModel.BaseModel.calculate_ER"> |
---|
| 77 | <tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.calculate_ER" title="Permalink to this definition">¶</a></dt> |
---|
| 78 | <dd></dd></dl> |
---|
| 79 | |
---|
| 80 | <dl class="method"> |
---|
| 81 | <dt id="sans.models.BaseModel.BaseModel.clone"> |
---|
| 82 | <tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.clone" title="Permalink to this definition">¶</a></dt> |
---|
| 83 | <dd><p>Returns a new object identical to the current object</p> |
---|
| 84 | </dd></dl> |
---|
| 85 | |
---|
| 86 | <dl class="method"> |
---|
| 87 | <dt id="sans.models.BaseModel.BaseModel.getParam"> |
---|
| 88 | <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParam" title="Permalink to this definition">¶</a></dt> |
---|
| 89 | <dd><p>Set the value of a model parameter</p> |
---|
| 90 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 91 | <col class="field-name" /> |
---|
| 92 | <col class="field-body" /> |
---|
| 93 | <tbody valign="top"> |
---|
| 94 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 95 | <li><strong>name</strong> – name of the parameter</li> |
---|
| 96 | <li><strong>value</strong> – value of the parameter</li> |
---|
| 97 | </ul> |
---|
| 98 | </td> |
---|
| 99 | </tr> |
---|
| 100 | </tbody> |
---|
| 101 | </table> |
---|
| 102 | </dd></dl> |
---|
| 103 | |
---|
| 104 | <dl class="method"> |
---|
| 105 | <dt id="sans.models.BaseModel.BaseModel.getParamList"> |
---|
| 106 | <tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParamList" title="Permalink to this definition">¶</a></dt> |
---|
| 107 | <dd><p>Return a list of all available parameters for the model</p> |
---|
| 108 | </dd></dl> |
---|
| 109 | |
---|
| 110 | <dl class="method"> |
---|
| 111 | <dt id="sans.models.BaseModel.BaseModel.getParamListWithToken"> |
---|
| 112 | <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> |
---|
| 113 | <dd></dd></dl> |
---|
| 114 | |
---|
| 115 | <dl class="method"> |
---|
| 116 | <dt id="sans.models.BaseModel.BaseModel.getParamWithToken"> |
---|
| 117 | <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> |
---|
| 118 | <dd></dd></dl> |
---|
| 119 | |
---|
| 120 | <dl class="method"> |
---|
| 121 | <dt id="sans.models.BaseModel.BaseModel.run"> |
---|
| 122 | <tt class="descname">run</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.run" title="Permalink to this definition">¶</a></dt> |
---|
| 123 | <dd></dd></dl> |
---|
| 124 | |
---|
| 125 | <dl class="method"> |
---|
| 126 | <dt id="sans.models.BaseModel.BaseModel.runXY"> |
---|
| 127 | <tt class="descname">runXY</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.runXY" title="Permalink to this definition">¶</a></dt> |
---|
| 128 | <dd></dd></dl> |
---|
| 129 | |
---|
| 130 | <dl class="method"> |
---|
| 131 | <dt id="sans.models.BaseModel.BaseModel.setParam"> |
---|
| 132 | <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.setParam" title="Permalink to this definition">¶</a></dt> |
---|
| 133 | <dd><p>Set the value of a model parameter</p> |
---|
| 134 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 135 | <col class="field-name" /> |
---|
| 136 | <col class="field-body" /> |
---|
| 137 | <tbody valign="top"> |
---|
| 138 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 139 | <li><strong>name</strong> – name of the parameter</li> |
---|
| 140 | <li><strong>value</strong> – value of the parameter</li> |
---|
| 141 | </ul> |
---|
| 142 | </td> |
---|
| 143 | </tr> |
---|
| 144 | </tbody> |
---|
| 145 | </table> |
---|
| 146 | </dd></dl> |
---|
| 147 | |
---|
| 148 | <dl class="method"> |
---|
| 149 | <dt id="sans.models.BaseModel.BaseModel.setParamWithToken"> |
---|
| 150 | <tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> |
---|
| 151 | <dd></dd></dl> |
---|
| 152 | |
---|
| 153 | </dd></dl> |
---|
| 154 | |
---|
| 155 | <dl class="class"> |
---|
| 156 | <dt id="sans.models.BaseModel.Parameter"> |
---|
| 157 | <em class="property">class </em><tt class="descclassname">sans.models.BaseModel.</tt><tt class="descname">Parameter</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.Parameter" title="Permalink to this definition">¶</a></dt> |
---|
| 158 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> |
---|
| 159 | <p>Parameter class</p> |
---|
| 160 | </dd></dl> |
---|
| 161 | |
---|
| 162 | <dl class="attribute"> |
---|
| 163 | <dt id="sans.models.BaseModel.ParameterProperty"> |
---|
| 164 | <tt class="descclassname">sans.models.BaseModel.</tt><tt class="descname">ParameterProperty</tt><a class="headerlink" href="#sans.models.BaseModel.ParameterProperty" title="Permalink to this definition">¶</a></dt> |
---|
| 165 | <dd><p>Parameter property allow direct access to |
---|
| 166 | the parameter values</p> |
---|
| 167 | </dd></dl> |
---|
| 168 | |
---|
| 169 | </div> |
---|
| 170 | </div> |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | </div> |
---|
| 174 | </div> |
---|
| 175 | </div> |
---|
| 176 | <div class="sphinxsidebar"> |
---|
| 177 | <div class="sphinxsidebarwrapper"> |
---|
| 178 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 179 | <ul> |
---|
| 180 | <li><a class="reference internal" href="#">BaseModel</a><ul> |
---|
| 181 | <li><a class="reference internal" href="#module-sans.models.BaseModel"><tt class="docutils literal"><span class="pre">sans.models.BaseModel</span></tt></a></li> |
---|
| 182 | </ul> |
---|
| 183 | </li> |
---|
| 184 | </ul> |
---|
| 185 | |
---|
| 186 | <h4>Previous topic</h4> |
---|
| 187 | <p class="topless"><a href="BaseComponent.html" |
---|
| 188 | title="previous chapter">BaseComponent</a></p> |
---|
| 189 | <h4>Next topic</h4> |
---|
| 190 | <p class="topless"><a href="BCCrystalModel.html" |
---|
| 191 | title="next chapter">BCCrystalModel</a></p> |
---|
| 192 | <h3>This Page</h3> |
---|
| 193 | <ul class="this-page-menu"> |
---|
| 194 | <li><a href="../_sources/api/BaseModel.txt" |
---|
| 195 | rel="nofollow">Show Source</a></li> |
---|
| 196 | </ul> |
---|
| 197 | <div id="searchbox" style="display: none"> |
---|
| 198 | <h3>Quick search</h3> |
---|
| 199 | <form class="search" action="../search.html" method="get"> |
---|
| 200 | <input type="text" name="q" size="18" /> |
---|
| 201 | <input type="submit" value="Go" /> |
---|
| 202 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 203 | <input type="hidden" name="area" value="default" /> |
---|
| 204 | </form> |
---|
| 205 | <p class="searchtip" style="font-size: 90%"> |
---|
| 206 | Enter search terms or a module, class or function name. |
---|
| 207 | </p> |
---|
| 208 | </div> |
---|
| 209 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 210 | </div> |
---|
| 211 | </div> |
---|
| 212 | <div class="clearer"></div> |
---|
| 213 | </div> |
---|
| 214 | <div class="related"> |
---|
| 215 | <h3>Navigation</h3> |
---|
| 216 | <ul> |
---|
| 217 | <li class="right" style="margin-right: 10px"> |
---|
| 218 | <a href="../genindex.html" title="General Index" |
---|
| 219 | >index</a></li> |
---|
| 220 | <li class="right" > |
---|
| 221 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 222 | >modules</a> |</li> |
---|
| 223 | <li class="right" > |
---|
| 224 | <a href="BCCrystalModel.html" title="BCCrystalModel" |
---|
| 225 | >next</a> |</li> |
---|
| 226 | <li class="right" > |
---|
| 227 | <a href="BaseComponent.html" title="BaseComponent" |
---|
| 228 | >previous</a> |</li> |
---|
| 229 | <li><a href="../index.html">sansmodels v0.1.0 documentation</a> »</li> |
---|
| 230 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 231 | </ul> |
---|
| 232 | </div> |
---|
| 233 | <div class="footer"> |
---|
| 234 | © Copyright 2010, sans group. |
---|
| 235 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. |
---|
| 236 | </div> |
---|
| 237 | </body> |
---|
| 238 | </html> |
---|