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/abs_reader.html

    rfc5d49e3 r7247844  
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    55 
     6 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    78  <head> 
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>abs_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>abs_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="ascii_reader" href="ascii_reader.html" /> 
     
    4447          <a href="index.html" title="Readers" 
    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="abs-reader"> 
    5760<h1>abs_reader<a class="headerlink" href="#abs-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.abs_reader"> 
    59 <span id="dataloader-readers-abs-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.abs_reader" title="DataLoader.readers.abs_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.abs_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.abs_reader" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
    61 <dt id="DataLoader.readers.abs_reader.Reader"> 
    62 <em class="property">class </em><tt class="descclassname">DataLoader.readers.abs_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.abs_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     61<div class="section" id="sans-dataloader-readers-abs-reader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.abs_reader" title="sans.dataloader.readers.abs_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.abs_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-abs-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.abs_reader"></span><dl class="class"> 
     64<dt id="sans.dataloader.readers.abs_reader.Reader"> 
     65<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.abs_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Class to load IGOR reduced .ABS files</p> 
     67<dl class="attribute"> 
     68<dt id="sans.dataloader.readers.abs_reader.Reader.__module__"> 
     69<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.abs_reader'</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     70<dd></dd></dl> 
     71 
     72<dl class="attribute"> 
     73<dt id="sans.dataloader.readers.abs_reader.Reader.ext"> 
     74<tt class="descname">ext</tt><em class="property"> = ['.abs', '.ABS']</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     75<dd></dd></dl> 
     76 
    6477<dl class="method"> 
    65 <dt id="DataLoader.readers.abs_reader.Reader.read"> 
    66 <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.readers.abs_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     78<dt id="sans.dataloader.readers.abs_reader.Reader.read"> 
     79<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    6780<dd><p>Load data file.</p> 
    6881<table class="docutils field-list" frame="void" rules="none"> 
     
    7083<col class="field-body" /> 
    7184<tbody valign="top"> 
    72 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
     85<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> 
    7386</td> 
    7487</tr> 
    75 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> 
     88<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> 
    7689</td> 
    7790</tr> 
    78 <tr class="field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
     91<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
    7992<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li> 
    8093<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li> 
     
    8598</table> 
    8699</dd></dl> 
     100 
     101<dl class="attribute"> 
     102<dt id="sans.dataloader.readers.abs_reader.Reader.type"> 
     103<tt class="descname">type</tt><em class="property"> = ['IGOR 1D files (*.abs)|*.abs']</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     104<dd></dd></dl> 
     105 
     106<dl class="attribute"> 
     107<dt id="sans.dataloader.readers.abs_reader.Reader.type_name"> 
     108<tt class="descname">type_name</tt><em class="property"> = 'IGOR 1D'</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     109<dd></dd></dl> 
    87110 
    88111</dd></dl> 
     
    100123  <ul> 
    101124<li><a class="reference internal" href="#">abs_reader</a><ul> 
    102 <li><a class="reference internal" href="#module-DataLoader.readers.abs_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.abs_reader</span></tt></a></li> 
     125<li><a class="reference internal" href="#sans-dataloader-readers-abs-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.abs_reader</span></tt></a></li> 
    103126</ul> 
    104127</li> 
     
    119142  <h3>Quick search</h3> 
    120143    <form class="search" action="../../search.html" method="get"> 
    121       <input type="text" name="q" size="18" /> 
     144      <input type="text" name="q" /> 
    122145      <input type="submit" value="Go" /> 
    123146      <input type="hidden" name="check_keywords" value="yes" /> 
     
    148171          <a href="index.html" title="Readers" 
    149172             >previous</a> |</li> 
    150         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     173        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    151174          <li><a href="index.html" >Readers</a> &raquo;</li>  
    152175      </ul> 
     
    154177    <div class="footer"> 
    155178        &copy; Copyright 2010, sans group. 
    156       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     179      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    157180    </div> 
    158181  </body> 
Note: See TracChangeset for help on using the changeset viewer.