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/BroadPeakModel.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>BroadPeakModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>BroadPeakModel &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="CappedCylinderModel" href="CappedCylinderModel.html" /> 
    … …  
    4447          <a href="BinaryHSPSF11Model.html" title="BinaryHSPSF11Model" 
    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="broadpeakmodel"> 
    5760<h1>BroadPeakModel<a class="headerlink" href="#broadpeakmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.BroadPeakModel"> 
    59 <span id="sans-models-broadpeakmodel"></span><h2><a class="reference internal" href="#module-sans.models.BroadPeakModel" title="sans.models.BroadPeakModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BroadPeakModel</span></tt></a><a class="headerlink" href="#module-sans.models.BroadPeakModel" title="Permalink to this headline">¶</a></h2> 
    60 <p>BroadPeakModel function as a BaseComponent model</p> 
     61<div class="section" id="sans-models-broadpeakmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.BroadPeakModel" title="sans.models.BroadPeakModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BroadPeakModel</span></tt></a><a class="headerlink" href="#sans-models-broadpeakmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.BroadPeakModel"></span><p>BroadPeakModel function as a BaseComponent model</p> 
    6164<dl class="class"> 
    6265<dt id="sans.models.BroadPeakModel.BroadPeakModel"> 
    … …  
    6770(1.0 + pow((qval*length_l),exponent_l) )+ background</p> 
    6871<dl class="method"> 
     72<dt id="sans.models.BroadPeakModel.BroadPeakModel.__add__"> 
     73<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__add__" title="Permalink to this definition">¶</a></dt> 
     74<dd></dd></dl> 
     75 
     76<dl class="method"> 
     77<dt id="sans.models.BroadPeakModel.BroadPeakModel.__div__"> 
     78<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__div__" title="Permalink to this definition">¶</a></dt> 
     79<dd></dd></dl> 
     80 
     81<dl class="method"> 
     82<dt id="sans.models.BroadPeakModel.BroadPeakModel.__init__"> 
     83<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__init__" title="Permalink to this definition">¶</a></dt> 
     84<dd><p>Initialization</p> 
     85</dd></dl> 
     86 
     87<dl class="attribute"> 
     88<dt id="sans.models.BroadPeakModel.BroadPeakModel.__module__"> 
     89<tt class="descname">__module__</tt><em class="property"> = 'sans.models.BroadPeakModel'</em><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__module__" title="Permalink to this definition">¶</a></dt> 
     90<dd></dd></dl> 
     91 
     92<dl class="method"> 
     93<dt id="sans.models.BroadPeakModel.BroadPeakModel.__mul__"> 
     94<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     95<dd></dd></dl> 
     96 
     97<dl class="method"> 
     98<dt id="sans.models.BroadPeakModel.BroadPeakModel.__str__"> 
     99<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__str__" title="Permalink to this definition">¶</a></dt> 
     100<dd><table class="docutils field-list" frame="void" rules="none"> 
     101<col class="field-name" /> 
     102<col class="field-body" /> 
     103<tbody valign="top"> 
     104<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     105</tr> 
     106</tbody> 
     107</table> 
     108</dd></dl> 
     109 
     110<dl class="method"> 
     111<dt id="sans.models.BroadPeakModel.BroadPeakModel.__sub__"> 
     112<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     113<dd></dd></dl> 
     114 
     115<dl class="method"> 
     116<dt id="sans.models.BroadPeakModel.BroadPeakModel._broadpeak"> 
     117<tt class="descname">_broadpeak</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel._broadpeak" title="Permalink to this definition">¶</a></dt> 
     118<dd><p>Model definition</p> 
     119</dd></dl> 
     120 
     121<dl class="method"> 
     122<dt id="sans.models.BroadPeakModel.BroadPeakModel._clone"> 
     123<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel._clone" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>Internal utility function to copy the internal 
     125data members to a fresh copy.</p> 
     126</dd></dl> 
     127 
     128<dl class="method"> 
    69129<dt id="sans.models.BroadPeakModel.BroadPeakModel.calculate_ER"> 
    70130<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    79139<dl class="method"> 
    80140<dt id="sans.models.BroadPeakModel.BroadPeakModel.evalDistribution"> 
    81 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     141<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    82142<dd><p>Evaluate a distribution of q-values.</p> 
    83143<ul> 
    … …  
    104164<col class="field-body" /> 
    105165<tbody valign="top"> 
    106 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     166<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  
    107167is supported for python models, thus C-models should have</p> 
    108168<blockquote class="last"> 
    … …  
    120180<col class="field-body" /> 
    121181<tbody valign="top"> 
    122 <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]  
     182<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]  
    123183where qx,qy are 1D ndarrays</td> 
    124184</tr> 
    … …  
    135195<dl class="method"> 
    136196<dt id="sans.models.BroadPeakModel.BroadPeakModel.getParam"> 
    137 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.getParam" title="Permalink to this definition">¶</a></dt> 
     197<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.getParam" title="Permalink to this definition">¶</a></dt> 
    138198<dd><p>Set the value of a model parameter</p> 
    139199<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    141201<col class="field-body" /> 
    142202<tbody valign="top"> 
    143 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     203<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    144204</tr> 
    145205</tbody> 
    … …  
    155215<dl class="method"> 
    156216<dt id="sans.models.BroadPeakModel.BroadPeakModel.getParamListWithToken"> 
    157 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     217<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    158218<dd></dd></dl> 
    159219 
    160220<dl class="method"> 
    161221<dt id="sans.models.BroadPeakModel.BroadPeakModel.getParamWithToken"> 
    162 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     222<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    163223<dd></dd></dl> 
    164224 
    165225<dl class="method"> 
    166226<dt id="sans.models.BroadPeakModel.BroadPeakModel.is_fittable"> 
    167 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     227<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    168228<dd><p>Check if a given parameter is fittable or not</p> 
    169229<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    171231<col class="field-body" /> 
    172232<tbody valign="top"> 
    173 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     233<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> 
    174234</tr> 
    175235</tbody> 
    … …  
    179239<dl class="method"> 
    180240<dt id="sans.models.BroadPeakModel.BroadPeakModel.run"> 
    181 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.run" title="Permalink to this definition">¶</a></dt> 
     241<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.run" title="Permalink to this definition">¶</a></dt> 
    182242<dd><p>Evaluate the model</p> 
    183243<p>param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    187247<dl class="method"> 
    188248<dt id="sans.models.BroadPeakModel.BroadPeakModel.runXY"> 
    189 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.runXY" title="Permalink to this definition">¶</a></dt> 
     249<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.runXY" title="Permalink to this definition">¶</a></dt> 
    190250<dd><p>Evaluate the model</p> 
    191251<p>param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    195255<dl class="method"> 
    196256<dt id="sans.models.BroadPeakModel.BroadPeakModel.setParam"> 
    197 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.setParam" title="Permalink to this definition">¶</a></dt> 
     257<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.setParam" title="Permalink to this definition">¶</a></dt> 
    198258<dd><p>Set the value of a model parameter</p> 
    199259<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    201261<col class="field-body" /> 
    202262<tbody valign="top"> 
    203 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    204264<li><strong>name</strong> &#8211; name of the parameter</li> 
    205265<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    213273<dl class="method"> 
    214274<dt id="sans.models.BroadPeakModel.BroadPeakModel.setParamWithToken"> 
    215 <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.BroadPeakModel.BroadPeakModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     275<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BroadPeakModel.BroadPeakModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    216276<dd></dd></dl> 
    217277 
    … …  
    230290  <ul> 
    231291<li><a class="reference internal" href="#">BroadPeakModel</a><ul> 
    232 <li><a class="reference internal" href="#module-sans.models.BroadPeakModel"><tt class="docutils literal"><span class="pre">sans.models.BroadPeakModel</span></tt></a></li> 
     292<li><a class="reference internal" href="#sans-models-broadpeakmodel"><tt class="docutils literal"><span class="pre">sans.models.BroadPeakModel</span></tt></a></li> 
    233293</ul> 
    234294</li> 
    … …  
    249309  <h3>Quick search</h3> 
    250310    <form class="search" action="../search.html" method="get"> 
    251       <input type="text" name="q" size="18" /> 
     311      <input type="text" name="q" /> 
    252312      <input type="submit" value="Go" /> 
    253313      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    278338          <a href="BinaryHSPSF11Model.html" title="BinaryHSPSF11Model" 
    279339             >previous</a> |</li> 
    280         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     340        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    281341          <li><a href="index.html" >Reference</a> &raquo;</li>  
    282342      </ul> 
    … …  
    284344    <div class="footer"> 
    285345        &copy; Copyright 2010, sans group. 
    286       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     346      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    287347    </div> 
    288348  </body> 
Note: See TracChangeset for help on using the changeset viewer.