Ignore:
Timestamp:
Oct 24, 2011 2:02:30 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
70ecd530
Parents:
a4f04f2
Message:

updates docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sansdataloader/docs/sphinx/html/api/readers/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> 
Note: See TracChangeset for help on using the changeset viewer.