Ignore:
Timestamp:
Oct 24, 2011 2:02:30 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:
70ecd530
Parents:
a4f04f2
Message:

updates docs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sansdataloader/docs/sphinx/html/api/readers/hfir1d_reader.html

    rfc5d49e3 r7247844  
    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>hfir1d_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>hfir1d_reader &mdash; DataLoader 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="DataLoader v0.1.0 documentation" href="../../index.html" /> 
     28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../../index.html" /> 
    2629    <link rel="up" title="Readers" href="index.html" /> 
    2730    <link rel="next" title="IgorReader" href="IgorReader.html" /> 
    … …  
    4447          <a href="danse_reader.html" title="danse_reader" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Readers</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="hfir1d-reader"> 
    5760<h1>hfir1d_reader<a class="headerlink" href="#hfir1d-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.hfir1d_reader"> 
    59 <span id="dataloader-readers-hfir1d-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.hfir1d_reader" title="DataLoader.readers.hfir1d_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.hfir1d_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.hfir1d_reader" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
    61 <dt id="DataLoader.readers.hfir1d_reader.Reader"> 
    62 <em class="property">class </em><tt class="descclassname">DataLoader.readers.hfir1d_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.hfir1d_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     61<div class="section" id="sans-dataloader-readers-hfir1d-reader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.hfir1d_reader" title="sans.dataloader.readers.hfir1d_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.hfir1d_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-hfir1d-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.hfir1d_reader"></span><dl class="class"> 
     64<dt id="sans.dataloader.readers.hfir1d_reader.Reader"> 
     65<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.hfir1d_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
    6467<p>Class to load HFIR 1D 4-column files</p> 
     68<dl class="attribute"> 
     69<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__class__"> 
     70<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__class__" title="Permalink to this definition">¶</a></dt> 
     71<dd><p>alias of <a class="reference internal" href="#sans.dataloader.readers.hfir1d_reader.Reader.type" title="sans.dataloader.readers.hfir1d_reader.Reader.type"><tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></a></p> 
     72</dd></dl> 
     73 
     74<dl class="attribute"> 
     75<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__delattr__"> 
     76<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__delattr__" title="Permalink to this definition">¶</a></dt> 
     77<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     78</dd></dl> 
     79 
     80<dl class="attribute"> 
     81<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__dict__"> 
     82<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0284D830&gt;</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__dict__" title="Permalink to this definition">¶</a></dt> 
     83<dd></dd></dl> 
     84 
     85<dl class="attribute"> 
     86<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__getattribute__"> 
     87<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     88<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     89</dd></dl> 
     90 
     91<dl class="attribute"> 
     92<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__hash__"> 
     93<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__hash__" title="Permalink to this definition">¶</a></dt> 
     94<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     95</dd></dl> 
     96 
     97<dl class="attribute"> 
     98<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__init__"> 
     99<tt class="descname">__init__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__init__" title="Permalink to this definition">¶</a></dt> 
     100<dd><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> 
     101</dd></dl> 
     102 
     103<dl class="attribute"> 
     104<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__module__"> 
     105<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.hfir1d_reader'</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     106<dd></dd></dl> 
     107 
     108<dl class="staticmethod"> 
     109<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__new__"> 
     110<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__new__" title="Permalink to this definition">¶</a></dt> 
     111<dd></dd></dl> 
     112 
    65113<dl class="method"> 
    66 <dt id="DataLoader.readers.hfir1d_reader.Reader.read"> 
    67 <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.readers.hfir1d_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     114<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__reduce__"> 
     115<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__reduce__" title="Permalink to this definition">¶</a></dt> 
     116<dd><p>helper for pickle</p> 
     117</dd></dl> 
     118 
     119<dl class="method"> 
     120<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__reduce_ex__"> 
     121<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     122<dd><p>helper for pickle</p> 
     123</dd></dl> 
     124 
     125<dl class="attribute"> 
     126<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__repr__"> 
     127<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__repr__" title="Permalink to this definition">¶</a></dt> 
     128<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     129</dd></dl> 
     130 
     131<dl class="attribute"> 
     132<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__setattr__"> 
     133<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__setattr__" title="Permalink to this definition">¶</a></dt> 
     134<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     135</dd></dl> 
     136 
     137<dl class="attribute"> 
     138<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__str__"> 
     139<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__str__" title="Permalink to this definition">¶</a></dt> 
     140<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     141</dd></dl> 
     142 
     143<dl class="attribute"> 
     144<dt id="sans.dataloader.readers.hfir1d_reader.Reader.__weakref__"> 
     145<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__weakref__" title="Permalink to this definition">¶</a></dt> 
     146<dd><p>list of weak references to the object (if defined)</p> 
     147</dd></dl> 
     148 
     149<dl class="attribute"> 
     150<dt id="sans.dataloader.readers.hfir1d_reader.Reader.ext"> 
     151<tt class="descname">ext</tt><em class="property"> = ['.d1d']</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     152<dd></dd></dl> 
     153 
     154<dl class="method"> 
     155<dt id="sans.dataloader.readers.hfir1d_reader.Reader.read"> 
     156<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    68157<dd><p>Load data file</p> 
    69158<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    71160<col class="field-body" /> 
    72161<tbody valign="top"> 
    73 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
     162<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
    74163</td> 
    75164</tr> 
    76 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> 
     165<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> 
    77166</td> 
    78167</tr> 
    79 <tr class="field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
     168<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
    80169<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li> 
    81170<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li> 
    … …  
    86175</table> 
    87176</dd></dl> 
     177 
     178<dl class="attribute"> 
     179<dt id="sans.dataloader.readers.hfir1d_reader.Reader.type"> 
     180<tt class="descname">type</tt><em class="property"> = ['HFIR 1D files (*.d1d)|*.d1d']</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     181<dd></dd></dl> 
     182 
     183<dl class="attribute"> 
     184<dt id="sans.dataloader.readers.hfir1d_reader.Reader.type_name"> 
     185<tt class="descname">type_name</tt><em class="property"> = 'HFIR 1D'</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     186<dd></dd></dl> 
    88187 
    89188</dd></dl> 
    … …  
    101200  <ul> 
    102201<li><a class="reference internal" href="#">hfir1d_reader</a><ul> 
    103 <li><a class="reference internal" href="#module-DataLoader.readers.hfir1d_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.hfir1d_reader</span></tt></a></li> 
     202<li><a class="reference internal" href="#sans-dataloader-readers-hfir1d-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.hfir1d_reader</span></tt></a></li> 
    104203</ul> 
    105204</li> 
    … …  
    120219  <h3>Quick search</h3> 
    121220    <form class="search" action="../../search.html" method="get"> 
    122       <input type="text" name="q" size="18" /> 
     221      <input type="text" name="q" /> 
    123222      <input type="submit" value="Go" /> 
    124223      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    149248          <a href="danse_reader.html" title="danse_reader" 
    150249             >previous</a> |</li> 
    151         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     250        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    152251          <li><a href="index.html" >Readers</a> &raquo;</li>  
    153252      </ul> 
    … …  
    155254    <div class="footer"> 
    156255        &copy; Copyright 2010, sans group. 
    157       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     256      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    158257    </div> 
    159258  </body> 
Note: See TracChangeset for help on using the changeset viewer.