Ignore:
Timestamp:
Oct 24, 2011 2:52:52 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
8d70c0a
Parents:
67cd7c0
Message:

edit docs for models

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sansmodels/docs/sphinx/html/api/pluginmodel.html

    r512573a rc0d873f  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>pluginmodel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>pluginmodel &mdash; sansmodels 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="sansmodels v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="next" title="PolymerExclVolume" href="PolymerExclVolume.html" /> 
    … …  
    4447          <a href="PearlNecklaceModel.html" title="PearlNecklaceModel" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="pluginmodel"> 
    5760<h1>pluginmodel<a class="headerlink" href="#pluginmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.pluginmodel"> 
    59 <span id="sans-models-pluginmodel"></span><h2><a class="reference internal" href="#module-sans.models.pluginmodel" title="sans.models.pluginmodel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.pluginmodel</span></tt></a><a class="headerlink" href="#module-sans.models.pluginmodel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-pluginmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.pluginmodel" title="sans.models.pluginmodel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.pluginmodel</span></tt></a><a class="headerlink" href="#sans-models-pluginmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.pluginmodel"></span><dl class="class"> 
    6164<dt id="sans.models.pluginmodel.Model1DPlugin"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.pluginmodel.</tt><tt class="descname">Model1DPlugin</tt><big>(</big><em>name='Plugin Model'</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.pluginmodel.</tt><tt class="descname">Model1DPlugin</tt><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Bases: <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> 
     67<dl class="method"> 
     68<dt id="sans.models.pluginmodel.Model1DPlugin.__add__"> 
     69<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__add__" title="Permalink to this definition">¶</a></dt> 
     70<dd></dd></dl> 
     71 
     72<dl class="method"> 
     73<dt id="sans.models.pluginmodel.Model1DPlugin.__div__"> 
     74<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__div__" title="Permalink to this definition">¶</a></dt> 
     75<dd></dd></dl> 
     76 
     77<dl class="method"> 
     78<dt id="sans.models.pluginmodel.Model1DPlugin.__init__"> 
     79<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__init__" title="Permalink to this definition">¶</a></dt> 
     80<dd><p>Initialization</p> 
     81</dd></dl> 
     82 
     83<dl class="attribute"> 
     84<dt id="sans.models.pluginmodel.Model1DPlugin.__module__"> 
     85<tt class="descname">__module__</tt><em class="property"> = 'sans.models.pluginmodel'</em><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__module__" title="Permalink to this definition">¶</a></dt> 
     86<dd></dd></dl> 
     87 
     88<dl class="method"> 
     89<dt id="sans.models.pluginmodel.Model1DPlugin.__mul__"> 
     90<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__mul__" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="method"> 
     94<dt id="sans.models.pluginmodel.Model1DPlugin.__str__"> 
     95<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__str__" title="Permalink to this definition">¶</a></dt> 
     96<dd><table class="docutils field-list" frame="void" rules="none"> 
     97<col class="field-name" /> 
     98<col class="field-body" /> 
     99<tbody valign="top"> 
     100<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     101</tr> 
     102</tbody> 
     103</table> 
     104</dd></dl> 
     105 
     106<dl class="method"> 
     107<dt id="sans.models.pluginmodel.Model1DPlugin.__sub__"> 
     108<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.__sub__" title="Permalink to this definition">¶</a></dt> 
     109<dd></dd></dl> 
     110 
     111<dl class="method"> 
     112<dt id="sans.models.pluginmodel.Model1DPlugin._clone"> 
     113<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin._clone" title="Permalink to this definition">¶</a></dt> 
     114<dd><p>Internal utility function to copy the internal 
     115data members to a fresh copy.</p> 
     116</dd></dl> 
     117 
    64118<dl class="method"> 
    65119<dt id="sans.models.pluginmodel.Model1DPlugin.calculate_ER"> 
    … …  
    75129<dl class="method"> 
    76130<dt id="sans.models.pluginmodel.Model1DPlugin.evalDistribution"> 
    77 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     131<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    78132<dd><p>Evaluate a distribution of q-values.</p> 
    79133<ul> 
    … …  
    100154<col class="field-body" /> 
    101155<tbody valign="top"> 
    102 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     156<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
    103157is supported for python models, thus C-models should have</p> 
    104158<blockquote class="last"> 
    … …  
    116170<col class="field-body" /> 
    117171<tbody valign="top"> 
    118 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]  
     172<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]  
    119173where qx,qy are 1D ndarrays</td> 
    120174</tr> 
    … …  
    125179<dl class="method"> 
    126180<dt id="sans.models.pluginmodel.Model1DPlugin.function"> 
    127 <tt class="descname">function</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.function" title="Permalink to this definition">¶</a></dt> 
     181<tt class="descname">function</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.function" title="Permalink to this definition">¶</a></dt> 
    128182<dd><p>Function to be implemented by the plug-in writer</p> 
    129183</dd></dl> 
    … …  
    137191<dl class="method"> 
    138192<dt id="sans.models.pluginmodel.Model1DPlugin.getParam"> 
    139 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.getParam" title="Permalink to this definition">¶</a></dt> 
     193<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.getParam" title="Permalink to this definition">¶</a></dt> 
    140194<dd><p>Set the value of a model parameter</p> 
    141195<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    143197<col class="field-body" /> 
    144198<tbody valign="top"> 
    145 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     199<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    146200</tr> 
    147201</tbody> 
    … …  
    157211<dl class="method"> 
    158212<dt id="sans.models.pluginmodel.Model1DPlugin.getParamListWithToken"> 
    159 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     213<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    160214<dd></dd></dl> 
    161215 
    162216<dl class="method"> 
    163217<dt id="sans.models.pluginmodel.Model1DPlugin.getParamWithToken"> 
    164 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     218<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    165219<dd></dd></dl> 
    166220 
    167221<dl class="method"> 
    168222<dt id="sans.models.pluginmodel.Model1DPlugin.is_fittable"> 
    169 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.is_fittable" title="Permalink to this definition">¶</a></dt> 
     223<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.is_fittable" title="Permalink to this definition">¶</a></dt> 
    170224<dd><p>Check if a given parameter is fittable or not</p> 
    171225<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    173227<col class="field-body" /> 
    174228<tbody valign="top"> 
    175 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     229<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> 
    176230</tr> 
    177231</tbody> 
    … …  
    181235<dl class="method"> 
    182236<dt id="sans.models.pluginmodel.Model1DPlugin.run"> 
    183 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.run" title="Permalink to this definition">¶</a></dt> 
     237<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.run" title="Permalink to this definition">¶</a></dt> 
    184238<dd><p>Evaluate the model</p> 
    185239<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    187241<col class="field-body" /> 
    188242<tbody valign="top"> 
    189 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x, or [x, phi] [radian]</td> 
    190 </tr> 
    191 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">function value</td> 
     243<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x, or [x, phi] [radian]</td> 
     244</tr> 
     245<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">function value</td> 
    192246</tr> 
    193247</tbody> 
    … …  
    197251<dl class="method"> 
    198252<dt id="sans.models.pluginmodel.Model1DPlugin.runXY"> 
    199 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.runXY" title="Permalink to this definition">¶</a></dt> 
     253<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.runXY" title="Permalink to this definition">¶</a></dt> 
    200254<dd><p>Evaluate the model</p> 
    201255<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    203257<col class="field-body" /> 
    204258<tbody valign="top"> 
    205 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x, or [x, y]</td> 
    206 </tr> 
    207 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">function value</td> 
     259<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x, or [x, y]</td> 
     260</tr> 
     261<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">function value</td> 
    208262</tr> 
    209263</tbody> 
    … …  
    213267<dl class="method"> 
    214268<dt id="sans.models.pluginmodel.Model1DPlugin.setParam"> 
    215 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.setParam" title="Permalink to this definition">¶</a></dt> 
     269<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.setParam" title="Permalink to this definition">¶</a></dt> 
    216270<dd><p>Set the value of a model parameter</p> 
    217271<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    219273<col class="field-body" /> 
    220274<tbody valign="top"> 
    221 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     275<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    222276<li><strong>name</strong> &#8211; name of the parameter</li> 
    223277<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    231285<dl class="method"> 
    232286<dt id="sans.models.pluginmodel.Model1DPlugin.setParamWithToken"> 
    233 <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.pluginmodel.Model1DPlugin.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     287<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.pluginmodel.Model1DPlugin.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    234288<dd></dd></dl> 
    235289 
    … …  
    248302  <ul> 
    249303<li><a class="reference internal" href="#">pluginmodel</a><ul> 
    250 <li><a class="reference internal" href="#module-sans.models.pluginmodel"><tt class="docutils literal"><span class="pre">sans.models.pluginmodel</span></tt></a></li> 
     304<li><a class="reference internal" href="#sans-models-pluginmodel"><tt class="docutils literal"><span class="pre">sans.models.pluginmodel</span></tt></a></li> 
    251305</ul> 
    252306</li> 
    … …  
    267321  <h3>Quick search</h3> 
    268322    <form class="search" action="../search.html" method="get"> 
    269       <input type="text" name="q" size="18" /> 
     323      <input type="text" name="q" /> 
    270324      <input type="submit" value="Go" /> 
    271325      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    296350          <a href="PearlNecklaceModel.html" title="PearlNecklaceModel" 
    297351             >previous</a> |</li> 
    298         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     352        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    299353          <li><a href="index.html" >Reference</a> &raquo;</li>  
    300354      </ul> 
    … …  
    302356    <div class="footer"> 
    303357        &copy; Copyright 2010, sans group. 
    304       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     358      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    305359    </div> 
    306360  </body> 
Note: See TracChangeset for help on using the changeset viewer.