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

Location:
sansdataloader/docs/sphinx/html/api/readers
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • sansdataloader/docs/sphinx/html/api/readers/IgorReader.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>IgorReader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>IgorReader &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="red2d_reader" href="red2d_reader.html" /> 
    … …  
    4447          <a href="hfir1d_reader.html" title="hfir1d_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="igorreader"> 
    5760<h1>IgorReader<a class="headerlink" href="#igorreader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.IgorReader"> 
    59 <span id="dataloader-readers-igorreader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.IgorReader" title="DataLoader.readers.IgorReader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.IgorReader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.IgorReader" title="Permalink to this headline">¶</a></h2> 
    60 <p>IGOR 2D reduced file reader</p> 
     61<div class="section" id="sans-dataloader-readers-igorreader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.IgorReader" title="sans.dataloader.readers.IgorReader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.IgorReader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-igorreader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.IgorReader"></span><p>IGOR 2D reduced file reader</p> 
    6164<dl class="class"> 
    62 <dt id="DataLoader.readers.IgorReader.Reader"> 
    63 <em class="property">class </em><tt class="descclassname">DataLoader.readers.IgorReader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.IgorReader.Reader" title="Permalink to this definition">¶</a></dt> 
     65<dt id="sans.dataloader.readers.IgorReader.Reader"> 
     66<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.IgorReader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.IgorReader.Reader" title="Permalink to this definition">¶</a></dt> 
    6467<dd><p>Simple data reader for Igor data files</p> 
     68<dl class="attribute"> 
     69<dt id="sans.dataloader.readers.IgorReader.Reader.__module__"> 
     70<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.IgorReader'</em><a class="headerlink" href="#sans.dataloader.readers.IgorReader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     71<dd></dd></dl> 
     72 
     73<dl class="attribute"> 
     74<dt id="sans.dataloader.readers.IgorReader.Reader.ext"> 
     75<tt class="descname">ext</tt><em class="property"> = ['.ASC', '.asc']</em><a class="headerlink" href="#sans.dataloader.readers.IgorReader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     76<dd></dd></dl> 
     77 
    6578<dl class="method"> 
    66 <dt id="DataLoader.readers.IgorReader.Reader.read"> 
    67 <tt class="descname">read</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#DataLoader.readers.IgorReader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     79<dt id="sans.dataloader.readers.IgorReader.Reader.read"> 
     80<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.IgorReader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    6881<dd><p>Read file</p> 
    6982</dd></dl> 
     83 
     84<dl class="attribute"> 
     85<dt id="sans.dataloader.readers.IgorReader.Reader.type"> 
     86<tt class="descname">type</tt><em class="property"> = ['IGOR 2D files (*.ASC)|*.ASC']</em><a class="headerlink" href="#sans.dataloader.readers.IgorReader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="attribute"> 
     90<dt id="sans.dataloader.readers.IgorReader.Reader.type_name"> 
     91<tt class="descname">type_name</tt><em class="property"> = 'IGOR 2D'</em><a class="headerlink" href="#sans.dataloader.readers.IgorReader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
    7093 
    7194</dd></dl> 
    … …  
    83106  <ul> 
    84107<li><a class="reference internal" href="#">IgorReader</a><ul> 
    85 <li><a class="reference internal" href="#module-DataLoader.readers.IgorReader"><tt class="docutils literal"><span class="pre">DataLoader.readers.IgorReader</span></tt></a></li> 
     108<li><a class="reference internal" href="#sans-dataloader-readers-igorreader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.IgorReader</span></tt></a></li> 
    86109</ul> 
    87110</li> 
    … …  
    102125  <h3>Quick search</h3> 
    103126    <form class="search" action="../../search.html" method="get"> 
    104       <input type="text" name="q" size="18" /> 
     127      <input type="text" name="q" /> 
    105128      <input type="submit" value="Go" /> 
    106129      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    131154          <a href="hfir1d_reader.html" title="hfir1d_reader" 
    132155             >previous</a> |</li> 
    133         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     156        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    134157          <li><a href="index.html" >Readers</a> &raquo;</li>  
    135158      </ul> 
    … …  
    137160    <div class="footer"> 
    138161        &copy; Copyright 2010, sans group. 
    139       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     162      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    140163    </div> 
    141164  </body> 

  • 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> 

  • sansdataloader/docs/sphinx/html/api/readers/ascii_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>ascii_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>ascii_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="associations" href="associations.html" /> 
    … …  
    4447          <a href="abs_reader.html" title="abs_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="ascii-reader"> 
    5760<h1>ascii_reader<a class="headerlink" href="#ascii-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.ascii_reader"> 
    59 <span id="dataloader-readers-ascii-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.ascii_reader" title="DataLoader.readers.ascii_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.ascii_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.ascii_reader" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
    61 <dt id="DataLoader.readers.ascii_reader.Reader"> 
    62 <em class="property">class </em><tt class="descclassname">DataLoader.readers.ascii_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.ascii_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     61<div class="section" id="sans-dataloader-readers-ascii-reader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.ascii_reader" title="sans.dataloader.readers.ascii_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.ascii_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-ascii-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.ascii_reader"></span><dl class="class"> 
     64<dt id="sans.dataloader.readers.ascii_reader.Reader"> 
     65<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.ascii_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Class to load ascii files (2, 3 or 4 columns).</p> 
     67<dl class="attribute"> 
     68<dt id="sans.dataloader.readers.ascii_reader.Reader.__module__"> 
     69<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.ascii_reader'</em><a class="headerlink" href="#sans.dataloader.readers.ascii_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.ascii_reader.Reader.allow_all"> 
     74<tt class="descname">allow_all</tt><em class="property"> = True</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.allow_all" title="Permalink to this definition">¶</a></dt> 
     75<dd></dd></dl> 
     76 
     77<dl class="attribute"> 
     78<dt id="sans.dataloader.readers.ascii_reader.Reader.ext"> 
     79<tt class="descname">ext</tt><em class="property"> = ['.txt', '.TXT', '.dat', '.DAT', '.abs', '.ABS', 'csv', 'CSV']</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     80<dd></dd></dl> 
     81 
    6482<dl class="method"> 
    65 <dt id="DataLoader.readers.ascii_reader.Reader.read"> 
    66 <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.readers.ascii_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     83<dt id="sans.dataloader.readers.ascii_reader.Reader.read"> 
     84<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    6785<dd><p>Load data file</p> 
    6886<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    7088<col class="field-body" /> 
    7189<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> 
     90<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> 
    7391</td> 
    7492</tr> 
    75 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> 
     93<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> 
    7694</td> 
    7795</tr> 
    78 <tr class="field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
     96<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
    7997<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li> 
    8098<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li> 
    … …  
    85103</table> 
    86104</dd></dl> 
     105 
     106<dl class="attribute"> 
     107<dt id="sans.dataloader.readers.ascii_reader.Reader.type"> 
     108<tt class="descname">type</tt><em class="property"> = ['ASCII files (*.txt)|*.txt', 'ASCII files (*.dat)|*.dat', 'ASCII files (*.abs)|*.abs', 'CSV files (*.csv)|*.csv']</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     109<dd></dd></dl> 
     110 
     111<dl class="attribute"> 
     112<dt id="sans.dataloader.readers.ascii_reader.Reader.type_name"> 
     113<tt class="descname">type_name</tt><em class="property"> = 'ASCII'</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     114<dd></dd></dl> 
    87115 
    88116</dd></dl> 
    … …  
    100128  <ul> 
    101129<li><a class="reference internal" href="#">ascii_reader</a><ul> 
    102 <li><a class="reference internal" href="#module-DataLoader.readers.ascii_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.ascii_reader</span></tt></a></li> 
     130<li><a class="reference internal" href="#sans-dataloader-readers-ascii-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.ascii_reader</span></tt></a></li> 
    103131</ul> 
    104132</li> 
    … …  
    119147  <h3>Quick search</h3> 
    120148    <form class="search" action="../../search.html" method="get"> 
    121       <input type="text" name="q" size="18" /> 
     149      <input type="text" name="q" /> 
    122150      <input type="submit" value="Go" /> 
    123151      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    148176          <a href="abs_reader.html" title="abs_reader" 
    149177             >previous</a> |</li> 
    150         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     178        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    151179          <li><a href="index.html" >Readers</a> &raquo;</li>  
    152180      </ul> 
    … …  
    154182    <div class="footer"> 
    155183        &copy; Copyright 2010, sans group. 
    156       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     184      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    157185    </div> 
    158186  </body> 

  • sansdataloader/docs/sphinx/html/api/readers/associations.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>associations &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>associations &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="cansas_reader" href="cansas_reader.html" /> 
    … …  
    4447          <a href="ascii_reader.html" title="ascii_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="associations"> 
    5760<h1>associations<a class="headerlink" href="#associations" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.associations"> 
    59 <span id="dataloader-readers-associations"></span><h2><a class="reference internal" href="#module-DataLoader.readers.associations" title="DataLoader.readers.associations"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.associations" title="Permalink to this headline">¶</a></h2> 
    60 <p>Module to associate default readers to file extensions. 
     61<div class="section" id="sans-dataloader-readers-associations"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.associations" title="sans.dataloader.readers.associations"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-associations" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.associations"></span><p>Module to associate default readers to file extensions. 
    6164The module reads an xml file to get the readers for each file extension. 
    6265The readers are tried in order they appear when reading a file.</p> 
    6366<dl class="function"> 
    64 <dt id="DataLoader.readers.associations.read_associations"> 
    65 <tt class="descclassname">DataLoader.readers.associations.</tt><tt class="descname">read_associations</tt><big>(</big><em>loader</em>, <em>settings='defaults.xml'</em><big>)</big><a class="headerlink" href="#DataLoader.readers.associations.read_associations" title="Permalink to this definition">¶</a></dt> 
     67<dt id="sans.dataloader.readers.associations.read_associations"> 
     68<tt class="descclassname">sans.dataloader.readers.associations.</tt><tt class="descname">read_associations</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.associations.read_associations" title="Permalink to this definition">¶</a></dt> 
    6669<dd><p>Read the specified settings file to associate 
    6770default readers to file extension.</p> 
    … …  
    7073<col class="field-body" /> 
    7174<tbody valign="top"> 
    72 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     75<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    7376<li><strong>loader</strong> &#8211; Loader object</li> 
    7477<li><strong>settings</strong> &#8211; path to the XML settings file [string]</li> 
    … …  
    8184 
    8285<dl class="function"> 
    83 <dt id="DataLoader.readers.associations.register_readers"> 
    84 <tt class="descclassname">DataLoader.readers.associations.</tt><tt class="descname">register_readers</tt><big>(</big><em>registry_function</em><big>)</big><a class="headerlink" href="#DataLoader.readers.associations.register_readers" title="Permalink to this definition">¶</a></dt> 
     86<dt id="sans.dataloader.readers.associations.register_readers"> 
     87<tt class="descclassname">sans.dataloader.readers.associations.</tt><tt class="descname">register_readers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.associations.register_readers" title="Permalink to this definition">¶</a></dt> 
    8588<dd><p>Function called by the registry/loader object to register 
    8689all default readers using a call back function.</p> 
    … …  
    8992<col class="field-body" /> 
    9093<tbody valign="top"> 
    91 <tr class="field"><th class="field-name">Warning :</th><td class="field-body">this method is now obsolete</td> 
     94<tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">this method is now obsolete</td> 
    9295</tr> 
    93 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>registry_function</strong> &#8211; function to be called to register each reader</td> 
     96<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><strong>registry_function</strong> &#8211; function to be called to register each reader</td> 
    9497</tr> 
    9598</tbody> 
    … …  
    109112  <ul> 
    110113<li><a class="reference internal" href="#">associations</a><ul> 
    111 <li><a class="reference internal" href="#module-DataLoader.readers.associations"><tt class="docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a></li> 
     114<li><a class="reference internal" href="#sans-dataloader-readers-associations"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a></li> 
    112115</ul> 
    113116</li> 
    … …  
    128131  <h3>Quick search</h3> 
    129132    <form class="search" action="../../search.html" method="get"> 
    130       <input type="text" name="q" size="18" /> 
     133      <input type="text" name="q" /> 
    131134      <input type="submit" value="Go" /> 
    132135      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    157160          <a href="ascii_reader.html" title="ascii_reader" 
    158161             >previous</a> |</li> 
    159         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     162        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    160163          <li><a href="index.html" >Readers</a> &raquo;</li>  
    161164      </ul> 
    … …  
    163166    <div class="footer"> 
    164167        &copy; Copyright 2010, sans group. 
    165       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     168      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    166169    </div> 
    167170  </body> 

  • sansdataloader/docs/sphinx/html/api/readers/cansas_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>cansas_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>cansas_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="danse_reader" href="danse_reader.html" /> 
    … …  
    4447          <a href="associations.html" title="associations" 
    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="cansas-reader"> 
    5760<h1>cansas_reader<a class="headerlink" href="#cansas-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.cansas_reader"> 
    59 <span id="dataloader-readers-cansas-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.cansas_reader" title="DataLoader.readers.cansas_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.cansas_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.cansas_reader" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
    61 <dt id="DataLoader.readers.cansas_reader.Reader"> 
    62 <em class="property">class </em><tt class="descclassname">DataLoader.readers.cansas_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.cansas_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     61<div class="section" id="sans-dataloader-readers-cansas-reader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.cansas_reader" title="sans.dataloader.readers.cansas_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-cansas-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.cansas_reader"></span><dl class="class"> 
     64<dt id="sans.dataloader.readers.cansas_reader.Reader"> 
     65<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.cansas_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Class to load cansas 1D XML files</p> 
    6467<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    6669<col class="field-body" /> 
    6770<tbody valign="top"> 
    68 <tr class="field"><th class="field-name">Dependencies :</th><td class="field-body">The CanSas reader requires PyXML 0.8.4 or later.</td> 
    69 </tr> 
    70 </tbody> 
    71 </table> 
    72 <dl class="method"> 
    73 <dt id="DataLoader.readers.cansas_reader.Reader.read"> 
    74 <tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.readers.cansas_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     71<tr class="field-odd field"><th class="field-name">Dependencies :</th><td class="field-body">The CanSas reader requires PyXML 0.8.4 or later.</td> 
     72</tr> 
     73</tbody> 
     74</table> 
     75<dl class="method"> 
     76<dt id="sans.dataloader.readers.cansas_reader.Reader.__init__"> 
     77<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.__init__" title="Permalink to this definition">¶</a></dt> 
     78<dd></dd></dl> 
     79 
     80<dl class="attribute"> 
     81<dt id="sans.dataloader.readers.cansas_reader.Reader.__module__"> 
     82<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.cansas_reader'</em><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     83<dd></dd></dl> 
     84 
     85<dl class="method"> 
     86<dt id="sans.dataloader.readers.cansas_reader.Reader._parse_entry"> 
     87<tt class="descname">_parse_entry</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader._parse_entry" title="Permalink to this definition">¶</a></dt> 
     88<dd><p>Parse a SASentry</p> 
     89<table class="docutils field-list" frame="void" rules="none"> 
     90<col class="field-name" /> 
     91<col class="field-body" /> 
     92<tbody valign="top"> 
     93<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> &#8211; SASentry node</td> 
     94</tr> 
     95<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td> 
     96</tr> 
     97</tbody> 
     98</table> 
     99</dd></dl> 
     100 
     101<dl class="method"> 
     102<dt id="sans.dataloader.readers.cansas_reader.Reader._store_content"> 
     103<tt class="descname">_store_content</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader._store_content" title="Permalink to this definition">¶</a></dt> 
     104<dd><p>Get the content of a xpath location and store 
     105the result. The value is treated as a string.</p> 
     106<p>The xpath location might or might not exist. 
     107If it does not exist, nothing is done</p> 
     108<table class="docutils field-list" frame="void" rules="none"> 
     109<col class="field-name" /> 
     110<col class="field-body" /> 
     111<tbody valign="top"> 
     112<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     113<li><strong>location</strong> &#8211; xpath location to fetch</li> 
     114<li><strong>node</strong> &#8211; node to read the data from</li> 
     115<li><strong>variable</strong> &#8211; name of the data member to store it in [string]</li> 
     116<li><strong>storage</strong> &#8211; data object that has the &#8216;variable&#8217; data member</li> 
     117</ul> 
     118</td> 
     119</tr> 
     120<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">return a list of errors</p> 
     121</td> 
     122</tr> 
     123</tbody> 
     124</table> 
     125</dd></dl> 
     126 
     127<dl class="method"> 
     128<dt id="sans.dataloader.readers.cansas_reader.Reader._store_float"> 
     129<tt class="descname">_store_float</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader._store_float" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>Get the content of a xpath location and store 
     131the result. Check that the units are compatible 
     132with the destination. The value is expected to 
     133be a float.</p> 
     134<p>The xpath location might or might not exist. 
     135If it does not exist, nothing is done</p> 
     136<table class="docutils field-list" frame="void" rules="none"> 
     137<col class="field-name" /> 
     138<col class="field-body" /> 
     139<tbody valign="top"> 
     140<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     141<li><strong>location</strong> &#8211; xpath location to fetch</li> 
     142<li><strong>node</strong> &#8211; node to read the data from</li> 
     143<li><strong>variable</strong> &#8211; name of the data member to store it in [string]</li> 
     144<li><strong>storage</strong> &#8211; data object that has the &#8216;variable&#8217; data member</li> 
     145<li><strong>optional</strong> &#8211; if True, no exception will be raised  
     146if unit conversion can&#8217;t be done</li> 
     147</ul> 
     148</td> 
     149</tr> 
     150<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     151<tr class="field-even field"><td>&nbsp;</td><td class="field-body"><p class="first last">raised when the units are not recognized</p> 
     152</td> 
     153</tr> 
     154</tbody> 
     155</table> 
     156</dd></dl> 
     157 
     158<dl class="method"> 
     159<dt id="sans.dataloader.readers.cansas_reader.Reader._to_xml_doc"> 
     160<tt class="descname">_to_xml_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader._to_xml_doc" title="Permalink to this definition">¶</a></dt> 
     161<dd><p>Create an XML document to contain the content of a Data1D</p> 
     162<table class="docutils field-list" frame="void" rules="none"> 
     163<col class="field-name" /> 
     164<col class="field-body" /> 
     165<tbody valign="top"> 
     166<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> &#8211; Data1D object</td> 
     167</tr> 
     168</tbody> 
     169</table> 
     170</dd></dl> 
     171 
     172<dl class="attribute"> 
     173<dt id="sans.dataloader.readers.cansas_reader.Reader.ext"> 
     174<tt class="descname">ext</tt><em class="property"> = ['.xml', '.XML', '.avex', '.AVEx', '.absx', 'ABSx']</em><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     175<dd></dd></dl> 
     176 
     177<dl class="method"> 
     178<dt id="sans.dataloader.readers.cansas_reader.Reader.read"> 
     179<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    75180<dd><p>Load data file</p> 
    76181<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    78183<col class="field-body" /> 
    79184<tbody valign="top"> 
    80 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p> 
    81 </td> 
    82 </tr> 
    83 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object if a single SASentry was found,  
     185<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> 
     186</td> 
     187</tr> 
     188<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object if a single SASentry was found,  
    84189or a list of Data1D objects if multiple entries were found, 
    85190or None of nothing was found</p> 
    86191</td> 
    87192</tr> 
    88 <tr class="field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
     193<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> 
    89194<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li> 
    90195<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li> 
    … …  
    96201</dd></dl> 
    97202 
    98 <dl class="method"> 
    99 <dt id="DataLoader.readers.cansas_reader.Reader.write"> 
    100 <tt class="descname">write</tt><big>(</big><em>filename</em>, <em>datainfo</em><big>)</big><a class="headerlink" href="#DataLoader.readers.cansas_reader.Reader.write" title="Permalink to this definition">¶</a></dt> 
     203<dl class="attribute"> 
     204<dt id="sans.dataloader.readers.cansas_reader.Reader.type"> 
     205<tt class="descname">type</tt><em class="property"> = ['CanSAS 1D files (*.xml)|*.xml', 'CanSAS 1D AVE files (*.AVEx)|*.AVEx', 'CanSAS 1D AVE files (*.ABSx)|*.ABSx']</em><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     206<dd></dd></dl> 
     207 
     208<dl class="attribute"> 
     209<dt id="sans.dataloader.readers.cansas_reader.Reader.type_name"> 
     210<tt class="descname">type_name</tt><em class="property"> = 'CanSAS 1D'</em><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     211<dd></dd></dl> 
     212 
     213<dl class="attribute"> 
     214<dt id="sans.dataloader.readers.cansas_reader.Reader.version"> 
     215<tt class="descname">version</tt><em class="property"> = '1.0'</em><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.version" title="Permalink to this definition">¶</a></dt> 
     216<dd></dd></dl> 
     217 
     218<dl class="method"> 
     219<dt id="sans.dataloader.readers.cansas_reader.Reader.write"> 
     220<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.Reader.write" title="Permalink to this definition">¶</a></dt> 
    101221<dd><p>Write the content of a Data1D as a CanSAS XML file</p> 
    102222<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    104224<col class="field-body" /> 
    105225<tbody valign="top"> 
    106 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     226<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    107227<li><strong>filename</strong> &#8211; name of the file to write</li> 
    108228<li><strong>datainfo</strong> &#8211; Data1D object</li> 
    … …  
    117237 
    118238<dl class="function"> 
    119 <dt id="DataLoader.readers.cansas_reader.get_content"> 
    120 <tt class="descclassname">DataLoader.readers.cansas_reader.</tt><tt class="descname">get_content</tt><big>(</big><em>location</em>, <em>node</em><big>)</big><a class="headerlink" href="#DataLoader.readers.cansas_reader.get_content" title="Permalink to this definition">¶</a></dt> 
     239<dt id="sans.dataloader.readers.cansas_reader.get_content"> 
     240<tt class="descclassname">sans.dataloader.readers.cansas_reader.</tt><tt class="descname">get_content</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.get_content" title="Permalink to this definition">¶</a></dt> 
    121241<dd><p>Get the first instance of the content of a xpath location.</p> 
    122242<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    124244<col class="field-body" /> 
    125245<tbody valign="top"> 
    126 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     246<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    127247<li><strong>location</strong> &#8211; xpath location</li> 
    128248<li><strong>node</strong> &#8211; node to start at</li> 
    … …  
    130250</td> 
    131251</tr> 
    132 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Element, or None</p> 
     252<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Element, or None</p> 
    133253</td> 
    134254</tr> 
    … …  
    138258 
    139259<dl class="function"> 
    140 <dt id="DataLoader.readers.cansas_reader.get_float"> 
    141 <tt class="descclassname">DataLoader.readers.cansas_reader.</tt><tt class="descname">get_float</tt><big>(</big><em>location</em>, <em>node</em><big>)</big><a class="headerlink" href="#DataLoader.readers.cansas_reader.get_float" title="Permalink to this definition">¶</a></dt> 
     260<dt id="sans.dataloader.readers.cansas_reader.get_float"> 
     261<tt class="descclassname">sans.dataloader.readers.cansas_reader.</tt><tt class="descname">get_float</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.get_float" title="Permalink to this definition">¶</a></dt> 
    142262<dd><p>Get the content of a node as a float</p> 
    143263<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    145265<col class="field-body" /> 
    146266<tbody valign="top"> 
    147 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     267<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    148268<li><strong>location</strong> &#8211; xpath location</li> 
    149269<li><strong>node</strong> &#8211; node to start at</li> 
    … …  
    156276 
    157277<dl class="function"> 
    158 <dt id="DataLoader.readers.cansas_reader.write_node"> 
    159 <tt class="descclassname">DataLoader.readers.cansas_reader.</tt><tt class="descname">write_node</tt><big>(</big><em>doc</em>, <em>parent</em>, <em>name</em>, <em>value</em>, <em>attr={}</em><big>)</big><a class="headerlink" href="#DataLoader.readers.cansas_reader.write_node" title="Permalink to this definition">¶</a></dt> 
     278<dt id="sans.dataloader.readers.cansas_reader.write_node"> 
     279<tt class="descclassname">sans.dataloader.readers.cansas_reader.</tt><tt class="descname">write_node</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.cansas_reader.write_node" title="Permalink to this definition">¶</a></dt> 
    160280<dd><table class="docutils field-list" frame="void" rules="none"> 
    161281<col class="field-name" /> 
    162282<col class="field-body" /> 
    163283<tbody valign="top"> 
    164 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     284<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    165285<li><strong>doc</strong> &#8211; document DOM</li> 
    166286<li><strong>parent</strong> &#8211; parent node</li> 
    … …  
    171291</td> 
    172292</tr> 
    173 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if something was appended, otherwise False</p> 
     293<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if something was appended, otherwise False</p> 
    174294</td> 
    175295</tr> 
    … …  
    190310  <ul> 
    191311<li><a class="reference internal" href="#">cansas_reader</a><ul> 
    192 <li><a class="reference internal" href="#module-DataLoader.readers.cansas_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.cansas_reader</span></tt></a></li> 
     312<li><a class="reference internal" href="#sans-dataloader-readers-cansas-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader</span></tt></a></li> 
    193313</ul> 
    194314</li> 
    … …  
    209329  <h3>Quick search</h3> 
    210330    <form class="search" action="../../search.html" method="get"> 
    211       <input type="text" name="q" size="18" /> 
     331      <input type="text" name="q" /> 
    212332      <input type="submit" value="Go" /> 
    213333      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    238358          <a href="associations.html" title="associations" 
    239359             >previous</a> |</li> 
    240         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     360        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    241361          <li><a href="index.html" >Readers</a> &raquo;</li>  
    242362      </ul> 
    … …  
    244364    <div class="footer"> 
    245365        &copy; Copyright 2010, sans group. 
    246       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     366      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    247367    </div> 
    248368  </body> 

  • sansdataloader/docs/sphinx/html/api/readers/danse_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>danse_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>danse_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="hfir1d_reader" href="hfir1d_reader.html" /> 
    … …  
    4447          <a href="cansas_reader.html" title="cansas_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="danse-reader"> 
    5760<h1>danse_reader<a class="headerlink" href="#danse-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.danse_reader"> 
    59 <span id="dataloader-readers-danse-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.danse_reader" title="DataLoader.readers.danse_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.danse_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.danse_reader" title="Permalink to this headline">¶</a></h2> 
    60 <p>DANSE/SANS file reader</p> 
     61<div class="section" id="sans-dataloader-readers-danse-reader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.danse_reader" title="sans.dataloader.readers.danse_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.danse_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-danse-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.danse_reader"></span><p>DANSE/SANS file reader</p> 
    6164<dl class="class"> 
    62 <dt id="DataLoader.readers.danse_reader.Reader"> 
    63 <em class="property">class </em><tt class="descclassname">DataLoader.readers.danse_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.danse_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     65<dt id="sans.dataloader.readers.danse_reader.Reader"> 
     66<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.danse_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.danse_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6467<dd><p>Example data manipulation</p> 
     68<dl class="attribute"> 
     69<dt id="sans.dataloader.readers.danse_reader.Reader.__module__"> 
     70<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.danse_reader'</em><a class="headerlink" href="#sans.dataloader.readers.danse_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     71<dd></dd></dl> 
     72 
     73<dl class="attribute"> 
     74<dt id="sans.dataloader.readers.danse_reader.Reader.ext"> 
     75<tt class="descname">ext</tt><em class="property"> = ['.sans', '.SANS']</em><a class="headerlink" href="#sans.dataloader.readers.danse_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     76<dd></dd></dl> 
     77 
    6578<dl class="method"> 
    66 <dt id="DataLoader.readers.danse_reader.Reader.read"> 
    67 <tt class="descname">read</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#DataLoader.readers.danse_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     79<dt id="sans.dataloader.readers.danse_reader.Reader.read"> 
     80<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.danse_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    6881<dd><p>Open and read the data in a file 
    6982&#64;param file: path of the file</p> 
    7083</dd></dl> 
     84 
     85<dl class="attribute"> 
     86<dt id="sans.dataloader.readers.danse_reader.Reader.type"> 
     87<tt class="descname">type</tt><em class="property"> = ['DANSE files (*.sans)|*.sans']</em><a class="headerlink" href="#sans.dataloader.readers.danse_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     88<dd></dd></dl> 
     89 
     90<dl class="attribute"> 
     91<dt id="sans.dataloader.readers.danse_reader.Reader.type_name"> 
     92<tt class="descname">type_name</tt><em class="property"> = 'DANSE'</em><a class="headerlink" href="#sans.dataloader.readers.danse_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     93<dd></dd></dl> 
    7194 
    7295</dd></dl> 
    … …  
    84107  <ul> 
    85108<li><a class="reference internal" href="#">danse_reader</a><ul> 
    86 <li><a class="reference internal" href="#module-DataLoader.readers.danse_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.danse_reader</span></tt></a></li> 
     109<li><a class="reference internal" href="#sans-dataloader-readers-danse-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.danse_reader</span></tt></a></li> 
    87110</ul> 
    88111</li> 
    … …  
    103126  <h3>Quick search</h3> 
    104127    <form class="search" action="../../search.html" method="get"> 
    105       <input type="text" name="q" size="18" /> 
     128      <input type="text" name="q" /> 
    106129      <input type="submit" value="Go" /> 
    107130      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    132155          <a href="cansas_reader.html" title="cansas_reader" 
    133156             >previous</a> |</li> 
    134         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     157        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    135158          <li><a href="index.html" >Readers</a> &raquo;</li>  
    136159      </ul> 
    … …  
    138161    <div class="footer"> 
    139162        &copy; Copyright 2010, sans group. 
    140       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     163      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    141164    </div> 
    142165  </body> 

  • 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> 

  • sansdataloader/docs/sphinx/html/api/readers/index.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>Readers &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>Readers &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="next" title="abs_reader" href="abs_reader.html" /> 
    27     <link rel="prev" title="Reference" href="../index.html" />  
     30    <link rel="prev" title="manipulations" href="../manipulations.html" />  
    2831  </head> 
    2932  <body> 
    … …  
    4144             accesskey="N">next</a> |</li> 
    4245        <li class="right" > 
    43           <a href="../index.html" title="Reference" 
     46          <a href="../manipulations.html" title="manipulations" 
    4447             accesskey="P">previous</a> |</li> 
    45         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>  
     48        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>  
    4649      </ul> 
    4750    </div>   
    … …  
    5861<col class="field-body" /> 
    5962<tbody valign="top"> 
    60 <tr class="field"><th class="field-name">Release:</th><td class="field-body">0.1.0</td> 
     63<tr class="field-odd field"><th class="field-name">Release:</th><td class="field-body">0.1.0</td> 
    6164</tr> 
    62 <tr class="field"><th class="field-name">Date:</th><td class="field-body">August 12, 2011</td> 
     65<tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">October 24, 2011</td> 
    6366</tr> 
    6467</tbody> 
    … …  
    6770<ul> 
    6871<li class="toctree-l1"><a class="reference internal" href="abs_reader.html">abs_reader</a><ul> 
    69 <li class="toctree-l2"><a class="reference internal" href="abs_reader.html#module-DataLoader.readers.abs_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.abs_reader</span></tt></a></li> 
     72<li class="toctree-l2"><a class="reference internal" href="abs_reader.html#sans-dataloader-readers-abs-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.abs_reader</span></tt></a></li> 
    7073</ul> 
    7174</li> 
    7275<li class="toctree-l1"><a class="reference internal" href="ascii_reader.html">ascii_reader</a><ul> 
    73 <li class="toctree-l2"><a class="reference internal" href="ascii_reader.html#module-DataLoader.readers.ascii_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.ascii_reader</span></tt></a></li> 
     76<li class="toctree-l2"><a class="reference internal" href="ascii_reader.html#sans-dataloader-readers-ascii-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.ascii_reader</span></tt></a></li> 
    7477</ul> 
    7578</li> 
    7679<li class="toctree-l1"><a class="reference internal" href="associations.html">associations</a><ul> 
    77 <li class="toctree-l2"><a class="reference internal" href="associations.html#module-DataLoader.readers.associations"><tt class="docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a></li> 
     80<li class="toctree-l2"><a class="reference internal" href="associations.html#sans-dataloader-readers-associations"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a></li> 
    7881</ul> 
    7982</li> 
    8083<li class="toctree-l1"><a class="reference internal" href="cansas_reader.html">cansas_reader</a><ul> 
    81 <li class="toctree-l2"><a class="reference internal" href="cansas_reader.html#module-DataLoader.readers.cansas_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.cansas_reader</span></tt></a></li> 
     84<li class="toctree-l2"><a class="reference internal" href="cansas_reader.html#sans-dataloader-readers-cansas-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader</span></tt></a></li> 
    8285</ul> 
    8386</li> 
    8487<li class="toctree-l1"><a class="reference internal" href="danse_reader.html">danse_reader</a><ul> 
    85 <li class="toctree-l2"><a class="reference internal" href="danse_reader.html#module-DataLoader.readers.danse_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.danse_reader</span></tt></a></li> 
     88<li class="toctree-l2"><a class="reference internal" href="danse_reader.html#sans-dataloader-readers-danse-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.danse_reader</span></tt></a></li> 
    8689</ul> 
    8790</li> 
    8891<li class="toctree-l1"><a class="reference internal" href="hfir1d_reader.html">hfir1d_reader</a><ul> 
    89 <li class="toctree-l2"><a class="reference internal" href="hfir1d_reader.html#module-DataLoader.readers.hfir1d_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.hfir1d_reader</span></tt></a></li> 
     92<li class="toctree-l2"><a class="reference internal" href="hfir1d_reader.html#sans-dataloader-readers-hfir1d-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.hfir1d_reader</span></tt></a></li> 
    9093</ul> 
    9194</li> 
    9295<li class="toctree-l1"><a class="reference internal" href="IgorReader.html">IgorReader</a><ul> 
    93 <li class="toctree-l2"><a class="reference internal" href="IgorReader.html#module-DataLoader.readers.IgorReader"><tt class="docutils literal"><span class="pre">DataLoader.readers.IgorReader</span></tt></a></li> 
     96<li class="toctree-l2"><a class="reference internal" href="IgorReader.html#sans-dataloader-readers-igorreader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.IgorReader</span></tt></a></li> 
    9497</ul> 
    9598</li> 
    9699<li class="toctree-l1"><a class="reference internal" href="red2d_reader.html">red2d_reader</a><ul> 
    97 <li class="toctree-l2"><a class="reference internal" href="red2d_reader.html#module-DataLoader.readers.red2d_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.red2d_reader</span></tt></a></li> 
     100<li class="toctree-l2"><a class="reference internal" href="red2d_reader.html#sans-dataloader-readers-red2d-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.red2d_reader</span></tt></a></li> 
    98101</ul> 
    99102</li> 
    100103<li class="toctree-l1"><a class="reference internal" href="tiff_reader.html">tiff_reader</a><ul> 
    101 <li class="toctree-l2"><a class="reference internal" href="tiff_reader.html#module-DataLoader.readers.tiff_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.tiff_reader</span></tt></a></li> 
     104<li class="toctree-l2"><a class="reference internal" href="tiff_reader.html#sans-dataloader-readers-tiff-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.tiff_reader</span></tt></a></li> 
    102105</ul> 
    103106</li> 
    … …  
    113116        <div class="sphinxsidebarwrapper"> 
    114117  <h4>Previous topic</h4> 
    115   <p class="topless"><a href="../index.html" 
    116                         title="previous chapter">Reference</a></p> 
     118  <p class="topless"><a href="../manipulations.html" 
     119                        title="previous chapter">manipulations</a></p> 
    117120  <h4>Next topic</h4> 
    118121  <p class="topless"><a href="abs_reader.html" 
    … …  
    126129  <h3>Quick search</h3> 
    127130    <form class="search" action="../../search.html" method="get"> 
    128       <input type="text" name="q" size="18" /> 
     131      <input type="text" name="q" /> 
    129132      <input type="submit" value="Go" /> 
    130133      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    153156             >next</a> |</li> 
    154157        <li class="right" > 
    155           <a href="../index.html" title="Reference" 
     158          <a href="../manipulations.html" title="manipulations" 
    156159             >previous</a> |</li> 
    157         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>  
     160        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>  
    158161      </ul> 
    159162    </div> 
    160163    <div class="footer"> 
    161164        &copy; Copyright 2010, sans group. 
    162       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     165      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    163166    </div> 
    164167  </body> 

  • sansdataloader/docs/sphinx/html/api/readers/red2d_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>red2d_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>red2d_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="tiff_reader" href="tiff_reader.html" /> 
    … …  
    4447          <a href="IgorReader.html" title="IgorReader" 
    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="red2d-reader"> 
    5760<h1>red2d_reader<a class="headerlink" href="#red2d-reader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.red2d_reader"> 
    59 <span id="dataloader-readers-red2d-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.red2d_reader" title="DataLoader.readers.red2d_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.red2d_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.red2d_reader" title="Permalink to this headline">¶</a></h2> 
    60 <p>TXT/IGOR 2D Q Map file reader</p> 
     61<div class="section" id="sans-dataloader-readers-red2d-reader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.red2d_reader" title="sans.dataloader.readers.red2d_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.red2d_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-red2d-reader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.red2d_reader"></span><p>TXT/IGOR 2D Q Map file reader</p> 
    6164<dl class="class"> 
    62 <dt id="DataLoader.readers.red2d_reader.Reader"> 
    63 <em class="property">class </em><tt class="descclassname">DataLoader.readers.red2d_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.red2d_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     65<dt id="sans.dataloader.readers.red2d_reader.Reader"> 
     66<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.red2d_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6467<dd><p>Simple data reader for Igor data files</p> 
     68<dl class="attribute"> 
     69<dt id="sans.dataloader.readers.red2d_reader.Reader.__module__"> 
     70<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.red2d_reader'</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     71<dd></dd></dl> 
     72 
     73<dl class="attribute"> 
     74<dt id="sans.dataloader.readers.red2d_reader.Reader.ext"> 
     75<tt class="descname">ext</tt><em class="property"> = ['.DAT', '.dat']</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     76<dd></dd></dl> 
     77 
    6578<dl class="method"> 
    66 <dt id="DataLoader.readers.red2d_reader.Reader.read"> 
    67 <tt class="descname">read</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#DataLoader.readers.red2d_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     79<dt id="sans.dataloader.readers.red2d_reader.Reader.read"> 
     80<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    6881<dd><p>Read file</p> 
    6982</dd></dl> 
    7083 
     84<dl class="attribute"> 
     85<dt id="sans.dataloader.readers.red2d_reader.Reader.type"> 
     86<tt class="descname">type</tt><em class="property"> = ['IGOR/DAT 2D file in Q_map (*.dat)|*.DAT']</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="attribute"> 
     90<dt id="sans.dataloader.readers.red2d_reader.Reader.type_name"> 
     91<tt class="descname">type_name</tt><em class="property"> = 'IGOR/DAT 2D Q_map'</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
     93 
    7194<dl class="method"> 
    72 <dt id="DataLoader.readers.red2d_reader.Reader.write"> 
    73 <tt class="descname">write</tt><big>(</big><em>filename</em>, <em>data</em><big>)</big><a class="headerlink" href="#DataLoader.readers.red2d_reader.Reader.write" title="Permalink to this definition">¶</a></dt> 
     95<dt id="sans.dataloader.readers.red2d_reader.Reader.write"> 
     96<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.write" title="Permalink to this definition">¶</a></dt> 
    7497<dd><p>Write to .dat</p> 
    7598<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    77100<col class="field-body" /> 
    78101<tbody valign="top"> 
    79 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     102<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    80103<li><strong>filename</strong> &#8211; file name to write</li> 
    81104<li><strong>data</strong> &#8211; data2D</li> 
    … …  
    90113 
    91114<dl class="function"> 
    92 <dt id="DataLoader.readers.red2d_reader.check_point"> 
    93 <tt class="descclassname">DataLoader.readers.red2d_reader.</tt><tt class="descname">check_point</tt><big>(</big><em>x_point</em><big>)</big><a class="headerlink" href="#DataLoader.readers.red2d_reader.check_point" title="Permalink to this definition">¶</a></dt> 
     115<dt id="sans.dataloader.readers.red2d_reader.check_point"> 
     116<tt class="descclassname">sans.dataloader.readers.red2d_reader.</tt><tt class="descname">check_point</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.check_point" title="Permalink to this definition">¶</a></dt> 
    94117<dd><p>check point validity</p> 
    95118</dd></dl> 
    … …  
    107130  <ul> 
    108131<li><a class="reference internal" href="#">red2d_reader</a><ul> 
    109 <li><a class="reference internal" href="#module-DataLoader.readers.red2d_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.red2d_reader</span></tt></a></li> 
     132<li><a class="reference internal" href="#sans-dataloader-readers-red2d-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.red2d_reader</span></tt></a></li> 
    110133</ul> 
    111134</li> 
    … …  
    126149  <h3>Quick search</h3> 
    127150    <form class="search" action="../../search.html" method="get"> 
    128       <input type="text" name="q" size="18" /> 
     151      <input type="text" name="q" /> 
    129152      <input type="submit" value="Go" /> 
    130153      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    155178          <a href="IgorReader.html" title="IgorReader" 
    156179             >previous</a> |</li> 
    157         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     180        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    158181          <li><a href="index.html" >Readers</a> &raquo;</li>  
    159182      </ul> 
    … …  
    161184    <div class="footer"> 
    162185        &copy; Copyright 2010, sans group. 
    163       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     186      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    164187    </div> 
    165188  </body> 

  • sansdataloader/docs/sphinx/html/api/readers/tiff_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>tiff_reader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>tiff_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="prev" title="red2d_reader" href="red2d_reader.html" />  
    … …  
    4043          <a href="red2d_reader.html" title="red2d_reader" 
    4144             accesskey="P">previous</a> |</li> 
    42         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     45        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    4346          <li><a href="index.html" accesskey="U">Readers</a> &raquo;</li>  
    4447      </ul> 
    … …  
    5255  <div class="section" id="tiff-reader"> 
    5356<h1>tiff_reader<a class="headerlink" href="#tiff-reader" title="Permalink to this headline">¶</a></h1> 
    54 <div class="section" id="module-DataLoader.readers.tiff_reader"> 
    55 <span id="dataloader-readers-tiff-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.tiff_reader" title="DataLoader.readers.tiff_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.tiff_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.tiff_reader" title="Permalink to this headline">¶</a></h2> 
    56 <p>Image reader. Untested.</p> 
     57<div class="section" id="sans-dataloader-readers-tiff-reader"> 
     58<h2><a class="reference internal" href="#module-sans.dataloader.readers.tiff_reader" title="sans.dataloader.readers.tiff_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.tiff_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-tiff-reader" title="Permalink to this headline">¶</a></h2> 
     59<span class="target" id="module-sans.dataloader.readers.tiff_reader"></span><p>Image reader. Untested.</p> 
    5760<dl class="class"> 
    58 <dt id="DataLoader.readers.tiff_reader.Reader"> 
    59 <em class="property">class </em><tt class="descclassname">DataLoader.readers.tiff_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.tiff_reader.Reader" title="Permalink to this definition">¶</a></dt> 
     61<dt id="sans.dataloader.readers.tiff_reader.Reader"> 
     62<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.tiff_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.tiff_reader.Reader" title="Permalink to this definition">¶</a></dt> 
    6063<dd><p>Example data manipulation</p> 
     64<dl class="attribute"> 
     65<dt id="sans.dataloader.readers.tiff_reader.Reader.__module__"> 
     66<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.tiff_reader'</em><a class="headerlink" href="#sans.dataloader.readers.tiff_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> 
     67<dd></dd></dl> 
     68 
     69<dl class="attribute"> 
     70<dt id="sans.dataloader.readers.tiff_reader.Reader.ext"> 
     71<tt class="descname">ext</tt><em class="property"> = ['.tif', '.tiff']</em><a class="headerlink" href="#sans.dataloader.readers.tiff_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> 
     72<dd></dd></dl> 
     73 
    6174<dl class="method"> 
    62 <dt id="DataLoader.readers.tiff_reader.Reader.read"> 
    63 <tt class="descname">read</tt><big>(</big><em>filename=None</em><big>)</big><a class="headerlink" href="#DataLoader.readers.tiff_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
     75<dt id="sans.dataloader.readers.tiff_reader.Reader.read"> 
     76<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.tiff_reader.Reader.read" title="Permalink to this definition">¶</a></dt> 
    6477<dd><p>Open and read the data in a file</p> 
    6578<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    6780<col class="field-body" /> 
    6881<tbody valign="top"> 
    69 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> &#8211; path of the file</td> 
     82<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> &#8211; path of the file</td> 
    7083</tr> 
    7184</tbody> 
    7285</table> 
    7386</dd></dl> 
     87 
     88<dl class="attribute"> 
     89<dt id="sans.dataloader.readers.tiff_reader.Reader.type"> 
     90<tt class="descname">type</tt><em class="property"> = ['TIF files (*.tif)|*.tif', 'TIFF files (*.tiff)|*.tiff']</em><a class="headerlink" href="#sans.dataloader.readers.tiff_reader.Reader.type" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="attribute"> 
     94<dt id="sans.dataloader.readers.tiff_reader.Reader.type_name"> 
     95<tt class="descname">type_name</tt><em class="property"> = 'TIF'</em><a class="headerlink" href="#sans.dataloader.readers.tiff_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> 
     96<dd></dd></dl> 
    7497 
    7598</dd></dl> 
    … …  
    87110  <ul> 
    88111<li><a class="reference internal" href="#">tiff_reader</a><ul> 
    89 <li><a class="reference internal" href="#module-DataLoader.readers.tiff_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.tiff_reader</span></tt></a></li> 
     112<li><a class="reference internal" href="#sans-dataloader-readers-tiff-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.tiff_reader</span></tt></a></li> 
    90113</ul> 
    91114</li> 
    … …  
    103126  <h3>Quick search</h3> 
    104127    <form class="search" action="../../search.html" method="get"> 
    105       <input type="text" name="q" size="18" /> 
     128      <input type="text" name="q" /> 
    106129      <input type="submit" value="Go" /> 
    107130      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    129152          <a href="red2d_reader.html" title="red2d_reader" 
    130153             >previous</a> |</li> 
    131         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     154        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    132155          <li><a href="index.html" >Readers</a> &raquo;</li>  
    133156      </ul> 
    … …  
    135158    <div class="footer"> 
    136159        &copy; Copyright 2010, sans group. 
    137       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     160      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    138161    </div> 
    139162  </body> 
Note: See TracChangeset for help on using the changeset viewer.