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/MulComponent.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>MulComponent &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>MulComponent &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="MultiplicationModel" href="MultiplicationModel.html" /> 
    … …  
    4447          <a href="ModelIO.html" title="ModelIO" 
    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="mulcomponent"> 
    5760<h1>MulComponent<a class="headerlink" href="#mulcomponent" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.MulComponent"> 
    59 <span id="sans-models-mulcomponent"></span><h2><a class="reference internal" href="#module-sans.models.MulComponent" title="sans.models.MulComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.MulComponent</span></tt></a><a class="headerlink" href="#module-sans.models.MulComponent" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide base functionality for all model components 
     61<div class="section" id="sans-models-mulcomponent"> 
     62<h2><a class="reference internal" href="#module-sans.models.MulComponent" title="sans.models.MulComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.MulComponent</span></tt></a><a class="headerlink" href="#sans-models-mulcomponent" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.MulComponent"></span><p>Provide base functionality for all model components 
    6164&#64;author: Mathieu Doucet / UTK 
    6265&#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> 
    6366<dl class="class"> 
    6467<dt id="sans.models.MulComponent.MulComponent"> 
    65 <em class="property">class </em><tt class="descclassname">sans.models.MulComponent.</tt><tt class="descname">MulComponent</tt><big>(</big><em>base=None</em>, <em>other=None</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent" title="Permalink to this definition">¶</a></dt> 
     68<em class="property">class </em><tt class="descclassname">sans.models.MulComponent.</tt><tt class="descname">MulComponent</tt><a class="headerlink" href="#sans.models.MulComponent.MulComponent" title="Permalink to this definition">¶</a></dt> 
    6669<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> 
    6770<p>Basic model component for Multiply 
    6871Provides basic arithmetics</p> 
    6972<dl class="method"> 
     73<dt id="sans.models.MulComponent.MulComponent.__add__"> 
     74<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__add__" title="Permalink to this definition">¶</a></dt> 
     75<dd></dd></dl> 
     76 
     77<dl class="method"> 
     78<dt id="sans.models.MulComponent.MulComponent.__div__"> 
     79<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__div__" title="Permalink to this definition">¶</a></dt> 
     80<dd></dd></dl> 
     81 
     82<dl class="method"> 
     83<dt id="sans.models.MulComponent.MulComponent.__init__"> 
     84<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__init__" title="Permalink to this definition">¶</a></dt> 
     85<dd><p>&#64;param base: component to multiply 
     86&#64;param other: component to multiply by</p> 
     87</dd></dl> 
     88 
     89<dl class="attribute"> 
     90<dt id="sans.models.MulComponent.MulComponent.__module__"> 
     91<tt class="descname">__module__</tt><em class="property"> = 'sans.models.MulComponent'</em><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__module__" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
     93 
     94<dl class="method"> 
     95<dt id="sans.models.MulComponent.MulComponent.__mul__"> 
     96<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__mul__" title="Permalink to this definition">¶</a></dt> 
     97<dd></dd></dl> 
     98 
     99<dl class="method"> 
     100<dt id="sans.models.MulComponent.MulComponent.__str__"> 
     101<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__str__" title="Permalink to this definition">¶</a></dt> 
     102<dd><table class="docutils field-list" frame="void" rules="none"> 
     103<col class="field-name" /> 
     104<col class="field-body" /> 
     105<tbody valign="top"> 
     106<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     107</tr> 
     108</tbody> 
     109</table> 
     110</dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.models.MulComponent.MulComponent.__sub__"> 
     114<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.__sub__" title="Permalink to this definition">¶</a></dt> 
     115<dd></dd></dl> 
     116 
     117<dl class="method"> 
     118<dt id="sans.models.MulComponent.MulComponent._clone"> 
     119<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent._clone" title="Permalink to this definition">¶</a></dt> 
     120<dd><p>Internal utility function to copy the internal 
     121data members to a fresh copy.</p> 
     122</dd></dl> 
     123 
     124<dl class="method"> 
    70125<dt id="sans.models.MulComponent.MulComponent.calculate_ER"> 
    71126<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    80135<dl class="method"> 
    81136<dt id="sans.models.MulComponent.MulComponent.evalDistribution"> 
    82 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     137<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    83138<dd><p>Evaluate a distribution of q-values.</p> 
    84139<ul> 
    … …  
    105160<col class="field-body" /> 
    106161<tbody valign="top"> 
    107 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     162<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  
    108163is supported for python models, thus C-models should have</p> 
    109164<blockquote class="last"> 
    … …  
    121176<col class="field-body" /> 
    122177<tbody valign="top"> 
    123 <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]  
     178<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]  
    124179where qx,qy are 1D ndarrays</td> 
    125180</tr> 
    … …  
    136191<dl class="method"> 
    137192<dt id="sans.models.MulComponent.MulComponent.getParam"> 
    138 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.getParam" title="Permalink to this definition">¶</a></dt> 
     193<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.getParam" title="Permalink to this definition">¶</a></dt> 
    139194<dd><p>Set the value of a model parameter 
    140195&#64;param name: name of the parameter 
    … …  
    150205<dl class="method"> 
    151206<dt id="sans.models.MulComponent.MulComponent.getParamListWithToken"> 
    152 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     207<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    153208<dd></dd></dl> 
    154209 
    155210<dl class="method"> 
    156211<dt id="sans.models.MulComponent.MulComponent.getParamWithToken"> 
    157 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     212<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    158213<dd></dd></dl> 
    159214 
    160215<dl class="method"> 
    161216<dt id="sans.models.MulComponent.MulComponent.is_fittable"> 
    162 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.is_fittable" title="Permalink to this definition">¶</a></dt> 
     217<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.is_fittable" title="Permalink to this definition">¶</a></dt> 
    163218<dd><p>Check if a given parameter is fittable or not</p> 
    164219<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    166221<col class="field-body" /> 
    167222<tbody valign="top"> 
    168 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     223<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> 
    169224</tr> 
    170225</tbody> 
    … …  
    174229<dl class="method"> 
    175230<dt id="sans.models.MulComponent.MulComponent.run"> 
    176 <tt class="descname">run</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.run" title="Permalink to this definition">¶</a></dt> 
     231<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.run" title="Permalink to this definition">¶</a></dt> 
    177232<dd><p>Evaluate each part of the component and sum the results 
    178233&#64;param x: input parameter 
    … …  
    182237<dl class="method"> 
    183238<dt id="sans.models.MulComponent.MulComponent.runXY"> 
    184 <tt class="descname">runXY</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.runXY" title="Permalink to this definition">¶</a></dt> 
     239<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.runXY" title="Permalink to this definition">¶</a></dt> 
    185240<dd><p>Evaluate each part of the component and sum the results 
    186241&#64;param x: input parameter 
    … …  
    190245<dl class="method"> 
    191246<dt id="sans.models.MulComponent.MulComponent.setParam"> 
    192 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.setParam" title="Permalink to this definition">¶</a></dt> 
     247<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.setParam" title="Permalink to this definition">¶</a></dt> 
    193248<dd><p>Set the value of a model parameter 
    194249&#64;param name: name of parameter to set 
    … …  
    198253<dl class="method"> 
    199254<dt id="sans.models.MulComponent.MulComponent.setParamWithToken"> 
    200 <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.MulComponent.MulComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     255<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MulComponent.MulComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    201256<dd></dd></dl> 
    202257 
    … …  
    215270  <ul> 
    216271<li><a class="reference internal" href="#">MulComponent</a><ul> 
    217 <li><a class="reference internal" href="#module-sans.models.MulComponent"><tt class="docutils literal"><span class="pre">sans.models.MulComponent</span></tt></a></li> 
     272<li><a class="reference internal" href="#sans-models-mulcomponent"><tt class="docutils literal"><span class="pre">sans.models.MulComponent</span></tt></a></li> 
    218273</ul> 
    219274</li> 
    … …  
    234289  <h3>Quick search</h3> 
    235290    <form class="search" action="../search.html" method="get"> 
    236       <input type="text" name="q" size="18" /> 
     291      <input type="text" name="q" /> 
    237292      <input type="submit" value="Go" /> 
    238293      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    263318          <a href="ModelIO.html" title="ModelIO" 
    264319             >previous</a> |</li> 
    265         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     320        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    266321          <li><a href="index.html" >Reference</a> &raquo;</li>  
    267322      </ul> 
    … …  
    269324    <div class="footer"> 
    270325        &copy; Copyright 2010, sans group. 
    271       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     326      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    272327    </div> 
    273328  </body> 
Note: See TracChangeset for help on using the changeset viewer.