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/Cos.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>Cos &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>Cos &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="CSParallelepipedModel" href="CSParallelepipedModel.html" /> 
    … …  
    4447          <a href="CorrLengthModel.html" title="CorrLengthModel" 
    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="cos"> 
    5760<h1>Cos<a class="headerlink" href="#cos" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.Cos"> 
    59 <span id="sans-models-cos"></span><h2><a class="reference internal" href="#module-sans.models.Cos" title="sans.models.Cos"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Cos</span></tt></a><a class="headerlink" href="#module-sans.models.Cos" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide cos(x) function as a BaseComponent model</p> 
     61<div class="section" id="sans-models-cos"> 
     62<h2><a class="reference internal" href="#module-sans.models.Cos" title="sans.models.Cos"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Cos</span></tt></a><a class="headerlink" href="#sans-models-cos" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.Cos"></span><p>Provide cos(x) function as a BaseComponent model</p> 
    6164<dl class="class"> 
    6265<dt id="sans.models.Cos.Cos"> 
    … …  
    6568<p>Class that evaluates a cos(x) model.</p> 
    6669<dl class="method"> 
     70<dt id="sans.models.Cos.Cos.__add__"> 
     71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.__add__" title="Permalink to this definition">¶</a></dt> 
     72<dd></dd></dl> 
     73 
     74<dl class="method"> 
     75<dt id="sans.models.Cos.Cos.__div__"> 
     76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.__div__" title="Permalink to this definition">¶</a></dt> 
     77<dd></dd></dl> 
     78 
     79<dl class="method"> 
     80<dt id="sans.models.Cos.Cos.__init__"> 
     81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.__init__" title="Permalink to this definition">¶</a></dt> 
     82<dd><p>Initialization</p> 
     83</dd></dl> 
     84 
     85<dl class="attribute"> 
     86<dt id="sans.models.Cos.Cos.__module__"> 
     87<tt class="descname">__module__</tt><em class="property"> = 'sans.models.Cos'</em><a class="headerlink" href="#sans.models.Cos.Cos.__module__" title="Permalink to this definition">¶</a></dt> 
     88<dd></dd></dl> 
     89 
     90<dl class="method"> 
     91<dt id="sans.models.Cos.Cos.__mul__"> 
     92<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.__mul__" title="Permalink to this definition">¶</a></dt> 
     93<dd></dd></dl> 
     94 
     95<dl class="method"> 
     96<dt id="sans.models.Cos.Cos.__str__"> 
     97<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.__str__" title="Permalink to this definition">¶</a></dt> 
     98<dd><table class="docutils field-list" frame="void" rules="none"> 
     99<col class="field-name" /> 
     100<col class="field-body" /> 
     101<tbody valign="top"> 
     102<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     103</tr> 
     104</tbody> 
     105</table> 
     106</dd></dl> 
     107 
     108<dl class="method"> 
     109<dt id="sans.models.Cos.Cos.__sub__"> 
     110<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.__sub__" title="Permalink to this definition">¶</a></dt> 
     111<dd></dd></dl> 
     112 
     113<dl class="method"> 
     114<dt id="sans.models.Cos.Cos._clone"> 
     115<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos._clone" title="Permalink to this definition">¶</a></dt> 
     116<dd><p>Internal utility function to copy the internal 
     117data members to a fresh copy.</p> 
     118</dd></dl> 
     119 
     120<dl class="method"> 
    67121<dt id="sans.models.Cos.Cos.calculate_ER"> 
    68122<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    77131<dl class="method"> 
    78132<dt id="sans.models.Cos.Cos.evalDistribution"> 
    79 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     133<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    80134<dd><p>Evaluate a distribution of q-values.</p> 
    81135<ul> 
    … …  
    102156<col class="field-body" /> 
    103157<tbody valign="top"> 
    104 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     158<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  
    105159is supported for python models, thus C-models should have</p> 
    106160<blockquote class="last"> 
    … …  
    118172<col class="field-body" /> 
    119173<tbody valign="top"> 
    120 <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]  
     174<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]  
    121175where qx,qy are 1D ndarrays</td> 
    122176</tr> 
    … …  
    133187<dl class="method"> 
    134188<dt id="sans.models.Cos.Cos.getParam"> 
    135 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.getParam" title="Permalink to this definition">¶</a></dt> 
     189<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.getParam" title="Permalink to this definition">¶</a></dt> 
    136190<dd><p>Set the value of a model parameter</p> 
    137191<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    139193<col class="field-body" /> 
    140194<tbody valign="top"> 
    141 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     195<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    142196</tr> 
    143197</tbody> 
    … …  
    153207<dl class="method"> 
    154208<dt id="sans.models.Cos.Cos.getParamListWithToken"> 
    155 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     209<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    156210<dd></dd></dl> 
    157211 
    158212<dl class="method"> 
    159213<dt id="sans.models.Cos.Cos.getParamWithToken"> 
    160 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     214<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    161215<dd></dd></dl> 
    162216 
    163217<dl class="method"> 
    164218<dt id="sans.models.Cos.Cos.is_fittable"> 
    165 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.is_fittable" title="Permalink to this definition">¶</a></dt> 
     219<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.is_fittable" title="Permalink to this definition">¶</a></dt> 
    166220<dd><p>Check if a given parameter is fittable or not</p> 
    167221<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    169223<col class="field-body" /> 
    170224<tbody valign="top"> 
    171 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     225<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> 
    172226</tr> 
    173227</tbody> 
    … …  
    177231<dl class="method"> 
    178232<dt id="sans.models.Cos.Cos.run"> 
    179 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.run" title="Permalink to this definition">¶</a></dt> 
     233<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.run" title="Permalink to this definition">¶</a></dt> 
    180234<dd><p>Evaluate the model 
    181235&#64;param x: input x, or [x, phi] [radian] 
    … …  
    185239<dl class="method"> 
    186240<dt id="sans.models.Cos.Cos.runXY"> 
    187 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.runXY" title="Permalink to this definition">¶</a></dt> 
     241<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.runXY" title="Permalink to this definition">¶</a></dt> 
    188242<dd><p>Evaluate the model 
    189243&#64;param x: input x, or [x, y] [radian] 
    … …  
    193247<dl class="method"> 
    194248<dt id="sans.models.Cos.Cos.setParam"> 
    195 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.setParam" title="Permalink to this definition">¶</a></dt> 
     249<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.setParam" title="Permalink to this definition">¶</a></dt> 
    196250<dd><p>Set the value of a model parameter</p> 
    197251<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    199253<col class="field-body" /> 
    200254<tbody valign="top"> 
    201 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     255<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    202256<li><strong>name</strong> &#8211; name of the parameter</li> 
    203257<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    211265<dl class="method"> 
    212266<dt id="sans.models.Cos.Cos.setParamWithToken"> 
    213 <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.Cos.Cos.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     267<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Cos.Cos.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    214268<dd></dd></dl> 
    215269 
    … …  
    228282  <ul> 
    229283<li><a class="reference internal" href="#">Cos</a><ul> 
    230 <li><a class="reference internal" href="#module-sans.models.Cos"><tt class="docutils literal"><span class="pre">sans.models.Cos</span></tt></a></li> 
     284<li><a class="reference internal" href="#sans-models-cos"><tt class="docutils literal"><span class="pre">sans.models.Cos</span></tt></a></li> 
    231285</ul> 
    232286</li> 
    … …  
    247301  <h3>Quick search</h3> 
    248302    <form class="search" action="../search.html" method="get"> 
    249       <input type="text" name="q" size="18" /> 
     303      <input type="text" name="q" /> 
    250304      <input type="submit" value="Go" /> 
    251305      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    276330          <a href="CorrLengthModel.html" title="CorrLengthModel" 
    277331             >previous</a> |</li> 
    278         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     332        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    279333          <li><a href="index.html" >Reference</a> &raquo;</li>  
    280334      </ul> 
    … …  
    282336    <div class="footer"> 
    283337        &copy; Copyright 2010, sans group. 
    284       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     338      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    285339    </div> 
    286340  </body> 
Note: See TracChangeset for help on using the changeset viewer.