<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>get_reader — Astropy v0.2.4</title> <link rel="stylesheet" href="../_static/bootstrap-astropy.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '0.2.4', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="shortcut icon" href="../_static/astropy_logo.ico"/> <link rel="top" title="Astropy v0.2.4" href="../index.html" /> <link rel="up" title="ASCII Tables (astropy.io.ascii)" href="../io/ascii/index.html" /> <link rel="next" title="get_writer" href="astropy.io.ascii.ui.get_writer.html" /> <link rel="prev" title="convert_numpy" href="astropy.io.ascii.core.convert_numpy.html" /> </head> <body> <div class="topbar"> <a class="brand" title="Documentation Home" href="../index.html"></a> <ul> <li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li> <li><a title="General Index" href="../genindex.html">Index</a></li> <li><a title="Python Module Index" href="../py-modindex.html">Modules</a></li> <li> <form action="../search.html" method="get"> <input type="text" name="q" placeholder="Search" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </li> </ul> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right"> <a href="astropy.io.ascii.ui.get_writer.html" title="get_writer"> next » </a> </li> <li class="right"> <a href="astropy.io.ascii.core.convert_numpy.html" title="convert_numpy"> « previous </a> | </li> <li> <a href="../index.html">Astropy v0.2.4</a> » </li> <li><a href="../io/ascii/index.html" accesskey="U">ASCII Tables (<tt class="docutils literal"><span class="pre">astropy.io.ascii</span></tt>)</a> »</li> <li>get_reader</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="get-reader"> <h1>get_reader<a class="headerlink" href="#get-reader" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="astropy.io.ascii.ui.get_reader"> <tt class="descclassname">astropy.io.ascii.ui.</tt><tt class="descname">get_reader</tt><big>(</big><em>Reader=None</em>, <em>Inputter=None</em>, <em>Outputter=None</em>, <em>**kwargs</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/ascii/ui.py#L61" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/ascii/ui.html#get_reader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.ascii.ui.get_reader" title="Permalink to this definition">¶</a></dt> <dd><p>Initialize a table reader allowing for common customizations. Most of the default behavior for various parameters is determined by the Reader class.</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> <li><strong>Reader</strong> – Reader class (default= <tt class="xref py py-class docutils literal"><span class="pre">Basic</span></tt>)</li> <li><strong>Inputter</strong> – Inputter class</li> <li><strong>Outputter</strong> – Outputter class</li> <li><strong>delimiter</strong> – column delimiter string</li> <li><strong>comment</strong> – regular expression defining a comment line in table</li> <li><strong>quotechar</strong> – one-character string to quote fields containing special characters</li> <li><strong>header_start</strong> – line index for the header line not counting comment lines</li> <li><strong>data_start</strong> – line index for the start of data not counting comment lines</li> <li><strong>data_end</strong> – line index for the end of data (can be negative to count from end)</li> <li><strong>converters</strong> – dict of converters</li> <li><strong>data_Splitter</strong> – Splitter class to split data columns</li> <li><strong>header_Splitter</strong> – Splitter class to split header columns</li> <li><strong>names</strong> – list of names corresponding to each data column</li> <li><strong>include_names</strong> – list of names to include in output (default=None selects all names)</li> <li><strong>exclude_names</strong> – list of names to exlude from output (applied after <tt class="docutils literal"><span class="pre">include_names</span></tt>)</li> <li><strong>fill_values</strong> – specification of fill values for bad or missing table values</li> <li><strong>fill_include_names</strong> – list of names to include in fill_values (default=None selects all names)</li> <li><strong>fill_exclude_names</strong> – list of names to exlude from fill_values (applied after <tt class="docutils literal"><span class="pre">fill_include_names</span></tt>)</li> </ul> </td> </tr> </tbody> </table> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"><h3>Page Contents</h3> <ul> <li><a class="reference internal" href="#">get_reader</a></li> </ul> </div> </div> <div class="clearer"></div> </div> <footer class="footer"> <p class="pull-right"> <a href="../_sources/_generated/astropy.io.ascii.ui.get_reader.txt" rel="nofollow">Page Source</a> <a href="#">Back to Top</a></p> <p> © Copyright 2011-2013, The Astropy Developers.<br/> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. Last built 22 Oct 2013. <br/> </p> </footer> </body> </html>